Class definition functions

Each class provided by the plugin is defined by a set of function pointers. WME calls these functions whenever it needs the class to perform some action. For example, if WME needs to create a new object of this class, it calls its Construct() method, when WME saves/loads game, it calls the Serialize() method etc. The plugin sends a set of function pointers to WME via the GetClassDefinition() function described here.

Each class has to provide the following functions:

• Construct
• ConstructEmpty
• Destruct
• CallMethod
• SetProperty
• GetProperty
• Serialize
• ReceiveEvent

unsigned long Construct(IWmeObject* Owner, IWmeGame* Game, IWmeScript* Script, IWmeStack* Stack)

This function is called by WME when it needs to create a new scripting object of this class. In the example above, the line

    var SnowGen = new Snow(100);

invokes a Construct() method of the "Snow" class.

Typically you create an initialized instance of your internal class in this function.

This function receives the following parameters:

• IWmeObject* Owner - it's a reference to the WME object encapsulating this newly created scripting object
• IWmeGame* Game - it's a reference to the one and only Game object, representing the current game "session"
• IWmeScript* Script - it's a reference to the WME script object which requested the object creation
• IWmeStack* Stack - it's a reference to WME stack object which contains parameters passed to the constructor. In the example above the stack would contain one value, the integer value of 100.

This function returns an ID of the newly created object. Typically this returned value is the pointer to the newly created object.

unsigned long ConstructEmpty(IWmeObject* Owner, IWmeGame* Game)

This function is called by WME when it restores a saved game. In that case, WME recreates the entire object graph by creating empty objects and then calls their Serialize() methods to restore their state from a savegame file. Typically you create an empty instance of your internal class in this function.

This function receives the following parameters:

• IWmeObject* Owner - it's a reference to the WME object encapsulating this newly created scripting object
• IWmeGame* Game - it's a reference to the one and only Game object, representing the current game "session"

This function returns an ID of the newly created object. Typically this returned value is the pointer to the newly created object.

void Destruct(unsigned long ID)

This function is called by WME when it needs to delete an existing scripting object. Typically you delete the instance of your internal class in this function.

This function receives the following parameter:

• unsigned long ID - it's the ID of your object, returned by Construct() or ConstructEmpty() methods

bool CallMethod(unsigned long ID, const char* MethodName, IWmeScript* Script, IWmeStack* Stack)

This function is called by WME whenever a script is calling a method of the plugin object.

This function receives the following parameters:

• unsigned long ID - it's the ID of your object, returned by Construct() or ConstructEmpty() methods
• const char* MethodName - the name of the method being invoked
• IWmeScript* Script - it's a reference to the WME script object which invoked the method
• IWmeStack* Stack - it's a reference to WME stack object which contains parameters passed to the method

This function returns true if it was able to handle the requested method call or false if the method name was invalid.

bool SetProperty(unsigned long ID, const char* PropName, IWmeValue* Value)

This function is called by WME whenever a script is attempting to set a property of the plugin object.

This function receives the following parameters:

• unsigned long ID - it's the ID of your object, returned by Construct() or ConstructEmpty() methods
• const char* PropName - the name of the property being set
• IWmeValue* Value - it's the reference to WME value object containing the value to be assigned to the property

This function returns true if it was able to set the requested property or false if the property name was invalid.

bool GetProperty(unsigned long ID, const char* PropName, IWmeValue* Value)

This function is called by WME whenever a script is attempting to access a property of the plugin object.

This function receives the following parameters:

• unsigned long ID - it's the ID of your object, returned by Construct() or ConstructEmpty() methods
• const char* PropName - the name of the property being read
• IWmeValue* Value - it's the reference to WME value object which will accept the value to be returned

This function returns true if it was able to return the requested property or false if the property name was invalid.

bool Serialize(unsigned long ID, IWmeSerialMgr* SerialMgr)

This function is called by WME whenever it needs to serialize or deserialize the contents of the plugin object (when saving/restoring game).

This function receives the following parameters:

• unsigned long ID - it's the ID of your object, returned by Construct() or ConstructEmpty() methods
• IWmeSerialMgr* SerialMgr - it's the reference to the WME serialization manager which handles the serialization/deserialization

This function returns true if the object was successfully serialized/deserialized.

bool ReceiveEvent(unsigned long ID, EWmeEvent EventID, void* EventData1, void* EventData2)

This function is called by WME whenever any of the subscribed events occurs.

This function receives the following parameters:

• unsigned long ID - it's the ID of your object, returned by Construct() or ConstructEmpty() methods
• EWmeEvent EventID - this parameter specifies which event occurred
• void* EventData1 - event specific data
• void* EventData2 - event specific data

This function returns true if it handled the event.