Uncertain future
It's not certain whether this function will change or be deprecated in future releases, so use with care.
Overview
Register a function to be called when a game object gets destroyed.This is incredibly useful because you can use it on objects owned by other players, and even destroyable features like trees.
Your function will be triggered immediately before the game object is removed from the map.
To detect when your own objects are destroyed, it's easier to use eventDestroyed() because it avoids having to bind to individual objects.
Availability
3.1 Beta 1 and above.
Syntax
bind(functionName,gameObject);
Parameters
Parameter | Type | Mandatory | Description | Game version |
---|---|---|---|---|
functionName | String | The name of the function that should be called immediately before the gameObject is destroyed. | 3.1 Beta 1 | |
gameObject | Droid object, Structure object, Feature object | Any game object, such as a droid, structure or feature. | 3.1 Beta 1 |
Return value
Value | Type | Description | Game version |
---|---|---|---|
undefined | Undefined | Indicates the bind was successful. | 3.1 Beta 1 |
<error> | Error | Indicates there was a problem (did you remember to specify functionName as as a string?) | 3.1 Beta 1 |
Example
Do something when someObject is destroyed
function certainDeath(gameObject) { // do stuff } bind("certainDeath",someObject); // where someObject would be a droid, structure or feature object
See also