Method Global:RegisterPlayerGossipEvent [-] [+]

Registers a Player gossip 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).

Note that you can not use ON_HELLO with this hook. It does nothing since players dont have an "on hello".

ID Event State Parameters Comment
1 ON_HELLO MAP event, player, object Object is the Creature/GameObject/Item. Can return false to do default action. For item gossip can return false to stop spell casting.
2 ON_SELECT MAP event, player, object, sender, intid, code, menu_id Object is the Creature/GameObject/Item/Player, menu_id is only for player gossip. Can return false to do default action.

Synopsis

cancel = RegisterPlayerGossipEvent( menu_id, event, function )

cancel = RegisterPlayerGossipEvent( menu_id, event, function, shots )

Arguments

number menu_id

Player gossip menu Id.

Valid numbers: integers from 0 to 4,294,967,295.

number event

Player gossip 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