WoW:API GetShapeshiftFormInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API GetShapeshiftFormInfo to API GetShapeshiftFormInfo without leaving a redirect)
 
(8 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<center>'''GetShapeshiftFormInfo''' ''-Documentation by Satsh-''</center>
{{wowapi}}


Retrieves information about an available Shapeshiftform or Stance.
Retrieves information about an available Shapeshiftform or Stance.


  icon, name, active = GetShapeshiftFormInfo(index);
  icon, name, active, castable, spellId = GetShapeshiftFormInfo(index);


----
----
Line 11: Line 11:
:;type : One of the following:
:;type : One of the following:
:::; index : Index of ShapeshiftForm, counted from left to right from Iconpositions in the Shapeshift/Stance bar. May not be greater then GetNumShapeshiftForms();
:::; index : Index of ShapeshiftForm, counted from left to right from Iconpositions in the Shapeshift/Stance bar. May not be greater then GetNumShapeshiftForms();
;Druid
:*1 = Bear/Dire Bear Form
:*2 = Aquatic Form
:*3 = Cat Form
:*4 = Travel Form
:*5 = Moonkin Form
:*6 = Tree of Life Form
:;Holy Priest
:* 1 = Chakra: Chastise (red)
:* 2 = Chakra: Sanctuary (blue)
:* 3 = Chakra: Serenity (yellow)
:; Rogue
:*1 = Stealth
:;Warrior
:*1 = Battle Stance
:*2 = Defensive Stance
:*3 = Beserker Stance
:;Paladin
:*1 = Devotion Aura
:*2 = Retribution Aura
:*3 = Concentration Aura
:*4 = Shadow Resistance Aura
:*5 = Frost Resistance Aura
:*6 = Fire Resistance Aura
:*7 = Crusader Aura


----
----
;''Returns''
;''Returns''


:; icon: Position and name of the icon used for the button
; icon: Position and name of the icon used for the button
:; name: Name of the ShapeshiftForm or Stance (optional)
:; name: Name of the ShapeshiftForm or Stance (optional)
:; active: Returns 1 if this ShapeshiftForm/Stance is currently active, else 0 (optional)
:; active: Returns 1 if this ShapeshiftForm/Stance is currently active, else 0 (optional)
 
:; castable: identifies if its castable.
:; spellid: Id of spell/aura
::
----
----
;''Example''
;''Example''
Line 24: Line 53:
  icon, name = GetShapeshiftFormInfo(1);
  icon, name = GetShapeshiftFormInfo(1);
  icon, name, active = GetShapeshiftFormInfo(1);
  icon, name, active = GetShapeshiftFormInfo(1);
 
icon, name, active, castable = GetShapeshiftFormInfo(1);
----
icon, name, active, castable, spellId = GetShapeshiftFormInfo(1);
{{Template:WoW API}}

Latest revision as of 04:46, 15 August 2023

WoW API < GetShapeshiftFormInfo

Retrieves information about an available Shapeshiftform or Stance.

icon, name, active, castable, spellId = GetShapeshiftFormInfo(index);

Arguments
(Number Index)
type
One of the following:
index
Index of ShapeshiftForm, counted from left to right from Iconpositions in the Shapeshift/Stance bar. May not be greater then GetNumShapeshiftForms();
Druid
  • 1 = Bear/Dire Bear Form
  • 2 = Aquatic Form
  • 3 = Cat Form
  • 4 = Travel Form
  • 5 = Moonkin Form
  • 6 = Tree of Life Form
Holy Priest
  • 1 = Chakra: Chastise (red)
  • 2 = Chakra: Sanctuary (blue)
  • 3 = Chakra: Serenity (yellow)
Rogue
  • 1 = Stealth
Warrior
  • 1 = Battle Stance
  • 2 = Defensive Stance
  • 3 = Beserker Stance
Paladin
  • 1 = Devotion Aura
  • 2 = Retribution Aura
  • 3 = Concentration Aura
  • 4 = Shadow Resistance Aura
  • 5 = Frost Resistance Aura
  • 6 = Fire Resistance Aura
  • 7 = Crusader Aura



Returns
icon
Position and name of the icon used for the button
name
Name of the ShapeshiftForm or Stance (optional)
active
Returns 1 if this ShapeshiftForm/Stance is currently active, else 0 (optional)
castable
identifies if its castable.
spellid
Id of spell/aura

Example
icon = GetShapeshiftFormInfo(1);
icon, name = GetShapeshiftFormInfo(1);
icon, name, active = GetShapeshiftFormInfo(1);
icon, name, active, castable = GetShapeshiftFormInfo(1);
icon, name, active, castable, spellId = GetShapeshiftFormInfo(1);