Unigine::BootConfig Class

#include "AppSystemLogic.h"
#include <UnigineConfig.h>
#include <UnigineConsole.h>

using namespace Unigine;

/* .. */

int AppSystemLogic::shutdown()
{
	// set the window title
	BootConfig::setWindowTitle("Project Name");
	Console::setString("starting_world", "my_world");

	// customize the boot screen
	BootConfig::setScreenWidth(960);
	BootConfig::setScreenHeight(540);

	BootConfig::setScreenBackgroundColor(Math::vec4_black);
	BootConfig::setScreenTransform(Math::vec4(1.0f, 1.0f, 0.5f, 0.5f));

	BootConfig::setScreenThreshold(16);
	BootConfig::setScreenTexture("textures/boot_screen.png");

	BootConfig::setScreenText("								\
			<p align=\"center\">							\
				<font color=\"#ffffff\" size=\"64\">		\
					<xy x=\"%10\" y=\"%50\"/>Helicopter	\
				</font>										\
			</p>");
	BootConfig::setScreenMessageEngineInit(R"(					\
			<p><font size=\"24\" color=\"#777777\">			\
				Engine initialization.						\
			</font></p>)");
	BootConfig::setScreenMessageFileSystemInit("Custom message for file system initialization.");
	BootConfig::setScreenMessageMaterialsInit("Custom message for materials initialization.");
	BootConfig::setScreenMessagePropertiesInit("Custom message for properties initialization.");
	BootConfig::setScreenMessageShadersCompilation("Custom message for shaders compilation.");

	BootConfig::save();

	return 1;
}

BootConfig Class

Members

void setScreenEnabled ( bool enabled ) #

Arguments

• bool enabled - Set true to enable the boot screen; false - to disable it.

bool isScreenEnabled() const#

Return value

true if the boot screen is enabled; otherwise false.

void setScreenMessageShadersCompilation ( const char * compilation ) #

Arguments

• const char * compilation - The message for shaders compilation.

const char * getScreenMessageShadersCompilation() const#

Return value

Current message for shaders compilation.

void setScreenMessageEngineInit ( const char * init ) #

Arguments

• const char * init - The Message for the engine initialization.

const char * getScreenMessageEngineInit() const#

Return value

Current Message for the engine initialization.

void setScreenMessageFileSystemInit ( const char * init ) #

Arguments

• const char * init - The Message for the file system initialization.

const char * getScreenMessageFileSystemInit() const#

Return value

Current Message for the file system initialization.

void setScreenMessagePropertiesInit ( const char * init ) #

Arguments

• const char * init - The message for properties initialization.

const char * getScreenMessagePropertiesInit() const#

Return value

Current message for properties initialization.

void setScreenMessageStaticMeshesInit ( const char * init ) #

Arguments

• const char * init - The Message for static meshes initialization.

const char * getScreenMessageStaticMeshesInit() const#

Return value

Current Message for static meshes initialization.

void setScreenMessageMaterialsInit ( const char * init ) #

Arguments

• const char * init - The Message for materials initialization.

const char * getScreenMessageMaterialsInit() const#

Return value

Current Message for materials initialization.

void setScreenMessageMaterialsPreloading ( const char * preloading ) #

Arguments

• const char * preloading - The Message for materials preloading.

const char * getScreenMessageMaterialsPreloading() const#

Return value

Current Message for materials preloading.

void setScreenText ( const char * text ) #

Arguments

• const char * text - The text of the boot screen. Can be either a plain or rich text. A number of aliases is provided:
  • UNIGINE_COPYRIGHT — the UNIGINE copyright text.
  • UNIGINE_VERSION — the current UNIGINE version.
  • LOADING_PROGRESS — the loading progress going from 0 to 100.

const char * getScreenText() const#

Return value

Current text of the boot screen. Can be either a plain or rich text. A number of aliases is provided:

• UNIGINE_COPYRIGHT — the UNIGINE copyright text.
• UNIGINE_VERSION — the current UNIGINE version.
• LOADING_PROGRESS — the loading progress going from 0 to 100.

void setScreenFont ( const char * font ) #

Arguments

• const char * font - The path to the font for text rendering.

const char * getScreenFont() const#

Return value

Current path to the font for text rendering.

void setScreenTexture ( const char * texture ) #

Arguments

• const char * texture - The path to the boot screen texture.

const char * getScreenTexture() const#

Return value

Current path to the boot screen texture.

void setScreenThreshold ( int threshold ) #

Arguments

• int threshold - The threshold for blending based on the alpha-channel.

int getScreenThreshold() const#

Return value

Current threshold for blending based on the alpha-channel.

void setScreenTransform ( const Math::vec4& transform ) #

Arguments

• const Math::vec4& transform - The transformation of the screen defined by a vector of four numbers in the [0; 1] range:
  1. Texture size multiplier
  2. Window size multiplier
  3. Horizontal position
  4. Vertical position

Math::vec4 getScreenTransform() const#

Return value

Current transformation of the screen defined by a vector of four numbers in the [0; 1] range:

