Method Global:RegisterBGEvent [-] [+]
Registers a BattleGround event handler.
In Multistate mode (default), events are either registered to the WORLD state (-1) or the MAP states (map ID). These events will only ever trigger on their respective state.
In Compatibility mode, all events are registered to the WORLD state (-1).
| ID | Event | State | Parameters | Comment |
|---|---|---|---|---|
| 1 | ON_START | MAP | event, bg, bgId, instanceId | Needs to be added to TC |
| 2 | ON_END | MAP | event, bg, bgId, instanceId, winner | Needs to be added to TC |
| 3 | ON_CREATE | MAP | event, bg, bgId, instanceId | Needs to be added to TC |
| 4 | ON_PRE_DESTROY | MAP | event, bg, bgId, instanceId | Needs to be added to TC |
Synopsis
cancel = RegisterBGEvent( event, function )
cancel = RegisterBGEvent( event, function, shots )
Arguments
number eventBattleGround event Id, refer to table above.
Valid numbers: integers from 0 to 4,294,967,295.
function functionFunction to register.
number shots (0)The number of times the function will be called, 0 means "always call this function".
Valid numbers: integers from 0 to 4,294,967,295.
Returns
function cancelA function that cancels the binding when called.