Method Global:RegisterBGEvent [-] [+]

Registers a BattleGround event handler.

Event State Parameters Comment
events.bg.on_start MAP event, bg, bgId, instanceId Needs to be added to TC
events.bg.on_end MAP event, bg, bgId, instanceId, winner Needs to be added to TC
events.bg.on_create MAP event, bg, bgId, instanceId Needs to be added to TC
events.bg.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 event

BattleGround event Id, refer to table 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.

Generated on
© 2010 - 2024 Eluna Lua Engine