WoW:API GetPetActionInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Added info based on Sarf's post on cosmosui forum)
 
m (Move page script moved page API GetPetActionInfo to API GetPetActionInfo without leaving a redirect)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<center>'''GetPetActionInfo''' </center>
{{wowapi}} __NOTOC__
 
''NB: Info based on a post from Sarf plus some guesswork, so may not be 100% accurate -- [[User:Goldark|Goldark]] 06:01, 17 Dec 2004 (EST)''
 
Returns information on the specified pet action.
Returns information on the specified pet action.
name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled = GetPetActionInfo(index);


GetPetActionInfo(petActionButtonId)
==Parameters==
 
===Arguments===
----
:; index : Number - The index of the pet action button you want to query.
;''Arguments''
===Returns===
 
:;name : String - The name of the action (or its global ID if isToken is true).
: petActionButtonId - the Id for the pet action button you want to query.
:;subtext : String - The subtext for the action's tooltip.
 
:;texture : String - The name (or its global ID, if isToken is true) of the texture for the action.
----
:;isToken : Boolean - Indicates if the action is a reference to a global action, or not (<small>guess</small>)
;''Returns''
:;isActive : Boolean - Returns true if the ability is currently active.
 
:;autoCastAllowed : Boolean - Returns true if this ability can use autocast.
:;name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled
:;autoCastEnabled : Boolean - Returns true if autocast is currently enabled for this ability.
 
:;name : The name of the action
:;subtext : ?
:;texture : ?
:;isToken : ?
:;isActive : Returns true if the ability is currently active
:;autoCastAllowed : Returns true if this ability can use autocast.
:;autoCastEnabled : Returns true if autocast is currently enabled for this ability.
 
----
;''Example''
  local name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled = GetPetActionInfo(4);
 
----
;''Description''
 
: Returns information on the specified pet action.


----
==Notes==
{{Template:WoW API}}
Information based on a post from Sarf plus some guesswork, so may not be 100% accurate

Latest revision as of 04:46, 15 August 2023

← WoW API < GetPetActionInfo

Returns information on the specified pet action. 

name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled = GetPetActionInfo(index);

Parameters[edit]

Arguments[edit]

index
Number - The index of the pet action button you want to query.

Returns[edit]

name
String - The name of the action (or its global ID if isToken is true).
subtext
String - The subtext for the action's tooltip.
texture
String - The name (or its global ID, if isToken is true) of the texture for the action.
isToken
Boolean - Indicates if the action is a reference to a global action, or not (guess)
isActive
Boolean - Returns true if the ability is currently active.
autoCastAllowed
Boolean - Returns true if this ability can use autocast.
autoCastEnabled
Boolean - Returns true if autocast is currently enabled for this ability.

Notes[edit]

Information based on a post from Sarf plus some guesswork, so may not be 100% accurate

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