WoW API: C_EquipmentSet.UseEquipmentSet

From AddOn Studio
Revision as of 04:45, 15 August 2023 by Move page script (talk | contribs) (Move page script moved page API C EquipmentSet UseEquipmentSet to API C EquipmentSet UseEquipmentSet without leaving a redirect)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Icon-addon-48x48.png This function is protected, and cannot be called from insecure code while in in combat.
  • It has been protected since patch 3.3 (?).

← WoW API < C_EquipmentSet.UseEquipmentSet

Equips items from a specified equipment set. 

local setWasEquipped = C_EquipmentSet.UseEquipmentSet(equipmentSetID)

Parameters[edit]

Arguments[edit]

  • equipmentSetID (number) - equipment set id

Returns[edit]

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

Examples[edit]

UseEquipmentSet(1)

Equips the equipment set named "Tank".

Details[edit]

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[edit]

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


v • d • e
EquipmentManager API
API
FrameXML
Widget API
Events
CVars
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_C_EquipmentSet_UseEquipmentSet&oldid=18577"