(more return values) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{wowapi}} |
{{wowapi}} |
||
Returns information about a saved equipment set: |
Returns information about a saved equipment set: |
||
| − | name, icon, |
+ | name, icon, setID, isEquipped, totalItems, equippedItems, inventoryItems, missingItems, ignoredSlots = GetEquipmentSetInfo(index) |
| − | icon, |
+ | icon, setID, isEquipped, numItems, equippedItems, availableItems, missingItems, ignoredSlots = GetEquipmentSetInfoByName("name") |
==Arguments== |
==Arguments== |
||
| Line 12: | Line 12: | ||
; name : String: Equipment set name. |
; name : String: Equipment set name. |
||
; icon : String: Icon texture file name (relative to Interface/Icons) selected for this set. |
; icon : String: Icon texture file name (relative to Interface/Icons) selected for this set. |
||
| + | ; setID : Number: Unknown. |
||
| − | ; lessIndex : Number: A number one less than the set index. ''This return value is not used by the default UI.'' |
||
; isEquipped : Boolean: True if all non-ignored slots in this set are equipped. |
; isEquipped : Boolean: True if all non-ignored slots in this set are equipped. |
||
; numItems : Number: Number of items included in the set |
; numItems : Number: Number of items included in the set |
||
| Line 21: | Line 21: | ||
==Example== |
==Example== |
||
| − | local name, icon |
+ | local name, icon = GetEquipmentSetInfo(1); |
if not name then |
if not name then |
||
print("You have no equipment sets"); |
print("You have no equipment sets"); |
||
Revision as of 00:34, 25 July 2011
 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Returns information about a saved equipment set:
name, icon, setID, isEquipped, totalItems, equippedItems, inventoryItems, missingItems, ignoredSlots = GetEquipmentSetInfo(index)
icon, setID, isEquipped, numItems, equippedItems, availableItems, missingItems, ignoredSlots = GetEquipmentSetInfoByName("name")
Arguments
- GetEquipmentSetInfo -- index
- Number: an ascending index going from 1 to GetNumEquipmentSets().
- GetEquipmentSetInfoByName -- name
- String: equipment set name.
Returns
The functions returns nothing if the queried index or set name does not exist. If the index/name is valid, the following values are returned:
- name
- String: Equipment set name.
- icon
- String: Icon texture file name (relative to Interface/Icons) selected for this set.
- setID
- Number: Unknown.
- isEquipped
- Boolean: True if all non-ignored slots in this set are equipped.
- numItems
- Number: Number of items included in the set
- equippedItems
- Number: Number of items in this set currently equipped
- availableItems
- Number: Number of items in this set currently in the player's bags/bank, if bank is available
- missingItems
- Number: Number of items in this set that are not currently available to the player.
- ignoredSlots
- Number: Number of inventory slots ignored by this set
Example
local name, icon = GetEquipmentSetInfo(1);
if not name then
print("You have no equipment sets");
else
print("First equipment set: \124TInterface\\Icons\\" .. icon .. ":16\124t " .. name);
end
| ||||||||||||||||||||