WoW API: UseContainerItem

Revision as of 11:36, 23 April 2008 by WoWWiki>Baudzilla (Noted that UseContainerItem's protected status doesn't always apply)

WoW API < UseContainerItem

Use an item from a container. If Merchant window is open, this will sell the item. Triggered when an item is Right Clicked.

UseContainerItem(bagId, slot [, onSelf])

Parameters

Arguments

(bagId, slot [, onSelf])
bagId
Integer - The bag id, where the item to use is located
slot
Integer - The slot in the bag, where the item to use is located
onSelf
Boolean - Optional parameter, if the item should be used on yourself (default: false).

Example

UseContainerItem(1, 16, 1)

Result

Uses the item located in the 16th slot in your 1st bag (not backpack) on yourself.
For instance if it's a bandage, this will bandage yourself.

Details

Slots in the bags are listed from left to right, top to bottom.
A 16 slot bag have the following slot numbers:
1 2 3 4
5 6 7 8
9 10 11 12
13 14 15 16


An 18 slot bag have the following slot numbers:
1 2
3 4 5 6
7 8 9 10
11 12 13 14
15 16 17 18

Other Notes

Because of previous malicious scripts, Blizzard has changed availability of this function only to Blizzard UI, except when using the item would result in it being sold, equipped, or opened.