WoW:API GetItemInfo - Revision history

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

2023-08-15T04:46:03Z

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

← Older revision	Revision as of 04:46, 15 August 2023
(No difference)

Bear: /* Changes */

2016-07-22T19:25:10Z

Changes

← Older revision		Revision as of 19:25, 22 July 2016
Line 1:		Line 1:
	{{wowapi}}__NOTOC__		{{wowapi}}__NOTOC__
	Return information about a specific item.		Return information about a specific item.
	itemName, itemLink, itemRarity, itemLevel, itemMinLevel, itemType, itemSubType,		itemName, itemLink, itemRarity, itemLevel, itemMinLevel, itemType,
	itemStackCount, itemEquipLoc, itemTexture, itemSellPrice =		itemSubType, itemStackCount, itemEquipLoc, itemTexture, itemSellPrice =
	GetItemInfo(itemID or "itemString" or "itemName" or "itemLink")		GetItemInfo(itemID or "itemString" or "itemName" or "itemLink")

	== Parameters ==		== Parameters ==
Line 44:		Line 44:
	:: String - Where the item may be equipped, if it can. If not equippable, this is an empty string, "". The string returned is also the name of a global string variable, i.e. for "INVTYPE_HEAD", _G["INVTYPE_HEAD"] is a localized, displayable name of the location.		:: String - Where the item may be equipped, if it can. If not equippable, this is an empty string, "". The string returned is also the name of a global string variable, i.e. for "INVTYPE_HEAD", _G["INVTYPE_HEAD"] is a localized, displayable name of the location.
	:;itemTexture		:;itemTexture
	:: String - ~~The name and path for~~ the ~~inventory~~ icon ~~texture for the item~~.		:: String (number) - Texture Id of the item icon.
	:;itemSellPrice		:;itemSellPrice
	:: Integer - Items vendor value, in copper. Will need to be parsed into gold, silver, copper. Format ggggsscc.		:: Integer - Items vendor value, in copper. Will need to be parsed into gold, silver, copper. Format ggggsscc.
Line 56:		Line 56:

	==Details==		==Details==
	: If you have never seen the item that belongs to the Item ID or Item Link it will return ''nil''.		* If you have never seen the item that belongs to the Item ID or Item Link it will return ''nil''.
	: All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.		* All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.
	~~: As of~~ Patch 3.2 ~~the~~ 11th returned value is the Vendor Sell Price for that item.
			== Changes ==
			* Patch 3.2 - 11th returned value is the Vendor Sell Price for that item.
			* Patch 7.0.3 - itemTexture is now returned as a texture id, type number, rather than the full texture path as a string from before.

108.221.21.77 at 18:30, 14 September 2013

2013-09-14T18:30:12Z

← Older revision		Revision as of 18:30, 14 September 2013
Line 3:		Line 3:
	itemName, itemLink, itemRarity, itemLevel, itemMinLevel, itemType, itemSubType,		itemName, itemLink, itemRarity, itemLevel, itemMinLevel, itemType, itemSubType,
	itemStackCount, itemEquipLoc, itemTexture, itemSellPrice =		itemStackCount, itemEquipLoc, itemTexture, itemSellPrice =
	GetItemInfo(itemID or "itemString" or "itemName" or "itemLink")		GetItemInfo(itemID or "itemString" or "itemName" or "itemLink")

	== Parameters ==		== Parameters ==
