Видеоуроки
Interface
Essentials
Advanced
Подсказки и советы
Программирование на C#
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Настройки и предпочтения
Работа с проектами
Настройка параметров узла
Setting Up Materials
Setting Up Properties
Освещение
Landscape Tool
Sandworm
Использование инструментов редактора для конкретных задач
Extending Editor Functionality
Встроенные объекты
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
Программирование
Основы
Настройка среды разработки
Примеры использования
UnigineScript
C++
C#
Унифицированный язык шейдеров UUSL
File Formats
Rebuilding the Engine Tools
GUI
Двойная точность координат
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Работа с контентом
Оптимизация контента
Материалы
Art Samples
Tutorials

Параметры командной строки при запуске

Startup command-line options can be specified on the UNIGINE executable file launching. These options control what rendering API to use, what resolution to set for Unigine window, where resources for initializing the engine are stored, etc. The options are either set in UNIGINE SDK Browser or manually via the command line. Параметры командной строки запуска можно указать при запуске исполняемого файла UNIGINE. Эти параметры определяют, какой API рендеринга использовать, какое разрешение установить для окна Unigine, где хранятся ресурсы для инициализации движка и т.д. Параметры задаются либо в UNIGINE SDK Browser , либо вручную через командную строку .

Примечание
If no command-line options is specified, the options with default values will be used when launching the application. Если параметры командной строки не указаны, при запуске приложения будут использоваться параметры со значениями по умолчанию.

The syntax of command-line options is as follows: the full name of the binary executable (64-bit development or production version) is specified first and then the start-up options. Синтаксис параметров командной строки следующий: сначала указывается полное имя двоичного исполняемого файла (64-разрядная версия для разработки или производственная версия), а затем параметры запуска.

Shell-команды
main_* -command argument
Shell-команды
main_* -command "argument,argument"
Shell-команды
main_* -console_command "command argument"

All paths are specified as absolute or relative to the binary executable or the data directory. Все пути указаны как абсолютные или относительно двоичного исполняемого файла или каталога data.

If the same command is specified multiple times, only the last command will be taken into account by the engine. For example, in the following case, only the argument3 will be used by the Engine: Если одна и та же команда указана несколько раз, движком будет учтена только последняя команда. Например, в следующем случае движком будет использоваться только argument3:

Shell-команды
-command "argument1" -command "argument2" -command "argument3"
Примечание
  • An exception is file system command-line options: they can accumulate all the specified values. Исключением являются параметры командной строки файловой системы : они могут накапливать все указанные значения.
  • The CLI options specified on the application start-up always take precedence over the ones stored in the configuration files. Some of the CLI options can be changed through the console. Such options are automatically stored in the configuration files (this way, after the application is quit, they will be restored on the next start-up). All other CLI options don't change the configuration files. Параметры интерфейса командной строки, указанные при запуске приложения, всегда имеют приоритет над параметрами, хранящимися в файле конфигурации. Некоторые параметры интерфейса командной строки можно изменить с помощью консоли . Такие параметры автоматически сохраняются в файле конфигурации (таким образом, после выхода из приложения они будут восстановлены при следующем запуске). Все остальные параметры интерфейса командной строки не изменяют файл конфигурации.

Video SettingsНастройки видео#

Имя Описание Аргументы По умолчанию
-video_mode Video mode to set window resolution or size Режим видео для установки разрешения или размера окна -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
1 1
-video_width Screen width
Makes sense only if video_mode =-1
Ширина экрана
Имеет смысл, только если video_mode = -1
010000 0
-video_height Screen height
Makes sense only if video_mode =-1
Высота экрана
Имеет смысл, только если video_mode = -1
010000 0
-video_resizable Allows changing a window size on the fly, without having to restart the application Позволяет изменять размер окна на лету, без перезапуска приложения 0 is a non-resizable mode
1 is a resizable mode
0 - размер неизменяемый
1 - размер изменяемый
0 0
-video_fullscreen Fullscreen mode Полноэкранный режим 0 is a windowed mode
1 is a fullscreen mode
2 is a fullwindow mode when an application window is rendered without decorations
0 - оконный режим
1 - полноэкранный режим
2 - полноэкранный режим, когда окно приложения отображается без декораций
0 0

Graphics SettingsНастройки графики#

Имя Описание Аргументы По умолчанию
-video_app Graphics API to be used for rendering:
  • No renderer: do not render anything onto the screen (for example, for servers in case of playing over the network)No renderer: do not render anything onto the screen (for example, for servers in case of playing over the network)
  • Automatically choose the best option from available onesAutomatically choose the best option from available ones
  • DirectXDirectX
  • OpenGLOpenGL
