WoW API: UseEquipmentSet

Reference  e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < UseEquipmentSet

Equips items from a specified equipment set.

local setWasEquipped = UseEquipmentSet("name")

Parameters

Arguments

• name (string) - equipment set name, e.g. "Damage", "Tank", "PvP" etc.

Returns

• setWasEquipped (boolean) - true if the set was equipped, nil otherwise. Failure conditions include invalid arguments, and engaging in combat.

Examples

UseEquipmentSet("Tank")

Equips the equipment set named "Tank".

Example 2

local name =  C_EquipmentSet.GetEquipmentSetInfo(1)
local ok =  C_EquipmentSet.UseEquipmentSet(name)
if ok then
 print("You're now clad in " .. name);
end

Details

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

Notes

• Moved in patch 7.2.0 (2017-03-28) to C_EquipmentSet.UseEquipmentSet.
• Added in Patch 3.0.2 (2008-10-14) as UseEquipmentSet.