WoW:API GetContainerItemInfo: Difference between revisions
Jump to navigation
Jump to search
GetContainerItemInfo -Documentation by Arvenis-
No edit summary |
(Formatting. Original examples were relevant to LUA, not the function.) |
||
| Line 1: | Line 1: | ||
<center>'''GetContainerItemInfo''' ''-Documentation by [[user:Arvenis|Arvenis]]-''</center> | <center>'''GetContainerItemInfo''' ''-Documentation by [[user:Arvenis|Arvenis]]-''</center> | ||
texture, itemCount, locked, quality, readable = GetContainerItemInfo(bagID, slot); | |||
---- | ---- | ||
;''Arguments'' | ;''Arguments'' | ||
:;[[API TYPE bagID|bagID]] : number - number of the bag the item is in, 0 is your backpack, 1-4 are the four additional bags | |||
:;slot : number - slot number of the bag item you want the info for. | |||
---- | ---- | ||
;''Returns'' | ;''Returns'' | ||
:;texture | :;texture : the texture for the item in the specified bag slot | ||
:; | :;itemCount : the number of items in the specified bag slot | ||
:; | :;locked : true if locked; that is, a stack that cannot be split | ||
:; | :;quality : the numeric quality of the item | ||
:; | :;readable : true if the item can be "read" (as in a book) | ||
---- | ---- | ||
;''Examples'' | ;''Examples'' | ||
local texture, itemCount, locked, quality, readable = GetContainerItemInfo(1,2); | local texture, itemCount, locked, quality, readable = GetContainerItemInfo(1,2); | ||
DEFAULT_CHAT_FRAME:AddMessage(itemCount .. " stacked items in 2nd slot of bag 1."); | |||
: | |||
---- | ---- | ||
Revision as of 20:11, 13 April 2006
texture, itemCount, locked, quality, readable = GetContainerItemInfo(bagID, slot);
- Arguments
- bagID
- number - number of the bag the item is in, 0 is your backpack, 1-4 are the four additional bags
- slot
- number - slot number of the bag item you want the info for.
- Returns
- texture
- the texture for the item in the specified bag slot
- itemCount
- the number of items in the specified bag slot
- locked
- true if locked; that is, a stack that cannot be split
- quality
- the numeric quality of the item
- readable
- true if the item can be "read" (as in a book)
- Examples
local texture, itemCount, locked, quality, readable = GetContainerItemInfo(1,2); DEFAULT_CHAT_FRAME:AddMessage(itemCount .. " stacked items in 2nd slot of bag 1.");
- Result
- The texture variable will contain the item's texture and the itemCount variable will contain the number of that item in the slot.
- The quality return value does not appear to directly correspond with the color used to display the item name. In addition, it only appears to be defined for equipment (as opposed to trade items).
- The readable return value simply indicates if there is text related to the item. If it's true, the default UI will change the cursor to the "Read" cursor (the magnifying glass) when the mouse is over the item button.
- The locked return value appears to be set to true only on an item that is picked up via PickupContainerItem.