Method Global:RegisterItemEvent [-] [+]
Registers an Item 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_DUMMY_EFFECT | MAP | event, caster, spellid, effindex, item | |
| 2 | ON_USE | MAP | event, player, item, target | Can return false to stop the spell casting |
| 3 | ON_QUEST_ACCEPT | MAP | event, player, item, quest | Can return true |
| 4 | ON_EXPIRE | MAP | event, player, itemid | Can return true |
| 5 | ON_REMOVE | MAP | event, player, item | Can return true |
| 6 | ON_ADD | MAP | event, player, item | |
| 8 | ON_UNEQUIP | MAP | event, player, item, slot | |
| 7 | ON_EQUIP | MAP | event, player, item, slot |
Synopsis
cancel = RegisterItemEvent( entry, event, function )
cancel = RegisterItemEvent( entry, event, function, shots )
Arguments
function functionFunction 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 cancelA function that cancels the binding when called.