The current value of -video_app can be obtained via the getVideoApp() method of Unigine API.No renderer: do not render anything onto the screen (for example, for servers in case of playing over the network)Automatically choose the best option from available onesDirectXOpenGL
Графический API, используемый для рендеринга:
  • No renderer: do not render anything onto the screen (for example, for servers in case of playing over the network) Без средства визуализации: ничего не отображать на экране (например, для серверов в случае игры по сети).
  • Automatically choose the best option from available ones Автоматически выбирать лучший вариант из доступных
  • DirectX DirectX
  • OpenGL OpenGL
Текущее значение -video_app можно получить через getVideoApp() метод Unigine API.
"null"
"auto"
"direct3d11" or "dx"
"opengl" or "gl"
"auto"
-video_adapter In case of several GPUs, allows selecting a GPU to be used.
Примечание
Available for DirectX only.Available for DirectX only.
Available for DirectX only.
В случае нескольких графических процессоров позволяет выбрать используемый графический процессор.
Примечание
Available for DirectX only. Доступно только для DirectX.
The number of the GPU to be used. Номер используемого графического процессора. 0
-video_debug Enables or disables the debug context of OpenGL or DirectX.
Примечание
Enabling the debug context may cause performance drop (~30-40%).Enabling the debug context may cause performance drop (~30-40%).
Enabling the debug context may cause performance drop (~30-40%).
Включает или отключает контекст отладки OpenGL или DirectX.
Примечание
Enabling the debug context may cause performance drop (~30-40%). Включение контекста отладки может привести к падению производительности (~ 30-40%).
DirectX:
  • 0 to disable0 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.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.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 disable0 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.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.2 works in the same way as 1 mode.
0 to disable1 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.0 to disable1 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:
  • 0 to disable 0 , чтобы отключить
  • 1 to write all DirectX errors (red) and warnings (yellow). If the error occurred, it means that there is a mistake in API. 1 для записи всех ошибок DirectX (красный) и предупреждений (желтый). Если ошибка возникла, значит, в 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. 2 для записи всех ошибок DirectX (красный) и предупреждений (желтый). Если произошла ошибка, движок выйдет из строя и будет показан полный стек вызовов.
OpenGL:
  • 0 to disable 0 , чтобы отключить
  • 1 to write all OpenGL errors (red) and warnings (yellow). If the error occurred, it means that there is a mistake in API. 1 для записи всех ошибок OpenGL (красный) и предупреждений (желтый). Если ошибка возникла, значит, в API есть ошибка.
  • 2 works in the same way as 1 mode. 2 работает так же, как режим 1 .
