WoW:API GetContainerItemInfo - Revision history

Move page script: Move page script moved page API GetContainerItemInfo to WoW:API GetContainerItemInfo without leaving a redirect

2023-08-15T04:45:50Z

Move page script moved page API GetContainerItemInfo to API GetContainerItemInfo without leaving a redirect

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>BryghtShadow: updated for 4.0.3a

2011-01-16T04:33:22Z

updated for 4.0.3a

← Older revision		Revision as of 04:33, 16 January 2011
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__

	texture, itemCount, locked, quality, readable = GetContainerItemInfo(bagID, slot);		texture, itemCount, locked, quality, readable, lootable, itemLink = GetContainerItemInfo(bagID, slot);

	== Parameters ==		== Parameters ==
Line 15:		Line 15:
	:;quality : Number - the numeric quality of the item		:;quality : Number - the numeric quality of the item
	:;readable : [[Boolean]] - 1 if the item can be "read" (as in a book)		:;readable : [[Boolean]] - 1 if the item can be "read" (as in a book)
			:;lootable : [[Boolean]] - 1 if the item is a temporary container containing items that can be looted; otherwise nil.
			:;[[itemLink]] : a hyperlink for the item.

	== Example ==		== Example ==

WoWWiki>MalygosMud: /* Example */

2009-02-12T11:27:05Z

Example

← Older revision		Revision as of 11:27, 12 February 2009
Line 33:		Line 33:
	== Example ==		== Example ==

	/script DEFAULT_CHAT_FRAME:AddMessage(({GetContainerItemInfo(1,1)} )~~[2]~~)		/script DEFAULT_CHAT_FRAME:AddMessage( (select(2, GetContainerItemInfo(1,1))) )

	=== Result ===		=== Result ===

	: This macro will print out the item count for the item located in slot 1 of bag 1. Different indices, instead of 2, can be used to slice out a specific return value.		: This macro will print out the item count for the item located in slot 1 of bag 1. Different indices, instead of 2, can be used to slice out a specific return value.

WoWWiki>Nappa at 02:52, 16 August 2008

2008-08-16T02:52:29Z

← Older revision		Revision as of 02:52, 16 August 2008
Line 30:		Line 30:

	: An item in a character's inventory can become "locked" for a number of reasons. It might be locked because it is attached to the cursor, or because it has been split and the new stack is attached to the cursor, or because is in the "create auction" item slot, or because it is in a trade slot. In all of these cases, the item is considered to be "locked". Also, typically, the item's icon is shown in grayscale. The item will become unlocked when the action that locked the icon is complete. When the item's move is finished (and the server accepts the move), the item will become unlocked. When the server reports that the auction has been created, the item will become unlocked (although it will also disappear). During the period that the item is locked, some methods that affect the item (such as [[API PickupContainerItem\|PickupContainerItem]]) silently fail.		: An item in a character's inventory can become "locked" for a number of reasons. It might be locked because it is attached to the cursor, or because it has been split and the new stack is attached to the cursor, or because is in the "create auction" item slot, or because it is in a trade slot. In all of these cases, the item is considered to be "locked". Also, typically, the item's icon is shown in grayscale. The item will become unlocked when the action that locked the icon is complete. When the item's move is finished (and the server accepts the move), the item will become unlocked. When the server reports that the auction has been created, the item will become unlocked (although it will also disappear). During the period that the item is locked, some methods that affect the item (such as [[API PickupContainerItem\|PickupContainerItem]]) silently fail.

			== Example ==

			/script DEFAULT_CHAT_FRAME:AddMessage(({GetContainerItemInfo(1,1)} )[2])

			=== Result ===

			: This macro will print out the item count for the item located in slot 1 of bag 1. Different indices, instead of 2, can be used to slice out a specific return value.

WoWWiki>Baudzilla: /* Returns */

2007-01-29T05:23:25Z

Returns

