WoW:API GetContainerItemInfo: Difference between revisions
Jump to navigation
Jump to search
GetContainerItemInfo -Documentation by Arvenis-
(Confirmed that "readable" marks items that are read) |
m (added name link) |
||
| Line 1: | Line 1: | ||
<center>'''GetContainerItemInfo''' ''-Documentation by Arvenis-''</center> | <center>'''GetContainerItemInfo''' ''-Documentation by [[user:Arvenis|Arvenis]]-''</center> | ||
---- | ---- | ||
;''Arguments'' | ;''Arguments'' | ||
| Line 17: | Line 17: | ||
;''Examples'' | ;''Examples'' | ||
local texture, itemCount = GetContainerItemInfo(1,2); | local texture, itemCount, locked, quality, readable = GetContainerItemInfo(1,2); | ||
: If you are only interested in one of these values you can use the _ character to ignore | : If you are only interested in one of these values you can use the _ character to ignore one of them. | ||
local _,itemCount = GetContainerItemInfo(1,2); | local _,itemCount,locked,quality,readable = GetContainerItemInfo(1,2); | ||
local texture, | |||
: You can also omit variables if your only interested in the first few values. | |||
local texture,itemCount = GetContainerItemInfo(1,2) | |||
''See also:'' [[API_GetInventorySlotInfo|GetInventorySlotInfo]] to get the same information from a player's inventory (or equipped items). | ''See also:'' [[API_GetInventorySlotInfo|GetInventorySlotInfo]] to get the same information from a player's inventory (or equipped items). | ||
| Line 31: | Line 33: | ||
: 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. | ||
: quality | : 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). | ||
: readable simply | : 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. | ||
---- | ---- | ||
{{Template:WoW API}} | {{Template:WoW API}} | ||
[[Category:API Inventory Functions|GetContainerItemInfo]] | [[Category:API Inventory Functions|GetContainerItemInfo]] | ||
Revision as of 20:58, 6 March 2005
- Arguments
-
- (bag,slot)
-
- bag
- number - number of the bag the item is in, 1 is your backpack, 2-5 are the four additional bags
- slot
- number - slot number of the bag item you want the info for.
- Returns
- texture, itemCount, locked, quality, readable
- 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);
- If you are only interested in one of these values you can use the _ character to ignore one of them.
local _,itemCount,locked,quality,readable = GetContainerItemInfo(1,2);
- You can also omit variables if your only interested in the first few values.
local texture,itemCount = GetContainerItemInfo(1,2)
See also: GetInventorySlotInfo to get the same information from a player's inventory (or equipped items).
- 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.