# Method Global:RegisterItemEvent [-] [+]

Registers an Item event handler.

    enum ItemEvents
    {
        ITEM_EVENT_ON_DUMMY_EFFECT                      = 1,    // (event, caster, spellid, effindex, item)
        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_ON_ADD                               = 6,    // (event, player, item)
        ITEM_EVENT_ON_EQUIP                             = 7,    // (event, player, item, slot)
        ITEM_EVENT_ON_UNEQUIP                           = 8,    // (event, player, item, slot)
        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.

# Keyboard shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

# Search tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct` (or `str`), `enum`, `trait`, `typedef` (or `tdef`).

Generated on
© 2010 - 2024 Eluna Lua Engine