Unigine.BootConfig Class

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Unigine;

namespace UnigineApp
{
	class AppSystemLogic : SystemLogic
	{
		
		public override bool Shutdown()
		{
            // set the window title
            BootConfig.WindowTitle = "Project Name";
            Unigine.Console.SetString("starting_world", "my_world");

            // customize the boot screen
            BootConfig.ScreenWidth = 960;
            BootConfig.ScreenHeight = 540;

            BootConfig.ScreenBackgroundColor = vec4.BLACK;
            BootConfig.ScreenTransform = new vec4(1.0f, 1.0f, 0.5f, 0.5f);

            BootConfig.ScreenThreshold = 16;
            BootConfig.ScreenTexture = "textures/boot_screen.png";

            BootConfig.ScreenText = @"
			<p align=""center"">
				<font color=""#ffffff"" size=""64"">
					<xy x=""%10"" y=""%50""/>Small Village
				</font>
			</p>";

            BootConfig.ScreenMessageEngineInit = @"
			<p><font size=""24"" color=""#777777"">
				Engine initialization.
			</font></p>";
            BootConfig.ScreenMessageFileSystemInit = "Custom message for file system initialization.";
            BootConfig.ScreenMessageMaterialsInit = "Custom message for materials initialization.";
            BootConfig.ScreenMessagePropertiesInit = "Custom message for properties initialization.";
            BootConfig.ScreenMessageShadersCompilation = "Custom message for shaders compilation.";

            BootConfig.Save();

            return true;
		}
	}
}

BootConfig Class

Properties

bool ScreenEnabled#

string ScreenMessageShadersCompilation#

string ScreenMessagePropertiesInit#

string ScreenMessageMaterialsInit#

string ScreenMessageFileSystemInit#

string ScreenMessageEngineInit#

string ScreenText#

string ScreenFont#

string ScreenTexture#

int ScreenThreshold#

vec4 ScreenTransform#

vec4 ScreenBackgroundColor#

int ScreenHeight#

int ScreenWidth#

int NumExternPlugins#

int NumPluginPaths#

string ConsoleCommand#

string ExternDefine#

string SoundApp#

string VideoApp#

string SystemCache#

string EditorCache#

string CachePath#

string EditorScript#

string SystemScript#

string EngineLog#

string GuiPath#

bool Autosave#

string Path#

string WindowTitle#

string WindowIconPath#

Members

---

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 ( ) #

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.

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.

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 SetWindowTitle ( string title ) #

Sets a new title for the application window.

Arguments

• string title - New application window title to be set.

string GetWindowTitle ( ) #

Returns the current application window title.

Return value

Current application window title.

static void setWindowIconPath ( string path ) #

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

Arguments

• string path - Path to the custom icon for the final application's window.

static string getWindowIconPath ( ) #

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

Return value

Path to the custom icon for the final application's window.