Axmol 3.0.0-89d6d9a
Loading...
Searching...
No Matches
ScriptEngineManager Class Reference

ScriptEngineManager is a singleton which manager an object instance of ScriptEngineProtocol, such as LuaEngine. More...

#include <ScriptSupport.h>

Public Member Functions

 ~ScriptEngineManager ()
 Constructor of ScriptEngineManager.
ScriptEngineProtocol * getScriptEngine ()
 Get the ScriptEngineProtocol object.
void setScriptEngine (ScriptEngineProtocol *scriptEngine)
 Set the ScriptEngineProtocol object should be managed.
void removeScriptEngine ()
 Remove the ScriptEngineProtocol object managed.

Static Public Member Functions

static ScriptEngineManager * getInstance ()
 Get the instance of ScriptEngineManager object.
static ScriptEngineProtocol * getScriptEngineIfExists ()
 Returns the active script engine without constructing the manager.
static void destroyInstance ()
 Destroy the singleton about ScriptEngineManager.
static int sendEventToLua (const ScriptEvent &event)
 Send a event to lua script.

Detailed Description

ScriptEngineManager is a singleton which manager an object instance of ScriptEngineProtocol, such as LuaEngine.

Since
v0.99.5-x-0.8.5

Constructor & Destructor Documentation

◆ ~ScriptEngineManager()

~ScriptEngineManager ( )

Constructor of ScriptEngineManager.

@lua NA

Member Function Documentation

◆ getScriptEngine()

ScriptEngineProtocol * getScriptEngine ( )
inline

Get the ScriptEngineProtocol object.

Returns
the ScriptEngineProtocol object.

@lua NA

◆ setScriptEngine()

void setScriptEngine ( ScriptEngineProtocol * scriptEngine)

Set the ScriptEngineProtocol object should be managed.

Parameters
scriptEngineshould be managed.

@lua NA

◆ removeScriptEngine()

void removeScriptEngine ( )

Remove the ScriptEngineProtocol object managed.

@lua NA

◆ getInstance()

ScriptEngineManager * getInstance ( )
static

Get the instance of ScriptEngineManager object.

Returns
the instance of ScriptEngineManager object.

@lua NA

◆ destroyInstance()

void destroyInstance ( )
static

Destroy the singleton about ScriptEngineManager.

@lua NA

◆ sendEventToLua()

int sendEventToLua ( const ScriptEvent & event)
static

Send a event to lua script.

Parameters
eventthe script event

@lua NA


The documentation for this class was generated from the following file:
  • ScriptSupport.h