Unigine::Engine Class

Header:

#include <UnigineEngine.h>

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.

Methods:

Name	Description View: Sort by:
getAppPath	Returns the path to a directory where binary executable file is stored.
getCachePath	Returns a path to a directory where cached files will be stored.
getDataPath	Returns a path to the -data_pathdirectory specified at the engine startup.
isDone	Returns the done flag on engine quit.
getEditorCache	Returns a path to the editor script cache file.
getEditorScript	Returns a path to the editor script (provided by the -editor_scriptcommand line argument).
getExternDefine	Returns the external definitions specified on the application start-up.
getFeatures	Returns the list of features (like OpenGL, Direct3D, Microprofile, Geodetic, etc.
getVersion	Returns the Engine version info.
isMainThread	Checks if the current thread is main.
getNumEditorLogics	Returns the number of registered EditorLogic instances.
getNumPluginPaths	Returns the number of paths to directories with plugins specified via -plugin_pathcommand-line option.
getNumPlugins	Returns the number of loaded plugins.
getNumSystemLogics	Returns the number of registered SystemLogic instances.
getNumWorldLogics	Returns the number of registered WorldLogic instances.
getPresentTime	Returns the total time spent on waiting for the GPU after all calculations on the CPU are completed.
getPrecision	Returns the Unigine Engine precision type.
getRenderTime	Returns the time value, required to prepare all data to be rendered in the current frame and feed rendering commands from the CPU to the GPU.
getSavePath	Returns a path to a directory where a default configuration file, saved files and screenshots will be stored.
getSoundApp	Returns the current sound API.
getSystemCache	Returns a path to the system script cache.
getSystemScript	Returns a path to the system script.
getTotalTime	Returns the total time that both rendering and calculating of the frame took (the duration of the main loop in the application execution sequence).
getTotalCPUTime	Returns the total CPU time taken to perform calculations for the frame (the duration of the main loop in the application execution sequence).
getUpdateTime	Returns the duration of the update phase, during which the objects are prepared for their collision response to be calculated.
getVideoApp	Returns a graphics API used for rendering.
isEvaluation	Returns a value indicating if the current version of the Engine is for evaluation only.
getFrame	Returns the number of the current engine frame.
get	Returns a pointer to the existing engine instance.
getArg	Returns a command line argument by its index.
getArgf	Returns a command line argument by its index converted to a floating point value.
getArgi	Returns a command line argument by its index converted to an integer value.
getBuildConfiguration	Returns the current Engine build configuration.
getLibraryModulePath	Returns a path to the Engine's dynamic library file.
getEditorFunction	Returns the editor function identifier.
isEditorFunction	Returns a value indicating if the editor script function exists.
getEditorInterpreter	Returns a pointer to the editor interpreter.
isEditorInterpreter	Returns a value indicating if the function is called from the editor script.
isEditorLoaded	Returns a value indicating if the editor script is loaded.
getEditorLogic	Returns the registered EditorLogic instance by its number.
setEditorVariable	Sets the editor script variable by its name.
getEditorVariable	Returns the editor script variable by its name.
isEditorVariable	Returns a value indicating if the editor script variable exists.
getError	Returns the system error message.
getArg	Returns the command-line argument by its index.
getPlugin	Returns the loaded plugin interface.
getPluginData	Returns the loaded plugin data.
getPluginInterface	Returns the loaded plugin interface.
getPluginName	Returns the name of the loaded plugin by its index.
getPluginOrder	Returns the execution order of the loaded plugin by its index.
getPluginPath	Returns a path to a plugin directory specified via -plugin_path.
getSystemFunction	Returns the system function identifier.
isSystemFunction	Checks whether the system script function exists.
getSystemInterpreter	Returns a pointer to the system interpreter.
isSystemInterpreter	Checks if the function is called from the system script.
getSystemLogic	Returns the registered SystemLogic instance by the given number.
setSystemVariable	Sets a system script variable by a name.
getSystemVariable	Returns the system script variable by its name.
isSystemVariable	Checks whether a system script variable exists.
getWorldFunction	Returns the world script function identifier.
isWorldFunction	Returns value indicating if the world script function exists.
getWorldInterpreter	Returns a pointer to the world interpreter.
isWorldInterpreter	Returns a value indicating if the function is called from the world script.
isWorldLoaded	Returns a value indicating if the world script is loaded.
getWorldLogic	Returns the registered WorldLogic instance by its number.
setWorldVariable	Sets a world script variable by its name.
getWorldVariable	Returns a world script variable by its name.
isWorldVariable	Returns a value indicating if the world script variable exists.
addEditorLogic	Adds an EditorLogic instance to the engine runtime.
addPlugin	Adds a plugin to engine runtime by using a pointer to this plugin.
addSystemLogic	Adds a SystemLogic instance to Engine runtime.
addWorldLogic	Adds a WorldLogic instance to the engine runtime.
dialogError	Displays a dialog window with errors set using the error() function.
dialogMessage	Displays a dialog window with the last message set using the message() function.
findPlugin	Searches the index of the loaded plugin by its name.
init	Initializes a new engine instance to be used with an external graphics application.
main	Engine main loop.
removeEditorLogic	Removes an EditorLogic instance from engine runtime.
removePlugin	Removes a plugin by using a pointer to this plugin.
removeSystemLogic	Removes a SystemLogic instance from engine runtime.
removeWorldLogic	Removes a WorldLogic instance from engine runtime.
render	Engine rendering function.
runEditorFunction	Runs the editor script function by its name.
runSystemFunction	Runs the system script function by its name.
runWorldFunction	Runs the world script function by its name.
shutdown	Deletes the pointer to the existing engine instance.
swap	Engine swap buffers function.
update	Engine update function.
addCallback	Adds a callback for the specified stage of the execution sequence.
removeCallback	Removes the specified callback from the list of callbacks for the specified stage of the execution sequence.
clearCallbacks	Clears all added callbacks for the specified stage of the execution sequence.
init	Initializes a new engine instance to be used with an external graphics application.

The InitParameters structure provides the way to set the following parameters to initialize a new Engine instance:.

Parameter	Description
window_title	Title of the window.
window_icon_path	Path to the window icon.
app_path	Path to a directory where binary executable file is stored.
home_path	Path to the user's home directory.
project	Project name.
password	Password for the filesystem archives.
app	Instance of the CustomApp class.

Variables:

Name	Description
BUILD_CONFIG_RELEASE = 2
BUILD_CONFIG_DEVELOPMENT = 1
BUILD_CONFIG_DEBUG = 0

Engine Class

Enums

BUILD_CONFIG#

Engine build configuration.

Name	Description
BUILD_CONFIG_DEBUG = 0	Debug build configuration.
BUILD_CONFIG_DEVELOPMENT = 1	Development build configuration.
BUILD_CONFIG_RELEASE = 2	Release build configuration.

CALLBACK_INDEX#

Name	Description
CALLBACK_BEGIN_UPDATE = 0	Callback before the update stage is started.
CALLBACK_BEGIN_PROPERTIES_UPDATE = 1	Callback before the properties update stage.
CALLBACK_END_PROPERTIES_UPDATE = 2	Callback after the properties update stage.
CALLBACK_BEGIN_INPUT_UPDATE = 3	Callback before the input update stage.
CALLBACK_END_INPUT_UPDATE = 4	Callback after the input update stage.
CALLBACK_BEGIN_CONTROLS_UPDATE = 5	Callback before the controls update stage.
CALLBACK_END_CONTROLS_UPDATE = 6	Callback after the controls update stage.
CALLBACK_BEGIN_WORLD_MANAGER_UPDATE = 7	Callback before the world manager update stage.
CALLBACK_END_WORLD_MANAGER_UPDATE = 8	Callback after the world manager update stage.
CALLBACK_BEGIN_SOUND_MANAGER_UPDATE = 9	Callback before the sound manager update stage.
CALLBACK_END_SOUND_MANAGER_UPDATE = 10	Callback after the sound manager update stage.
CALLBACK_BEGIN_RENDER_MANAGER_UPDATE = 11	Callback before the render manager update stage.
CALLBACK_END_RENDER_MANAGER_UPDATE = 12	Callback after the render manager update stage.
CALLBACK_BEGIN_LANDSCAPE_UPDATE = 13	Callback before the landscape update stage.
CALLBACK_END_LANDSCAPE_UPDATE = 14	Callback after the landscape update stage.
CALLBACK_BEGIN_LANDSCAPE_ASYNC_UPDATE = 15	Callback before the landscape asynchronous update stage.
CALLBACK_END_LANDSCAPE_ASYNC_UPDATE = 16	Callback after the landscape asynchronous update stage.
CALLBACK_BEGIN_GAME_UPDATE = 17	Callback before the game logic update stage.
CALLBACK_END_GAME_UPDATE = 18	Callback after the game logic update stage.
CALLBACK_BEGIN_RENDER_UPDATE = 19	Callback before the render functions update stage.
CALLBACK_END_RENDER_UPDATE = 20	Callback after the render functions update stage.
CALLBACK_BEGIN_EXPRESSION_UPDATE = 21	Callback before the expressions update stage.
CALLBACK_END_EXPRESSION_UPDATE = 22	Callback after the expressions update stage.
CALLBACK_BEGIN_SOUNDS_UPDATE = 23	Callback before the sounds update stage.
CALLBACK_END_SOUNDS_UPDATE = 24	Callback after the sounds update stage.
CALLBACK_BEGIN_PLUGINS_UPDATE = 25	Callback before the plugins update stage.
CALLBACK_END_PLUGINS_UPDATE = 26	Callback after the plugins update stage.
CALLBACK_BEGIN_EDITOR_UPDATE = 27	Callback before the editor update stage.
CALLBACK_END_EDITOR_UPDATE = 28	Callback after the editor update stage.
CALLBACK_BEGIN_SYSTEM_SCRIPT_UPDATE = 29	Callback before the system script update stage.
CALLBACK_END_SYSTEM_SCRIPT_UPDATE = 30	Callback after the system script update stage.
CALLBACK_BEGIN_SYSTEM_LOGIC_UPDATE = 31	Callback before the system logic update stage.
CALLBACK_END_SYSTEM_LOGIC_UPDATE = 32	Callback after the system logic update stage.
CALLBACK_BEGIN_WORLD_UPDATE = 33	Callback before the world logic update stage.
CALLBACK_END_WORLD_UPDATE = 34	Callback after the world logic update stage.
CALLBACK_BEGIN_GUI_UPDATE = 35	Callback before the GUI update stage.
CALLBACK_END_GUI_UPDATE = 36	Callback after the GUI update stage.
CALLBACK_BEGIN_WORLD_POST_UPDATE = 37	Callback before the world logic postupdate stage.
CALLBACK_END_WORLD_POST_UPDATE = 38	Callback after the world logic postupdate stage.
CALLBACK_BEGIN_SYSTEM_SCRIPT_POST_UPDATE = 39	Callback before the system script postupdate stage.
CALLBACK_END_SYSTEM_SCRIPT_POST_UPDATE = 40	Callback after the system script postupdate stage.
CALLBACK_BEGIN_SYSTEM_LOGIC_POST_UPDATE = 41	Callback before the system logic postupdate stage.
CALLBACK_END_SYSTEM_LOGIC_POST_UPDATE = 42	Callback after the system logic postupdate stage.
CALLBACK_BEGIN_EDITOR_POST_UPDATE = 43	Callback before the editor logic postupdate stage.
CALLBACK_END_EDITOR_POST_UPDATE = 44	Callback after the editor logic postupdate stage.
CALLBACK_BEGIN_PLUGINS_POST_UPDATE = 45	Callback before the plugins postupdate stage.
CALLBACK_END_PLUGINS_POST_UPDATE = 46	Callback after the plugins postupdate stage.
CALLBACK_BEGIN_SPATIAL_UPDATE = 47	Callback before the spatial tree update stage.
CALLBACK_END_SPATIAL_UPDATE = 48	Callback after the spatial tree update stage.
CALLBACK_BEGIN_ASYNC_TASKS_UPDATE = 49	Callback before the asynchronous tasks update stage.
CALLBACK_END_ASYNC_TASKS_UPDATE = 50	Callback after the asynchronous tasks update stage.
CALLBACK_BEGIN_FILESYSTEM_UPDATE = 51	Callback before the filesystem update stage.
CALLBACK_END_FILESYSTEM_UPDATE = 52	Callback after the filesystem update stage.
CALLBACK_BEGIN_PHYSICS = 53	Callback before the physics module is updated.
CALLBACK_BEGIN_PATHFINDING = 54	Callback before the pathfinding module is updated.
CALLBACK_END_UPDATE = 55	Callback after the update stage is finished.
CALLBACK_BEGIN_RENDER = 56	Callback before the rendering stage is started.
CALLBACK_BEGIN_EDITOR_RENDER = 57	Callback before the editor rendering stage.
CALLBACK_END_EDITOR_RENDER = 58	Callback after the editor rendering stage.
CALLBACK_BEGIN_PLUGINS_RENDER = 59	Callback before the plugins rendering stage.
CALLBACK_END_PLUGINS_RENDER = 60	Callback after the plugins rendering stage.
CALLBACK_BEGIN_RENDER_WORLD = 61	Callback before the world rendering stage.
CALLBACK_END_RENDER_WORLD = 62	Callback after the world rendering stage.
CALLBACK_BEGIN_PLUGINS_GUI = 63	Callback before the gui() function of plugins is called.
CALLBACK_END_PLUGINS_GUI = 64	Callback after the gui() function of plugins is called.
CALLBACK_BEGIN_GUI_RENDER = 65	Callback before the GUI rendering stage.
CALLBACK_END_GUI_RENDER = 66	Callback after the GUI rendering stage.
CALLBACK_BEGIN_POST_RENDER = 67	Callback before the post-rendering stage.
CALLBACK_END_POST_RENDER = 68	Callback after the post-rendering stage.
CALLBACK_END_RENDER = 69	Callback after the rendering stage is finished.
CALLBACK_BEGIN_SWAP = 70	Callback before the swap stage is started.
CALLBACK_BEGIN_VIDEOGRAB = 71	Callback before the videograbbing stage.
CALLBACK_END_VIDEOGRAB = 72	Callback after the videograbbing stage.
CALLBACK_END_PHYSICS = 75	Callback after the physics calculations are finished.
CALLBACK_BEGIN_PHYSICS_SYNC = 76	Callback before the physics synchronization is started.
CALLBACK_END_PHYSICS_SYNC = 77	Callback after the physics synchronization is finished.
CALLBACK_END_PATHFINDING = 78	Callback after the pathfinding is updated.
CALLBACK_BEGIN_WORLD_SWAP = 79	Callback before the world logic swap() function is executed.
CALLBACK_END_WORLD_SWAP = 80	Callback after the world logic swap() function is executed.
CALLBACK_BEGIN_PLUGINS_SWAP = 73	Callback before the plugin swap() function is called, if it exists.
CALLBACK_END_PLUGINS_SWAP = 74	Callback after the plugin swap() function is called, if it exists.
CALLBACK_BEGIN_DELETE_OBJECTS = 81	Callback before the objects are deleted.
CALLBACK_END_DELETE_OBJECTS = 82	Callback after the objects are deleted.
CALLBACK_END_SWAP = 83	Callback after the swap stage is finished.
CALLBACK_INDEX_NUM_CALLBACKS = 84	Callback counter.

PRECISION#

Engine precision type.

Name	Description
PRECISION_PRECISION_FLOAT = 0	Float precision type.
PRECISION_PRECISION_DOUBLE = 1	Double precision type.

Members

Engine * get ( ) #

Returns a pointer to the existing engine instance.

Return value

Pointer to the existing engine.

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

const char * getArg ( int num ) const#

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.

Engine::BUILD_CONFIG getBuildConfiguration ( ) #

Returns the current Engine build configuration.

Return value

Current build configuration. One of the BUILD_CONFIG_ values.

const char * getCachePath ( ) #

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

Return value

Path to the directory with cached files.

const char * getDataPath ( ) #

Returns a path to the -data_pathdirectory specified at the engine startup.

Return value

Path to the data directory.

const char * getLibraryModulePath ( ) #

Returns a path to the Engine's dynamic library file.

Return value

Path to the Engine's dynamic library file.

virtual bool isDone ( ) const =0#

Returns the done flag on engine quit.

Return value

true if engine is quitting; otherwise, false.

const char * getEditorCache ( ) const#

Returns a path to the editor script cache file.

Return value

Path to the editor script cache.

int getEditorFunction ( const char * name, int num_args ) const#

Returns the editor function identifier.

Arguments

const char * name - Name of the editor script function.
int num_args - Number of editor script function arguments.

Return value

The editor script function identifier.

bool isEditorFunction ( const char * name, int num_args ) const#

Returns a value indicating if the editor script function exists.

Arguments

const char * name - Name of the editor script function.
int num_args - Number of editor script function arguments.

Return value

true if the editor script function exists; otherwise, false.

virtual void * getEditorInterpreter ( ) const =0#

Returns a pointer to the editor interpreter.

Return value

Pointer to the editor interpreter.

virtual bool isEditorInterpreter ( ) const =0#

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

Return value

true if the function is called from the editor script; otherwise, false.

virtual bool isEditorLoaded ( ) const =0#

Returns a value indicating if the editor script is loaded.

Return value

true if the editor script is loaded; otherwise, false.

EditorLogic * getEditorLogic ( int num ) const#

Returns the registered EditorLogic instance by its number.

Arguments

int num - Number of the EditorLogic instance.

Return value

EditorLogic instance.

const char * getEditorScript ( ) #

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

Return value

Path to the editor script.

void setEditorVariable ( const char * name, const Variable & v ) #

Sets the editor script variable by its name.

Arguments

const char * name - Name of the editor script variable.
const Variable & v - Value of the editor script variable.

const Variable & getEditorVariable ( const char * name ) const#

Returns the editor script variable by its name.

Arguments

const char * name - Name of the world script variable.

Return value

Value of the editor script variable.

bool isEditorVariable ( const char * name ) const#

Returns a value indicating if the editor script variable exists.

Arguments

const char * name - Name of the editor script variable.

Return value

true if the editor script variable exists; otherwise, false.

String getError ( ) #

Returns the system error message.

Return value

The system error message of the current frame, if there is one; otherwise an empty string.

const char * getExternDefine ( ) const#

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

Return value

The list of external definitions.

const char * getFeatures ( ) #

Returns the list of features (like OpenGL, Direct3D, Microprofile, Geodetic, etc.).

Return value

The list of features (like OpenGL, Direct3D, Microprofile, Geodetic, etc.).

static const char * getVersion ( ) #

Returns the Engine version info.

Return value

Engine version info.

bool isMainThread ( ) #

Checks if the current thread is main.

Return value

true if the current thread is main; otherwise, false.

const char * getArg ( int num ) #

Returns the command-line argument by its index.

Arguments

int num - Index of the argument

Return value

Command-line argument

int getNumEditorLogics ( ) const#

Returns the number of registered EditorLogic instances.

Return value

Number of EditorLogic instances.

int getNumPluginPaths ( ) #

Returns the number of paths to directories with plugins specified via -plugin_pathcommand-line option.

Return value

Number of the specified paths to directories with plugins.

int getNumPlugins ( ) const#

Returns the number of loaded plugins.

Return value

Number of plugins.

int getNumSystemLogics ( ) const#

Returns the number of registered SystemLogic instances.

Return value

Number of SystemLogic instances.

int getNumWorldLogics ( ) const#

Returns the number of registered WorldLogic instances.

Return value

Number of WorldLogic instances.

SingletonClass * getPlugin ( const char * name ) #

Returns the loaded plugin interface.

Arguments

const char * name - Name of the loaded plugin.

Return value

Interface of the loaded plugin, if it exists; otherwise, nullptr.

virtual void * getPluginData ( int num ) const =0#

Returns the loaded plugin data.

Arguments

int num - Index of the loaded plugin.

Return value

Data of the loaded plugin, if it exists; otherwise, 0.

virtual Plugin * getPluginInterface ( int num ) const =0#

Returns the loaded plugin interface.

Arguments

int num - Index of the loaded plugin.

Return value

Interface of the loaded plugin, if it exists; otherwise, 0.

const char * getPluginName ( int num ) const#

Returns the name of the loaded plugin by its index.

Arguments

int num - Index of the loaded plugin.

Return value

Loaded plugin name.

int getPluginOrder ( int num ) const#

Returns the execution order of the loaded plugin by its index.

Arguments

int num - Index of the loaded plugin.

Return value

Loaded plugin execution order.

const char * getPluginPath ( int num ) const#

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.

Engine::PRECISION getPrecision ( ) #

Returns the Unigine Engine precision type.

Return value

Precision type.

float getRenderTime ( ) #

Returns the time value, required to prepare all data to be rendered in the current frame and feed rendering commands from the CPU to the GPU. See the Profiler article for details.

Return value

Rendering time value, milliseconds.

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

const char * getSoundApp ( ) const#

Returns the current sound API.

Return value

Sound API used.

const char * getSystemCache ( ) const#

Returns a path to the system script cache.

Return value

Path to the system script cache.

int getSystemFunction ( const char * name, int num_args ) const#

Returns the system function identifier.

Arguments

const char * name - Name of the system script function.
int num_args - Number of system script function arguments.

Return value

System script function identifier.

bool isSystemFunction ( const char * name, int num_args ) const#

Checks whether the system script function exists.

Arguments

const char * name - Name of the system script function.
int num_args - Number of system script function arguments.

Return value

true if the system script function exists; otherwise, false.

virtual void * getSystemInterpreter ( ) const =0#

Returns a pointer to the system interpreter.

Return value

Pointer to the system interpreter.

virtual bool isSystemInterpreter ( ) const =0#

Checks if the function is called from the system script.

Return value

true when the function is called from the system script; otherwise, false.

virtual SystemLogic * getSystemLogic ( int num ) const =0#

Returns the registered SystemLogic instance by the given number.

Arguments

int num - Number of the SystemLogic instance.

Return value

SystemLogic instance.

const char * getSystemScript ( ) #

Returns a path to the system script.

Return value

Path to the system script.

void setSystemVariable ( const char * name, const Variable & v ) #

Sets a system script variable by a name.

Arguments

const char * name - Name of the system script variable.
const Variable & v - Value of the system script variable.

const Variable & getSystemVariable ( const char * name ) const#

Returns the system script variable by its name.

Arguments

const char * name - Name of the system script variable.

Return value

System script variable.

bool isSystemVariable ( const char * name ) const#

Checks whether a system script variable exists.

Arguments

const char * name - Name of the system script variable.

Return value

true if the system script variable exists; otherwise, false.

float getTotalTime ( ) #

Returns the total time that both rendering and calculating of the frame took (the duration of the main loop in the application execution sequence). Includes update, render, swap and wait GPU.

Return value

Total time value, milliseconds.

float getTotalCPUTime ( ) #

Returns the total CPU time taken to perform calculations for the frame (the duration of the main loop in the application execution sequence). Includes update, render and swap.

Return value

Total CPU time value, milliseconds.

float getUpdateTime ( ) #

Returns the duration of the update phase, during which the objects are prepared for their collision response to be calculated.

Return value

The update phase duration value, milliseconds.

const char * getVideoApp ( ) #

Returns a graphics API used for rendering.

Return value

Graphics API used for rendering.

int getWorldFunction ( const char * name, int num_args ) const#

Returns the world script function identifier.

Arguments

const char * name - Name of the world script function.
int num_args - Number of world script function arguments.

Return value

World script function identifier.

bool isWorldFunction ( const char * name, int num_args ) const#

Returns value indicating if the world script function exists.

Arguments

const char * name - Name of the world script function.
int num_args - Number of world script function arguments.

Return value

true if the world script function exists; otherwise, false.

virtual void * getWorldInterpreter ( ) const =0#

Returns a pointer to the world interpreter.

Return value

Pointer to the world interpreter.

virtual bool isWorldInterpreter ( ) const =0#

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

Return value

true if the function is called from the world script; otherwise, false.

virtual bool isWorldLoaded ( ) const =0#

Returns a value indicating if the world script is loaded.

Return value

true if the world script is loaded; otherwise, false.

virtual WorldLogic * getWorldLogic ( int num ) const =0#

Returns the registered WorldLogic instance by its number.

Arguments

int num - Number of the WorldLogic instance.

Return value

WorldLogic instance.

void setWorldVariable ( const char * name, const Variable & v ) #

Sets a world script variable by its name.

Arguments

const char * name - Name of the world script variable.
const Variable & v - Value of the world script variable.

const Variable & getWorldVariable ( const char * name ) const#

Returns a world script variable by its name.

Arguments

const char * name - Name of the world script variable.

Return value

World script variable.

bool isWorldVariable ( const char * name ) const#

Returns a value indicating if the world script variable exists.

Arguments

const char * name - Name of the world script variable.

Return value

true if the world script variable exists; otherwise, false.

bool addEditorLogic ( EditorLogic * logic ) #

Adds an EditorLogic instance to the engine runtime.

Arguments

EditorLogic * logic - EditorLogic instance.

Return value

true if the EditorLogic instance has been added successfully; otherwise, false.

virtual bool addPlugin ( Plugin * plugin ) =0#

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

Arguments

Plugin * plugin - Plugin pointer.

Return value

true if the plugin ha been added successfully; otherwise, false.

bool addPlugin ( const char * name ) #

Adds a plugin to engine runtime by its name.

Arguments

const char * name - Plugin name.

Return value

true if the plugin has been added successfully; otherwise, false.

bool addSystemLogic ( SystemLogic * logic ) #

Adds a SystemLogic instance to Engine runtime.

Arguments

SystemLogic * logic - SystemLogic instance.

Return value

true if the SystemLogic instance has been added successfully; otherwise, false.

bool addWorldLogic ( WorldLogic * logic ) #

Adds a WorldLogic instance to the engine runtime.

NoticeInstances of the WorldLogic class should not be added while the world is loaded and the world script is being executed (as you can't change a world script while the world is loaded). In such a case the init() method shall not be called if the WorldLogic is added before opening the world.

Arguments

WorldLogic * logic - WorldLogic instance.

Return value

true if the WorldLogic instance has been added successfully; otherwise, false.

void dialogError ( const char * title ) #

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

Arguments

const char * title - Title to be displayed in the error window.

void dialogMessage ( const char * title ) #

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

Arguments

const char * title - Title to be displayed in the message window.

int findPlugin ( const char * name ) const#

Searches the index of the loaded plugin by its name.

Arguments

const char * name - Name of the plugin.

Return value

Index of the plugin if it is found, or -1 otherwise.

Engine * init ( int argc, char ** argv, const char * project, const char * password ) #

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

Arguments

int argc - Number of command line arguments.
char ** argv - Array of command line arguments values.
const char * 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.
const char * 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

Pointer to the new engine instance.

Engine * init ( int argc, wchar_t ** argv, const char * project = 0, const char * password = 0 ) #

Initializes a new engine instance.

Arguments

int argc - Number of command line arguments.
wchar_t ** argv - Array of command line arguments values.
const char * 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.
const char * 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

Pointer to the new engine instance.

Engine * init ( const char * window_title, int argc, char ** argv, const char * project, const char * password ) #

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

Arguments

const char * window_title - Title to be set for the application window.
int argc - Number of command line arguments.
char ** argv - Array of command line arguments values.
const char * 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.
const char * 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

Pointer to the new engine instance.

Engine * init ( const char * window_title, int argc, wchar_t ** argv, const char * project = 0, const char * password = 0 ) #

Initializes a new engine instance.

Arguments

const char * window_title - Title to be set for the application window.
int argc - Number of command line arguments.
wchar_t ** argv - Array of command line arguments values.
const char * 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.
const char * 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

Pointer to the new engine instance.

Engine * init ( CustomApp * app, int argc, wchar_t ** argv, const char * project = 0, const char * password = 0 ) #

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

Arguments

CustomApp * app - Pointer to the graphics CustomApp class.
int argc - Number of command line arguments.
wchar_t ** argv - Array of values of command line arguments (a wide-character string).
const char * 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.
const char * 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

Pointer to the new engine instance.

Engine * init ( CustomApp * app, int argc, char ** argv, const char * project = 0, const char * password = 0 ) #

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

Arguments

CustomApp * app - Pointer to the graphics CustomApp class.
int argc - Number of command line arguments.
char ** argv - Array of values of command line arguments.
const char * 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.
const char * 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

Pointer to the new engine instance.

Engine * init ( CustomApp * app, const char * window_title, const char * app_path, const char * home_path, int argc, wchar_t ** argv, const char * project = 0, const char * password = 0 ) #

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

Arguments

CustomApp * app - Pointer to the graphics CustomApp class.
const char * window_title - Title to be set for the application window.
const char * app_path - Path to a directory where binary executable file is stored. Pass the 0 value to ignore this parameter.
const char * home_path - Path to the user's home directory.
int argc - Number of command line arguments.
wchar_t ** argv - Array of values of command line arguments (a wide-character string).
const char * 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.
const char * 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

Pointer to the new engine instance.

Engine * init ( CustomApp * app, const char * app_path, const char * home_path, int argc, wchar_t ** argv, const char * project = 0, const char * password = 0 ) #

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

Arguments

CustomApp * app - Pointer to the graphics CustomApp class.
const char * app_path - Path to a directory where binary executable file is stored. Pass the 0 value to ignore this parameter.
const char * home_path - Path to the user's home directory.
int argc - Number of command line arguments.
wchar_t ** argv - Array of values of command line arguments (a wide-character string).
const char * 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.
const char * 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

Pointer to the new engine instance.

Engine * init ( CustomApp * app, const char * window_title, const char * app_path, const char * home_path, int argc, char ** argv, const char * project = 0, const char * password = 0 ) #

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

Arguments

CustomApp * app - Pointer to the graphics CustomApp class.
const char * window_title - Title to be set for the application window.
const char * app_path - Path to a directory where binary executable file is stored. Pass the 0 value to ignore this parameter.
const char * home_path - Path to the user's home directory.
int argc - Number of command line arguments.
char ** argv - Array of values of command line arguments.
const char * 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.
const char * 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

Pointer to the new engine instance.

Engine * init ( CustomApp * app, const char * app_path, const char * home_path, int argc, char ** argv, const char * project = 0, const char * password = 0 ) #

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

Arguments

CustomApp * app - Pointer to the graphics CustomApp class.
const char * app_path - Path to a directory where binary executable file is stored. Pass the 0 value to ignore this parameter.
const char * home_path - Path to the user's home directory.
int argc - Number of command line arguments.
char ** argv - Array of values of command line arguments.
const char * 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.
const char * 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

Pointer to the 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(); 
}

Source code (C#)

while (!IsDone) { 
	Update();  
	Render(); 
	Swap(); 
}

Arguments

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

bool removeEditorLogic ( EditorLogic * logic ) #

Removes an EditorLogic instance from engine runtime.

Arguments

EditorLogic * logic - An EditorLogic instance.

Return value

true if the instance has been removed successfully; otherwise, false.

virtual bool removePlugin ( Plugin * plugin ) =0#

Removes a plugin by using a pointer to this plugin.

Arguments

Plugin * plugin - Plugin pointer to remove.

Return value

true if the plugin has been removed successfully; otherwise, false.

bool removeSystemLogic ( SystemLogic * logic ) #

Removes a SystemLogic instance from engine runtime.

Arguments

SystemLogic * logic - A SystemLogic instance.

Return value

true if the instance has been removed successfully; otherwise, false.

bool removeWorldLogic ( WorldLogic * logic ) #

Removes a WorldLogic instance from engine runtime.

NoticeInstances of the WorldLogic class should not be removed while the world is loaded and the world script is being executed (as you can't change a world script while the world is loaded). In such a case the shutdown() method shall not be called if the WorldLogic is removed before closing the world.

Arguments

WorldLogic * logic - A WorldLogic instance.

Return value

true if the instance has been removed successfully; otherwise, false.

virtual void render ( ) =0#

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

virtual const Variable & runEditorFunction ( const Variable & name ) =0#

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