Method Global:RegisterItemEvent [-] [+]

Registers an Item event handler.

Event State Parameters Comment
events.item.on_dummy_effect MAP event, caster, spellid, effindex, item
events.item.on_use MAP event, player, item, target Can return false to stop the spell casting
events.item.on_quest_accept MAP event, player, item, quest Can return true
events.item.on_expire MAP event, player, itemid Can return true
events.item.on_remove MAP event, player, item Can return true
events.item.on_add MAP event, player, item
events.item.on_equip MAP event, player, item, slot
events.item.on_unequip MAP event, player, item, slot

Synopsis

cancel = RegisterItemEvent( entry, event, function )

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

Arguments

number entry

Item entry Id.

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

number event

Item 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