Unigine.Engine Class

Sort by:

List of functions:

The Engine class is required for the engine initialization and executing the main loop of the program. Also, you can get the engine startup options through this class.

Engine Class

Members

static Engine get()

Returns a pointer to the existing engine instance.

Return value

Pointer to the existing engine.

string getAppPath()

Returns the path to a directory where binary executable file is stored.

Return value

Path to a directory where binary executable file is stored.

string getArg(int num)

Returns a command line argument by its index.

Arguments

int num - Index of the command line argument.

Return value

Command line argument.

virtual float getArgf(int num) const =0

Returns a command line argument by its index converted to a floating point value.

Arguments

int num - Index of the command line argument.

Return value

Command line argument.

virtual int getArgi(int num) const =0

Returns a command line argument by its index converted to an integer value.

Arguments

int num - Index of the command line argument.

Return value

Command line argument.

string getCachePath()

Returns a path to a directory where cached files will be stored.

Return value

Path to the directory with cached files.

string getDataPath()

Returns a path to the -data_path directory specified at the engine startup.

Arguments

Return value

Path to the data directory.

virtual int isDone() const =0

Returns the done flag on engine quit.

Return value

1 if engine is quitting; otherwise, 0.

int getEditorFunction(string name, int num_args)

Returns the editor function identifier.

Arguments

string name - Name of the editor script function.
int num_args - Number of editor script function arguments.

Return value

The editor script function identifier.

int isEditorFunction(string name, int num_args)

Returns a value indicating if the editor script function exists.

Arguments

string name - Name of the editor script function.
int num_args - Number of editor script function arguments.

Return value

1 if the editor script function exists; otherwise, 0.

virtual IntPtr getEditorInterpreter() const =0

Returns a pointer to the editor interpreter.

Return value

Pointer to the editor interpreter.

virtual int isEditorInterpreter() const =0

Returns a value indicating if the function is called from the editor script.

Return value

1 if the function is called from the editor script; otherwise, 0.

virtual int isEditorLoaded() const =0

Returns a value indicating if the editor script is loaded.

Return value

1 if the editor script is loaded; otherwise, 0.

EditorLogic getEditorLogic(int num)

Returns the registered EditorLogic instance by its number.

Arguments

int num - Number of the EditorLogic instance.

Return value

EditorLogic instance.

string getEditorScript()

Returns a path to the editor script (provided by the -editor_script command line argument).

Return value

Path to the editor script.

void setEditorVariable(string name, Variable v)

Sets the editor script variable by its name.

Arguments

string name - Name of the editor script variable.
Variable v - Value of the editor script variable.

Variable getEditorVariable(string name)

Returns the editor script variable by its name.

Arguments

string name - Name of the world script variable.

Return value

Value of the editor script variable.

int isEditorVariable(string name)

Returns a value indicating if the editor script variable exists.

Arguments

string name - Name of the editor script variable.

Return value

1 if the editor script variable exists; otherwise, 0.

string getExternDefines()

Returns the external definitions specified on the application start-up.

Return value

The list of external definitions.

string getHomePath()

Returns a path to the user's home directory.

Return value

Path to the user's home directory.

static int isInitialized()

Returns the initialization status of the engine.

Return value

1 if the engine is initialized; otherwise, 0.

virtual int getNumArgs() const =0

Returns the number of command line arguments.

Return value

Number of command line arguments.

int getNumEditorLogics()

Returns the number of registered EditorLogic instances.

Return value

Number of EditorLogic instances.

int getNumPlugins()

Returns the number of loaded plugins.

Return value

Number of plugins.

int getNumSystemLogics()

Returns the number of registered SystemLogic instances.

Return value

Number of SystemLogic instances.

int getNumWorldLogics()

Returns the number of registered WorldLogic instances.

Return value

Number of WorldLogic instances.

string getPluginName(int num)

Returns the name of the loaded plugin by its index.

Arguments

int num - Index of the loaded plugin.

Return value

Loaded plugin name.

string getPluginPath(int num)

Returns a path to a plugin directory specified via -plugin_path.

Arguments

int num - Plugin path number in the row of the specified plugin paths.

Return value

Path to a plugin directory.

float getPresentTime()

Returns the total time spent on waiting for the GPU after all calculations on the CPU are completed. See the Profiler article for details.

Return value

Time value, in milliseconds.

string getSavePath()

