Method Global:RegisterItemEvent [-] [+]

Registers an Item event handler.

enum ItemEvents
{
    ITEM_EVENT_ON_DUMMY_EFFECT                      = 1,    // (event, caster, spellid, effindex, item) - Can return true
    ITEM_EVENT_ON_USE                               = 2,    // (event, player, item, target) - Can return false to stop the spell casting
    ITEM_EVENT_ON_QUEST_ACCEPT                      = 3,    // (event, player, item, quest) - Can return true
    ITEM_EVENT_ON_EXPIRE                            = 4,    // (event, player, itemid) - Can return true
    ITEM_EVENT_ON_REMOVE                            = 5,    // (event, player, item) - Can return true
    ITEM_EVENT_COUNT
};

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 ItemEvents 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 11/04/2018
©2016 - Eluna Lua Engine