1. Texture size multiplier
2. Window size multiplier
3. Horizontal position
4. Vertical position

void setScreenBackgroundColor ( const Math::vec4& color ) #

Arguments

• const Math::vec4& color - The background color defined by a vector of four numbers in the [0; 1] range.

Math::vec4 getScreenBackgroundColor() const#

Return value

Current background color defined by a vector of four numbers in the [0; 1] range.

void setScreenHeight ( int height ) #

Arguments

• int height - The height of the boot screen window, in pixels.

int getScreenHeight() const#

Return value

Current height of the boot screen window, in pixels.

void setScreenWidth ( int width ) #

Arguments

• int width - The width of the boot screen window, in pixels.

int getScreenWidth() const#

Return value

Current width of the boot screen window, in pixels.

int getNumExternPlugins() const#

Return value

Current number of plugin libraries to be loaded at the Engine startup.

int getNumPluginPaths() const#

Return value

Current number of plugin directories.

void setConsoleCommand ( const char * command ) #

Arguments

• const char * command - The console command(s) used at the Engine startup. Several commands can be separated using the && sequence.

const char * getConsoleCommand() const#

Return value

Current console command(s) used at the Engine startup. Several commands can be separated using the && sequence.

void setExternDefine ( const char * define ) #

Arguments

• const char * define - The external definition(s) used at the Engine startup. 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

const char * getExternDefine() const#

Return value

Current external definition(s) used at the Engine startup. 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 setSoundApp ( const char * app ) #

Arguments

• const char * app - The sound API used for rendering: nosound, auto, or openal.

const char * getSoundApp() const#

Return value

Current sound API used for rendering: nosound, auto, or openal.

void setVideoApp ( const char * app ) #

Arguments

• const char * app - The graphics API used for rendering: null, auto, dx, dx11, direct3d11, dx12, direct3d12, vk, vulkan.

const char * getVideoApp() const#

Return value

Current graphics API used for rendering: null, auto, dx, dx11, direct3d11, dx12, direct3d12, vk, vulkan.

void setSystemCache ( const char * cache ) #

Arguments

• const char * cache - The path to a cache file used by the Engine. Can be an absolute path or a path relative to the data path, or to the cache path (if any).

const char * getSystemCache() const#

Return value

Current path to a cache file 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 setEditorCache ( const char * cache ) #

Arguments

• const char * cache - The path to a cache file used by the UnigineEditor. Can be an absolute path or a path relative to the data path, or to the cache path (if any).

const char * getEditorCache() const#

Return value

Current path to a cache file 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 setCachePath ( const char * path ) #

Arguments

• const char * path - The path to the store system and Editor cache files. Can be an absolute path or a relative path to the data path.

const char * getCachePath() const#

Return value

Current path to the store system and Editor cache files. Can be an absolute path or a relative path to the data path.

void setEditorScript ( const char * script ) #

Arguments

• const char * script - The path to the editor script (specified relative to the data folder).

const char * getEditorScript() const#

Return value

Current path to the editor script (specified relative to the data folder).

void setSystemScript ( const char * script ) #

Arguments

• const char * script - The path to the system script (specified relative to the data folder).

const char * getSystemScript() const#

Return value

Current path to the system script (specified relative to the data folder).

void setEngineLog ( const char * log ) #

Arguments

• const char * log - The log file (in TXT format) used by the Engine.

const char * getEngineLog() const#

Return value

Current log file (in TXT format) used by the Engine.

void setGuiPath ( const char * path ) #

Arguments

• const char * path - The path to a GUI skin used for the Engine interface (absolute path or path relative to the data folder).

const char * getGuiPath() const#

Return value

Current path to a GUI skin used for the Engine interface (absolute path or path relative to the data folder).

void setAutosave ( bool autosave ) #

Arguments

• bool autosave - Set true to enable automatic saving of current startup configuration settings; false - to disable it.

bool isAutosave() const#

Return value

true if automatic saving of current startup configuration settings is enabled; otherwise false.

void setPath ( const char * path ) #

Arguments

• const char * path - The path to the startup configuration file.

const char * getPath() const#

Return value

Current path to the startup configuration file.

void setWindowTitle ( const char * title ) #

Arguments

• const char * title - The application window title.

const char * getWindowTitle() const#

Return value

Current application window title.

void setWindowIconPath ( const char * path ) #

Arguments

• const char * path - The path to the custom icon for the final application's window.

const char * getWindowIconPath() const#

Return value

Current path to the custom icon for the final application's window.

---

bool load ( ) #

Loads Engine startup configuration from the file. To change the path to the configuration file use the setPath() method.

Return value

true if the config is successfully loaded from the file; otherwise, false.

bool save ( ) const#

Saves the current Engine startup configuration to the file. To change the path to the configuration file use the setPath() method.

Return value

true if the current configuration is successfully saved to the file; otherwise, false.

void reset ( ) #

Resets the settings in the Engine startup configuration file to the default.

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.

const char * 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, const char * 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.
• const char * 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.

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.

const char * 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, const char * 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.
• const char * 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").