WoW:API GetInventorySlotInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API GetInventorySlotInfo to API GetInventorySlotInfo without leaving a redirect)
 
(7 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<center>'''GetInventorySlotInfo''' ''-Documentation by [[user:Arvenis|Arvenis]]-''</center>
{{wowapi}}
----
Return information about a specific inventory slot
;''Arguments''


'''This is incorrect!!''' Please see line 90 of the PaperDollFrame.lua file within the default interface code.
slotId, textureName = GetInventorySlotInfo("slotName")
eg id, textureName = GetInventorySlotInfo("HEADSLOT");
== Parameters ==
=== Arguments ===
:("slotName")


:;slot : number - slot number of the Inventory item you want the info for.
:;slotName : String - The [[API TYPE InventorySlotName|InventorySlotName]] to query ("HEADSLOT", etc).
=== Returns ===
:slotId, textureName


: 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:
:;slotId : Numeric - The [[API TYPE InventorySlotID|slot ID]] to use to refer to that slot in the other GetInventory functions.
# Head
:;textureName : String - The texture to use for the empty slot on the paper doll display.
# Neck
# Shoulders
# Shirt
# Chest
# Waist
# Legs
# Feet
# Wrists
# Hands
# Finger 1
# Finger 2
# Trinket 1 ??
# Trinket 2 ??
# Back
# Main Hand
# Off Hand
# Ranged
# Tabard ??
# Bag (4th from left)
# Bag (3rd from left)
# Bag (2nd from left)
# Bag (1st)
 
----
;''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 = 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:'' [[API_GetContainerItemInfo|GetContainerItemInfo]] to get the same information from any of the player's bags.
----
;''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.
 
 
----
{{Template:WoW API}}
[[Category:API Inventory Functions|GetInventorySlotInfo]]

Latest revision as of 04:46, 15 August 2023

← WoW API < GetInventorySlotInfo

Return information about a specific inventory slot 

slotId, textureName = GetInventorySlotInfo("slotName")

Parameters[edit]

Arguments[edit]

("slotName")
slotName
String - The InventorySlotName to query ("HEADSLOT", etc).

Returns[edit]

slotId, textureName
slotId
Numeric - The slot ID to use to refer to that slot in the other GetInventory functions.
textureName
String - The texture to use for the empty slot on the paper doll display.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetInventorySlotInfo&oldid=19085"