WoW:API GetInventoryItemLink: Difference between revisions

← Older edit

WoW:API GetInventoryItemLink (source)

Revision as of 04:46, 15 August 2023

471 bytes removed , 15 August 2023

m

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

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi}} __NOTOC__
-<center>'''GetInventoryItemLink''' - ''Documentation by [[User:Flickering|Flickering]]''</center>
-Get a link string for the specified item.
+Get the [[itemLink]] for the specified item.
+ "itemLink" = GetInventoryItemLink("unit", slotId)
- link = GetInventoryItemLink("unit", slotId)
+== Arguments ==
-== Parameters ==
-=== Arguments ===
 :("unit", slotId)
-:;unit : String - The [[API TYPE UnitId|UnitId]] of the unit whose inventory is to be queried.
+:;"unit" : [[UnitId]] - A string representing the unit whose inventory is to be queried.
-:;slotId : Numeric - The [[API TYPE InventorySlotID|inventory slot]] to be queried, obtained via [[API GetInventorySlotInfo|GetInventorySlotInfo]].
+:;slotId : [[InventorySlotId]] - The inventory slot to be queried, obtained via [[API GetInventorySlotInfo|GetInventorySlotInfo()]].
-=== Returns ===
+== Returns ==
-:;link : String - The link string for the specified item, or nil if the slot is empty.
+;"itemLink" : [[itemLink]]- The item link for the specified item or
+:nil, if the slot is empty.
 == Example ==
-=== Code ===
   local mainHandLink = GetInventoryItemLink("player",GetInventorySlotInfo("MainHandSlot"))
-  local _, _, itemCode = strfind(mainHandLink, "(%d+):")
+  local _, _, _, _, _, _, itemType = GetItemInfo(mainHandLink)
- local _, _, _, _, _, itemType = GetItemInfo(itemCode)
   DEFAULT_CHAT_FRAME:AddMessage(itemType)
-=== Results ===
+<big>'''Result'''</big>
+:Prints the subtype of the mainhand weapon - for example "Mace" or "Sword".
-Prints the subtype of the mainhand weapon - for example "Mace" or "Sword".
-=== Comments ===
-The 2nd line of the example is used to strip down the link returned by the function into a format that [[API GetItemInfo|GetItemInfo]] will accept.  You can't pass a link from [[API GetInventoryItemLink|GetInventoryItemLink]] to [[API GetItemInfo|GetItemInfo]] directly.
-----
-__NOTOC__