#include <CEGUIScriptModule.h>
Collaboration diagram for CEGUI::ScriptModule:
Public Member Functions | |
ScriptModule (void) | |
Constructor for ScriptModule base class. | |
virtual | ~ScriptModule (void) |
Destructor for ScriptModule base class. | |
virtual void | executeScriptFile (const String &filename, const String &resourceGroup="")=0 |
Execute a script file. | |
virtual int | executeScriptGlobal (const String &function_name)=0 |
Execute a scripted global function. The function should not take any parameters and should return an integer. | |
virtual bool | executeScriptedEventHandler (const String &handler_name, const EventArgs &e)=0 |
Execute a scripted global 'event handler' function. The function should take some kind of EventArgs like parameter that the concrete implementation of this function can create from the passed EventArgs based object. The function should not return anything. | |
virtual void | executeString (const String &str)=0 |
Execute script code contained in the given CEGUI::String object. | |
virtual void | createBindings (void) |
Method called during system initialisation, prior to running any scripts via the ScriptModule, to enable the ScriptModule to perform any operations required to complete initialisation or binding of the script language to the gui system objects. | |
virtual void | destroyBindings (void) |
Method called during system destruction, after all scripts have been run via the ScriptModule, to enable the ScriptModule to perform any operations required to cleanup bindings of the script language to the gui system objects, as set-up in the earlier createBindings call. | |
const String & | getIdentifierString () const |
Return identification string for the ScriptModule. If the internal id string has not been set by the ScriptModule creator, a generic string of "Unknown scripting module" will be returned. | |
Protected Attributes | |
String | d_identifierString |
String that holds some id information about the module. |
Definition at line 42 of file CEGUIScriptModule.h.
|
Constructor for ScriptModule base class.
Definition at line 35 of file CEGUIScriptModule.cpp. |
|
Destructor for ScriptModule base class.
Definition at line 59 of file CEGUIScriptModule.h. |
|
Method called during system initialisation, prior to running any scripts via the ScriptModule, to enable the ScriptModule to perform any operations required to complete initialisation or binding of the script language to the gui system objects.
Definition at line 132 of file CEGUIScriptModule.h. |
|
Method called during system destruction, after all scripts have been run via the ScriptModule, to enable the ScriptModule to perform any operations required to cleanup bindings of the script language to the gui system objects, as set-up in the earlier createBindings call.
Definition at line 144 of file CEGUIScriptModule.h. |
|
Execute a scripted global 'event handler' function. The function should take some kind of EventArgs like parameter that the concrete implementation of this function can create from the passed EventArgs based object. The function should not return anything.
Referenced by CEGUI::ScriptFunctor::operator()(). |
|
Execute a script file.
|
|
Execute a scripted global function. The function should not take any parameters and should return an integer.
|
|
Execute script code contained in the given CEGUI::String object.
|
|
Return identification string for the ScriptModule. If the internal id string has not been set by the ScriptModule creator, a generic string of "Unknown scripting module" will be returned.
Definition at line 39 of file CEGUIScriptModule.cpp. References d_identifierString. |
|
String that holds some id information about the module.
Definition at line 157 of file CEGUIScriptModule.h. Referenced by getIdentifierString(). |