Changes: API GetInventorySlotInfo

Revision as of 05:24, 6 March 2005

GetInventorySlotInfo -Documentation by Arvenis-

A player's inventory includes all the items show in the character equipment screen. The inventory slot numbers start at one and work as follows:

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)

local texture, itemCount, locked, quality, readable = GetInventorySlotInfo(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 = GetInventorySlotInfo(2);

You can also omit variables if your only interested in the first few values.

local texture,itemCount = GetInventorySlotInfo(2)

See also: GetContainerItemInfo to get the same information from a player's other bags.

The texture variable will contain the item's texture and the itemCount variable will contain the number of that item in the slot.

Template:WoW API

@@ Line 33: / Line 33: @@
 ;''Returns''
-:;texture, itemCount : texture - the texture for the item in the specified 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 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 = GetInventorySlotInfo(2);
+ local texture, itemCount, locked, quality, readable = GetInventorySlotInfo(2);
-: If you are only interested in one of these values you can use the _ character to ignore the texture or the itemCount.
+: 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 = GetInventorySlotInfo(2);
+: You can also omit variables if your only interested in the first few values.
+ local texture,itemCount = GetInventorySlotInfo(2)
- local _,itemCount = GetInventorySlotInfo(2);
- local texture,_ = GetInventorySlotInfo(2);
 ''See also:'' [[API_GetContainerItemInfo|GetContainerItemInfo]] to get the same information from a player's other bags.
 ----