Returns a path to a directory where a default configuration file, saved files and screenshots will be stored.

Return value

Path to a directory with the default configuration file, saved files, etc.

getSoundApp()

Returns the current sound API.

Return value

A sound API instance.

const char * getSystemCache()

Returns a path to the system script cache.

Return value

Path to the system script cache.

int getSystemFunction(string name, int num_args)

Returns the system function identifier.

Arguments

string name - Name of the system script function.
int num_args - Number of system script function arguments.

Return value

System script function identifier.

int isSystemFunction(string name, int num_args)

Checks whether the system script function exists.

Arguments

string name - Name of the system script function.
int num_args - Number of system script function arguments.

Return value

1 if the system script function exists; otherwise, 0.

virtual IntPtr getSystemInterpreter() const =0

Returns a pointer to the system interpreter.

Return value

Pointer to the system interpreter.

virtual int isSystemInterpreter() const =0

Checks if the function is called from the system script.

Return value

1 when the function is called from the system script; otherwise, 0.

SystemLogic getSystemLogic(int num)

Returns the registered SystemLogic instance by the given number.

Arguments

int num - Number of the SystemLogic instance.

Return value

SystemLogic instance.

string getSystemScript()

Returns a path to the system script.

Return value

Path to the system script.

void setSystemVariable(string name, Variable v)

Sets a system script variable by a name.

Arguments

string name - Name of the system script variable.
Variable v - Value of the system script variable.

Variable getSystemVariable(string name)

Returns the system script variable by its name.

Arguments

string name - Name of the system script variable.

Return value

System script variable.

int isSystemVariable(string name)

Checks whether a system script variable exists.

Arguments

string name - Name of the system script variable.

Return value

1 if the system script variable exists; otherwise, 0.

getVideoApp()

Returns a graphics API used for rendering.

Return value

Graphics API used for rendering.

int getWorldFunction(string name, int num_args)

Returns the world script function identifier.

Arguments

string name - Name of the world script function.
int num_args - Number of world script function arguments.

Return value

World script function identifier.

int isWorldFunction(string name, int num_args)

Returns value indicating if the world script function exists.

Arguments

string name - Name of the world script function.
int num_args - Number of world script function arguments.

Return value

1 if the world script function exists; otherwise, 0.

virtual IntPtr getWorldInterpreter() const =0

Returns a pointer to the world interpreter.

Return value

Pointer to the world interpreter.

virtual int isWorldInterpreter() const =0

Returns a value indicating if the function is called from the world script.

Return value

1 if the function is called from the world script; otherwise, 0.

virtual int isWorldLoaded() const =0

Returns a value indicating if the world script is loaded.

Return value

1 if the world script is loaded; otherwise, 0.

WorldLogic getWorldLogic(int num)

Returns the registered WorldLogic instance by its number.

Arguments

int num - Number of the WorldLogic instance.

Return value

WorldLogic instance.

void setWorldVariable(string name, Variable v)

Sets a world script variable by its name.

Arguments

string name - Name of the world script variable.
Variable v - Value of the world script variable.

Variable getWorldVariable(string name)

Returns a world script variable by its name.

Arguments

string name - Name of the world script variable.

Return value

World script variable.

int isWorldVariable(string name)

Returns a value indicating if the world script variable exists.

Arguments

string name - Name of the world script variable.

Return value

1 if the world script variable exists; otherwise, 0.

int addEditorLogic(EditorLogic logic)

Adds an EditorLogic instance to the engine runtime.

Arguments

EditorLogic logic - EditorLogic instance.

Return value

1 if the EditorLogic instance has been added successfuly; otherwise, 0.

virtual int addPlugin(Plugin plugin) const =0

Adds a plugin in engine runtime by using a pointer to this plugin.

Arguments

Plugin plugin - Plugin.

Return value

1 if the plugin ha been added successfully; otherwise, 0.

int addPlugin(string name)

Adds a plugin in engine runtime by its name.

Arguments

string name - Plugin name.

Return value

1 if the plugin has been added successfully; otherwise, 0.

int addSystemLogic(SystemLogic logic)

Adds an SystemLogic instance to the engine runtime.

Arguments

SystemLogic logic - SystemLogic instance.

Return value

1 if the SystemLogic instance has been added successfully; otherwise, 0.

int addWorldLogic(WorldLogic logic)

Adds an WorldLogic instance to the engine runtime.

Arguments

