WoW:API GetItemIcon: Difference between revisions

Revision as of 00:36, 14 October 2010

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Return the icon texture for the item.

itemIcon = GetItemIcon(itemID)

(itemID)

"itemIcon"

itemIcon = GetItemIcon(6948)
print("itemIcon :", itemIcon)

prints Hearthstone icon - "Interface\\Icons\\INV_Misc_Rune_01".

As of patch 4.0.1, this function requires an itemID, it will not work with item names or links.

@@ Line 1: / Line 1: @@
 {{wowapi}}__NOTOC__
 Return the icon texture for the item.
-  itemIcon = GetItemIcon(itemID or "itemString" or "itemName" or "itemLink")
+  itemIcon = GetItemIcon(itemID)
 == Parameters ==
 === Arguments ===
-:(itemId or "[[itemString]]" or "itemName" or "[[itemLink]]")
+:(itemID)
-:;itemId : Integer - The numeric ID of the item. ie. 12345
+:;itemID : 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"
-:;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.
-:;[[itemLink]] : String - The [[itemLink]], when Shift-Clicking items.
 === Returns ===
@@ Line 20: / Line 15: @@
 == Example ==
- local itemIcon = GetItemIcon("item:6948")
- print("itemIcon :", itemIcon)
- itemIcon = GetItemIcon("Hearthstone")
- print("itemIcon :", itemIcon)
   itemIcon = GetItemIcon(6948)
   print("itemIcon :", itemIcon)
 ====Result====
-: prints Hearthstone icon 3 times - "Interface\\Icons\\INV_Misc_Rune_01".
+: prints Hearthstone icon - "Interface\\Icons\\INV_Misc_Rune_01".
-== Common usage ==
-local itemIcon = GetItemIcon(link)
+== Notes ==
+* As of patch 4.0.1, this function requires an itemID, it will not work with item names or links.