0
-video_quad_buffer Enables of disables quad buffered stereo. Включает / отключает стерео с четырехкратной буферизацией . 0 to disable quad buffering
1 to enable quad buffering
0 для отключения четырехъядерной буферизации
1 , чтобы включить четырехкратную буферизацию
0
-video_surround Allows rendering of the application across 3 monitors. Разрешает рендеринг приложения на 3 мониторах. 0 to disable rendering across 3 monitors
1 to enable rendering across 3 monitors
0 отключить рендеринг на 3-х мониторах
1 включить рендеринг на 3-х мониторах
0
-video_surround_border Sets the size of monitor bezel compensation in pixels. It is used together with -video_surround 1. Устанавливает размер компенсации лицевой панели монитора в пикселях. Он используется вместе с -video_surround 1 . Size of the bezel compensation in pixels. Размер компенсации лицевой панели в пикселях.
-video_vsync Vertical synchronization (synchronize FPS with monitor's refresh rate) Вертикальная синхронизация (синхронизация FPS с частотой обновления монитора) 0 - don't use synchronization
1 - use synchronization
0 - не использовать синхронизацию
1 - использовать синхронизацию
0

File SystemФайловая система#

Имя Описание Аргументы По умолчанию
-data_path A path to the data directory with all resources. The path can be specified as an absolute path or relatively to the binary executable. The specified -data_path directory can be obtained via the getDataPath() function. Путь к каталогу data со всеми ресурсами . Путь может быть указан как абсолютный путь или относительно двоичного исполняемого файла. Указанный каталог -data_path можно получить с помощью функции getDataPath(). The argument can be passed as follows:
  • ../RELATIVE_PATH/
  • ABSOLUTE_PATH
Аргумент можно передать следующим образом:
  • ../RELATIVE_PATH/
  • ABSOLUTE_PATH
../
-plugin_path Path to a directory that contains plugins. All of the plugins in this directory will be loaded automatically on the start-up. The path can be specified relatively to the binary executable or as an absolute path. The list of the specified -plugin_path directories can be obtained via the getNumPluginPaths() and getPluginPath(int num) methods. Путь к каталогу, содержащему плагины. Все плагины в этом каталоге будут загружены автоматически при запуске. Путь может быть указан относительно двоичного исполняемого файла или как абсолютный путь. Список указанных каталогов -plugin_path можно получить с помощью методов getNumPluginPaths() и getPluginPath(int num). The arguments can be passed as follows:
  • ../RELATIVE_PATH/
  • ABSOLUTE_PATH
Аргументы могут быть переданы следующим образом:
  • ../RELATIVE_PATH/
  • ABSOLUTE_PATH
plugins/
Примечание
Unlike other command-line options, the plugin_path option can accumulate all specified values. It allows specifying multiple paths, each of which will be used by the Engine. В отличие от других параметров командной строки, параметр plugin_path может накапливать все указанные значения. Он позволяет указать несколько путей, каждый из которых будет использоваться движком.

For several directories or packages you should specify each item separately without commas, for example: Для нескольких каталогов или пакетов необходимо указывать каждый элемент отдельно без запятых, например:

Исходный код
-plugin_path ../RELATIVE_PATH_1/ -plugin_path ../RELATIVE_PATH_2/ -plugin_path ABSOLUTE_PATH

Other DataПрочие данные#

Имя Описание Аргументы По умолчанию
-boot_config Path to Startup Configuration File containing the engine start-up options. The path can be specified as an absolute path or relative to the -data_path or <project_name> folder if the -project_name is set.Путь к стартовому файлу конфигурации, содержащему настройки запуска. Путь может быть указан как абсолютный путь или относительно -data_path. The arguments can be passed as follows:
  • ../RELATIVE_PATH/
  • ABSOLUTE_PATH
Аргументы могут быть переданы следующим образом:
  • ../RELATIVE_PATH/
  • ABSOLUTE_PATH
configs/default.boot
-cache_path A path to store system and editor cache files (specified by system_cache and editor_cache respectively). The path can be specified as an absolute path or relatively to the -data_path.
Примечание
For this parameter to take effect you should either delete existing system and editor cache files or move them to the new specified location.For this parameter to take effect you should either delete existing system and editor cache files or move them to the new specified location.
For this parameter to take effect you should either delete existing system and editor cache files or move them to the new specified location.
Путь для хранения файлов кэша системы и редактора (указывается system_cache а также editor_cache соответственно). Путь может быть указан как абсолютный путь или относительно -data_path.
Примечание
For this parameter to take effect you should either delete existing system and editor cache files or move them to the new specified location. Чтобы этот параметр вступил в силу, вы должны либо удалить существующие файлы кэша system и editor , либо переместить их в новое указанное место.
data/
-editor_cache A path to a cache file to be used by the UnigineEditor. The path can be specified as an absolute path or relatively to the -data_path, or to the -cache_path (if any). Путь к файлу кеша, который будет использоваться UnigineEditor. Путь может быть указан как абсолютный путь или относительно -data_path, или к -cache_path (если есть). editor.cache
-system_cache A path to a cache file to be used by the Engine. The path can be specified as an absolute path or relatively to the -data_path, or to the -cache_path (if any). Путь к файлу кеша, который будет использоваться движком. Путь может быть указан как абсолютный путь или относительно -data_path, или к -cache_path (если есть). unigine.cache
-engine_log The log file to be created and used. The path can be specified as an absolute path or relatively to the binary executable. For relative paths, if the -project_name is set, the log file with the specified name will be created in the corresponding directory in the User profile (only the name will be used, the remaining part of the relative path will be discarded). Файл журнала, который будет создан и использован. Путь может быть указан как абсолютный путь или относительно двоичного исполняемого файла. Для относительных путей, если установлено -project_name , файл журнала с указанным именем будет создан в соответствующем каталоге в профиле пользователя (будет использоваться только имя , оставшаяся часть относительного пути будет отброшена). log.txt
-editor_script Path to the editor script (specified relative to the data directory) Путь к скрипту редактора (указан относительно каталога data )
-gui_path A path to a GUI skin to be used for the engine interface. The path can be specified as an absolute path or relatively to the -data_path. Путь к оболочке GUI, которая будет использоваться для интерфейса движка. Путь может быть указан как абсолютный путь или относительно -data_path. core/gui/
-project_name Forces the engine to store all changing data (a log file, cache files and configuration files) in the User profile rather than in a directory with binaries. For that, a directory will be created with a specified PROJECT_NAME or a path to the project directory relative to the User profile (for example, unigine_projects/my_project). Заставляет движок сохранять все изменяющиеся данные (файл журнала, файлы кеша и файл конфигурации) в профиле пользователя, а не в каталоге с двоичными файлами. Для этого будет создан каталог с указанным PROJECT_NAME или путем к каталогу проекта относительно профиля пользователя (например, unigine_projects/my_project). PROJECT_NAME, namely:
  • A name of the project directory. For example, -project_name my_project will create the following directory:

    Windows:Windows:

    C:/Users/<username>/my_project/

    Linux:Linux:

    /home/<username>/.my_project/

    Windows:Linux:
    A name of the project directory. For example, -project_name my_project will create the following directory:

    Windows:Windows:

    C:/Users/<username>/my_project/

    Linux:Linux:

    /home/<username>/.my_project/

  • A path to the project directory relative to the User profile. For example, -project_name unigine_projects/my_project will create my_project directory in the following directory:

    Windows:Windows:

    C:/Users/<username>/unigine_projects/

    Linux:Linux:

    /home/<username>/.unigine_projects/

    Примечание
    The specified unigine_projects folder must exist in the User profile.The specified unigine_projects folder must exist in the User profile.
    Windows:Linux:The specified unigine_projects folder must exist in the User profile.
    A path to the project directory relative to the User profile. For example, -project_name unigine_projects/my_project will create my_project directory in the following directory:

    Windows:Windows:

    C:/Users/<username>/unigine_projects/

    Linux:Linux:

    /home/<username>/.unigine_projects/

    Примечание
    The specified unigine_projects folder must exist in the User profile.The specified unigine_projects folder must exist in the User profile.
A name of the project directory. For example, -project_name my_project will create the following directory:

Windows:Windows:

C:/Users/<username>/my_project/

Linux:Linux:

/home/<username>/.my_project/

Windows:Linux:A path to the project directory relative to the User profile. For example, -project_name unigine_projects/my_project will create my_project directory in the following directory:

Windows:Windows:

C:/Users/<username>/unigine_projects/

Linux:Linux:

/home/<username>/.unigine_projects/

Примечание
The specified unigine_projects folder must exist in the User profile.The specified unigine_projects folder must exist in the User profile.
Windows:Linux:The specified unigine_projects folder must exist in the User profile.
PROJECT_NAME, а именно:
  • A name of the project directory. For example, -project_name my_project will create the following directory:

    Windows:Windows:

    C:/Users/<username>/my_project/

    Linux:Linux:

    /home/<username>/.my_project/

    Windows:Linux:
    Имя каталога проекта. Например, -project_name my_project создаст следующий каталог:

    Windows: Windows :

    C:/Users/<username>/my_project/

    Linux: Linux :

    /home/<username>/.my_project/

  • A path to the project directory relative to the User profile. For example, -project_name unigine_projects/my_project will create my_project directory in the following directory:

    Windows:Windows:

    C:/Users/<username>/unigine_projects/

    Linux:Linux:

    /home/<username>/.unigine_projects/

    Примечание
    The specified unigine_projects folder must exist in the User profile.The specified unigine_projects folder must exist in the User profile.
    Windows:Linux:The specified unigine_projects folder must exist in the User profile.
    Путь к каталогу проекта относительно профиля пользователя. Например, -project_name unigine_projects/my_project создаст каталог my_project в следующем каталоге:

    Windows: Windows :

    C:/Users/<username>/unigine_projects/

    Linux: Linux :

    /home/<username>/.unigine_projects/

    Примечание
    The specified unigine_projects folder must exist in the User profile. Указанная папка unigine_projects должна существовать в профиле пользователя.
-system_script Path to the system script (specified relative to the data directory). Путь к системному скрипту (указан относительно каталога данных ). core/unigine.usc
-skip_guidsdb The Engine ignores the guids.db file and searches for GUIDs among all .meta files inside the data folder and all mounted external directories and packages.
Примечание
UnigineEditor uses this argument by default to avoid errors, and always re-generates the guids.db file to ensure its validity.UnigineEditor uses this argument by default to avoid errors, and always re-generates the guids.db file to ensure its validity.
UnigineEditor uses this argument by default to avoid errors, and always re-generates the guids.db file to ensure its validity.
Движок игнорирует файл guids.db и ищет идентификаторы GUID среди всех файлов .meta внутри папки данных и всех смонтированных внешних каталогов и пакетов.
Примечание
UnigineEditor uses this argument by default to avoid errors, and always re-generates the guids.db file to ensure its validity. UnigineEditor использует этот аргумент по умолчанию, чтобы избежать ошибок, и всегда повторно генерирует файл guids.db, чтобы гарантировать его достоверность.

Engine-Related SettingsНастройки, относящиеся к движку#

Имя Описание Аргументы
-console_command Консольная команда для использования при запуске двигателя. Несколько команд можно разделить с помощью последовательности &&. command <arguments>
-extern_plugin Загрузите библиотеку плагинов (путь указывается относительно исполняемого двоичного файла).
  • Имя библиотеки не должно содержать префиксов и постфиксов.
    (Например, libNetwork_x64d.so следует передавать как "Network".)
  • The library name should go without any prefixes and postfixes.
    (For example, libNetwork_x64d.so should be passed as "Network".)
    Некоторые плагины разделяются запятыми (без пробелов).
  • Several plugins are comma separated (no whitespace). Если вы хотите очистить список плагинов (они автоматически загружаются движком после того, как он был указан при запуске), просто передайте ""в качестве аргумента этой команды.
Load a plugin library (the path is specified relative to the binary executable).
  • The library name should go without any prefixes and postfixes.
    (For example, libNetwork_x64d.so should be passed as "Network".)
    The library name should go without any prefixes and postfixes.
    (For example, libNetwork_x64d.so should be passed as "Network".)
  • Several plugins are comma separated (no whitespace).Several plugins are comma separated (no whitespace).
  • If you want to clear the list of plugins (they are automatically loaded by the engine once specified on the start-up), simply pass "" as an argument to this command. If you want to clear the list of plugins (they are automatically loaded by the engine once specified on the start-up), simply pass "" as an argument to this command.
The library name should go without any prefixes and postfixes.
(For example, libNetwork_x64d.so should be passed as "Network".) Several plugins are comma separated (no whitespace).If you want to clear the list of plugins (they are automatically loaded by the engine once specified on the start-up), simply pass "" as an argument to this command.
Аргументы можно указать следующим образом:
  • PLUGIN_NAME
  • PLUGIN_NAME_1,PLUGIN_NAME_2,...,PLUGIN_NAME_N
-extern_define Будет использоваться внешнее определение.
  • Некоторые определения разделяются запятыми (без пробелов).
  • Several definitions are comma separated (no whitespace). Вы также можете использовать следующий синтаксис: -extern_define "A=B,C=D".
    (Например, -extern_define  "TEST=42" .)
  • You can also use the following syntax: -extern_define "A=B,C=D".
    (For example, -extern_define  "TEST=42" .)
    Если вы хотите удалить все определения, просто передайте ""в качестве аргумента этой команды.
Текущее значение -extern_define можно получить через getExternDefine() метод Unigine API.
External definition to be used.
  • Several definitions are comma separated (no whitespace).Several definitions are comma separated (no whitespace).
  • You can also use the following syntax: -extern_define "A=B,C=D".
    (For example, -extern_define  "TEST=42" .)
    You can also use the following syntax: -extern_define "A=B,C=D".
    (For example, -extern_define  "TEST=42" .)
  • If you want to clear all definitions, simply pass "" as an argument to this command. If you want to clear all definitions, simply pass "" as an argument to this command.
The current value of -extern_define can be obtained via the getExternDefine() method of Unigine API.Several definitions are comma separated (no whitespace).You can also use the following syntax: -extern_define "A=B,C=D".
(For example, -extern_define  "TEST=42" .) If you want to clear all definitions, simply pass "" as an argument to this command.
Аргументы можно указать следующим образом:
  • DEFINITION_NAME
  • DEFINITION_NAME=VALUE
  • DEFINITION_NAME_1,DEFINITION_NAME_2,
    DEFINITION_NAME_3=VALUE,...,DEFINITION_NAME_N

Sound SettingsНастройки звука#

Имя Описание Аргументы По умолчанию
-sound_app Используемый звуковой API:
  • No sound
  • No sound Автоматический выбор лучшего варианта звуковой библиотеки из доступных (OpenAL)
  • Automatically choose the best sound library option from available ones (OpenAL) Библиотека звуков OpenAL
Текущее значение -sound_app можно получить через getSoundApp() метод Unigine API.
null
auto
openal
auto
Последнее обновление: 11.11.2020