WoW:API GetPetActionInfo: Difference between revisions

Revision as of 18:34, 23 December 2006

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

Returns information on the specified pet action.

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

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.

Information based on a post from Sarf plus some guesswork, so may not be 100% accurate -- Goldark 06:01, 17 Dec 2004 (EST)

@@ 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.
+ name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled = GetPetActionInfo(index);
-  name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled = GetPetActionInfo(index)
+==Parameters==
+===Arguments===
-----
-;''Arguments''
-: (index)
 :; index : Number - The index of the pet action button you want to query.
+===Returns===
-----
-;''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.
@@ Line 26: / Line 15: @@
 :;autoCastEnabled : Boolean - Returns true if autocast is currently enabled for this ability.
-----
+==Notes==
-;''Example''
+Information based on a post from Sarf plus some guesswork, so may not be 100% accurate -- [[User:Goldark|Goldark]] 06:01, 17 Dec 2004 (EST)
-  local name, subtext, texture, isToken, isActive, autoCastAllowed, autoCastEnabled = GetPetActionInfo(4);
-----
-;''Description''
-: Returns information on the specified pet action.
-----
-{{WoW API}}