Programming
Fundamentals
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
Rendering-Related Classes

Console

Unigine console is used for standard input, output and error streams for the file loading, rendering system, audio and video systems, path-finding system, physics engine, file system and many others.

Can be opened in any UNIGINE-based application.

How to Open Console

A built-in console is called by pressing the grave accent (`) key, placed under the ESC key:

The console can be hidden by pressing the grave accent (`) key one more time. See how to assign another key here.

Console Operation

Console operation can be either command or variable:

  • Command is a directive to a console to perform a specific task.
  • Variable is an identifier that contains some stored value.

Command Syntax

Console command can take null, one or several arguments. The syntax is:

Source code
command_to_execute // null argument
command_to_execute argument // one argument
command_to_execute argument argument // two arguments

Hints

  • To see the current variable value, other acceptable values and short description, just type it and press the Enter key. For example, if you type the video_resizable variable, you get the following result:
    Source code
    video resizable toggle
    0 is non-resizable mode
    1 is resizable mode
    video_resizable = 1
  • To complete a command or variable name, just start typing first letters and press the TAB key until you get the required result.

How to Change the Console Opening Key

If you want to change the default grave accent (`) console turning on or off key, do one of the following actions:

  • Open the configuration file data/unigine.cfg and change the ASCII-based key code in the following line:
    Source code (XML)
    <item name="console_key" type="int">96</item>

Console

Basic operations on the console, command and variable.

Name Description Arguments
bind
  • Command. Bind a key to a command.

    For example, to bind the asterisk (*) key to the world_reload command, type:

    Source code
    Unigine~# bind * world_reload
1. A key to bind
2. A command to execute
clear
  • Command. Clear all messages from the console window.
console_key
  • Variable. Print the ASCII code of the current console turning on or off key.
  • Command. Assign a new key to turn on or off the console.
An ASCII code of the key
help
  • Command. Print the list of the built-in commands.
hide
  • Command. Hide the console.
ls
  • Command. Print a set of all available console keys, commands and variables.
show
  • Command. Show the console.
switch
  • Command. Switch among all variable values.
    Notice
    Make sure, that the variable is integer.
A variable, which values will be switched
toggle
  • Command. Enable or disable a variable.
    Notice
    Enabled variable will have a default value.

    For example, if you toggle the show_visualizer variable, you will get the following result:

    Source code
    toggle show_visualizer
    show_visualizer = 0 // disabled visualizer
    toggle show_visualizer
    show_visualizer = 1 // enabled visualizer
A variable to be toggled
unbind
  • Command. Unbind a key from a command.
A key to unbind

Console GUI

Operations on the console GUI.

Name Description Arguments
console_size
  • Variable. Print a current size of the console font.
  • Command. Set a size for the console font.
432
(16 by default)
console_font
  • Variable. Print a current path to a *.ttf file used as a console font.
  • Command. Set a path to a *.ttf file to be used as a console font.
A path to a *.ttf file
(core/gui/console.ttf by default)

Engine

Basic operations on the engine.

Name Description Arguments
engine_threaded
Notice
If these variables are enabled, multithreading is used.
0 - disabled
1 - enabled (by default)
quit Quit the engine.

Engine Configuration File

General operations on the engine configuration.

Name Description Arguments
config_load
  • Variable. Print the current path to the engine configuration file.
  • Command. Set a new path to the engine configuration file.
A path to the configuration file
( data/unigine.cfg by default)
config_readonly
  • Variable. Print the value specifying if the data could be written to the configuration file.
  • Command. Specify if the data could be written to the configuration file.
0 - writing is allowed
1 - writing is forbidden
config_save
  • Command. Save the engine configuration file.
A path to the configuration file (optional)

Engine Analyzer

Operations on the engine debugging.

Notice
Available only for debug builds.
Name Description Arguments
engine_analyze
  • Command. Analyze the performance of the engine. Can be used only in the single-threaded mode. The information can be printed to the console or dumped into a specified file.
A path to the logfile to dump the log file information into (optional)

World

Basic operations on world.

Name Description Arguments
world_load
  • Command. Load the specified world. A cache file can also be specified for faster application loading.
1. A name of the world to load (inside of the data directory)
2. A name of the world cache file (optional)
world_quit
  • Command. Clear all the world data.
world_save
  • Command. Save the world.
world_reload
  • Command. Reload the world. A cache file can also be specified to be reloaded.
A name of the world cache file (optional)
world_handler_3d
  • Variable. Print the value indicating which world handler is used.
  • Command. Set the world handler.
0 - screen scale
1 - 3D

World State

Serialized operations on world.

Name Description Arguments
state_save
  • Command. Save states of all world nodes into the .save file and take a screenshot.
    Notice
    File is saved as quicksave.save in the /bin/save directory by default. You can pass another directory as an argument.
1. A path to the file (optional)
2. A noscreenshot flag - save a state without taking a screenshot (optional)
state_restore
  • Command. Restore states of all world nodes.
    Notice
    File is restored using quicksave.save file in the /bin/save directory by default. You can pass another directory as an argument.
A path to the file (optional)

World Resources

Operations, representing information on ObjectGrass, ObjectMeshClutter andWorldClutter objects.

Name Description
world_manager_info
  • Command. Print general information (the number of registered/loaded resources; used memory) on world manager resources, such as:
    1. ImageManaged - loaded images (if not fully loaded, a dummy texture or one-mipmap texture is used)
    2. PathManaged - loaded splines
    3. ImageStream - streamed mask images
    4. MeshStream - streamed meshes used as an intersection mask for grass or clutters
world_manager_list
  • Command. Print the list of resources handled by the world manager (mask images for ObjectGrass and WorldClutter objects), if any.
Notice
To get information on loaded meshes and images, see the Render resources section.

World Queueing

Operations on the world queued nodes.

Name Description Arguments
world_queue
  • Command. Print names of all the queued nodes, if any.
world_delay
  • Variable. Print the current time delay between loading of the queued nodes in seconds.
  • Command. Set the time delay between loading of the queued nodes in seconds. For example, this function can be used to debug streaming of resources.
01
(0 by default)
world_clear
  • Command. Clear the queue and all of the loaded nodes.

Sound

Operations on the sound.

Name Description Arguments
sound_occlusion
  • Variable. Print the value indicating if sound occlusion is enabled.
  • Command. Occlude sound if other nodes are found in front of the sound source.
0 - disabled
1 - enabled (by default)
sound_reverb
  • Variable. Print the current sound reverberation mode.
  • Command. Set a sound reverberation mode.
0 - sound reverberation is disabled
1 - single-environment sound reverberation
2 - multi-environment sound reverberation (by default)

Sound Resources

Operations on the sound resources.

Name Description Arguments
sound_manager_load_samples
  • Variable. Print the value indicating if sound samples are preloaded on world loading.
  • Command. Preload sound samples on world loading (ensure there are no lags afterwards but increases loading time and memory footprint).
0 - disabled (by default)
1 - enabled
sound_manager_info
  • Command. Print general information on sound resources: the number of static and streamed sound sources (registered/loaded; memory used).
sound_manager_list
  • Command. Print the detailed list of sound files, if any, with used space.
sound_manager_sample_static_memory
  • Variable. Print the current cache memory limit for static sound resources in Mbytes.
  • Command. Set the cache memory limit for static sound resources in Mbytes.
11024
(64 by default)
sound_manager_sample_stream_memory
  • Variable. Print the current cache memory limit for streamed sound resources in Mbytes.
  • Command. Set the cache memory limit for streamed sound resources in Mbytes.
11024
(16 by default)

Camera

Operations for fast positioning of the game camera.

Name Description Arguments
camera_get Command. Get the current position of the game camera and its rotation (Euler angles).
camera_set Command. Set position and rotation (Euler angles) of the game camera.
Notice
Position and rotation of the game camera can be changed only if it is unlocked.
Source code
camera_set 20.0 19.0 3.0 0.0 45.0 90.0
The first 3 arguments set position.
The second 3 arguments set rotation (optional)

File System

Operations on the File system.

Name Description Arguments
filesystem_clear
  • Command. Remove all the loaded, but unused resources.
filesystem_icase
  • Variable. Print the value indicating if the case of file names in the data directory is ignored.
  • Command. Ignore the case of file names in the data directory.
0 - checked (by default)
1 - ignored
filesystem_ignore
  • Variable. Print the list of ignored directories.
  • Command. Set the folders to be ignored within the data directory. It can be used to discard version control system folders. This option comes into effect only after the filesystem_reload command is run.
    Notice
    Multiple values are comma separated (no whitespaces).
A full directory name
filesystem_mmap
  • Variable. Print the value indicating if memory-mapped files are used.
  • Command. Use memory-mapped files for faster access.
0 - not used
1 - used (default)
filesystem_reload
  • Command. Reload the file system, thereby update the list of files.

File System Info

Operations, representing information on the File system.

Name Description Arguments
filesystem_info
  • Command. Print general file system information (the total number of files and files per package).
filesystem_list
  • Command. Print the list of all files.

File Queueing

Operations, representing information on the file loading queue.

Name Description Arguments
filesystem_queue
  • Command. Print names of the queued files, if any.
filesystem_delay
  • Variable. Print the current time delay between the loading of the queued files in seconds.
  • Command. Set the time delay between loading of the queued files in seconds. For example, this function can be used to debug streaming of resources.
01
(0 by default)

Editor

Operations on UnigineEditor.

Name Description Arguments
editor_load
  • Command. Load UnigineEditor (both Qt and Unigine-native GUI will be loaded).
editor_quit
  • Command. Quit UnigineEditor (both Qt and Unigine-native GUI will be hidden).
editor_reload
  • Command. Reload UnigineEditor (both Qt and Unigine-native GUI will be reloaded). This command reloads the editor script, all unsaved changes are lost.

Editor Controls

Operations on UnigineEditor controls.

Name Description Arguments
default_presets_edit_mode
  • Command. Enable or disable default preset editing.
0 - disable editing (by default)
1 - enable editing

Asset Browser

Operations on assets.

Name Description Arguments
assets_delete
  • Variable. Print the current mode used to delete assets.
  • Command. Delete all assets by using the specified mode.
0 - delete assets from the assets folder and the sub folders
1 - delete assets from the assets folder and the sub folders and the corresponding assets in the runtime formats generated in the data folder.
assets_import Command. Import an assets from the external folder.
Notice
When importing an asset, the *.asset file with the same name is created in the destination folder.
Source code
assets_import 1 D:\external_assets\plane.fbx
The command receives 3 arguments:
  1. The flag indicating whether to copy the source assets from the external folder into the assets folder or to keep the link to this source file:
    • 0 - copy the source assets into the assets folder and store it together with the generated *.asset file.
    • 1 - do not copy the source assets and keep the link to it inside the generated *.asset file.
  2. An absolute path to the source asset.
  3. (optional) A destination folder relative to the assets folder.
assets_reload Command. Synchronize assets in the assets and the data folder.
assets_verbose
  • Variable. Print the current log level used for the assets system.
  • Command. Set the log level for the assets system.
0 - output only errors and warnings (by default)
1 - output all log information

Scripts

Operations on the world, system and editor scripts.

World Script Analyzer

Operations on the world script debugging.

Notice
Available only for debug builds.

Name Description Arguments
world_memory_usage
  • Command. Print memory usage by the world script to the console or dump into a specified file.
A path to a file to dump the information into (optional)
world_analyze
  • Command. Analyze the performance of the world script. Can be used only in the single-threaded mode. The information can be printed to the console or dumped into a specified file.
A path to the logfile to dump the log file information into (optional)
world_disassemble
  • Command. Disassemble the world script. The information can be printed to the console or dumped into a specified file.
A path to a file to dump the information into (optional)
world_manager_images_memory
  • Variable. Print the cache memory limit set for images in MB.
  • Command. Set the cache memory limit for images in MB.
0 - 8192
(128 by default)
world_manager_meshes_memory
  • Variable. Print the cache memory limit set for meshes in MB.
  • Command. Set the cache memory limit for meshes in MB.
0 - 8192
(128 by default)

Script Debugger

Operations on the per-function breakpoint. The syntax to set the breakpoint is the following:

Source code
system_breakpoint/world_breakpoint/editor_breakpoint set/remove function_name number_of_arguments
Name Description Arguments
world_breakpoint
  • Command. Set a breakpoint to the specified function in the world script.
The syntax to set the breakpoint is the following:
Source code
world_breakpoint set/remove function_name number_of_arguments
1. Name of the function
2. The number of the arguments
system_breakpoint
  • Command. Set a breakpoint to the specified function in the system script.
The syntax to set the breakpoint is the following:
Source code
system_breakpoint set/remove function_name number_of_arguments
1. Name of the function
2. The number of the arguments
editor_breakpoint
  • Command. Set a breakpoint to the specified function in the editor script.
The syntax to set the breakpoint is the following:
Source code
editor_breakpoint set/remove function_name number_of_arguments
1. Name of the function
2. The number of the arguments

Multi-Threading

Name Description Arguments
world_threaded
  • Variable. Print the thread mode used to update the world.
  • Command. Specify if the world will be updated in a single or multiple-threaded mode.
0 - single-threaded
1 - multiple-threaded (by default)
Multiple-threaded mode creates 8 thread jobs and splits the nodes hierarchy: it finds root nodes (with their children) and distributes them in a balanced manner. Nodes are distributed between thread jobs, thread jobs are distributed between CPUs cores. Then, in each thread, it selects nodes to be updated. Thus, world update takes less time in case of complex nodes hierarchy.
physics_threaded
  • Variable. Print the value indicating how many threads are used to perform physical calculations.
  • Command. Set a number of threads used to perform physical calculations.
0 - separate thread is not used at all (physics will be calculated in the main thread) - flush() and render() are called sequentially
1 - one separate thread is used (physics will be calculated in separate thread) - flush() and render() are called simultaneously
2 - all available CPUs are used to perform multi-threaded physical calculations (by default)
pathfind_threaded
  • Variable. Print the value indicating how many threads are used to perform physical calculations.
  • Command. Set a number of threads used to perform physical calculations.
0 - separate thread is not used at all (pathfinding will be calculated in the main thread)
1 - one separate thread is used (pathfinding will be calculated in separate thread)
2 - all available CPUs are used to perform multi-threaded physical calculations (by default)

Asynchronous Operations

Asynchronous operations.

Name Description Arguments
async_log_mode
  • Variable. Print the value indicating which engine component's operations are shown.
  • Command. Print the list of asynchronous operations (loading / unloading of images, meshes, files, etc.) related to the specified engine component.
    Notice
    You can specify whether only loading and unloading operations, or all operations should be shown.
0 - do not print
1 - print operations with the nodes
2 - print operations with the renderer resources (loading / unloading of meshes and textures)
3 - print operations with the file system resources (loading / unloading of files)
2 - print all operations with the nodes, renderer and file systems resources
async_log_priority
  • Variable. Print the value indicating whether only loading and unloading operations, or all operations are shown via async_log_mode .
  • Command. Specify whether only loading and unloading operations, or all operations will be shown via async_log_mode .
0 - print only frequently used operations
1 - print all operations

Visualizer

Operations on the visualizer.

Notice
To debug the world and objects within it, the show_visualizer command should be set to 1.
Name Description Arguments
show_visualizer
  • Variable. Print the current visualizer mode.
  • Command. Specify if the visualizer geometry (bounding volumes, wireframe, physics bodies and shapes, etc.) is shown.
0 - visualizer is not shown (by default)
1 - visualizer is shown with a depth testing (to check if other objects in the scene do not occlude visualized geometry)
2 - visualizer is shown without a depth testing (visualized geometry is rendered in front of all objects in the scene)
show_fps
  • Variable. Print the value indicating if the FPS counter is hidden.
  • Command. Show or hide the FPS counter.
0 - hide the FPS counter
1 - display the FPS counter (by default)
2 - display the FPS counter and statistics on the last 600 frames: minimum FPS, maximum FPS and average FPS for the last 600 frames.
show_messages
  • Variable. Print the value indicating if the system messages are displayed in the viewport.
  • Command. Hide the system messages.
0 - hidden
1 - displayed (by default)

World Debugging

Operations on the world debugging.

Name Description Arguments
world_show_spatial
  • Variable. Print the value indicating if the scene spatial tree is displayed.
  • Command. Display the scene spatial tree.
0 - hidden (by default)
1 - displayed
world_show_visualizer
  • Variable. Print the list of node types for which the visualizer is displayed.
  • Command. Set node types for which the visualizer is displayed.
The available arguments are:
  • all
  • world
  • field
  • light
  • decal
  • object
  • player
  • physical
  • navigation
  • obstacle
  • sound
To hide the visualizer, pass "" as a argument.
render_show_triangles
  • Variable. Print the current wireframe mode for scene triangles.
  • Command. Set the wireframe mode for scene triangles.
0 - triangles are hidden (by default)
1 - front faces with the depth test are shown
2 - front faces without the depth test are shown
3 - front and back faces without the depth test are shown

Node Debugging

Operations on the node debugging.

Name Description Arguments
world_show_handler
  • Variable. Print the value indicating if nodes handlers for lights, particle systems, sectors, portals and so on are displayed.
  • Command. Display nodes handlers for lights, particle systems, sectors, portals, etc.
The available arguments are:
  • all
  • world
  • field
  • light
  • decal
  • object
  • player
  • physical
  • navigation
  • obstacle
  • sound
To hide the visualizer, pass "" as an argument.
render_show_decals
  • Variable. Print the value indicating if the wireframe for decals is displayed.
  • Command. Display the wireframe for decals.
0 - hidden (by default)
1 - displayed

Occluder Debugging

Operations on the occluder debugging.

Name Description Arguments
render_show_occluder
  • Variable. Print the value indicating if buffer used for occluders is displayed in the viewport.
  • Command. Display buffer used for occluders displayed in the viewport.
0 - hidden (by default)
1 - displayed

Physics Debugging

Name Description Arguments
physics_show_contacts
  • Variable. Print the value indicating if contact points between physical bodies are displayed.
  • Command. Display contact points between physical bodies.
0 - hidden (by default)
1 - displayed
physics_show_joints
  • Variable. Print the value indicating if joints between physical bodies are displayed.
  • Command. Display joints between physical bodies.
0 - hidden (by default)
1 - displayed
physics_show_shapes
  • Variable. Print the value indicating if collision shapes for physical bodies are displayed.
  • Command. Display collision shapes for physical bodies.
0 - hidden (by default)
1 - displayed

Texture Debugging

Operations on the texture debugging.

Name Description Arguments
render_show_mipmaps
  • Variable. Print the value indicating if mipmap levels are displayed in color.
  • Command. Display mipmap levels in color.
0 - hidden (by default)
1 - displayed in color

Occlusion Queries

Name Description Arguments
render_show_queries
  • Variable. Print the value indicating if occlusion query boxes are displayed.
  • Command. Display occlusion query boxes.
    Notice
    Make sure that the Culled by occlusion query flag is set for nodes.
0 - hidden (by default)
1 - displayed

Performance Profiler

Operations on the Performance profiler.

Name Description Arguments
show_profiler
  • Variable. Print a mode set to Performance profiler.
  • Command. Specify a mode for Performance profiler.
0 - profiler information is hidden (by default)
1 - generic profiler information is shown
2 - rendering profiler information is shown
3 - physics profiler information is shown
4 - world profiler information is shown
5 - pathfinding and sound usage profiler information is shown
render_profiler 0 - disabled (by default)
1 - enabled

Profiler GUI

Operations on the Performance profiler style.

Name Description Arguments
profiler_size
  • Variable. Print a current size of the profiler font.
  • Command. Set a size for the profiler font.
432
(13 by default)
profiler_font
  • Variable. Print a current path to a *.ttf file used as a profiler font.
  • Command. Set a path to a *.ttf file to be used as a profiler font.
A path to a *.ttf file
(core/gui/font.ttf by default)

Video Settings

Notice
To come to effect, the commands below require video_restart to be run after them.

Name Description
video_restart
  • Command. Restart the video application to apply changes to video settings, if any.

Resolution and Full Screen

Operations on the video resolution adjustment.

Name Description Arguments
video_mode
  • Variable. Print the current video resolution mode.
  • Command. Set a new video resolution mode.
-1 - video_width × video_height
0 - 640 × 360
1 - 960 × 540
2 - 1024 × 576
3 - 1280 × 720
4 - 1366 × 768
5 - 1600 × 900
6 - 1920 × 1080
7 - 2560 × 1440
8 - 3840 × 2160
9 - 640 × 400
10 - 960 × 600
11 - 1024 × 640
12 - 1280 × 800
13 - 1440 × 900
14 - 1680 × 1050
15 - 1920 × 1200
16 - 2560 × 1600
17 - 640 × 480
18 - 800 × 600
19 - 1024 × 768
20 - 1280 × 960
21 - 1280 × 1024
22 - 1600 × 1200
23 - 2048 × 1536
24 - 2560 × 2048
video_width
  • Variable. Print the current screen width.
  • Command. Set the custom screen width.
Notice
Valid only if the video_mode command is set to -1.
010000
video_height
  • Variable. Print the current screen height.
  • Command. Set the custom screen height.
Notice
Valid only if the video_mode command is set to -1.
010000
video_resizable
  • Variable. Print the value indicating if the application window is resizable.
  • Command. Set a resizable mode for an application window (its size can be changed on the fly without restarting the application).
0 - non-resizable mode (by default)
1 - resizable mode
video_fullscreen
  • Variable. Print the value indicating if the application is running in full-screen mode.
  • Command. Set full-screen mode for the application window.
0 - windowed mode (by default)
1 - full-screen mode
2 - full-window mode when an application window is rendered without decorations

Graphics Settings

Operations on the graphics adjustment.

Name Description Arguments
video_vsync
  • Variable. Print the value indicating if the vertical FPS synchronization is enabled.
  • Command. Set the vertical FPS synchronization.
0 - not to synchronize FPS (by default)
1 - synchronize FPS
video_refresh
  • Variable. Print the current graphics refresh rate.
  • Command. Set the graphics refresh rate.
0 (by default) – 200
video_gamma
  • Variable. Print the current gamma correction value.
  • Command. Set the gamma correction value.
0.53.5
(1.0 by default)

Multi-Monitor and Stereo Rendering

Name Description Arguments
video_surround
  • Variable. Print a value indicating whether rendering across 3 monitors is enabled or not.
  • Command. Enable or disable rendering of the application across 3 monitors.
0 - disabled (by default)
1 - enabled
video_surround_border
  • Variable. Print the size of monitor bezel compensation in pixels.
  • Command. Set the size of monitor bezel compensation in pixels. It is used together with video_surround enabled.
video_quad_buffer
  • Variable. Print a value indicating if quad buffering is enabled.
  • Command. Enable quad buffered stereo.
0 - disabled (by default)
1 - enabled

Rendering Settings

Operations on the renderer.

Name Description Arguments
shaders_reload
  • Command. Reload the renderer. This command reloads all shaders (but does not update shader variables - it is done automatically). It can also be called, for example, for graphics API changes to come to effect.
textures_reload
  • Command. Reload all render textures.
render_manager_reload
  • Command. Reload all render manager resources. You can specify an optional argument to reload resources selectively.
  • mesh - reload only meshes
  • texture - reload only textures

Rendering Resources

Operations, representing information on the rendering resources.

Name Description
render_manager_info
  • Command. Print general information (the number of registered/loaded resources; memory used) on renderer manager resources:
    1. Mesh - loaded meshes
    2. MeshSkinned - skinned meshes
    3. MeshDynamic - dynamic meshes stored in the memory rather than on disk
    4. TextureManaged - images loaded into the memory; if image is not fully loaded, a dummy texture or a mipmap texture is used
    5. TextureStream - streamed images
render_manager_list
  • Command. Print the list of loaded resources and detailed information regarding:
    1. Meshes, MeshSkinned and MeshDynamic with used memory
    2. TextureManaged (textures loaded into memory at once) and TextureStream (textures streamed on demand) with texture format, used compression, if any, texture dimensions and size (available only for already loaded textures).

Rendering Buffers

Rendering Buffer Info

Operations, representing information on the rendering buffers.

Name Description
render_info
  • Command. Print general information on render buffers:
    1. Renderer - GPU and available video memory
    2. Per-type information on buffers created by the renderer, their number and used space
    3. Total - how much video memory is used in whole
render_list
  • Command. Print the detailed list of render buffers, with texture size, format and used space.

Rendering Buffer Debugging

Operations on the rendering buffer debugging.

Name Description Arguments
render_show_textures
  • Variable. Print the current set of buffers used by the renderer.
  • Command. Specify a mode of textures buffers used by the renderer (how many buffers are shown depends on the number of buffers in a row specified by the render_show_number ) command.
0 - all buffers are hidden (by default)
1 - show render textures (compact).
2 - show render textures (full).
render_use_format_rg11b10
  • Variable. Print the value indicating if the RG11B10 texture format is used for rendering buffers.
  • Command. Set a value indicating if the RG11B10 texture format is used for rendering buffers.
0 - do not use the RG11B10 texture format
1 - use the RG11B10 texture format (by default).
render_use_format_depth_d32f
  • Variable. Print the value indicating if the D32F texture format is used for the depth buffers.
  • Command. Set a value indicating if the D32F texture format is used for the depths buffers.
0 - do not use the D32F texture format
1 - use the D32F texture format (by default).
render_show_number
  • Variable. Print the current number of buffers in a row to be output to the screen.
  • Command. Set the number of buffers in a row to be output to the screen.
A number of buffers in a row (from 1 to 8)
(4 by default).
1 - a single texture per screen
2 - 4 textures per screen
3 - 9 textures per screen
4 - 16 textures per screen

Rendering Passes

Operations on rendering passes.

Name Description Arguments
render_skip_post_materials 0 - enabled (by default)
1 - skipped
render_skip_render_materials 0 - enabled (by default)
1 - skipped
render_skip_transparent_ambient
  • Variable. Print the value indicating if the ambient rendering pass is skipped for transparent objects rendering.
  • Command. Skip the ambient rendering pass for transparent objects rendering.
Notice
This console command takes effect only when the forward rendering pass is used for transparent objects rendering.
0 - enabled (by default)
1 - skipped
render_skip_transparent_light
  • Variable. Print the value indicating if the rendering pass for world lights is skipped for transparent objects rendering.
  • Command. Skip the world lights' rendering pass for transparent objects rendering.
Notice
This console command takes effect only when the forward rendering pass is used for transparent objects rendering.
0 - enabled (by default)
1 - skipped

Meshes

Operations on the mesh rendering.

Name Description Arguments
render_alpha_fade
  • Variable. Print the value indicating if alpha fading (dithering) is enabled for objects.
  • Command. Use alpha fading (dithering) for objects.
0 - disabled
1 - enabled (by default)

Mesh Loading

Operations on the mesh loading.

Name Description Arguments
render_manager_create_dummy_meshes
  • Variable. Print the current loading mode for the dummy meshes.
  • Command. Preload dummy meshes (without any vertex data, only surfaces) on the world start-up. Meshes with full geometry data are loaded on demand, when they get into the view frustum. This option increases the world loading time, but safeguards against any lags on resource loading in run-time.
    Notice
    This command doesn't force loading of meshes of ObjectMeshStatic, ObjectMeshClutter and ObjectMeshCluster.
0 - dummy meshes are loaded only when they get into a view frustum
1 - dummy meshes are preloaded on the start-up (by default)
render_manager_create_meshes
  • Variable. Print the current loading mode for all meshes.
  • Command. Load all meshes on the start-up. This option insures against any lags on mesh loading at run-time, but increases world loading time.
    Notice
    This command doesn't force loading of meshes of ObjectMeshStatic, ObjectMeshClutter and ObjectMeshCluster.
0 - meshes are loaded only when they get into a view frustum (by default)
1 - meshes are preloaded on the start-up
render_manager_meshes_memory
  • Variable. Print the current cache memory limits for meshes, in percents of the total GPU memory.
  • Command. Set the cache memory limits for meshes, in percents of the total GPU memory.
0 - 100
(15 by default)

Decals

Operations on the mesh rendering.

Name Description Arguments
render_decals
  • Variable. Print the value indicating if decals should be rendered.
  • Command. Render decals.
0 - disabled
1 - enabled (by default)

Fields

Operations on the field rendering.

Name Description Arguments
render_field_height_resolution
  • Variable. Print the current resolution of the texture into which all textures set for all FieldHeight objects are rendered.
  • Command. Set resolution of the texture into which all textures set for all FieldHeight objects are rendered.
0 - 128×128
1 - 256×256
2 - 512×512 (by default)
3 - 1024×1024
4 - 2048×2048
5 - 4096×4096
6 - 8192×8192
render_field_height_high_precision
  • Variable. Print the variable indicating the type of the heightmap texture for FieldHeight object.
  • Command. Set the variable indicating the type of the heightmap texture for FieldHeight object.
0 - is to use 16-bit texture (R16) (by default)
1 - is to use 32-bit texture (R32F)
render_field_shoreline_resolution
  • Variable. Print the current resolution of the texture into which all textures set for all FieldShoreline objects are rendered.
  • Command. Set resolution of the texture into which all textures set for all FieldShoreline objects are rendered.
0 - 128×128
1 - 256×256
2 - 512×512 (by default)
3 - 1024×1024
4 - 2048×2048
5 - 4096×4096
6 - 8192×8192

Textures

Operations on the texture rendering.

Name Description Arguments
render_textures_quality
  • Variable. Print the current texture resolution.
  • Command. Set the texture resolution.
0 - low resolution
1 - medium resolution
2 - high resolution (by default)
render_textures_max_resolution
  • Variable. Print the current texture resolution.
  • Command. Set max resolution of all textures. The engine doesn't compress existing textures: it uses specified mip maps of *.dds textures.
0 - is 128x128
1 - is 256x256
2 - is 512x512
3 - is 1024x1024
4 - is 2048x2048
5 - is 4096x4096
6 - is 8192x8192
7 - is 16384x16384
-5 - is 1x1
render_filter
  • Variable. Print the current texture filtering mode.
  • Command. Set the texture filtering mode.
0 - bilinear filtering
1 - trilinear filtering (by default)
render_anisotropy
  • Variable. Print the current texture anisotropy level.
  • Command. Set the texture anisotropy level.
0 - level 1
1 - level 2 (by default)
2 - level 4
3 - level 8
4 - level 16

Texture Loading

Operations on the texture loading.

Name Description Arguments
render_manager_textures_memory
  • Variable. Print the current cache memory limits for textures, in percents of the total GPU memory.
  • Command. Set the cache memory limits for textures, in percents of the total GPU memory.
0 - 100
(65 by default)

Shaders

Operations on shaders.

Name Description Arguments
render_defines
  • Command. Print the macros list related to the renderer (defines to make corresponding resources available in shaders).
render_shaders_quality
  • Variable. Print the current shader quality.
  • Command. Set the shader quality.
0 - low
1 - medium (by default)
2 - high

Shader Loading

Operations on the shader loading.

Name Description Arguments
render_manager_create_shaders
  • Variable. Print the value indicating if shaders are compiled on the start-up.
  • Command. Compile all shaders that are used in the loaded world on start-up.
0 - non-compiled (by default)
1 - compiled

Effects and Postprocesses

Operations on the effects and postprocesses.

Name Description Arguments
render_auxiliary
  • Variable. Print the value indicating if the auxiliary render buffer is enabled.
  • Command. Enable auxiliary render buffer (should be enabled for render and post post-processes to work)
0 - disabled
1 - enabled (by default)
render_dof
  • Variable. Print the value indicating if the Gaussian blur depth of field effect is enabled.
  • Command. Enable the Gaussian blur depth of field effect.
0 - disabled (by default)
1 - enabled
render_dof_resolution
  • Variable. Print the value indicating the resolution of DOF.
  • Command. Set the DOF rendering resolution.
0 - quad resolution
1 - half resolution
2 - full resolution (by default)
render_dof_quality
  • Variable. Print the value indicating the quality of DOF.
  • Command. Set the DOF rendering quality.
0 - low
1 - medium (by default)
2 - high
2 - ultra
render_dof_bokeh_mode
  • Variable. Print the value indicating the mode of bokeh DOF effect.
  • Command. Set the DOF bokeh effect mode.
0 - ring (by default)
1 - circle
render_dof_increased_accuracy
  • Variable. Print the value indicating if the DOF increased accuracy is enabled.
  • Command. Enable or disable the DOF increased accuracy.
0 - disabled (by default)
1 - enabled
render_dof_focus_improvement
  • Variable. Print the value indicating if the DOF render_dof_focus_improvement is enabled.
  • Command. Enable or disable the DOF render_dof_focus_improvement.
0 - disabled (by default)
1 - enabled
render_supersampling
  • Variable.
  • Command.
render_bloom_passes
  • Variable.
  • Command.
render_occluders
  • Variable.
  • Command.
render_ssgi
  • Variable.
  • Command.
render_ssgi_resolution
  • Variable.
  • Command.
render_ssgi_quality
  • Variable.
  • Command.
render_antialiasing
  • Variable. Print the current anti-aliasing type.
  • Command. Set the anti-aliasing type.
0 - do not use anti-aliasing
1 - use FXAA
2 - use TAA
render_alternative_taa
  • Variable. Print the value indicating if the alternative TAA is enabled. The alternative TAA provides better antialiasing but produces more blurred image.
  • Command. Enable or disable the alternative TAA. The alternative TAA provides better antialiasing but produces more blurred image.
0 - disabled (by default)
1 - enabled
render_taa_color_clamping
  • Variable. Print the value indicating if TAA color clamping is enabled.
  • Command. Enable or disable TAA color clamping (when TAA is enabled). This command clamps the color of the current and previous frame. The image becomes more sharp.
0 - disabled TAA color clamping
1 - enable (by default)
render_taa_velocity_clamping
  • Variable. Print the value indicating if TAA velocity clamping is enabled.
  • Command. Enable or disable TAA velocity clamping (when TAA is enabled). This command controls the number of frames for velocity buffer. That reduces the blurring in dynamic scenes with a lot of moving objects
0 - disabled TAA velocity clamping
1 - enable (by default)
render_taa_fix_flicker
  • Variable. Print the value indicating if the bright pixels flicker fix is enabled.
  • Command. Enable or disable the bright pixels flicker fix (when TAA is enabled).
Notice
Enabling fix flicker may increase performance costs.
0 - disabled fix flicker
1 - enable (by default)
render_filmic
  • Variable. Print the value indicating if the filmic high-dynamic range color correction rendering is enabled.
  • Command. Enable the filmic high-dynamic range color correction rendering.
0 - disabled (by default)
1 - enabled
render_bloom
  • Variable. Print the value indicating if the bloom effect is enabled.
  • Command. Enable the bloom effect.
0 - disabled (by default)
1 - enabled
render_bloom_quality
  • Variable. Print the value indicating the quality of the bloom effect.
  • Command. Set the quality of the bloom effect.
0 - half resolution
1 - full resolution (by default)
render_bokeh
  • Variable. Print the value indicating if the bokeh effect is enabled.
  • Command. Enable the bokeh effect.
0 - disabled (by default)
1 - enabled
render_cross
  • Variable. Print the value indicating if the cross flares effect is enabled.
  • Command. Enable the cross flares effect.
0 - disabled
1 - enabled (by default)
render_exposure_mode
  • Variable. Print the value indicating what mode of the adaptive exposure effect is enabled.
  • Command. Change the mode of the adaptive exposure effect.
0 - disabled
1 - logarithmic adaptive exposure
2 - quadratic adaptive exposure
render_lens
  • Variable. Print the value indicating if the lens flares effect is enabled.
  • Command. Enable the lens flares effect.
0 - disabled (by default)
1 - enabled
render_motion_blur
  • Variable. Print the value indicating if the motion blur effect is enabled.
  • Command. Enable the motion blur effect.
0 - disabled
1 - enabled (by default)
render_motion_blur_quality
  • Variable. Print the value indicating if the high-quality motion blur effect is enabled.
  • Command. Enable the high-quality motion blur effect.
0 - disabled (low-quality motion blur effect is used)
1 - enabled (by default)
render_reflection_dynamic
  • Variable. Print the value indicating if dynamic reflection is enabled.
  • Command. Enable dynamic reflection.
0 - disabled
1 - enabled (by default)
render_reflection_lods
  • Variable. Print the value indicating if dynamic reflections is enabled.
  • Command. Enable reduction of resolution of dynamic reflections when the camera moves away.
0 - disabled
1 - enabled (by default)
render_refraction
  • Variable. Print the value indicating if refraction is enabled.
  • Command. Enable refraction.
0 - disabled
1 - enabled (by default)
render_sharpen
  • Variable. Print the value indicating if the sharpening effect is enabled.
  • Command. Enable or disable the sharpening effect.
0 - disabled (by default)
1 - enabled
render_vr_emulation
  • Variable.
  • Command.
render_stereo
  • Variable. Print the value indicating the current stereo rendering mode.
  • Command. Set the stereo rendering mode (it is not possible to set a stereo mode via a console if a default system script is used; it allows for setting it only on the start-up).
0 - disabled (by default)
1 - enabled anaglyph stereo
2 - enabled interlaced stereo
3 - enabled horizontal stereo
4 - enabled vertical stereo
render_ssr
  • Variable. Print the value indicating if screen space reflections are enabled.
  • Command. Enable or disable screen space reflections.
0 - disabled
1 - enabled (by default)
render_ssr_resolution
  • Variable. Print the value indicating the quality of screen space reflections.
  • Command. Set the quality of screen space reflections.
0 - render reflections in quad resolution
1 - render reflections in half resolution (by default)
1 - render reflections in full resolution
render_ssr_scale
  • Variable. Print the current scale of screen space reflections.
  • Command. Set the scale of screen space reflections.
Scale can be in range [0;10]
1 by default
render_ssr_stretching
  • Variable. Print the current stretching factor of screen space reflections.
  • Command. Set the stretching factor of screen space reflections.
Stretching factor can be in range [0;10]
0.5 by default
render_ssr_roughness_quality
  • Variable. Print the current quality of screen space reflections roughness.
  • Command. Set the quality of screen space reflections roughness.
0 - low quality
1 - medium quality (by default)
2 - high quality
3 - ultra quality
render_ssr_normal_threshold
  • Variable. Print the value indicating if the normal threshold is enabled for screen space reflections. The normal threshold limits blur of screen space reflections (calculation of SSR roughness) by normals.
  • Command. Enable or disable the normal threshold for screen space reflections. The normal threshold limits blur of screen space reflections (calculation of SSR roughness) by normals.
0 - disable
1 - enable (by default)
render_ssr_depth_threshold
  • Variable. Print the value indicating if the depth threshold is enabled for screen space reflections. The depth threshold limits blur of screen space reflections (calculation of SSR roughness) by depth.
  • Command. Enable or disable the depth threshold for screen space reflections. The depth threshold limits blur of screen space reflections (calculation of SSR roughness) by depth.
0 - disable
1 - enable (by default)
render_ssr_near
  • Variable. Print the value indicating if screen space reflections calculation is enabled for the near view.
  • Command. Enable or disable screen space reflections calculation for the near view.
0 - disable
1 - enable (by default)
render_ssr_near_quality
  • Variable. Print the current quality of screen space reflections rendered at the near view.
  • Command. Set the quality of screen space reflections rendered at the near view.
0 - low quality
1 - medium quality (by default)
2 - high quality
3 - ultra quality
render_ssr_near_distance_scale
  • Variable. Print the scale of the rendering distance of the near view.
  • Command. Set the scale for the rendering distance the near view.
Scale in range [0;10]
1 by default
render_ssr_far
  • Variable. Print the value indicating if screen space reflections calculation is enabled for the far view.
  • Command. Enable or disable screen space reflections calculation for the far view.
0 - disable
1 - enable (by default)
render_ssr_far_quality
  • Variable. Print the current quality of screen space reflections rendered at the far view.
  • Command. Set the quality of screen space reflections rendered at the far view.
0 - low quality
1 - medium quality (by default)
2 - high quality
3 - ultra quality
render_ssr_far_distance_scale
  • Variable. Print the scale of the rendering distance of the far view.
  • Command. Set the scale for the rendering distance of the far view.
Scale in range [0;10]
1 by default
render_sss
  • Variable. Print the value indicating if the subsurface scattering is enabled.
  • Command. Enable or disable the subsurface scattering.
0 - disabled
1 - enabled
render_sss_resolution
  • Variable. Print the value indicating which resolution mode is used for subsurface scattering.
  • Command. Set the resolution mode to be used for subsurface scattering.
0 - quarter
1 - half (by default)
2 - full
render_sss_quality
  • Variable. Print a value indicating which subsurface scattering quality mode is used.
  • Command. Set the quality mode for the subsurface scattering.
0 - low
1 - medium
2 - high
3 - ultra

Lighting and Shading

Operations on the lighting and shading.

Name Description Arguments
render_environment
  • Variable. Print the value indicating if the environment is enabled.
  • Command. Use the environment.
0 - disabled
1 - enabled (by default)
render_haze
  • Variable. Print the current mode of haze rendering.
  • Command. Set the mode of haze rendering.
0 - disabled the haze
1 - enabled the haze colored the specific color
2 - enabled the haze colored the sky LUT (by default)
render_specular_light
  • Variable. Print the value indicating if the specular light is rendered.
  • Command. Enable or disable rendering of the specular light.
0 - disable
1 - enable (by default)
render_lights_max_per_batch
  • Variable. Print the current number of lights per batch call.
  • Command. Set maximum number of lights per batch call.
0 - disabled optimization (by default)
render_lights_tile_grid_size
  • Variable. Print the grid size in tiles per axis (8 by default).
  • Command. Set the grid size in tiles per axis.
render_shadows
  • Variable. Print a value indicating whether shadows are rendered or not.
  • Command. Enable or disable shadows rendering.
0 - skip shadows rendering
1 (default) - enable shadows rendering
render_shadows_d32f
  • Variable.
  • Command.
0 - skip shadows rendering
1 (default) - enable shadows rendering
render_ssao
  • Variable. Print the value indicating whether screen-space ambient occlusion is enabled.
  • Command. Use screen-space ambient occlusion.
0 - disable SSAO
1 - use SSAO
render_ssao_quality
  • Variable. Print the value indicating the quality of screen-space ambient occlusion.
  • Command. Set screen-space ambient occlusion quality.
0 - use 4 samples
1 - use 8 samples
2 - use 16 samples
3 - use 32 samples
render_ssao_resolution
  • Variable. Print the value indicating the resolution of screen-space ambient occlusion.
  • Command. Set screen-space ambient resolution quality.
0 - quarter
1 - half (by default)
2 - full
render_ssao_noise
  • Variable. Print the value indicating if screen-space ambient occlusion noise is enabled.
  • Command. Enable the screen-space ambient occlusion noise.
0 - disabled
1 - enabled
render_parallax
  • Variable. Print the value indicating if the parallax occlusion mapping is enabled.
  • Command. Enable parallax occlusion mapping.
0 - disabled
1 - enabled (by default)
render_gbuffer_ao
  • Variable. Print the value indicating if the G-Buffer ambient occlusion is enabled.
  • Command. Enable G-Buffer ambient occlusion.
0 - skip G-Buffer ambient occlusion
1 - use G-Buffer ambient occlusion (by default)
render_gbuffer_lightmap
  • Variable. Print the value indicating if the G-Buffer lightmap is enabled.
  • Command. Enable G-Buffer lightmap usage.
0 - skip G-Buffer lightmap
1 - use G-Buffer lightmap (by default)
render_gbuffer_material_mask
  • Variable. Print the value indicating if the G-Buffer material mask is enabled.
  • Command. Enable G-Buffer material mask.
0 - skip G-Buffer material mask
1 - use G-Buffer material mask (by default)
render_gbuffer_microfiber
  • Variable. Print the value indicating if the G-Buffer microfiber effect is enabled.
  • Command. Enable the G-Buffer microfiber effect.
0 - skip G-Buffer microfiber effect
1 - use G-Buffer microfiber effect (by default)
render_gbuffer_specular
  • Variable. Print the value indicating if the G-Buffer specular is enabled.
  • Command. Enable the G-Buffer specular.
0 - skip G-Buffer specular
1 - use G-Buffer specular (by default)
render_gbuffer_translucent
  • Variable. Print the value indicating if the G-Buffer translucency is enabled.
  • Command. Enable G-Buffer translucency.
0 - skip G-Buffer translucency
1 - use G-Buffer translucency (by default)
render_gbuffer_velocity
  • Variable. Print the value indicating if the G-Buffer velocity is enabled.
  • Command. Enable G-Buffer velocity.
0 - skip G-Buffer velocity
1 - use G-Buffer velocity (by default)

Geodetics

Operations on geodetics.

Name Description Arguments
render_show_geodetic_pivot 0 - the geodetic pivot is hidden (by default)
1 - the geodetic pivot is displayed

Lights

Operations on lights.

Name Description Arguments
render_show_lights
  • Variable. Print the value indicating if the light areas are displayed without attenuation.
  • Command. Display light areas without attenuation.
0 - lights are faded (by default)
1 - lights are displayed without attenuation
render_show_scissors
  • Variable. Print the value indicating if scissor rectangles are shown.
  • Command. Enable scissor rectangles.
0 - hidden (by default)
1 - shown
render_skip_transparent_deferred
  • Variable. Print the value indicating if the deferred pass for transparent objects is skipped.
  • Command. Skips the deferred pass for transparent objects.
0 - enabled (by default)
1 - skipped
render_world_lights_per_forward_object
  • Variable. Print the value indicating the maximum number of world lights per object (only for forward material).
  • Command. Set the maximum number of world lights per object (only for forward material).
[0;128] - 4 is the default value (128 max)
render_omni_lights_per_forward_object
  • Variable. Print the value indicating the maximum number of omni lights per object (only for forward material).
  • Command. Set the maximum number of omni lights per object (only for forward material).
[0;128] - 4 is the default value (128 max)
render_proj_lights_per_forward_object
  • Variable. Print the value indicating the maximum number of projected lights per object (only for forward material).
  • Command. Set the maximum number of projected lights per object (only for forward material).
[0;128] - 4 is the default value (128 max)
render_env_probes_per_forward_object
  • Variable. Print the value indicating the maximum number of environment probes per object (only for forward material).
  • Command. Set the maximum number of environment probes per object (only for forward material).
[0;128] - 4 is the default value (128 max)

Shadows

Operations on shadows.

Name Description Arguments
render_shadow_shafts
  • Variable. Print the value indicating if shadow shafts are enabled.
  • Command. Enable shadows shafts.
0 - disabled
1 - enabled (by default)
render_sun_shafts
  • Variable. Print the value indicating if sun shadows shafts are enabled.
  • Command. Enable sun shadows.
0 - disabled
1 - enabled (by default)
render_show_cascades
  • Variable. Print the value indicating if Parallel Split Shadow Map (PSSM) splits for world lights are enabled.
  • Command. Enable Parallel Split Shadow Map (PSSM) splits for world lights.
0 - disabled (by default)
1 - enabled
render_show_penumbra
  • Variable. Print the value indicating if penumbra (half-shade regions) in color is enabled.
  • Command. Enable penumbra (half-shade regions).
0 - disabled (by default)
1 - enabled
render_soft_shadows
  • Variable. Print the value indicating if the soft shadows are used.
  • Command. Enable or disable the soft shadows.
0 - disabled
1 - enabled
render_soft_shadows
  • Variable. Print the value indicating if the quality of the soft shadows.
  • Command. Set the quality of the soft shadows.
0 - low
1 - medium
2 - high
render_omni_shadow_jitter
  • Variable. Print the value indicating if the jittering for shadows casted by the omni light sources is enabled.
  • Command. Enable or disable jittering for shadows casted by the omni light sources.
0 - disabled
1 - enabled
render_lerp_cascades
  • Variable. Print the value indicating if the shadows cascades lerp is enabled.
  • Command. Enable or disable the shadows cascades lerp.
0 - disabled
1 - enabled

Clouds Rendering

Name Description Arguments
render_clouds_transparent_order
  • Variable. Print a value indicating if rendering of clouds after all transparent objects (except water) is enabed.
  • Command. Enable rendering of clouds after all transparent objects (except water).
0 - disabled (by default)
1 - enabled

Terrain Rendering

Notice
The commands described below affect only terrain (the ObjectTerrain class).
Name Description Arguments
render_terrain_anisotropy
  • Variable. Print a value indicating the current terrain texture anisotropy level.
  • Command. Set the terrain texture anisotropy level.
0 - anisotropy level 1
1 - anisotropy level 2
2 - anisotropy level 4 (default)
3 - anisotropy level 8
4 - anisotropy level 16
render_terrain_refined_albedo
  • Variable. Print a value indicating what terrain albedo textures (coarse of refined) are used.
  • Command. Set the type (coarse of refined) of albedo terrain textures.
0 - use coarse albedo
1 - use refined albedo
render_terrain_refined_normal
  • Variable. Print a value indicating what terrain normal textures (coarse of refined) are used.
  • Command. Set the type (coarse of refined) of normal terrain textures.
0 - use coarse normal
1 - use refined normal
render_terrain_refined_mask
  • Variable. Print a value indicating what terrain mask textures (coarse of refined) are used.
  • Command. Set the type (coarse of refined) of mask terrain textures.
0 - use coarse mask
1 - use refined mask

Water Rendering

Notice
The commands described below affect only global water (the ObjectWater class).
Name Description Arguments
render_water_ssr
  • Variable. Print a value indicating if the water screen-space reflections are enabled.
  • Command. Enable the water screen-space reflections.
0 - disabled
1 - enabled (by default)
render_water_ssr_quality
  • Variable. Print a value indicating which water screen-space reflections quality mode is used.
  • Command. Set the quality mode for the water screen-space reflections.
0 - low
1 - medium
2 - high
3 - ultra
render_water_ssr_increased_accuracy
  • Variable. Print a value indicating if the increased accuracy for the water screen-space reflections is enabled.
  • Command. Enable the increased accuracy for the water screen-space reflections.
0 - disabled
1 - enabled
render_water_fragment_discard
  • Variable. Print the value indicating if full fragment discard is enabled for field spacers used with water.
  • Command. Enable or disable full fragment discard for field spacers used with water.
0 - disabled (by default)
1 - enabled
render_water_enviroment_probes
  • Variable. Print the value indicating if environment probes are enabled for water rendering.
  • Command. Enable or disable environment probes for water rendering.
0 - disable
1 - enable (by default)
render_water_lights
  • Variable. Print the value indicating if lights are enabled for water rendering.
  • Command. Enable or disable lights for water rendering.
0 - disable
1 - enable (by default)
render_water_shafts
  • Variable. Print the value indicating if underwater shafts are enabled.
  • Command. Enable or disable underwater shafts.
0 - disable
1 - enable (by default)
render_water_anisotropy
  • Variable. Print a value indicating the current water texture anisotropy level.
  • Command. Set the water texture anisotropy level.
  • Variable. Print the value indicating the current water texture anisotropy level.
  • Command. Set the water texture anisotropy level.
0 - anisotropy level 1
1 - anisotropy level 2 (default)
2 - anisotropy level 4
3 - anisotropy level 8
4 - anisotropy level 16
render_water_opacity_depth
  • Variable. Print the value indicating if writing depth for water in opacity buffer is enabled.
  • Command. Enable or disable writing depth for water in opacity buffer.
0 - disable
1 - enable (by default)
render_water_shoreline_wetness
  • Variable. Print the value indicating if shoreline wetness is enabled.
  • Command. Enable or disable shoreline wetness.
0 - disable
1 - enable (by default)

Output Modes

Name Description Arguments
render_panorama
  • Variable. Print the value indicating which mode of panoramic rendering is enabled.
  • Command. Enable panoramic rendering of the specified mode.
Notice
If the panoramic rendering is enabled, underwater shafts and water line effects will be disabled.
0 - disabled panoramic rendering (by default)
1 - a 180-degree panorama with curved edges
2 - a 180-degree linear panorama without distortion at the edges
3 - a 180-degree spherical panorama (fisheye)
4 - a 360-degree panorama with curved edges
5 - a 360-degree panorama with curved edges
6 - a 360-degree spherical panorama (fisheye)

Other Settings

Name Description Arguments
render_queries
  • Variable. Print the value indicating if a query test is run.
  • Command. Run an additional hardware occlusion query test before sending data to the GPU.
0 - disable occlusion query
1 - enable occlusion query for all objects with the Culled by occlusion query flag set (isQuery returns 1) (by default)
2 - enable occlusion query for all objects
render_queries_num_frames
  • Variable. Print the value indicating the number of frames required for the occlusion query update.
  • Command. Set the number of frames for the occlusion query update.
Notice
Make sure that the additional hardware occlusion query test is run.
Number of frames

Renderers

Name Description Arguments
video_debug
  • Variable. Print the value indicating whether the debug context is enabled.
  • Command. Enable the debug context of OpenGL or DirectX 11. To come to effect, the command requires video_restart to be run after it.
    Notice
    Enabling the debug context may cause performance drop (~30-40%).
Direct X:
  • 0 to disable
  • 1 to write all DirectX errors (red) and warnings (yellow). If the error occurred, it means that there is a mistake in API.
  • 2 to write all DirectX errors (red) and warnings (yellow). If the error occurred, the engine will crash and the full callstack will be shown.
OpenGL:
  • 0 to disable
  • 1 to write all OpenGL errors (red) and warnings (yellow). If the error occurred, it means that there is a mistake in API.
  • 2 works in the same way as 1 mode.

DirectX 11

Operations on the Direct3D11 API.

Name Description Arguments
d3d11_render_desc
  • Command. Print the information about the hardware configuration.
d3d11_render_use_compute_shader_11
  • Variable. Print the value indicating if the Direct3D 11 level compute shader is applied.
  • Command. Apply the Direct3D 11 level compute shader.
0 - not applied
1 - applied (by default)
d3d11_render_use_tessellation
  • Variable. Print the value indicating if tessellation is enabled.
  • Command. Enable tessellation.
0 - disabled
1 - enabled (by default)

OpenGL

Operations on the OpenGL API.

Name Description Arguments
gl_render_renderer
  • Command. Print the information on the graphics card.
gl_render_vendor
  • Command. Print the manufacturer of the OpenGL driver.
gl_render_version
  • Command. Print the version of the OpenGL driver.
gl_render_shading_language
  • Command. Print the version of the OpenGL shading language.
gl_render_extensions
  • Command. Print OpenGL render extensions.
gl_render_use_arb_compute_shader
  • Variable. Print the value indicating if the GL_ARB_compute_shader extension is set.
  • Command. Set the GL_ARB_compute_shader extension.
0 - not set (by default)
1 - set
gl_render_use_arb_sample_shading
  • Variable. Print the value indicating if the GL_ARB_sample_shading extension is set.
  • Command. Set the GL_ARB_sample_shading extension.
0 - not set
1 - set (by default)
gl_render_use_arb_tessellation_shader
  • Variable. Print the value indicating if the GL_ARB_tessellation_shader extension is set.
  • Command. Set the GL_ARB_tessellation_shader extension.
0 - not set
1 - set (by default)
gl_render_skip_errors
  • Variable. Print the value indicating if OpenGL errors are skipped.
  • Command. Skip OpenGL errors.
0 - checked (by default)
1 - skipped

OpenAL Settings

Operations on the OpenAL API.

Name Description Arguments
al_sound_renderer
  • Command. Print the information on the sound card.
al_sound_vendor
  • Command. Print the manufacturer of the OpenAL driver.
al_sound_version
  • Command. Print the version of the OpenAL driver.
al_sound_extensions
  • Command. Print the available OpenAL sound extensions.
alc_sound_extensions
  • Command. Print OpenAL context sound extensions.
al_sound_skip_errors
  • Variable. Print the value indicating if OpenAL errors are skipped.
  • Command. Skip OpenAL errors.
0 - checked (by default)
1 - skipped

Screenshots

Operations on the screenshot.

Name Description Arguments
video_extension
  • Variable. Print the current screenshot format.
  • Command. Set a screenshot format.
0 - TGA (by default)
1 - DDS
2 - PNG
3 - JPG
video_grab
  • Command. Take a screenshot.
    Notice
    A screenshot is saved in the bin/screenshots directory by default. You can specify another directory.
A path to the folder the screenshots will be saved in (optional)

General Information

Memory Info

Operations, representing information on the system memory.

Name Description
memory_dump
  • Command. Print information on the memory dump in form of the fragmentation map.
memory_info
  • Command. Print information on the memory usage:
    1. Heap usage - size of the heap memory
    2. Memory usage - size of the used system memory
    3. Allocations - number of allocations
memory_save
  • Command. Dump memory pools (useful for offline analysis).

CPU Info

Operations, representing information on the CPU.

Name Description
cpu_info
  • Command. Print an information on the CPU and instruction set supported by it.
cpu_frequency
  • Command. Print the CPU frequency in MHz.
cpu_count
  • Command. Print the number of available CPUs.

System Info

Operations, representing information on the system.

Name Description
binary_info
  • Command. Print an information on the engine binary.
system_info
  • Command. Print an information on the operating system and the engine build version.
system_memory
  • Command. Print the system memory size in Mbytes.

GPU Info

Operations, representing information on the GPU.

Name Description
gpu_info
  • Command. Print the video card and driver versions.
gpu_memory
  • Command. Print the video memory size in Mbytes.
gpu_count
  • Command. Print the number of available GPUs.
Last update: 2017-07-03