WorldLogic logic - WorldLogic instance.

Return value

1 if the WorldLogic instance has been added successfully; otherwise, 0.

void dialogError()

Displays a dialog window with errors set using the error() function.

Arguments

void dialogMessage()

Displays a dialog window with the last message set using the message() function.

Arguments

int findPlugin(string name)

Searches the index of the loaded plugin by its name.

Arguments

string name - Name of the plugin.

Return value

Index of the plugin.

Engine init(int version, string[] args, string project = 0, string password = 0)

Initializes a new engine instance.

Arguments

int version - Engine version number (UNIGINE_VERSION).
string[] args - Array of command line arguments values.
string project - Project name. If this parameter is set, it forces the engine to store rewritable data (such as log file, cache files, config files) in user profile rather than in a directory with binaries. Notice that only the project name is required to pass in for this parameter, not the full path to the project. If there is no need to change location of such files, pass the 0 value.
string password - Password for the filesystem archives. Notice that the specified password must be the same as for the project archive (if it exists). Pass the 0 value if you do not need to set a password.

Return value

New engine instance.

Engine init(int version, App app, string[] args, string project = 0, string password = 0)

Initializes a new engine instance to be used with an external graphics application.

Arguments

int version - Version number (UNIGINE_VERSION).
App app - Instance of the graphics App class
string[] args - Array of values of command line arguments.
string project - Project name. If this parameter is set, it forces the engine to store rewritable data (such as log file, cache files, config files) in user profile rather than in a directory with binaries. Notice that only the project name is required to pass in for this parameter, not the full path to the project. If there is no need to change location of such files, pass the 0 value.
string password - Password for the filesystem archives. Notice that the specified password must be the same as for the project archive (if it exists). Pass the 0 value if you do not need to set a password.

Return value

New engine instance.

Engine init(int version, App app, string app_path, string home_path, string[] args, string project = 0, string password = 0)

Initializes a new engine instance to be used with an external graphics application, which is stored at the specified path.

Arguments

int version - Version number (UNIGINE_VERSION).
App app - Instance of the graphics App class.
string app_path - Path to a directory where binary executable file is stored. Pass the 0 value to ignore this parameter.
string home_path - Path to the user's home directory.
string[] args - Array of values of command line arguments.
string project - Project name. If this parameter is set, it forces the engine to store rewritable data (such as log file, cache files, config files) in user profile rather than in a directory with binaries. Notice that only the project name is required to pass in for this parameter, not the full path to the project. If there is no need to change location of such files, pass the 0 value.
string password - Password for the filesystem archives. Notice that the specified password must be the same as for the project archive (if it exists). Pass the 0 value if you do not need to set a password. Notice that the specified password must be the same as for the project archive (if it exists). Pass the 0 value if you do not need to set a password.

Return value

New engine instance.

Engine init(int version, string app_path, string home_path, string[] argv, string project = 0, string password = 0)

Initializes a new engine instance to be used with an external graphics application, which is stored at the specified path.

Arguments

int version - Version number (UNIGINE_VERSION).
string app_path - Path to a directory where binary executable file is stored. Pass the 0 value to ignore this parameter.
string home_path - Path to the user's home directory.
string[] argv - Array of values of command line arguments.
string project - Project name. If this parameter is set, it forces the engine to store rewritable data (such as log file, cache files, config files) in user profile rather than in a directory with binaries. Notice that only the project name is required to pass in for this parameter, not the full path to the project. If there is no need to change location of such files, pass the 0 value.
string password - Password for the filesystem archives. Notice that the specified password must be the same as for the project archive (if it exists). Pass the 0 value if you do not need to set a password. Notice that the specified password must be the same as for the project archive (if it exists). Pass the 0 value if you do not need to set a password.

Return value

New engine instance.

void main(SystemLogic system, WorldLogic world, EditorLogic editor)

Engine main loop. Replaces the following commands:

Source code (C++)

while (isDone() == 0) { 
	update();  
	render(); 
	swap(); 
}

Arguments

SystemLogic system - A SystemLogic instance.
WorldLogic world - A WorldLogic instance.
EditorLogic editor - An EditorLogic instance.

int removeEditorLogic(EditorLogic logic)

Removes an EditorLogic instance from engine runtime.

Arguments

EditorLogic logic - An EditorLogic instance.

Return value

1 if the instance has been removed successfuly; otherwise, 0.

virtual int removePlugin(Plugin plugin) const =0

