WoW:API GetActionText: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (New)
 
m (Move page script moved page API GetActionText to API GetActionText without leaving a redirect)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<center>'''GetActionText''' - ''Documentation by [[User:Flickering|Flickering]]''</center>
{{wowapi}} __NOTOC__


Get the text label for an action.
Gets the text label for an action.
text = GetActionText(actionSlot)


text = GetActionText(actionSlot)
== Parameters ==
== Parameters ==
=== Arguments ===
<big>'''Arguments'''</big>
:(actionSlot)
 
:;actionSlot - [[ActionSlot]] : The queried slot.


:;actionSlot : Numeric - The slot number of the action to query.
<big>'''Returns'''</big>
=== Returns ===
:text


:;text : String - If the action has a text label (such as macro actions), then the label is returned. nil is returned for slots with no label as well as for empty slots.
:;text - String
----
:* The action's text, if present.  Macro actions use their names for their action text.
__NOTOC__
:* nil, if the slot has no action text, or is empty. Most standard WoW action icons don't have action text.
{{Template:WoW API}}
[[Category:API Action Functions|GetActionText]]

Latest revision as of 04:45, 15 August 2023

WoW API < GetActionText

Gets the text label for an action.

text = GetActionText(actionSlot)

Parameters[edit]

Arguments

actionSlot - ActionSlot
The queried slot.

Returns

text - String
  • The action's text, if present. Macro actions use their names for their action text.
  • nil, if the slot has no action text, or is empty. Most standard WoW action icons don't have action text.