Console
Represents 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_resizable variable, 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:
- Specify the console_command option and the console_key console command with ASCII-based key code in your CLI.
For example, to assign the asterisk (*) key, type:bin\main_x86d.exe -console_command "console_key 42"
- 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>
- Open the console and assign a new key
via the console_command command.
For example, to assign the (@) key, type:Unigine~# console_command 64
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 |
hide |
|
|
ls |
|
|
show |
|
|
switch |
|
A variable, which values will be switched |
toggle |
|
A variable to be toggled |
unbind |
|
A key to unbind |
Engine
Basic operations on the engine.
Name | Description | Arguments |
---|---|---|
console_command |
|
|
engine_threaded |
If these variables are enabled, multithreading is used. |
0 - disabled 1 - enabled (by default) |
extern_define |
|
"DEFINE_NAME" - name of the directive "DEFINE_NAME=VALUE" - name and value of the directive |
extern_plugin |
|
A name of the plugin |
quit | Quit the engine. |
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.
Name | Description | Arguments |
---|---|---|
world_load |
|
1. A name of the world to load (inside of the data directory) 2. A name of the world cache file (optional) |
world_quit |
|
|
world_save |
|
|
world_reload |
|
A name of the world cache file (optional) |
world_threaded |
|
0 - single-threaded 1 - multiple-threaded (by default) |
World State
Serialized operations on world.
World Analyzer
World Resources
Operations, representing information on ObjectGrass, ObjectMeshClutter and WorldClutter objects.
Name | Description |
---|---|
world_manager_info |
|
world_manager_list |
|
World Script
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 Queueing
Operations on the world queued nodes.
Name | Description | Arguments |
---|---|---|
world_queue |
|
|
world_delay |
|
0 – 1 (0 by default) |
world_clear |
|
Editor
Operations on UNIGINE Editor.
Name | Description | Arguments |
---|---|---|
editor_load |
|
|
editor_quit |
|
|
editor_reload |
|
|
editor_script |
|
A path to the editor script (relatively to the data directory) |
editor_cache |
|
A name of the editor script cache |
Editor Analyzer
Debug operations on the editor script.
Name | Description | Arguments |
---|---|---|
editor_memory_usage |
|
A path to a file to dump the information into (optional) |
editor_analyze |
|
A path to the file to dump the log file information into (optional) |
editor_disassemble |
|
A path to file to dump the information into (optional) |
File System
Operations on the File system.
Name | Description | Arguments |
---|---|---|
data_path |
|
A path to the data directory (relatively to the binary executable) |
extern_package |
|
"../RELATIVE_PATH" - relative path "ABSOLUTE_PATH" - absolute path |
filesystem_reload |
|
|
filesystem_clear |
|
|
filesystem_ignore |
|
A full directory name |
filesystem_icase |
0 - checked (by default) 1 - ignored |
|
filesystem_mmap |
|
0 - not used 1 - used (default) |
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) |
filesystem_data_memory |
|
8 – 1024 (32 by default) |
filesystem_files_memory |
|
8 – 1024 (64 by default) |
filesystem_images_memory |
|
8 – 1024 (64 by default) |
Memory Info
Operations, representing information on the system memory.
Name | Description |
---|---|
memory_dump |
|
memory_info |
|
memory_save |
|
GUI
Operations on the GUI and console style.
Name | Description | Arguments |
---|---|---|
gui_path |
|
A path to the GUI skin (core/gui/ by default) |
console_size |
|
4 – 32 (16 by default) |
console_font |
|
A path to a *.ttf file (core/gui/console.ttf by default) |
Visualizer and Perfomance Profiler
Operations on the visualizer.
Name | Description | Arguments |
---|---|---|
show_visualizer |
|
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 |
|
0 - hidden 1 - displayed (by default) |
show_messages |
|
0 - hidden 1 - displayed (by default) |
show_gpu |
|
0 - hidden 1 - displayed (by default) This operation can be performed if the GPUMonitor plugin is enabled. |
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) |
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) |
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 |
---|---|---|
system_breakpoint |
|
1. Name of the function 2. The number of the arguments |
world_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 |
General Settings
Configuration File
General operations on the engine configuration.
Name | Description | Arguments |
---|---|---|
config_load |
|
A path to the configuration file (data/unigine.cfg by default) |
config_save |
|
A path to the configuration file (optional) |
System Script
Operations on the system script.
Name | Description | Arguments |
---|---|---|
system_script |
|
A path to the system script (relatively to the data directory) (core/unigine.cpp by default) |
system_reload |
|
|
system_cache |
|
A name of the system script cache (unigine.cache by default) |
System Analyzer
Operations on the system script debugging.
Name | Description | Arguments |
---|---|---|
system_memory_usage |
|
A path to a file to dump the information into (optional) |
system_analyze |
|
A path to the file to dump the log file information into (optional) |
system_disassemble |
|
A path to the file to dump the information into (optional) |
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 |
|
Video Settings
Name | Description |
---|---|
video_restart |
|
GPU Info
Operations, representing information on the GPU.
Name | Description |
---|---|
gpu_info |
|
gpu_memory |
|
gpu_count |
|
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 (by default) 2 - 1024 × 576 3 - 1280 × 720 4 - 1366 × 768 5 - 1600 × 900 6 - 1920 × 1080 7 - 2560 × 1440 8 - 640 × 400 9 - 960 × 600 10 - 1024 × 640 11 - 1280 × 800 12 - 1440 × 900 13 - 1680 × 1050 14 - 1920 × 1200 15 - 2560 × 1600 16 - 640 × 480 17 - 800 × 600 18 - 1024 × 768 19 - 1280 × 960 20 - 1280 × 1024 21 - 1600 × 1200 22 - 2048 × 1536 |
video_width |
Valid only if the video_mode command is set to -1. |
0 – 10000 |
video_height |
Valid only if the video_mode command 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_app |
|
"null" - no renderer "auto" (by default) - automatically "direct3d9" - DirectX 9 "direct3d11" - DirectX 11 "opengl" - OpenGL "opengles" - OpenGL ES "direct3d119" - DirectX 11 renderer of DirectX 9 feature level "playstation3" - PlayStation 3 |
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) |
Anti-aliasing
Operations on the anti-aliasing adjustment.
Name | Description | Arguments |
---|---|---|
video_multisample |
|
0 - no anti-aliasing (by default) 1 - 2× anti-aliasing 2 - 4× anti-aliasing 3 - 8× anti-aliasing 4 - 16× anti-aliasing |
video_renderable |
|
0 - disabled (by default) 1 - enabled |
Rendering Settings
Operations on the renderer.
Name | Description | Arguments |
---|---|---|
render_reload |
|
|
render_restart |
|
|
render_manager_reload |
|
|
Renderer Resources
Operations, representing information on the renderer resources.
Name | Description |
---|---|
render_manager_info |
|
render_manager_list |
|
Renderer Buffers
Operations on the renderer buffers.
Name | Description | Arguments |
---|---|---|
render_use_rgb10a2 |
|
0 - RGBA8 format 1 - RGB10A2 format (by default) |
render_use_d32f |
|
0 - standard precision (24-bit for depth values and 8 for stencil) 1 - 32-bit floating point precision (by default) |
Renderer Buffer Info
Operations, representing information on the renderer buffers.
Name | Description |
---|---|
render_info |
|
render_list |
|
Renderer Buffer Debugging
Operations on the renderer buffer debugging.
Name | Description | Arguments |
---|---|---|
render_show_textures |
|
0 - all buffers are hidden (by default) A number of buffers (can be up to 16) |
render_show_number |
A number of buffers in a row (from 1 to 8) (4 by default) |
Meshes
Mesh Loading
Operations on the mesh loading.
Mesh Rendering
Operations on the mesh rendering.
Name | Description | Arguments |
---|---|---|
render_alpha_fade |
|
0 - disabled 1 - enabled (by default) |
render_use_dual_quaternions |
|
0 - disabled (by default) 1 - enabled |
render_use_vertex_float |
|
0 - disabled (by default) 1 - enabled |
Mesh Debugging
Operations on the mesh debugging.
Name | Description | Arguments |
---|---|---|
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 |
render_show_normals |
|
0 - hidden (by default) 1 - displayed |
Textures
Texture Loading
Operations on the texture loading.
Texture Rendering
Operations on the texture rendering.
Name | Description | Arguments |
---|---|---|
render_textures |
|
0 - low resolution 1 - medium resolution 2 - high resolution (by default) |
render_filter |
|
0 - bilinear filtering 1 - trilinear filtering (by default) |
render_anisotropy |
|
0 - level 1 1 - level 2 (by default) 2 - level 4 3 - level 8 4 - level 16 |
Texture Debugging
Operations on the texture debugging.
Name | Description | Arguments |
---|---|---|
render_show_mipmaps |
|
0 - hidden (by default) 1 - displayed in color |
Shaders
Operations on shaders.
Name | Description | Arguments |
---|---|---|
render_shader_defines |
|
|
render_shaders |
|
0 - low 1 - medium (by default) 2 - high |
Shader Loading
Operations on the shader loading.
Effects and Postprocesses
Operations on the effects and postprocesses.
Name | Description | Arguments |
---|---|---|
render_auxiliary |
|
0 - disabled 1 - enabled (by default) |
render_dof |
|
0 - disabled (by default) 1 - enabled |
render_glow |
|
0 - disabled 1 - enabled using the half-screen sized buffer for glow (by default) |
render_hdr |
|
0 - disabled (by default) 1 - enabled using the standard logarithmic algorithm 2 - enabled using the quadratic algorithm (for brighter light) |
render_use_filmic |
|
0 - disabled (by default) 1 - enabled |
render_motion_blur |
|
0 - disabled (by default) 1 - enabled |
render_reflection |
|
0 - disable 1 - enabled (by default) |
render_refraction |
|
0 - disabled 1 - enabled (by default) |
render_scattering |
|
0 - disabled 1 - enabled (by default) |
render_translucent |
|
0 - disabled (by default) 1 - enabled |
render_stereo |
|
0 - disabled (by default) 1 - enabled anaglyph stereo 2 - enabled side-by-side stereo 3 - enabled top-bottom stereo |
Lighting and Shading
Operations on the lighting and shading.
Name | Description | Arguments |
---|---|---|
render_use_phong_rim |
|
0 - enable simple Phong shading 1 - enable Phong rim shading (by default) |
render_use_environment |
|
0 - disabled 1 - enabled (by default) |
render_use_directional_lightmaps |
|
0 - simple non-directional light maps 1 - directional light maps (by default) |
render_parallax |
|
0 - disabled 1 - enabled (by default) |
render_use_normalization |
|
0 - disabled 1 - enabled (by default) |
Lights
Operations on lights.
Name | Description | Arguments |
---|---|---|
world_show_lights |
|
0 - hidden (by default) 1 - shown |
render_show_lights |
|
0 - lights are faded (by default) 1 - lights are displayed without attenuation |
render_use_scissors |
|
0 - disabled 1 - enabled (by default) |
render_show_scissors |
|
0 - hidden (by default) 1 - shown |
Deferred (Simplified) Lighting
Operations on deferred lights.
Name | Description | Arguments |
---|---|---|
render_deferred |
|
0 - disabled 1 (by default) -
|
render_force_deferred |
|
0 - lights are rendered with their normal settings (by default) 1 - lights are rendered with the force deferred lighting |
Shadows
Operations on shadows.
Name | Description | Arguments |
---|---|---|
render_volumetric |
|
0 - disabled 1 - enabled (by default) |
render_use_shadow_kernel |
|
0 - simplified shadows 1 - high-quality shadows (by default) |
render_show_splits |
|
0 - disabled (by default) 1 - enabled |
render_show_penumbra |
|
0 - disabled (by default) 1 - enabled |
Ambient Occlusion and GI
Operations on ambient and light occlusion.
Name | Description | Arguments |
---|---|---|
render_occlusion |
|
0 - disabled (by default) 1 - enabled ambient occlusion 2 - enabled light occlusion (GI) 3 - enabled both ambient and light occlusion (GI) |
render_light_prob |
|
0 - disabled (by default) 1 - enabled |
render_show_occlusion |
|
0 - disabled (by default) 1 - enabled |
Other Settings
Name | Description | Arguments |
---|---|---|
render_use_srgb |
|
0 - disabled (by default) 1 - enabled |
render_use_queries |
|
0 - not run 1 - run (by default) |
render_show_queries |
|
0 - hidden (by default) 1 - displayed |
Renderer Debugging
Operations on rendering passes.
Name | Description | Arguments |
---|---|---|
render_force_no_shadows |
|
0 - enabled (by default) 1 - disabled |
render_skip_translucent |
|
0 - enabled (by default) 1 - disabled |
render_skip_auxiliary |
|
0 - enabled (by default) 1 - skipped |
render_skip_decal_ambient |
|
0 - enabled (by default) 1 - skipped |
render_skip_decal_light |
|
0 - enabled (by default) 1 - skipped |
render_skip_deferred |
|
0 - enabled (by default) 1 - skipped |
render_skip_light_prob |
|
0 - enabled (by default) 1 - skipped |
render_skip_motion_blur |
|
0 - enabled (by default) 1 - skipped |
render_skip_occlusion |
|
0 - enabled (by default) 1 - skipped |
render_skip_opacity_ambient |
|
0 - enabled (by default) 1 - skipped |
render_skip_opacity_light |
|
0 - enabled (by default) 1 - skipped |
render_skip_post_materials |
|
0 - enabled (by default) 1 - skipped |
render_skip_reflection |
|
0 - enabled (by default) 1 - skipped |
render_skip_refraction |
|
0 - enabled (by default) 1 - skipped |
render_skip_render_materials |
|
0 - enabled (by default) 1 - skipped |
render_skip_scattering |
|
0 - enabled (by default) 1 - skipped |
render_skip_transparent_ambient |
|
0 - enabled (by default) 1 - skipped |
render_skip_transparent_light |
|
0 - enabled (by default) 1 - skipped |
World Debugging
Operations on the world debugging.
Name | Description | Arguments |
---|---|---|
world_show_spatial |
|
0 - hidden (by default) 1 - displayed |
world_show_portals |
|
0 - hidden (by default) 1 - displayed |
world_show_sectors |
|
0 - hidden (by default) 1 - displayed |
Node Debugging
Operations on the node debugging.
Name | Description | Arguments |
---|---|---|
world_show_handlers |
|
0 - hidden (by default) 1 - displayed |
render_show_decals |
|
0 - hidden (by default) 1 - displayed |
world_show_transforms |
|
0 - hidden (by default) 1 - displayed |
world_show_triggers |
|
0 - hidden (by default) 1 - displayed |
world_show_fields |
|
0 - hidden (by default) 1 - displayed |
world_show_players |
|
0 - hidden (by default) 1 - displayed |
Occluder Debugging
Operations on the occluder debugging.
Name | Description | Arguments |
---|---|---|
world_show_occluders |
|
0 - hidden (by default) 1 - displayed |
render_show_occluder |
|
0 - hidden (by default) 1 - displayed |
Renderers
DirectX 11
Operations on the Direct3D11 API.
DirectX 9
Operations on the Direct3D9 API.
Name | Description | Arguments |
---|---|---|
d3d9_render_desc |
|
|
d3d9_render_driver |
|
|
d3d9_render_use_ati_texture_fetch4 |
|
0 - disabled 1 - enabled (by default) |
d3d9_render_use_instancing |
|
0 - disabled 1 - enabled (by default) |
d3d9_render_use_alpha_to_coverage |
|
0 - disabled 1 - enabled (by default) |
d3d9_render_use_nvidia_hardware_shadow |
|
0 - disabled 1 - enabled (by default) |
OpenGL
Operations on the OpenGL API.
Renderers for Mobile Platforms
DirectX 11 of DirectX 9 Feature Level
Operations on the Direct3D119 API.
Name | Description | Arguments |
---|---|---|
d3d119_render_desc |
|
|
d3d119_render_use_instancing |
|
0 - disabled 1 - enabled (by default) |
d3d119_render_use_rgba8 |
|
0 - R5G6B5 is used (by default) 1 - RGBA8 is used for the screen buffer, R5G6B5 for the reflection buffer 2 - RGBA8 is used |
OpenGL ES Settings
Operations on the OpenGL ES API.
Name | Description | Arguments |
---|---|---|
gles_render_renderer |
|
|
gles_render_vendor |
|
|
gles_render_version |
|
|
gles_render_shading_language |
|
|
gles_render_extensions |
|
|
gles_render_use_amd_texture_compression_3dc |
|
0 - not set 1 - set (by default) |
gles_render_use_amd_texture_compression_atc |
|
0 - not set 1 - set (by default) |
gles_render_use_ext_texture_array |
|
0 - not set (by default) 1 - set |
gles_render_use_ext_texture_compression_latc |
|
0 - not set 1 - set (by default) |
gles_render_use_ext_texture_compression_s3tc |
|
0 - not set 1 - set (by default) |
gles_render_use_img_texture_compression_pvrtc |
|
0 - not set 1 - set (by default) |
gles_render_use_oes_texture_3d |
|
0 - not set (by default) 1 - set |
gles_render_use_oes_texture_compression_etc |
|
0 - not set 1 - set (by default) |
gles_render_use_rgba8 |
|
0 - R5G6B5 is used (by default) 1 - RGBA8 is used for the screen buffer, R5G6B5 for the reflection buffer 2 - RGBA8 is used |
gles_render_skip_errors |
|
0 - checked (by default) 1 - skipped |
PlayStation 3 Settings
Operations on the PlayStation 3 API.
Name | Description | Arguments |
---|---|---|
ps3_render_memory_dump |
|
|
ps3_render_memory_info |
|
|
ps3_render_use_instancing |
|
0 - disabled 1 - enabled (by default) |
ps3_render_use_mesh_raw |
|
0 - disabled (by default) 1 - enabled |
Physics
Operations on the engine physics.
Pathfinding
Operations on the pathfinding.
Sound
Operations on the sound.
Name | Description | Arguments |
---|---|---|
sound_app |
|
"null" - no sound "auto" - automatically (by default) "openal" - OpenAL "xaudio2" - XAudio2 "playstation3" - PlayStation 3 |
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) |
world_show_sounds |
|
0 - hidden (by default) 1 - displayed |
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) |
XAudio2 Settings
Operations on the XAudio2 API.
Name | Description | Arguments |
---|---|---|
xa2_sound_device |
|
A name of the sound device |
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 |