Removes a plugin by using a pointer to this plugin.

Arguments

Plugin plugin - Plugin instance to remove.

Return value

1 if the plugin has been removed successfully; otherwise, 0.

int removeSystemLogic(SystemLogic logic)

Removes a SystemLogic instance from engine runtime.

Arguments

SystemLogic logic - A SystemLogic instance.

Return value

1 if the instance has been removed successfuly; otherwise, 0.

int removeWorldLogic(WorldLogic logic)

Removes a WorldLogic instance from engine runtime.

Arguments

WorldLogic logic - A WorldLogic instance.

Return value

1 if the instance has been removed successfully; otherwise, 0.

virtual void render() const =0

Engine rendering function. This function must be called every frame.

virtual Variable runEditorFunction(Variable name) const =0

Runs the editor script function by its name. The target function can receive up to 8 arguments.

Arguments

Variable name - Name of the editor script function.

Return value

Editor script function return value.

Variable runEditorFunction(Variable name, Variable a0)

Runs the editor script function by its name. The target function must receive 1 argument.

Arguments

Variable name - Name of the editor script function.
Variable a0 - First argument.

Return value

Editor script function return value.

Variable runEditorFunction(Variable name, Variable a0, Variable a1)

Runs the editor script function by its name. The target function must receive 2 arguments.

Arguments

Variable name - Name of the editor script function.
Variable a0 - First argument.
Variable a1 - Second argument.

Return value

Editor script function return value.

Variable runEditorFunction(Variable name, Variable a0, Variable a1, Variable a2)

Runs the editor script function by its name. The target function must receive 3 arguments.

Arguments

Variable name - Name of the editor script function.
Variable a0 - First argument.
Variable a1 - Second argument.
Variable a2 - Third argument.

Return value

Editor script function return value.

Variable runEditorFunction(Variable name, Variable a0, Variable a1, Variable a2, Variable a3)

Runs the editor script function by its name. The target function must receive 4 arguments.

Arguments

Variable name - Name of the editor script function.
Variable a0 - First argument.
Variable a1 - Second argument.
Variable a2 - Third argument.
Variable a3 - Fourth argument.

Return value

Editor script function return value.

Variable runEditorFunction(Variable name, Variable a0, Variable a1, Variable a2, Variable a3, Variable a4)

Runs the editor script function by its name. The target function must receive 5 arguments.

Arguments

Variable name - Name of the editor script function.
Variable a0 - First argument.
Variable a1 - Second argument.
Variable a2 - Third argument.
Variable a3 - Fourth argument.
Variable a4 - Fifth argument.

Return value

Editor script function return value.

Variable runEditorFunction(Variable name, Variable a0, Variable a1, Variable a2, Variable a3, Variable a4, Variable a5)

Runs the editor script function by its name. The target function must receive 6 arguments.

Arguments

Variable name - Name of the editor script function.
Variable a0 - First argument.
Variable a1 - Second argument.
Variable a2 - Third argument.
Variable a3 - Fourth argument.
Variable a4 - Fifth argument.
Variable a5 - Sixth argument.

Return value

Editor script function return value.

Variable runEditorFunction(Variable name, Variable a0, Variable a1, Variable a2, Variable a3, Variable a4, Variable a5, Variable a6)

Runs the editor script function by its name. The target function must receive 7 arguments.

Arguments

Variable name - Name of the editor script function.
Variable a0 - First argument.
Variable a1 - Second argument.
Variable a2 - Third argument.
Variable a3 - Fourth argument.
Variable a4 - Fifth argument.
Variable a5 - Sixth argument.
Variable a6 - Seventh argument.

Return value

Editor script function return value.

Variable runEditorFunction(Variable name, Variable a0, Variable a1, Variable a2, Variable a3, Variable a4, Variable a5, Variable a6, Variable a7)

Runs the editor script function by its name. The target function must receive 8 arguments.

Arguments

Variable name - Name of the editor script function.
Variable a0 - First argument.
Variable a1 - Second argument.
Variable a2 - Third argument.
Variable a3 - Fourth argument.
Variable a4 - Fifth argument.
Variable a5 - Sixth argument.
Variable a6 - Seventh argument.
Variable a7 - Eighth argument.

Return value

Editor script function return value.

virtual Variable runSystemFunction(Variable name) const =0

Runs the system script function by its name. The target function can receive up to 8 arguments.