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 Syntax
Console command can take null, one or several arguments. The syntax is:
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_resizablevariable, you get the following result:
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:
<item name="console_key" type="int">96</item>
Console
Basic operations on the console, command and variable.
Name | Description | Arguments |
---|---|---|
bind |
|
1. A key to bind
2. A command to execute |
clear |
|
|
console_key |
|
An ASCII code of the key |
help |
|
|
hide |
|
|
ls |
|
|
show |
|
|
switch |
|
A variable, which values will be switched |
toggle |
|
A variable to be toggled |
unbind |
|
A key to unbind |
Console GUI
Operations on the console GUI.
Name | Description | Arguments |
---|---|---|
console_size |
|
4 – 32
( 16 by default) |
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 |
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.
Engine Analyzer
Operations on the engine debugging.
Name | Description | Arguments |
---|---|---|
engine_analyze |
|
A path to the logfile to dump the log file information into (optional) |
World
Basic operations on world.
World State
Serialized operations on world.
World Resources
Operations, representing information on ObjectGrass,ObjectMeshClutterandWorldClutterobjects.
Name | Description |
---|---|
world_manager_info |
|
world_manager_list |
|
World Queueing
Operations on the world queued nodes.
Name | Description | Arguments |
---|---|---|
world_queue |
|
|
world_delay |
|
0 – 1
( 0 by default) |
world_clear |
|
Sound
Operations on the sound.
Name | Description | Arguments |
---|---|---|
sound_occlusion |
|
0 - disabled
1 - enabled (by default) |
sound_reverb |
|
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 |
|
0 - disabled (by default)
1 - enabled |
sound_manager_info |
|
|
sound_manager_list |
|
|
sound_manager_sample_static_memory |
|
1 – 1024
( 64 by default) |
sound_manager_sample_stream_memory |
|
1 – 1024
( 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.
Position and rotation of the game camera can be changed only if it is unlocked.
|
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 |
|
|
filesystem_icase |
|
0 - checked (by default)
1 - ignored |
filesystem_ignore |
|
A full directory name |
filesystem_mmap |
|
0 - not used
1 - used (default) |
filesystem_reload |
|
File System Info
Operations, representing information on the File system.
Name | Description | Arguments |
---|---|---|
filesystem_info |
|
|
filesystem_list |
|
File Queueing
Operations, representing information on the file loading queue.
Name | Description | Arguments |
---|---|---|
filesystem_queue |
|
|
filesystem_delay |
|
0 – 1
( 0 by default) |
Editor
Operations on UnigineEditor.
Editor Controls
Operations on UnigineEditor controls.
Name | Description | Arguments |
---|---|---|
default_presets_edit_mode |
|
0 (default) - disable editing
1 - enable editing |
Asset Browser
Operations on assets.
Name | Description | Arguments |
---|---|---|
assets_delete |
|
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 asset from the external folder.
When importing an asset, the *.asset file with the same name is created in the destination folder.
|
The command receives 3 arguments:
|
assets_reload | Command. Synchronize assets in the assets and the data folder. | |
assets_verbose |
|
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.
Name | Description | Arguments |
---|---|---|
world_memory_usage |
|
A path to a file to dump the information into (optional) |
world_analyze |
|
A path to the logfile to dump the log file information into (optional) |
world_disassemble |
|
A path to a file to dump the information into (optional) |
world_manager_images_memory |
|
0 - 8192
( 128 by default) |
world_manager_meshes_memory |
|
0 - 8192
( 128 by default) |
Script Debugger
Operations on the per-function breakpoint. The syntax to set the breakpoint is the following:
system_breakpoint/world_breakpoint/editor_breakpoint set/remove function_name number_of_arguments
Name | Description | Arguments |
---|---|---|
world_breakpoint |
|
1. Name of the function
2. The number of the arguments |
system_breakpoint |
|
1. Name of the function
2. The number of the arguments |
editor_breakpoint |
|
1. Name of the function
2. The number of the arguments |
Multi-Threading
Asynchronous Operations
Asynchronous operations.
Name | Description | Arguments |
---|---|---|
async_log_mode |
|
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 |
|
0 - print only frequently used operations
1 - print all operations |
Visualizer
Operations on the visualizer.
World Debugging
Operations on the world debugging.
Name | Description | Arguments |
---|---|---|
world_show_spatial |
|
0 - hidden (by default)
1 - displayed |
world_show_visualizer |
|
The available arguments are:
|
render_show_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 |
|
The available arguments are:
|
render_show_decals |
|
0 - hidden (by default)
1 - displayed |
Occluder Debugging
Operations on the occluder debugging.
Name | Description | Arguments |
---|---|---|
render_show_occluder |
|
0 - hidden (by default)
1 - displayed |
Physics Debugging
Name | Description | Arguments |
---|---|---|
physics_show_contacts |
|
0 - hidden (by default)
1 - displayed |
physics_show_joints |
|
0 - hidden (by default)
1 - displayed |
physics_show_shapes |
|
0 - hidden (by default)
1 - displayed |
Texture Debugging
Operations on the texture debugging.
Name | Description | Arguments |
---|---|---|
render_show_mipmaps |
|
0 - hidden (by default)
1 - displayed in color |
Occlusion Queries
Name | Description | Arguments |
---|---|---|
render_show_queries |
|
0 - hidden (by default)
1 - displayed |
Performance Profiler
Operations on the Performance profiler.
Name | Description | Arguments |
---|---|---|
show_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 |
|
4 – 32
( 13 by default) |
profiler_font |
|
A path to a *.ttf file
( core/gui/font.ttf by default) |
Video Settings
Name | Description |
---|---|
video_restart |
|
Resolution and Full Screen
Operations on the video resolution adjustment.
Name | Description | Arguments |
---|---|---|
video_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 |
Valid only if the
video_modecommand is set to
-1. |
0 – 10000 |
video_height |
Valid only if the
video_modecommand is set to
-1. |
0 – 10000 |
video_resizable |
|
0 - non-resizable mode (by default)
1 - resizable mode |
video_fullscreen |
|
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 |
|
0 - not to synchronize FPS (by default)
1 - synchronize FPS |
video_refresh |
|
0 (by default) – 200 |
video_gamma |
|
0.5 – 3.5
( 1.0 by default) |
Multi-Monitor and Stereo Rendering
Name | Description | Arguments |
---|---|---|
video_surround |
|
0 - disabled (by default)
1 - enabled |
video_surround_border |
|
|
video_quad_buffer |
|
0 - disabled (by default)
1 - enabled |
Rendering Settings
Operations on the renderer.
Rendering Resources
Operations, representing information on the rendering resources.
Name | Description |
---|---|
render_manager_info |
|
render_manager_list |
|
Rendering Buffers
Rendering Buffer Info
Operations, representing information on the rendering buffers.
Name | Description |
---|---|
render_info |
|
render_list |
|
Rendering Buffer Debugging
Operations on the rendering buffer debugging.
Name | Description | Arguments |
---|---|---|
render_show_textures |
|
0 - all buffers are hidden (by default)
1 - show render textures (compact). 2 - show render textures (full). |
render_use_format_rg11b10 |
|
0 - do not use the RG11B10 texture format
1 - use the RG11B10 texture format (by default). |
render_use_format_depth_d32f |
|
0 - do not use the D32F texture format
1 - use the D32F texture format (by default). |
render_show_number | 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 |
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 |
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 |
|
0 - disabled
1 - enabled (by default) |
Mesh Loading
Operations on the mesh loading.
Decals
Operations on the mesh rendering.
Name | Description | Arguments |
---|---|---|
render_decals |
|
0 - disabled
1 - enabled (by default) |
Fields
Operations on the field rendering.
Textures
Operations on the texture rendering.
Texture Loading
Operations on the texture loading.
Name | Description | Arguments |
---|---|---|
render_manager_textures_memory |
|
0 - 100
( 65 by default) |
Shaders
Operations on shaders.
Shader Loading
Effects and Postprocesses
Operations on the effects and postprocesses.
Lighting and Shading
Operations on the lighting and shading.
Lights
Operations on lights.
Shadows
Operations on shadows.
Terrain Rendering
Water Rendering
Output Modes
Other Settings
Renderers
Name | Description | Arguments |
---|---|---|
video_debug |
|
0 - not enabled (by default)
1 - enabled |
DirectX 11
Operations on the Direct3D11 API.
OpenGL
Operations on the OpenGL API.
OpenAL Settings
Operations on the OpenAL API.
Name | Description | Arguments |
---|---|---|
al_sound_renderer |
|
|
al_sound_vendor |
|
|
al_sound_version |
|
|
al_sound_extensions |
|
|
alc_sound_extensions |
|
|
al_sound_skip_errors |
|
0 - checked (by default)
1 - skipped |
Screenshots
Operations on the screenshot.
Name | Description | Arguments |
---|---|---|
video_extension |
|
0 - TGA (by default)
1 - DDS 2 - PNG 3 - JPG |
video_grab |
|
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 |
|
memory_info |
|
memory_save |
|
CPU Info
Operations, representing information on the CPU.
Name | Description |
---|---|
cpu_info |
|
cpu_frequency |
|
cpu_count |
|
System Info
Operations, representing information on the system.
Name | Description |
---|---|
binary_info |
|
system_info |
|
system_memory |
|
GPU Info
Operations, representing information on the GPU.
Name | Description |
---|---|
gpu_info |
|
gpu_memory |
|
gpu_count |
|