WoW:API GetItemInfo: Difference between revisions
Jump to navigation
Jump to search
GetItemInfo -Documentation by Darjk-
m (itemEquipLoc a separate page now) |
|||
| Line 21: | Line 21: | ||
:;itemSubType : String - The sub type of the item. Enchanting, Cloth, Sword, etc. | :;itemSubType : String - The sub type of the item. Enchanting, Cloth, Sword, etc. | ||
:;itemStackCount : Integer - How many of the item per stack. ie. 20 for Runecloth, 1 for weapon, 100 for Alterac Ram Hide, etc. | :;itemStackCount : Integer - How many of the item per stack. ie. 20 for Runecloth, 1 for weapon, 100 for Alterac Ram Hide, etc. | ||
:;itemEquipLoc : String - Equip location of the item specified. The string contains the name a global string variable, such as "INVTYPE_HEAD", which contains the localized name of the location. | :;itemEquipLoc : String - Equip [[API TYPE itemEquipLoc|location]] of the item specified. The string contains the name a global string variable, such as "INVTYPE_HEAD", which contains the localized 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. | ||
| Line 36: | Line 36: | ||
: All string returns (itemName, itemType, itemSubType, itemEquipLoc(until 1.9)) are localized. | : All string returns (itemName, itemType, itemSubType, itemEquipLoc(until 1.9)) are localized. | ||
: itemString is a subset of an item's link, not the actual link returned from functions like GetContainerItemLink() | : itemString is a subset of an item's link, not the actual link returned from functions like GetContainerItemLink() | ||
---- | ---- | ||
__NOTOC__ | __NOTOC__ | ||
{{Template:WoW API}} | {{Template:WoW API}} | ||
Revision as of 00:09, 22 March 2006
Return information about a specific item.
args = GetItemInfo(itemID | "itemString");
Parameters
Arguments
- (itemID or "itemString")
- itemID
- Integer - The numeric ID of the item. ie. 12345
- "itemString"
- String - The full item ID in string format. ie. "item:12345:0:0:0"
Returns
- itemName, itemLink, itemRarity, itemMinLevel, itemType, itemSubType, itemStackCount, itemEquipLoc, itemTexture
- itemName
- String - The name of the item.
- itemLink
- String - The item link ie. "item:12345:0:0:0".
- itemRarity
- Integer - The value is 0 to 6, which represents Poor to Artifact.
- itemMinLeveL
- Integer - The minimum level required to use the item, 0 being no level requirement.
- itemType
- String - The type of the item. Armor, Weapon, Quest, Key, etc.
- itemSubType
- String - The sub type of the item. Enchanting, Cloth, Sword, etc.
- itemStackCount
- Integer - How many of the item per stack. ie. 20 for Runecloth, 1 for weapon, 100 for Alterac Ram Hide, etc.
- itemEquipLoc
- String - Equip location of the item specified. The string contains the name a global string variable, such as "INVTYPE_HEAD", which contains the localized name of the location.
- itemTexture
- String - The name and path for the inventory icon texture for the item.
Example
local sName, sLink, iQuality, iLevel, sType, sSubType, iCount = GetItemInfo(16846); message(sName..","..iQuality..","..sType..","..iCount);
Result
- Message box will pop-up with - "Gianstalker's Helmet,4,Armor,1".
Details
- This function will ONLY retrieve data that is in your local cache.
- 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, itemEquipLoc(until 1.9)) are localized.
- itemString is a subset of an item's link, not the actual link returned from functions like GetContainerItemLink()