WoW:API EquipmentManager UnpackLocation: Difference between revisions

m
no edit summary
(Created page)
 
mNo edit summary
Line 1: Line 1:
{{framexmlfunc|<FrameXML/EquipmentManager.lua>}}
{{framexmlfunc|FrameXML/EquipmentManager.lua}}
 
Takes an integer location value as returned by [[API_GetEquipmentSetLocations|GetEquipmentSetLocations]] and returns unpacked location info.
Takes an integer location value as returned by [[API_GetEquipmentSetLocations|GetEquipmentSetLocations]] and returns unpacked location info.
  player, bank, bags, slot, bag = EquipmentManager_UnpackLocation(location)
  player, bank, bags, slot, bag = EquipmentManager_UnpackLocation(location)


== Arguments ==
== Arguments ==
;location : integer - This is the integer returned for a specific slot by [[API_GetEquipmentSetLocations|GetEquipmentSetLocations]]
;location
: integer - This is the integer returned for a specific slot by [[API_GetEquipmentSetLocations|GetEquipmentSetLocations]]


== Returns ==
== Returns ==
:player, bank, bags, slot, bag
:player, bank, bags, slot, bag
;player : boolean - Is the item currently available to the player (either equipped, or in the player's bags)
;player
;bank : boolean - Is the item in the bank (only true if the item is in the bank, and the player has the bank frame open)
: boolean - Is the item currently available to the player (either equipped, or in the player's bags)
;bags : boolean - Is the item in a bag (if bank is also true, then it is in a bank bag)
;bank
;slot : integer - Which slot number is the item in, may be an [[InventorySlotId|inventory slot]] or bag slot (see notes)
: boolean - Is the item in the bank (only true if the item is in the bank, and the player has the bank frame open)
;bag : integer - Which [[BagId|bag]] is the item in (nil if bags is false)
;bags
: boolean - Is the item in a bag (if bank is also true, then it is in a bank bag)
;slot
: integer - Which slot number is the item in, may be an [[InventorySlotId|inventory slot]] or bag slot (see notes)
;bag
: integer - Which [[BagId|bag]] is the item in (nil if bags is false)