Method Global:RegisterBGEvent [-] [+]
Registers a BattleGround event handler.
enum BGEvents { BG_EVENT_ON_START = 1, // (event, bg, bgId, instanceId) - Needs to be added to TC BG_EVENT_ON_END = 2, // (event, bg, bgId, instanceId, winner) - Needs to be added to TC BG_EVENT_ON_CREATE = 3, // (event, bg, bgId, instanceId) - Needs to be added to TC BG_EVENT_ON_PRE_DESTROY = 4, // (event, bg, bgId, instanceId) - Needs to be added to TC BG_EVENT_COUNT };
Synopsis
cancel = RegisterBGEvent( event, function )
cancel = RegisterBGEvent( event, function, shots )
Arguments
number event
BattleGround event Id, refer to BGEvents above.
Valid numbers: integers from 0 to 4,294,967,295.
function function
Function 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 cancel
A function that cancels the binding when called.