Method Global:RegisterGroupEvent [-] [+]

Registers a Group 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_MEMBER_ADD WORLD event, group, guid
2 ON_MEMBER_INVITE WORLD event, group, guid
3 ON_MEMBER_REMOVE WORLD event, group, guid, method, kicker, reason
4 ON_LEADER_CHANGE WORLD event, group, newLeaderGuid, oldLeaderGuid
5 ON_DISBAND WORLD event, group
6 ON_CREATE WORLD event, group, leaderGuid, groupType
7 ON_MEMBER_ACCEPT WORLD event, group, player Can return false to disable accepting

Synopsis

cancel = RegisterGroupEvent( event, function )

cancel = RegisterGroupEvent( event, function, shots )

Arguments

number event

Group 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