struct IFunctionHandler { };
IScriptSystem.h
This interface is used by the C++ function mapped to the script to retrieve the function parameters passed by the script and to return an optiona result value to the script.
virtual ~IFunctionHandler();
virtual int EndFunction() = 0;
template <class T> int EndFunction(const T & value);
template <class T1,class T2> int EndFunction(const T1 & value1, const T2 & value2);
template <class T1,class T2,class T3> int EndFunction(const T1 & value1, const T2 & value2, const T3 & value3);
virtual int EndFunctionAny(const ScriptAnyValue & any) = 0;
virtual int EndFunctionAny(const ScriptAnyValue & any1, const ScriptAnyValue & any2) = 0;
virtual int EndFunctionAny(const ScriptAnyValue & any1, const ScriptAnyValue & any2, const ScriptAnyValue & any3) = 0;
int EndFunctionNull();
virtual const char* GetFuncName() = 0;
Returns the function name of the currently called function. Notes: Use this only used for error reporting.
Returns pointer to the script system.
virtual IScriptSystem* GetIScriptSystem() = 0;
template <typename T> bool GetParam(int nIdx, T & value);
|
Parameters |
Description |
|
int nIdx |
1-based index of the parameter. |
|
val |
Reference to the C++ variable that will store the value. |
Get the nIdx param passed by the script.
virtual bool GetParamAny(int nIdx, ScriptAnyValue & any) = 0;
|
Parameters |
Description |
|
int nIdx |
1-based index of the parameter. |
|
val |
Reference to the C++ variable that will store the value. |
Gets the nIdx param passed by the script.
virtual int GetParamCount() = 0;
Gets the number of parameter at specified index passed by the Lua.
Template methods to get multiple parameters.
template <class P1> bool GetParams(P1 & p1);
template <class P1,class P2> bool GetParams(P1 & p1, P2 & p2);
template <class P1,class P2,class P3> bool GetParams(P1 & p1, P2 & p2, P3 & p3);
template <class P1,class P2,class P3,class P4> bool GetParams(P1 & p1, P2 & p2, P3 & p3, P4 & p4);
template <class P1,class P2,class P3,class P4,class P5> bool GetParams(P1 & p1, P2 & p2, P3 & p3, P4 & p4, P5 & p5);
template <class P1,class P2,class P3,class P4,class P5,class P6> bool GetParams(P1 & p1, P2 & p2, P3 & p3, P4 & p4, P5 & p5, P6 & p6);
template <class P1,class P2,class P3,class P4,class P5,class P6,class P7> bool GetParams(P1 & p1, P2 & p2, P3 & p3, P4 & p4, P5 & p5, P6 & p6, P7 & p7);
template <class P1,class P2,class P3,class P4,class P5,class P6,class P7,class P8> bool GetParams(P1 & p1, P2 & p2, P3 & p3, P4 & p4, P5 & p5, P6 & p6, P7 & p7, P8 & p8);
template <class P1,class P2,class P3,class P4,class P5,class P6,class P7,class P8,class P9> bool GetParams(P1 & p1, P2 & p2, P3 & p3, P4 & p4, P5 & p5, P6 & p6, P7 & p7, P8 & p8, P9 & p9);
template <class P1,class P2,class P3,class P4,class P5,class P6,class P7,class P8,class P9,class P10> bool GetParams(P1 & p1, P2 & p2, P3 & p3, P4 & p4, P5 & p5, P6 & p6, P7 & p7, P8 & p8, P9 & p9, P10 & p10);
virtual ScriptVarType GetParamType(int nIdx) = 0;
Gets the type of the parameter at specified index passed by the Lua.
template <class T> bool GetSelf(T & value);
Retrieves the value of the self passed when calling the table. Notes: Always the 1st argument of the function.
virtual bool GetSelfAny(ScriptAnyValue & any) = 0;
Retrieves the value of the self passed when calling the table. Notes: Always the 1st argument of the function.
virtual void* GetThis() = 0;
Gets this pointer of table which called C++ method. This pointer is assigned to key "__this" in the table.