WoW:API GetContainerItemInfo: Difference between revisions
Jump to navigation
Jump to search
GetContainerItemInfo -Documentation by Arvenis-
No edit summary |
(Added three missing return fields that are used as of version 4216) |
||
Line 3: | Line 3: | ||
;''Arguments'' | ;''Arguments'' | ||
:;:(bag,slot) | :;:(bag,slot) | ||
::;bag | :::;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. | |||
::;slot | |||
---- | ---- | ||
;''Returns'' | ;''Returns'' | ||
:;texture, itemCount : texture - the texture for the item in the specified bag slot | :;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 | :;;;: 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)? -- [[User:Xenoveritas|Xenoveritas]] 17:27, 27 Feb 2005 (EST) | |||
---- | ---- | ||
;''Examples'' | ;''Examples'' |
Revision as of 22:27, 27 February 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)? -- Xenoveritas 17:27, 27 Feb 2005 (EST)
- Examples
local texture, itemCount = GetContainerItemInfo(1,2);
- If you are only interested in one of these values you can use the _ character to ignore the texture or the itemCount.
local _,itemCount = GetContainerItemInfo(1,2); local texture,_ = GetContainerItemInfo(1,2);
See also: GetInventorySlotInfo to get the same information from a player's inventory (a.k.a. backpack).
- Result
- The texture variable will contain the item's texture and the itemCount variable will contain the number of that item in the slot.