WoW:API UseAction: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (Move page script moved page API UseAction to API UseAction without leaving a redirect)
 
(15 intermediate revisions by 15 users not shown)
Line 1: Line 1:
UseAction (ID,#{,target})
{{wowapi}}
{{protectedapi|2.0.1|For alternatives, try [[API SecureTemplates|SecureTemplates]] or the new [[Conditional slash commands]].}}


The first number is the action ID.  
Perform the specified action.  


Each button on your action bar has an ID. The first button id is 1, and so on. There are 10 action bars in all, thus the highets action bar is 120.
UseAction(slot[, checkCursor[, onSelf]])


The second number is either 1 or 0. The third number is optional and represents whether the action should be executed on yourself (1 = on yourself, 0 or nil, on your target or give you the spell targeting cursor). The default appears to be 0.
== Parameters ==
=== Arguments ===
:;slot
:: Numeric - The action [[ActionSlot|slot]] to use.
:;checkCursor
:: Flag <small>''(optional)''</small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.
:;onSelf
:: Flag <small>''(optional)''</small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.
 
=== Returns ===
 
:''none''
 
== Example ==
 
action = 18 -- Change this to the slot number you want to activate
UseAction(action, 0, 1)
 
=== Result ===
 
-- Causes action bar slot #18 to be cast on the player, regardless
-- of whether the cursor is currently "holding" an item or ability.
 
== Details ==
 
See the [[actionSlot]] API Type for more information on slot numbers and example code for listing available slots.

Latest revision as of 04:47, 15 August 2023

← WoW API < UseAction

Icon-addon-48x48.png This function is PROTECTED, and can only be called from Blizzard code.

Perform the specified action. 

UseAction(slot[, checkCursor[, onSelf]])

Parameters[edit]

Arguments[edit]

slot
Numeric - The action slot to use.
checkCursor
Flag (optional) - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.
onSelf
Flag (optional) - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.

Returns[edit]

none

Example[edit]

action = 18 -- Change this to the slot number you want to activate
UseAction(action, 0, 1)

Result[edit]

-- Causes action bar slot #18 to be cast on the player, regardless
-- of whether the cursor is currently "holding" an item or ability.

Details[edit]

See the actionSlot API Type for more information on slot numbers and example code for listing available slots.

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_UseAction&oldid=20114"