WoW:Events/Item: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (automated upload)
m (This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.)
Line 1: Line 1:
__NOTOC____NOEDITSECTION__{{eventlistheader}}
<!-- DO NOT EDIT. THIS IS AN AUTOMATICALLY GENERATED PAGE. -->
<!-- DO NOT EDIT. THIS IS AN AUTOMATICALLY GENERATED PAGE. -->
<!-- DO NOT EDIT. THIS IS AN AUTOMATICALLY GENERATED PAGE. -->


:{{icon-information}}Note that this page is automatically generated; editing it is pointless. To edit event descriptions, edit the entries in the alphabetical pages, e.g. [[Events/A]], [[Events/B]], etc. Changes there will be copied over to here within a few hours.
== Item related events ==
{{evt|AUTOEQUIP_BIND_CONFIRM|Item,Loot}}
Fired when the game attempts to autobind bind-on-equip items.
{{evt|BAG_CLOSED|Item}}
Fired when a bag is (re)moved from its bagslot. Fires both for player bags and bank bags.
; arg1 : container ID
{{evt|BAG_OPEN|Item}}
Fired when a bag (NOTE: This is NOT fired for player containers, it's for those bag-like objects that you can remove items from but not put items into) is opened.
; arg1 : container ID
{{evt|BAG_UPDATE|Item}}
Fired when a bags inventory changes. Bag zero, the sixteen slot default backpack, may not fire on login. Upon login (or reloading the console) this event fires even for bank bags. When moving an item in your inventory, this fires multiple times: once each for the source and destination bag. If the bag involved is the default backpack, this event will also fire with a container ID of "-2" (twice if you are moving the item inside the same bag).
; arg1 : container ID
{{evt|BAG_UPDATE_COOLDOWN|Item}}
Fired when a cooldown update call is sent to a bag
; arg1 : container ID (may also be nil, 00:47, 15 January 2007 (EST))
{{evt|BIND_ENCHANT|Item}}
Fired when Enchanting an unbound item.
{{evt|DELETE_ITEM_CONFIRM|Item}}
Fired when the player attempts to destroy an item.
; arg1 : item name
{{evt|END_BOUND_TRADEABLE|Item}}
?
{{evt|END_REFUND|Item}}
?
{{evt|EQUIPMENT_SWAP_PENDING|Item,Player}}
?
{{evt|EQUIP_BIND_CONFIRM|Loot,Item}}
Fired when the player attempts to equip bind on equip loot.
{{evt|EQUIPMENT_SETS_CHANGED|Misc,Item}}
Fired when a new equipment set is created, an equipment set is deleted or an equipment set has changed.
{{evt|EQUIPMENT_SWAP_FINISHED|Misc, Item}}
Fired when an equipment set has finished equipping
; arg1 : Boolean value: True if the set change was successful
; arg2 : String Value: The name of the set that was changed.
{{evt|ITEM_LOCKED|Item}}
Fires when an item gets "locked" in the inventory or a container
;arg1: Bag of item
;arg2: Slot of item
{{evt|ITEM_LOCK_CHANGED|Item}}
Fires when the "locked" status on a container or inventory item changes, usually from but not limited to Pickup functions to move items.
- If arg2 is non-nil:
;arg1: Bag of updated item.
;arg2: Slot of updated item.
- If arg2 is nil:
;arg1: Equipment slot of item
* Usually fires in pairs when an item is swapping with another.
* Empty slots do not lock.
* GetContainerItemInfo and IsInventoryItemLocked can be used to query lock status.
* This does NOT fire on ammo pickups.
{{evt|ITEM_UNLOCKED|Item}}
?
{{evt|ITEM_PUSH|Item}}
Fired when an item is pushed onto the "inventory-stack". For instance when you manufacture something with your trade skills or picks something up.
;arg1: the bag that has received the new item
;arg2: the path to the item's icon
{{evt|ITEM_TEXT_BEGIN|Item}}
Fired when an items text begins displaying
{{evt|ITEM_TEXT_CLOSED|Item}}
Fired when the items text has completed its viewing and is done.
{{evt|ITEM_TEXT_READY|Item}}
Fired when the item's text can continue and is ready to be scrolled.
{{evt|ITEM_TEXT_TRANSLATION|Item}}
Fired when an item is in the process of being translated.
{{evt|REPLACE_ENCHANT|Item}}
Fired when the player must confirm an enchantment replacement.
; arg1 : new enchantment
; arg2 : current enchantment
{{evt|UNIT_INVENTORY_CHANGED|Unit Info,Item}}
Fired when the player equips or unequips an item. This can also be called if your target, [[API_TYPE_UnitId|mouseover]] or party member changes equipment (untested for hostile targets).
This event is also raised when a new item is placed in the player's containers, taking up a new slot. If the new item(s) are placed onto an existing stack or when two stacks already in the containers are merged, the event is not raised. When an item is moved inside the container or to the bank, the event is not raised. The event ''is'' raised when an existing stack is split inside the player's containers.
This event is also raised when a temporary enhancement (poison, lure, etc..) is applied to the player's weapon (untested for other units). It will again be raised when that enhancement is removed, including by manual cancellation or buff expiration.
If multiple slots are equipped/unequipped at once it only fires once now. 
This event is no longer triggered when changing zones or logging in. Inventory information is available when PLAYER_ENTERING_WORLD is triggered.
; arg1 : the [[API_TYPE_UnitId|UnitID]] of the entity
{{evt|UPDATE_INVENTORY_ALERTS|Item,Player}}
Fires whenever an item's durability status becomes yellow (low) or red (broken). Signals that the durability frame needs to be updated. May also fire on any durability status change, even if that change doesn't require an update to the durability frame.
{{evt|UPDATE_INVENTORY_DURABILITY|Item,Player}}
Should fire whenever the durability of an item in the character's possession changes. (?)
{{evt|USE_BIND_CONFIRM|Item}}
{{evt|WEAR_EQUIPMENT_SET|Player,Item}}
?

Revision as of 20:49, 6 October 2010

Event API


"I" iconNote that this page is automatically generated; editing it is pointless. To edit event descriptions, edit the entries in the alphabetical pages, e.g. Events/A, Events/B, etc. Changes there will be copied over to here within a few hours.


Item related events

"AUTOEQUIP_BIND_CONFIRM"
Category: Item,Loot
 

Fired when the game attempts to autobind bind-on-equip items.


"BAG_CLOSED"
Category: Item
 

Fired when a bag is (re)moved from its bagslot. Fires both for player bags and bank bags.

arg1
container ID


"BAG_OPEN"
Category: Item
 

Fired when a bag (NOTE: This is NOT fired for player containers, it's for those bag-like objects that you can remove items from but not put items into) is opened.

arg1
container ID


"BAG_UPDATE"
Category: Item
 

Fired when a bags inventory changes. Bag zero, the sixteen slot default backpack, may not fire on login. Upon login (or reloading the console) this event fires even for bank bags. When moving an item in your inventory, this fires multiple times: once each for the source and destination bag. If the bag involved is the default backpack, this event will also fire with a container ID of "-2" (twice if you are moving the item inside the same bag).

arg1
container ID


"BAG_UPDATE_COOLDOWN"
Category: Item
 

Fired when a cooldown update call is sent to a bag

arg1
container ID (may also be nil, 00:47, 15 January 2007 (EST))


"BIND_ENCHANT"
Category: Item
 

Fired when Enchanting an unbound item.


"DELETE_ITEM_CONFIRM"
Category: Item
 

Fired when the player attempts to destroy an item.

arg1
item name


"END_BOUND_TRADEABLE"
Category: Item
 

?


"END_REFUND"
Category: Item
 

?


"EQUIPMENT_SWAP_PENDING"
Category: Item,Player
 

?


"EQUIP_BIND_CONFIRM"
Category: Loot,Item
 

Fired when the player attempts to equip bind on equip loot.


"EQUIPMENT_SETS_CHANGED"
Category: Misc,Item
 

Fired when a new equipment set is created, an equipment set is deleted or an equipment set has changed.


"EQUIPMENT_SWAP_FINISHED"
Category: Misc, Item
 

Fired when an equipment set has finished equipping

arg1
Boolean value: True if the set change was successful
arg2
String Value: The name of the set that was changed.


"ITEM_LOCKED"
Category: Item
 

Fires when an item gets "locked" in the inventory or a container

arg1
Bag of item
arg2
Slot of item


"ITEM_LOCK_CHANGED"
Category: Item
 

Fires when the "locked" status on a container or inventory item changes, usually from but not limited to Pickup functions to move items.

- If arg2 is non-nil:

arg1
Bag of updated item.
arg2
Slot of updated item.

- If arg2 is nil:

arg1
Equipment slot of item
  • Usually fires in pairs when an item is swapping with another.
  • Empty slots do not lock.
  • GetContainerItemInfo and IsInventoryItemLocked can be used to query lock status.
  • This does NOT fire on ammo pickups.


"ITEM_UNLOCKED"
Category: Item
 

?


"ITEM_PUSH"
Category: Item
 

Fired when an item is pushed onto the "inventory-stack". For instance when you manufacture something with your trade skills or picks something up.

arg1
the bag that has received the new item
arg2
the path to the item's icon


"ITEM_TEXT_BEGIN"
Category: Item
 

Fired when an items text begins displaying


"ITEM_TEXT_CLOSED"
Category: Item
 

Fired when the items text has completed its viewing and is done.


"ITEM_TEXT_READY"
Category: Item
 

Fired when the item's text can continue and is ready to be scrolled.


"ITEM_TEXT_TRANSLATION"
Category: Item
 

Fired when an item is in the process of being translated.


"REPLACE_ENCHANT"
Category: Item
 

Fired when the player must confirm an enchantment replacement.

arg1
new enchantment
arg2
current enchantment


"UNIT_INVENTORY_CHANGED"
Category: Unit Info,Item
 

Fired when the player equips or unequips an item. This can also be called if your target, mouseover or party member changes equipment (untested for hostile targets).

This event is also raised when a new item is placed in the player's containers, taking up a new slot. If the new item(s) are placed onto an existing stack or when two stacks already in the containers are merged, the event is not raised. When an item is moved inside the container or to the bank, the event is not raised. The event is raised when an existing stack is split inside the player's containers.

This event is also raised when a temporary enhancement (poison, lure, etc..) is applied to the player's weapon (untested for other units). It will again be raised when that enhancement is removed, including by manual cancellation or buff expiration.

If multiple slots are equipped/unequipped at once it only fires once now.

This event is no longer triggered when changing zones or logging in. Inventory information is available when PLAYER_ENTERING_WORLD is triggered.

arg1
the UnitID of the entity


"UPDATE_INVENTORY_ALERTS"
Category: Item,Player
 

Fires whenever an item's durability status becomes yellow (low) or red (broken). Signals that the durability frame needs to be updated. May also fire on any durability status change, even if that change doesn't require an update to the durability frame.


"UPDATE_INVENTORY_DURABILITY"
Category: Item,Player
 

Should fire whenever the durability of an item in the character's possession changes. (?)


"USE_BIND_CONFIRM"
Category: Item
 



"WEAR_EQUIPMENT_SET"
Category: Player,Item
 

?