Line 9:		Line 9:
	:(itemId or "[[itemString]]" or "itemName" or "[[itemLink]]")		:(itemId or "[[itemString]]" or "itemName" or "[[itemLink]]")

	:;itemId : Integer - The numeric ID of the item. ie. 12345		:;itemId
	:;[[itemString]] : String - The full item ID in string format, e.g. "item:12345:0:0:0:0:0:0:0".		:: Integer - The numeric ID of the item. ie. 12345
			:;[[itemString]]
			:: String - The full item ID in string format, e.g. "item:12345:0:0:0:0:0:0:0".
	:::Also supports partial [[itemString]]s, by filling up any missing ":x" value with ":0", e.g. "item:12345:0:0:0"		:::Also supports partial [[itemString]]s, by filling up any missing ":x" value with ":0", e.g. "item:12345:0:0:0"
	:;itemName : String - The Name of the Item, ex: "Hearthstone"
			:;itemName
			:: String - The Name of the Item, ex: "Hearthstone"
	:::The item must have been equiped, in your bags or in your bank once in this session for this to work.		:::The item must have been equiped, in your bags or in your bank once in this session for this to work.
	:;[[itemLink]] : String - The [[itemLink]], when Shift-Clicking items.
			:;[[itemLink]]
			:: String - The [[itemLink]], when Shift-Clicking items.

	=== Returns ===		=== Returns ===
	:"itemName", "[[itemLink]]", itemRarity, itemLevel, itemMinLevel, "[[itemType]]", "itemSubType", itemStackCount, "[[itemEquipLoc]]", "invTexture"		:"itemName", "[[itemLink]]", itemRarity, itemLevel, itemMinLevel, "[[itemType]]", "itemSubType", itemStackCount, "[[itemEquipLoc]]", "invTexture", "itemSellPrice"

	:;itemName : String - The name of the item.		:;itemName
	:;[[itemLink]] : String - The item Link; you will see the clickable Link instead of the string. (String, such as: "\|cFFFFFFFF\|Hitem:12345:0:0:0\|h[Item Name]\|h\|r")		:: String - The name of the item.
	:;itemRarity : Integer - The [[API TYPE Quality\|quality]] of the item. The value is 0 to 7, which represents Poor to Heirloom.		:;[[itemLink]]
	:;itemLevel : Integer - The item level of this item.		:: String - The item Link; you will see the clickable Link instead of the string. (String, such as: "\|cFFFFFFFF\|Hitem:12345:0:0:0\|h[Item Name]\|h\|r")
	:;itemMinLevel : Integer - The minimum level required to use the item, 0 meaning no level requirement.		:;itemRarity
	:;[[itemType]] : String - The type of the item: Armor, Weapon, Quest, Key, etc.		:: Integer - The [[API TYPE Quality\|quality]] of the item. The value is 0 to 7, which represents Poor to Heirloom.
	:;itemSubType : String - The sub-type of the item: Enchanting, Cloth, Sword, etc. See [[itemType]].		:;itemLevel
	:;itemStackCount : Integer - How many of the item per stack: 20 for Runecloth, 1 for weapon, 100 for Alterac Ram Hide, etc.		:: Integer - The item level of this item.
	:;[[itemEquipLoc]] : String - Where the item may be equipped, if it can. If not equippable, this is an empty string, "". The string returned is also the name of a global string variable, i.e. for "INVTYPE_HEAD", _G["INVTYPE_HEAD"] is a localized, displayable name of the location.		:;itemMinLevel
	:;itemTexture : String - The name and path for the inventory icon texture for the item.		:: Integer - The minimum level required to use the item, 0 meaning no level requirement.
	:;itemSellPrice : Integer - Items vendor value, in copper. Will need to be parsed into gold, silver, copper. Format ggggsscc.		:;[[itemType]]
			:: String - The type of the item: Armor, Weapon, Quest, Key, etc.
			:;itemSubType
			:: String - The sub-type of the item: Enchanting, Cloth, Sword, etc. See [[itemType]].
			:;itemStackCount
			:: Integer - How many of the item per stack: 20 for Runecloth, 1 for weapon, 100 for Alterac Ram Hide, etc.
			:;[[itemEquipLoc]]
			:: String - Where the item may be equipped, if it can. If not equippable, this is an empty string, "". The string returned is also the name of a global string variable, i.e. for "INVTYPE_HEAD", _G["INVTYPE_HEAD"] is a localized, displayable name of the location.
			:;itemTexture
			:: String - The name and path for the inventory icon texture for the item.
			:;itemSellPrice
			:: Integer - Items vendor value, in copper. Will need to be parsed into gold, silver, copper. Format ggggsscc.

	== Example ==		== Example ==

