ScriptEngineProtocol Class Reference

#include <CCScriptSupport.h>

Inheritance diagram for ScriptEngineProtocol:

Public Types
enum	ConfigType { NONE, COCOSTUDIO }

Public Member Functions
virtual	~ScriptEngineProtocol ()
virtual ccScriptType	getScriptType ()
	Get script type. More...
virtual void	removeScriptObjectByObject (Object *obj)=0
	Remove script object. More...
virtual void	removeScriptHandler (int handler)
	Remove script function handler, only LuaEngine class need to implement this function. More...
virtual int	reallocateScriptHandler (int handler)
	Reallocate script function handler, only LuaEngine class need to implement this function. More...
virtual int	executeString (const char *codes)=0
	Execute script code contained in the given string. More...
virtual int	executeScriptFile (const char *filename)=0
	Execute a script file. More...
virtual int	executeGlobalFunction (const char *functionName)=0
	Execute a scripted global function. More...
virtual int	sendEvent (ScriptEvent *evt)=0
	when trigger a script event ,call this func,add params needed into ScriptEvent object.nativeObject is object triggering the event, can be nullptr in lua More...
virtual bool	handleAssert (const char *msg)=0
	called by CCAssert to allow scripting engine to handle failed assertions More...
virtual bool	parseConfig (ConfigType type, const std::string &str)=0
	Parse configuration file. More...

Member Enumeration Documentation

enum ConfigType

strong

Enumerator
NONE
COCOSTUDIO

Constructor & Destructor Documentation

virtual ~ScriptEngineProtocol ( )

inlinevirtual

Member Function Documentation

virtual int executeGlobalFunction ( const char *  functionName)

pure virtual

Execute a scripted global function.

The function should not take any parameters and should return an integer.

Parameters

functionName

String object holding the name of the function, in the global script environment, that is to be executed.

Returns

The integer value returned from the script function.

Implemented in LuaEngine, and ScriptingCore.

virtual int executeScriptFile ( const char *  filename)

pure virtual

Execute a script file.

Parameters

filename

String object holding the filename of the script file that is to be executed

Implemented in LuaEngine, and ScriptingCore.

virtual int executeString ( const char *  codes)

pure virtual

Execute script code contained in the given string.

Parameters

codes

holding the valid script code that should be executed.

Returns

0 if the string is executed correctly.

other if the string is executed wrongly.

Implemented in LuaEngine, and ScriptingCore.

virtual ccScriptType getScriptType ( )

inlinevirtual

Get script type.

Reimplemented in ScriptingCore, and LuaEngine.

virtual bool handleAssert ( const char *  msg)

pure virtual

called by CCAssert to allow scripting engine to handle failed assertions

Returns

true if the assert was handled by the script engine, false otherwise.

Implemented in LuaEngine, and ScriptingCore.

virtual bool parseConfig ( ConfigType  type, const std::string &  str  )

pure virtual

Parse configuration file.

Implemented in LuaEngine, and ScriptingCore.

virtual int reallocateScriptHandler ( int  handler)

inlinevirtual

Reallocate script function handler, only LuaEngine class need to implement this function.

Reimplemented in LuaEngine.

virtual void removeScriptHandler ( int  handler)

inlinevirtual

Remove script function handler, only LuaEngine class need to implement this function.

Reimplemented in LuaEngine.

virtual void removeScriptObjectByObject ( Object *  obj)

pure virtual

Remove script object.

Implemented in LuaEngine, and ScriptingCore.

virtual int sendEvent ( ScriptEvent *  evt)

pure virtual

when trigger a script event ,call this func,add params needed into ScriptEvent object.nativeObject is object triggering the event, can be nullptr in lua

Implemented in LuaEngine, and ScriptingCore.

---

The documentation for this class was generated from the following file:

• /Users/cocos2d/MyWork/cocos2d-x-develop/cocos/2d/CCScriptSupport.h