Method Global:RegisterGameObjectEvent [-] [+]

Registers a GameObject 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_AIUPDATE MAP event, go, diff
2 ON_SPAWN MAP event, go
3 ON_DUMMY_EFFECT MAP event, caster, spellid, effindex, go Can return true to stop normal action
4 ON_QUEST_ACCEPT MAP event, player, go, quest Can return true to stop normal action
5 ON_QUEST_REWARD MAP event, player, go, quest, opt Can return true to stop normal action
6 ON_DIALOG_STATUS MAP event, player, go
7 ON_DESTROYED MAP event, go
8 ON_DAMAGED MAP event, go, attacker
9 ON_LOOT_STATE_CHANGE MAP event, go, state
10 ON_GO_STATE_CHANGED MAP event, go, state
12 ON_ADD MAP event, go
13 ON_REMOVE MAP event, go
14 ON_USE MAP event, go, player Can return true to stop normal action

Synopsis

cancel = RegisterGameObjectEvent( entry, event, function )

cancel = RegisterGameObjectEvent( entry, event, function, shots )

Arguments

number entry

GameObject entry Id.

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

number event

GameObject 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