WoW:API GetContainerItemInfo: Difference between revisions
Jump to navigation
Jump to search
(Formatting) |
(→Result) |
||
| Line 25: | Line 25: | ||
: The texture variable will contain the item's texture and the itemCount variable will contain the number of that item in the slot. | : 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 | : The quality return value will either be -1 or a standard [[API TYPE_Quality|quality]] value from 0 to 6. A value of -1 seems to indicate that the item requires special handling: It's stackable, it's unique or it's a quest item. | ||
: 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 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 [[API PickupContainerItem|PickupContainerItem]]. | : The locked return value appears to be set to true only on an item that is picked up via [[API PickupContainerItem|PickupContainerItem]]. | ||
Revision as of 01:16, 3 November 2006
← WoW API < GetContainerItemInfo
texture, itemCount, locked, quality, readable = GetContainerItemInfo(bagID, slot);
Parameters
Arguments
- bagID
- Number - number of the bag the item is in, e.g. 0 for your backpack
- slot
- Number - slot number of the bag item you want the info for.
Returns
- texture
- String - the texture for the item in the specified bag slot
- itemCount
- Number - the number of items in the specified bag slot
- locked
- Boolean - 1 if locked; that is, a stack that cannot be split (?)
- quality
- Number - the numeric quality of the item
- readable
- [[Boolean - 1 if the item can be "read" (as in a book)
Example
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 will either be -1 or a standard quality value from 0 to 6. A value of -1 seems to indicate that the item requires special handling: It's stackable, it's unique or it's a quest item.
- 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.