WoW API: UseEquipmentSet

From AddOn Studio
Revision as of 14:51, 20 May 2009 by WoWWiki>Starlightblunder (Created page with '{{wowapi}} Equips items from a specified equipment set. success = UseEquipmentSet("name"); ==Parameters== ===Arguments=== ;name : String - equipment set name. ===Returns=== ;s...')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

WoW API < UseEquipmentSet

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).