Bear at 00:38, 11 October 2012

2012-10-11T00:38:36Z

← Older revision		Revision as of 00:38, 11 October 2012
Line 1:		Line 1:
	{{wowapi}}__NOTOC__		{{wowapi}}__NOTOC__
	Return information about a specific item.		Return information about a specific item.
	itemName, itemLink, itemRarity, itemLevel, itemMinLevel, itemType, itemSubType, itemStackCount,		itemName, itemLink, itemRarity, itemLevel, itemMinLevel, itemType, itemSubType,
	itemEquipLoc, itemTexture, itemSellPrice = GetItemInfo(itemID or "itemString" or "itemName" or "itemLink")		itemStackCount, itemEquipLoc, itemTexture, itemSellPrice =
			GetItemInfo(itemID or "itemString" or "itemName" or "itemLink")

	== Parameters ==		== Parameters ==

WoWWiki>Kawolski: /* Details */ - As of 3.3.5, this statement is inaccurate. The function returns information for any item in your game's cache.

2010-09-06T09:14:41Z

Details: - As of 3.3.5, this statement is inaccurate. The function returns information for any item in your game's cache.

← Older revision		Revision as of 09:14, 6 September 2010
Line 38:		Line 38:

	==Details==		==Details==
	: This function will '''ONLY''' retrieve data if the item is in your bags or on your character sheet (being worn). (This is not entirely correct, see [[Talk:API_GetItemInfo\|the discussion page]] for the exact rules.)
	: If you have never seen the item that belongs to the Item ID or Item Link it will return ''nil''.		: If you have never seen the item that belongs to the Item ID or Item Link it will return ''nil''.
	: All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.		: All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.
	: As of Patch 3.2 the 11th returned value is the Vendor Sell Price for that item.		: As of Patch 3.2 the 11th returned value is the Vendor Sell Price for that item.

WoWWiki>Farmbuyer: /* Details */ this sentence no verb

2009-10-28T17:28:46Z

Details: this sentence no verb

← Older revision		Revision as of 17:28, 28 October 2009
Line 38:		Line 38:

	==Details==		==Details==
	: This function will '''ONLY''' retrieve data if the item is in your bags or on your character sheet (being worn).		: This function will '''ONLY''' retrieve data if the item is in your bags or on your character sheet (being worn). (This is not entirely correct, see [[Talk:API_GetItemInfo\|the discussion page]] for the exact rules.)
	: If you have never seen the item that belongs to the Item ID or Item Link it will return ''nil''.		: If you have never seen the item that belongs to the Item ID or Item Link it will return ''nil''.
	: All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.		: All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.
	: As of Patch 3.2 the 11th returned value is the Vendor Sell Price for that item.		: As of Patch 3.2 the 11th returned value is the Vendor Sell Price for that item.

WoWWiki>Egingell: /* Details */

2009-10-24T20:31:28Z

Details

← Older revision		Revision as of 20:31, 24 October 2009
Line 38:		Line 38:

	==Details==		==Details==
	: This function will '''ONLY''' retrieve data ~~that~~ is in your ~~local cache~~.		: This function will '''ONLY''' retrieve data if the item is in your bags or on your character sheet (being worn).
	: If you have never seen the item that belongs to the Item ID or Item Link it will return ''nil''.		: If you have never seen the item that belongs to the Item ID or Item Link it will return ''nil''.
	: All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.		: All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.
	: As of Patch 3.2 the 11th returned value is the Vendor Sell Price for that item.		: As of Patch 3.2 the 11th returned value is the Vendor Sell Price for that item.

WoWWiki>Elkano: /* Example */

2009-09-09T09:46:26Z

Example

← Older revision		Revision as of 09:46, 9 September 2009
Line 31:		Line 31:

	== Example ==		== Example ==
	local sName, sLink, iRarity, iLevel, iMinLevel, sType, sSubType, iStackCount~~, iSellPrice~~ = GetItemInfo(16846);		local sName, sLink, iRarity, iLevel, iMinLevel, sType, sSubType, iStackCount = GetItemInfo(16846);
	message(sName..","..iRarity..","..sType..","..iStackCount);		message(sName..","..iRarity..","..sType..","..iStackCount);

