Method Global:RegisterGuildEvent [-] [+]

Registers a Guild 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_ADD_MEMBER WORLD event, guild, player, rank
2 ON_REMOVE_MEMBER WORLD event, guild, player, isDisbanding
3 ON_MOTD_CHANGE WORLD event, guild, newMotd
4 ON_INFO_CHANGE WORLD event, guild, newInfo
5 ON_CREATE WORLD event, guild, leader, name Not on TC
6 ON_DISBAND WORLD event, guild
7 ON_MONEY_WITHDRAW WORLD event, guild, player, amount, isRepair Can return new money amount
8 ON_MONEY_DEPOSIT WORLD event, guild, player, amount Can return new money amount
9 ON_ITEM_MOVE WORLD event, guild, player, item, isSrcBank, srcContainer, srcSlotId, isDestBank, destContainer, destSlotId TODO
10 ON_EVENT WORLD event, guild, eventType, plrGUIDLow1, plrGUIDLow2, newRank TODO
11 ON_BANK_EVENT WORLD event, guild, eventType, tabId, playerGUIDLow, itemOrMoney, itemStackCount, destTabId

Synopsis

cancel = RegisterGuildEvent( event, function )

cancel = RegisterGuildEvent( event, function, shots )

Arguments

number event

Guild 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