BootConfig Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
A singleton that controls the Engine startup configuration and enables you to customize the boot screen.
Notice
Fonts, textures, or any other resources used in the boot screen cannot be packed into an UNG archive.
BootConfig Class
Members
void setPath ( string path ) #
Sets a new path to the startup configuration file (default: data/configs/default.boot).Arguments
- string path - New path to the startup configuration file to be set.
string getPath ( ) #
Returns the current path to the startup configuration file (default: data/configs/default.boot).Return value
Current path to the startup configuration file.void setAutosave ( int autosave ) #
Sets a value indicating if current startup configuration settings are automatically saved to the corresponding config file on loading, closing, and saving the world, as well as on the Engine shutdown.Arguments
- int autosave - 1 to enable automatic saving of current startup configuration settings; 0 — to disable it.
int isAutosave ( ) #
Returns a value indicating if current startup configuration settings are automatically saved to the corresponding config file on loading, closing, and saving the world, as well as on the Engine shutdown.Return value
1 if automatic saving of current Engine configuration settings is enabled; otherwise, 0.int load ( ) #
Loads Engine startup configuration from the file. To change the path to the configuration file use the setPath() method.Return value
1 if the config is successfully loaded from the file; otherwise, 0.int save ( ) #
Saves the current Engine startup configuration to the file. To change the path to the configuration file use the setPath() method.Return value
1 if the current configuration is successfully saved to the file; otherwise, 0.void reset ( ) #
Resets the settings in the Engine startup configuration file to the default.void setGuiPath ( string path ) #
Sets 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 folder.Arguments
- string path - Path to a GUI skin to be used for the Engine interface (absolute path or path relative to the data folder).
string getGuiPath ( ) #
Returns a path to a GUI skin currently used for the Engine interface. The path can be specified as absolute or relatively to the data folder.Return value
Path to a GUI skin currently used for the Engine interface (absolute path or path relative to the data folder).void setEngineLog ( string log ) #
Sets a log file (in txt format) to be created and used by the Engine. The path can be absolute or relative to the binary executable. For relative paths, if the Project Name startup parameter 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).Arguments
- string log - Log file (in txt format) to be used by the Engine.
string getEngineLog ( ) #
Returns a log file (in txt format) currently used by the Engine. The path can be absolute or relative to the binary executable. For relative paths, if the Project Name startup parameter 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).Return value
Log file (in txt format) currently used by the Engine.void setSystemScript ( string script ) #
Sets a new path to the system script (corresponds to the system_script element of the .boot configuration file).Arguments
- string script - Path to the system script (specified relative to the data folder).
string getSystemScript ( ) #
Returns the path to the system script (corresponds to the system_script element of the .boot configuration file).Return value
Path to the system script (specified relative to the data folder).void setEditorScript ( string script ) #
Sets a new path to the editor script (corresponds to the system_script element of the .boot configuration file).Arguments
- string script - Path to the editor script (specified relative to the data folder).
string getEditorScript ( ) #
Returns the path to the editor script (corresponds to the system_script element of the .boot configuration file).Return value
Path to the editor script (specified relative to the data folder).void setCachePath ( string path ) #
Sets a new path to store system and Editor cache files(corresponds to the cache_path element of the .boot configuration file).Arguments
- string path - Path to store system and Editor cache files. Can be an absolute path or a relative path to the data path.
string getCachePath ( ) #
Returns the current path to store system and Editor cache files(corresponds to the cache_path element of the .boot configuration file).Return value
Path to store system and Editor cache files. Can be an absolute path or a relative path to the data path.void setEditorCache ( string cache ) #
Sets a new path to a cache file to be used by the UnigineEditor (corresponds to the editor_cache element of the .boot configuration file).Arguments
- string cache - Path to a cache file to be used by the UnigineEditor. Can be an absolute path or a path relative to the data path, or to the cache path (if any).
string getEditorCache ( ) #
Returns the path to a cache file currently used by the UnigineEditor (corresponds to the editor_cache element of the .boot configuration file).Return value
Path to a cache file to be used by the UnigineEditor. Can be an absolute path or a path relative to the data path, or to the cache path (if any).void setSystemCache ( string cache ) #
Sets a new path to a cache file to be used by the Engine (corresponds to the system_cache element of the .boot configuration file).Arguments
- string cache - Path to a cache file currently used by the Engine. Can be an absolute path or a path relative to the data path, or to the cache path (if any).
string getSystemCache ( ) #
Returns the current path to a cache file to be used by the Engine (corresponds to the system_cache element of the .boot configuration file).Return value
Path to a cache file currently used by the Engine. Can be an absolute path or a path relative to the data path, or to the cache path (if any).void setVideoApp ( string app ) #
Sets a new graphics API to be used for rendering. (corresponds to the video_app element of the .boot configuration file).Arguments
- string app - Graphics API used for rendering: null, auto, dx, or gl.
string getVideoApp ( ) #
Returns the graphics API currently used for rendering (corresponds to the video_app element of the .boot configuration file).Return value
Graphics API used for rendering: null, auto, dx, or gl.void setSoundApp ( string app ) #
Sets a new sound API to be used (corresponds to the sound_app element of the .boot configuration file).Arguments
- string app - Sound API used for rendering: nosound, auto, or openal.
string getSoundApp ( ) #
Returns the sound API currently used (corresponds to the sound_app element of the .boot configuration file).Return value
Sound API used for rendering: nosound, auto, or openal.void setExternDefine ( string defines ) #
Sets extern define(s) to be used at the Engine startup (corresponds to the extern_define element of the .boot configuration file).Arguments
- string defines - External definition(s) to be used. Several definitions are comma separated (no whitespaces). Definitions can be specified as follows:
- DEFINITION_NAME
- DEFINITION_NAME=VALUE
- DEFINITION_NAME_1,DEFINITION_NAME_2,
DEFINITION_NAME_3=VALUE,...,DEFINITION_NAME_N
string getExternDefine ( ) #
Returns extern define(s) currently used at the Engine startup (corresponds to the extern_define element of the .boot configuration file).Return value
External definition(s) to be used. Several definitions are comma separated (no whitespaces). Definitions can be specified as follows:- DEFINITION_NAME
- DEFINITION_NAME=VALUE
- DEFINITION_NAME_1,DEFINITION_NAME_2,
DEFINITION_NAME_3=VALUE,...,DEFINITION_NAME_N
void setConsoleCommand ( string command ) #
Sets a new Console command(s) to be used at the Engine startup (corresponds to the console_command element of the .boot configuration file).Arguments
- string command - Console command(s) to be used at the engine startup. Several commands can be separated using the && sequence.
string getConsoleCommand ( ) #
Returns Console command(s) currently used at the Engine startup (corresponds to the console_command element of the .boot configuration file).Return value
Console command(s) currently used at the Engine startup. Several commands can be separated using the && sequence.int getNumPluginPaths ( ) #
Returns the number of directory(ies) containing plugins to be automatically loaded at the Engine startup. These directories are specified in the .boot configuration file via the plugin_path element. The list of these plugin paths can be obtained via the getNumPluginPaths() and getPluginPath(int num) methods. The order of loading plugins matters, you can rearrange the paths via swapPluginPath()Return value
Current number of plugin directories.void removePluginPath ( int num ) #
Removes a plugin path with the specified number from the list of the plugin paths specified in the .boot configuration file via the plugin_path element. A plugin path is a directory containing plugins to be automatically loaded at the Engine startup.Arguments
- int num - Number of the plugin path to be removed from the list of the specified plugin paths, in the range from 0 to the total number of plugin paths specified.
void swapPluginPath ( int num0, int num1 ) #
Swaps two plugin paths with the given numbers specified in the .boot configuration file. A plugin path is a directory containing plugins to be automatically loaded at the Engine startup. The list of these plugin paths can be obtained via the getNumPluginPaths() and getPluginPath(int num) methods. The order of loading plugins matters, you can rearrange the paths via swapPluginPath()Arguments
- int num0 - Number of the first plugin path in the list of the specified plugin paths to be swapped, in the range from 0 to the total number of plugin paths specified.
- int num1 - Number of the second plugin path in the list of the specified plugin paths to be swapped, in the range from 0 to the total number of plugin paths specified.
string getPluginPath ( int num ) #
Returns a plugin path with the given number specified in the .boot configuration file via the plugin_path element. A plugin path is a directory containing plugins to be automatically loaded at the Engine startup. The order of loading plugins matters, you can rearrange the paths via swapPluginPath().Arguments
- int num - Plugin path number in the list of the specified plugin paths, in the range from 0 to the total number of plugin paths specified.
Return value
Path to the plugins directory with the given number in the list of the plugin paths. Сan be absolute or specified relatively to the binary executable.void setPluginPath ( int num, string value ) #
Sets a new path for the item of the list of the plugin paths with the given number specified in the .boot configuration file via the plugin_path element. A plugin path is a directory containing plugins to be automatically loaded at the Engine startup. The order of loading plugins matters, you can rearrange the paths via swapPluginPath().Arguments
- int num - Plugin path number in the list of the specified plugin paths.
- string value - New path to be set for the specified item of the list of the plugin paths. Сan be specified relatively to the binary executable or as an absolute path.
int getNumExternPlugins ( ) #
Returns the number of plugin libraries to be automatically loaded at the Engine startup. These plugins are specified in the .boot configuration file via the extern_plugin element. The list of these plugin paths can be obtained via the getNumExternPlugins() and getExternPlugin(int num) methods. The order of loading plugins matters, you can rearrange them via swapPluginPath().Return value
Current number of plugin libraries to be loaded at the Engine startup.void removeExternPlugin ( int num ) #
Removes a plugin with the specified number from the list of the plugins specified in the .boot configuration file via the extern_plugin element.Arguments
- int num - Number of the plugin to be removed from the list of the specified plugins, in the range from 0 to the total number of plugins specified.
void swapExternPlugin ( int num0, int num1 ) #
Swaps two plugins with the given numbers specified in the .boot configuration file. The list of these plugins can be obtained via the getNumExternPlugins() and getExternPlugin(int num) methods. The order of loading plugins matters, this method enables you to rearrange plugins to change loading order.Arguments
- int num0 - Number of the first plugin in the list of the specified plugins to be swapped, in the range from 0 to the total number of plugins specified.
- int num1 - Number of the second plugin in the list of the specified plugins to be swapped, in the range from 0 to the total number of plugins specified.
string getExternPlugin ( int num ) #
Returns the name of the plugin with the given number specified in the .boot configuration file via the extern_plugin element. The order of loading plugins matters, you can rearrange the paths via swapExternPlugin().Arguments
- int num - Number of the plugin in the list of the specified plugins, in the range from 0 to the total number of plugins specified.
Return value
Name of the plugin with the given number specified in the .boot configuration file. Plugin library name goes without any prefixes and postfixes (e.g., libNetwork_x64d.so is listed as "Network").void setExternPlugin ( int num, string value ) #
Sets a new name of the plugin with the given number specified in the .boot configuration file via the extern_plugin element. The order of loading plugins matters, you can rearrange the paths via swapExternPlugin().Arguments
- int num - Number of the plugin to be set in the list of the specified plugins, in the range from 0 to the total number of plugins specified.
- string value - Name of the plugin with the given number specified in the .boot configuration file. Plugin library name goes without any prefixes and postfixes (e.g., libNetwork_x64d.so is listed as "Network").
void setScreenWidth ( int width = 860 ) #
Sets the width of the boot screen window, in pixels.Arguments
- int width - Width of the boot screen window, in pixels.
int getScreenWidth ( ) #
Returns the current width of the boot screen window.Return value
Current width of the boot screen window, in pixels.void setScreenHeight ( int height = 560 ) #
Sets the height of the boot screen window, in pixels.Arguments
- int height - Height of the boot screen window, in pixels.
int getScreenHeight ( ) #
Returns the height of the boot screen window, in pixels.Return value
Current height of the boot screen window, in pixels.void setScreenBackgroundColor ( vec4 color ) #
Sets the background color of the screen. The default value is vec4_zero.Arguments
- vec4 color - Background color defined by a vector of four numbers in the [0; 1] range.
vec4 getScreenBackgroundColor ( ) #
Returns the current background color of the screen.Return value
Background color defined by a vector of four numbers in the [0; 1] range.void setScreenTransform ( vec4 transform ) #
Sets the transformation of the boot screen texture. The default value is vec4(1.0f, 1.0f, 0.5f, 0.5f).Arguments
- vec4 transform - Transformation of the screen defined by a vector of four numbers in the [0; 1] range:
- Texture size multiplier
- Window size multiplier
- Horizontal position
- Vertical position
vec4 getScreenTransform ( ) #
Returns the current transformation of the boot screen texture.Return value
Transformation of the screen defined by a vector of four numbers in the [0; 1] range:- Texture size multiplier
- Window size multiplier
- Horizontal position
- Vertical position
void setScreenThreshold ( int threshold = 16 ) #
Sets the threshold for blending based on the alpha-channel.Arguments
- int threshold - Threshold for blending based on the alpha-channel.
int getScreenThreshold ( ) #
Returns the current threshold for blending based on the alpha-channel.Return value
Threshold for blending based on the alpha-channel.void setScreenTexture ( string texture ) #
Sets the path to the boot screen texture.Notice
Textures or any other resources used in the Boot screen cannot be packed into an UNG archive.
Arguments
- string texture - Path to the boot screen texture.
string getScreenTexture ( ) #
Returns the current path to the boot screen texture.Return value
Path to the boot screen texture.void setScreenFont ( string font ) #
Sets the path to the font for text rendering.Notice
Fonts or any other resources used in the Boot screen cannot be packed into an UNG archive.
Arguments
- string font - Path to the font for text rendering.
string getScreenFont ( ) #
Returns the current path to the font for text rendering.Return value
Path to the font for text rendering.void setScreenText ( string text ) #
Sets the text of the boot screen.Arguments
- string text - Text of the boot screen.
string getScreenText ( ) #
Returns the current text of the boot screen.Return value
Text of the boot screen.void setScreenMessageEngineInit ( string init ) #
Sets the message to be displayed on the engine initialization.Arguments
- string init - Message on the engine initialization.
string getScreenMessageEngineInit ( ) #
Returns the message currently displayed on the engine initialization.Return value
Message on the engine initialization.void setScreenMessageFileSystemInit ( string init ) #
Sets the message to be displayed on the file system initialization.Arguments
- string init - Message for file system initialization.
string getScreenMessageFileSystemInit ( ) #
Returns the message currently displayed on the file system initialization.Return value
Message for file system initialization.void setScreenMessageMaterialsInit ( string init ) #
Sets the message to be displayed on materials initialization.Arguments
- string init - Message for materials initialization.
string getScreenMessageMaterialsInit ( ) #
Returns the message currently displayed on materials initialization.Return value
Message for materials initialization.void setScreenMessagePropertiesInit ( string init ) #
Sets the message to be displayed on properties initialization.Arguments
- string init - Message for properties initialization.
string getScreenMessagePropertiesInit ( ) #
Returns the message currently displayed on properties initialization.Return value
Message for properties initialization.void setScreenMessagePluginsInit ( string init ) #
Sets the message to be displayed on the plugins initialization.Arguments
- string init - Message for plugins initialization.
string getScreenMessagePluginsInit ( ) #
Returns the message currently displayed on plugins initialization.Return value
Message for plugins initialization.void setScreenMessageShadersCompilation ( string compilation ) #
Sets the message to be displayed on shaders compilation.Arguments
- string compilation - Message for shaders compilation.
string getScreenMessageShadersCompilation ( ) #
Returns the message currently displayed on shaders compilation.Return value
Message for shaders compilation.Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)