WoW:API GetActionCount: Difference between revisions

Latest revision as of 04:45, 15 August 2023

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

Gets the available count for an action, if applicable.

text = GetActionCount(actionSlot)

Arguments

Returns

The action's count as displayed on the action's icon; e.g. for a potion action, returns the number of potions left.
0, if the action has no count or if the specified action slot is empty

Use IsConsumableAction(slot) to determine whether a returned 0 means that there are no more charges of the item, or whether it simply doesn't have a count.

@@ Line 1: / Line 1: @@
-<center>'''GetActionCount''' - ''Documentation by [[User:Flickering|Flickering]]''</center>
+{{wowapi}} __NOTOC__
-Get the available count for an action.
+Gets the available count for an action, if applicable.
+ text = GetActionCount(actionSlot)
- text = GetActionCount(actionSlot)
 == Parameters ==
-=== Arguments ===
+<big>'''Arguments'''</big>
-:(actionSlot)
+:;actionSlot - [[ActionSlot]] : The queried action slot.
+<big>'''Returns'''</big>
+:;text - Number
+:* The action's count as displayed on the action's icon; e.g. for a potion action, returns the number of potions left.
+:* 0, if the action has no count or if the specified action slot is empty
-:;actionSlot : Numeric - The slot number of the action to query.
-=== Returns ===
-:text
-:;count : Numeric - If the action has a count (such as potion actions), then the count for the action is returned. 0 is returned for slots with no count as well as empty slots.
+== See Also ==
-----
+* Use [[API IsConsumableAction|IsConsumableAction(slot)]] to determine whether a returned <tt>0</tt> means that there are no more charges of the item, or whether it simply doesn't have a count.
-__NOTOC__
-{{Template:WoW API}}