WoWWiki>Starlightblunder: /* Common usage */ remove section: more or less covered by the function signature.

2009-08-05T14:21:03Z

Common usage: remove section: more or less covered by the function signature.

← Older revision		Revision as of 14:21, 5 August 2009
Line 42:		Line 42:
	: All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.		: All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.
	: As of Patch 3.2 the 11th returned value is the Vendor Sell Price for that item.		: As of Patch 3.2 the 11th returned value is the Vendor Sell Price for that item.

	~~== Common usage ==~~

	~~local itemName, itemLink, itemRarity, itemLevel, itemMinLevel, itemType, itemSubType, itemCount, itemEquipLoc, itemTexture, itemSellPrice = GetItemInfo(link)~~

WoWWiki>Alcedema: Adding reference to the new 11th return value for vendor price.

2009-08-05T12:54:31Z

Adding reference to the new 11th return value for vendor price.

← Older revision		Revision as of 12:54, 5 August 2009
Line 2:		Line 2:
	Return information about a specific item.		Return information about a specific item.
	itemName, itemLink, itemRarity, itemLevel, itemMinLevel, itemType, itemSubType, itemStackCount,		itemName, itemLink, itemRarity, itemLevel, itemMinLevel, itemType, itemSubType, itemStackCount,
	itemEquipLoc, itemTexture = GetItemInfo(itemID or "itemString" or "itemName" or "itemLink")		itemEquipLoc, itemTexture, itemSellPrice = GetItemInfo(itemID or "itemString" or "itemName" or "itemLink")

	== Parameters ==		== Parameters ==
Line 28:		Line 28:
	:;[[itemEquipLoc]] : String - Where the item may be equipped, if it can. If not equippable, this is an empty string, "". The string returned is also the name of a global string variable, i.e. for "INVTYPE_HEAD", _G["INVTYPE_HEAD"] is a localized, displayable name of the location.		:;[[itemEquipLoc]] : String - Where the item may be equipped, if it can. If not equippable, this is an empty string, "". The string returned is also the name of a global string variable, i.e. for "INVTYPE_HEAD", _G["INVTYPE_HEAD"] is a localized, displayable name of the location.
	:;itemTexture : String - The name and path for the inventory icon texture for the item.		:;itemTexture : String - The name and path for the inventory icon texture for the item.
			:;itemSellPrice : Integer - Items vendor value, in copper. Will need to be parsed into gold, silver, copper. Format ggggsscc.

	== Example ==		== Example ==
	local sName, sLink, iRarity, iLevel, iMinLevel, sType, sSubType, iStackCount = GetItemInfo(16846);		local sName, sLink, iRarity, iLevel, iMinLevel, sType, sSubType, iStackCount, iSellPrice = GetItemInfo(16846);
	message(sName..","..iRarity..","..sType..","..iStackCount);		message(sName..","..iRarity..","..sType..","..iStackCount);

Line 40:		Line 41:
	: If you have never seen the item that belongs to the Item ID or Item Link it will return ''nil''.		: If you have never seen the item that belongs to the Item ID or Item Link it will return ''nil''.
	: All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.		: All string returns (itemName, itemType, itemSubType) are localized. Prior to 1.9, itemEquipLoc was localized also.
			: As of Patch 3.2 the 11th returned value is the Vendor Sell Price for that item.

	== Common usage ==		== Common usage ==

	local itemName, itemLink, itemRarity, itemLevel, itemMinLevel, itemType, itemSubType, itemCount, itemEquipLoc, itemTexture = GetItemInfo(link)		local itemName, itemLink, itemRarity, itemLevel, itemMinLevel, itemType, itemSubType, itemCount, itemEquipLoc, itemTexture, itemSellPrice = GetItemInfo(link)