Changes: API IsUsableAction

Revision as of 03:21, 26 August 2021

Determine if an action can be used (you have sufficient mana, reagents and the action is not on cooldown).

isUsable, notEnoughMana = IsUsableAction(slot)

Arguments

slot: Number - Action slot to query

Returns

isUsable: boolean - true if the action is currently usable (does not check cooldown or range), false otherwise.
notEnoughMana: boolean - true if the action is unusable beacuse the player does not have enough mana, rage, etc.; false otherwise.

@@ Line 1: / Line 1: @@
+{{wowapi}} __NOTOC__
-<center>'''IsUsableAction'''</center>
-Determine if an action can be used.
+Determine if an action can be used (you have sufficient mana, reagents and the action is not on cooldown).
  isUsable, notEnoughMana = IsUsableAction(slot)
-== Parameters ==
-=== Arguments ===
-:(slot)
+== Arguments ==
-:;slot : Integer - The action slot to retrieve data for.
-For a warrior, the action slot numbering is
--36  bar on right-side of screen, far right    (top to bottom)
--48  bar on right-side of screen, in one column    (top to bottom)
--60  lower right bar    (left to right)
--72  lower left  bar    (left to right)
--84  battle stance bar    (left to right)
--96  defensive stance bar    (left to right)
--108 berserker stance bar    (left to right)
+:;slot : Number - [[Action slot]] to query
+== Returns ==
-For a rogue, the default Blizzard UI action slot numbering is
--12   main bar
--24  unknown. I could not find what these 12 buttons were
--36  far right (on the right) (added through Interface Options)    (top to bottom)
--48  far right (on the left) (added through Interface Options)    (top to bottom)
--60  bottom right (added through Interface Options)    (left to right)
--72  bottom left (added through Interface Options)    (left to right)
--84  stealth bar    (left to right)
+;isUsable : <span class="apitype">boolean</span> - true if the action is currently usable (does not check cooldown or range), false otherwise.
-not sure for other classes, but it is probably different.
+;notEnoughMana : <span class="apitype">boolean</span> - true if the action is unusable beacuse the player does not have enough mana, rage, etc.; false otherwise.
-=== Returns ===
-:isUsable, notEnoughMana
-:;isUsable : Flag - Returns 1 if the action is valid for use at present (Does NOT include cooldown or range tests), nil otherwise.
-:;notEnoughMana : Flag - Returns 1 if the reason for the action not being usable is because there is not enough mana/rage/energy, nil otherwise.
-== Example ==
-<!-- begin code -->
- local isUsable, notEnoughMana = IsUsableAction(1);
-<!-- end code -->
-----
-__NOTOC__
-{{Template:WoW API}}