← Older revision		Revision as of 05:23, 29 January 2007
Line 14:		Line 14:
	:;locked : [[Boolean]] - 1 if the item is locked by the server, nil otherwise.		:;locked : [[Boolean]] - 1 if the item is locked by the server, nil otherwise.
	:;quality : Number - the numeric quality of the item		:;quality : Number - the numeric quality of the item
	:;readable : [[Boolean - 1 if the item can be "read" (as in a book)		:;readable : [[Boolean]] - 1 if the item can be "read" (as in a book)

	== Example ==		== Example ==

WoWWiki>Bytecrafter: better summary of the locked return value

2007-01-08T04:51:16Z

better summary of the locked return value

← Older revision		Revision as of 04:51, 8 January 2007
Line 12:		Line 12:
	:;texture : String - the texture for the item in the specified bag slot		:;texture : String - the texture for the item in the specified bag slot
	:;itemCount : Number - the number of items 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 (?)~~		:;locked : [[Boolean]] - 1 if the item is locked by the server, nil otherwise.
	:;quality : Number - the numeric quality of the item		:;quality : Number - the numeric quality of the item
	:;readable : [[Boolean - 1 if the item can be "read" (as in a book)		:;readable : [[Boolean - 1 if the item can be "read" (as in a book)
Line 29:		Line 29:
	: 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]].		: An item in a character's inventory can become "locked" for a number of reasons. It might be locked because it is attached to the cursor, or because it has been split and the new stack is attached to the cursor, or because is in the "create auction" item slot, or because it is in a trade slot. In all of these cases, the item is considered to be "locked". Also, typically, the item's icon is shown in grayscale. The item will become unlocked when the action that locked the icon is complete. When the item's move is finished (and the server accepts the move), the item will become unlocked. When the server reports that the auction has been created, the item will become unlocked (although it will also disappear). During the period that the item is locked, some methods that affect the item (such as [[API PickupContainerItem\|PickupContainerItem]]) silently fail.

WoWWiki>Fabozz: /* Result */

2006-11-03T01:16:25Z

Result

← Older revision		Revision as of 01:16, 3 November 2006
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 ~~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 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]].

WoWWiki>Mikk: Formatting

2006-08-13T14:34:28Z

Formatting

← Older revision		Revision as of 14:34, 13 August 2006
Line 1:		Line 1:
	~~<center>'''GetContainerItemInfo''' ''-Documentation by [[user:Arvenis\|Arvenis]]-''</center>~~		{{wowapi}} __NOTOC__

	texture, itemCount, locked, quality, readable = GetContainerItemInfo(bagID, slot);		texture, itemCount, locked, quality, readable = GetContainerItemInfo(bagID, slot);

	~~----~~		== Parameters ==
	~~;''~~Arguments''		=== Arguments ===

	:;[[~~API TYPE bagID\|~~bagID]] : ~~number~~ - number of the bag the item is in, 0 is your backpack~~, 1-4 are the four additional bags~~		:;[[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.		:;slot : Number - slot number of the bag item you want the info for.

	----		=== Returns ===
	;~~''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)

	~~:;texture : the texture for the item in the specified bag slot~~		== Example ==
	~~:;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);		local texture, itemCount, locked, quality, readable = GetContainerItemInfo(1,2);
	DEFAULT_CHAT_FRAME:AddMessage(itemCount .. " stacked items in 2nd slot of bag 1.");		DEFAULT_CHAT_FRAME:AddMessage(itemCount .. " stacked items in 2nd slot of bag 1.");

	~~----~~		=== Result ===
	~~;''~~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 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 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.		: 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]].


	~~----~~
	~~{{WoW API}}~~

WoWWiki>Starlightblunder: Formatting. Original examples were relevant to LUA, not the function.

2006-04-13T20:11:45Z

Formatting. Original examples were relevant to LUA, not the function.

← Older revision		Revision as of 20:11, 13 April 2006
Line 1:		Line 1:
	<center>'''GetContainerItemInfo''' ''-Documentation by [[user:Arvenis\|Arvenis]]-''</center>		<center>'''GetContainerItemInfo''' ''-Documentation by [[user:Arvenis\|Arvenis]]-''</center>
			texture, itemCount, locked, quality, readable = GetContainerItemInfo(bagID, slot);

	----		----
	;''Arguments''		;''Arguments''
	~~:;:(bagID,slot)~~
	:::;[[API TYPE bagID\|bagID]] : number - number of the bag the item is in, 0 is your backpack, 1-4 are the four additional bags		:;[[API TYPE bagID\|bagID]] : number - number of the bag the item is in, 0 is your backpack, 1-4 are the four additional bags
	:::;slot : number - slot number of the bag item you want the info for.		:;slot : number - slot number of the bag item you want the info for.

	----		----
	;''Returns''		;''Returns''

	:;texture~~, itemCount, locked, quality, readable~~ : ~~texture -~~ the texture for the item in the specified bag slot		:;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		:;locked : true if locked; that is, a stack that cannot be split
	:;;;: ~~quality -~~ the numeric quality of the item		:;quality : the numeric quality of the item
	:;;;: ~~readable -~~ true if the item can be "read" (as in a book)		:;readable : true if the item can be "read" (as in a book)
	----		----
	;''Examples''		;''Examples''

	local texture, itemCount, locked, quality, readable = GetContainerItemInfo(1,2);		local texture, itemCount, locked, quality, readable = GetContainerItemInfo(1,2);
			DEFAULT_CHAT_FRAME:AddMessage(itemCount .. " stacked items in 2nd slot of bag 1.");
	: ~~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:'' [[API_GetInventorySlotInfo\|GetInventorySlotInfo]] to get the same information from a player's inventory (or equipped items).~~

	----		----

WoWWiki>Ebnusn at 23:59, 14 March 2006

2006-03-14T23:59:14Z

← Older revision		Revision as of 23:59, 14 March 2006
Line 2:		Line 2:
	----		----
	;''Arguments''		;''Arguments''
	:;:(~~bag~~,slot)		:;:(bagID,slot)
	:::;~~bag~~ : number - number of the bag the item is in, 0 is your backpack, 1-4 are the four additional bags		:::;[[API TYPE bagID\|bagID]] : number - number of the bag the item is in, 0 is your backpack, 1-4 are the four additional bags
	:::;slot : number - slot number of the bag item you want the info for.		:::;slot : number - slot number of the bag item you want the info for.