WoW:API GetPetActionInfo: Difference between revisions
Jump to navigation
Jump to search
GetPetActionInfo
(Added info based on Sarf's post on cosmosui forum) |
(Formatting, filled in some blanks, categorization) |
||
| Line 5: | Line 5: | ||
Returns information on the specified pet action. | Returns information on the specified pet action. | ||
name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled = GetPetActionInfo(index) | |||
---- | ---- | ||
;''Arguments'' | ;''Arguments'' | ||
: | : (index) | ||
:; index : Number - The index of the pet action button you want to query. | |||
---- | ---- | ||
| Line 17: | Line 18: | ||
:;name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled | :;name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled | ||
:;name : The name of the action | :;name : String - The name of the action (or its global ID if isToken is true). | ||
:;subtext : | :;subtext : String - The subtext for the action's tooltip. | ||
:;texture : | :;texture : String - The name (or its global ID, if isToken is true) of the texture for the action. | ||
:;isToken : | :;isToken : Boolean - Indicates if the action is a reference to a global action, or not (<small>guess -- [[User:Flickering|Flickering]] 15:12, 28 Dec 2004 (EST)</small>) | ||
:;isActive : Returns true if the ability is currently active | :;isActive : Boolean - Returns true if the ability is currently active. | ||
:;autoCastAllowed : Returns true if this ability can use autocast. | :;autoCastAllowed : Boolean - Returns true if this ability can use autocast. | ||
:;autoCastEnabled : Returns true if autocast is currently enabled for this ability. | :;autoCastEnabled : Boolean - Returns true if autocast is currently enabled for this ability. | ||
---- | ---- | ||
| Line 36: | Line 37: | ||
---- | ---- | ||
{{Template:WoW API}} | {{Template:WoW API}} | ||
[[Category:API Pet Functions|GetPetActionInfo]] | |||
Revision as of 20:12, 28 December 2004
NB: Info based on a post from Sarf plus some guesswork, so may not be 100% accurate -- Goldark 06:01, 17 Dec 2004 (EST)
Returns information on the specified pet action.
name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled = GetPetActionInfo(index)
- Arguments
- (index)
- index
- Number - The index of the pet action button you want to query.
- Returns
- name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled
- 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 -- Flickering 15:12, 28 Dec 2004 (EST))
- 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.
- Example
local name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled = GetPetActionInfo(4);
- Description
- Returns information on the specified pet action.