(Created page with '{{wowapi}} Equips items from a specified equipment set. success = UseEquipmentSet("name"); ==Parameters== ===Arguments=== ;name : String - equipment set name. ===Returns=== ;s...') |
(→Parameters: style) |
||
| Line 3: | Line 3: | ||
success = UseEquipmentSet("name"); |
success = UseEquipmentSet("name"); |
||
| − | == |
+ | ==Arguments== |
| − | ===Arguments=== |
||
;name : String - equipment set name. |
;name : String - equipment set name. |
||
| − | + | ==Returns== |
|
;success : Boolean - true if the set was equipped, nil otherwise. Failure conditions include invalid arguments, and engaging in combat. |
;success : Boolean - true if the set was equipped, nil otherwise. Failure conditions include invalid arguments, and engaging in combat. |
||
Revision as of 19:20, 24 May 2009
 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Equips items from a specified equipment set.
success = UseEquipmentSet("name");
Arguments
- name
- String - equipment set name.
Returns
- success
- Boolean - true if the set was equipped, nil otherwise. Failure conditions include invalid arguments, and engaging in combat.
Example
local name = GetEquipmentSetInfo(1);
local ok = UseEquipmentSet(name);
if ok then
print("You're now clad in " .. name);
end
Notes
This function does not produce error messages. FrameXML/EquipmentManager.lua provides EquipmentManager_EquipSet("name"), which will provide the player with an error message if the equip action fails (but does not provide you with a return value).