WoW:API GetSpellInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
Line 4: Line 4:
Get information about a spell.
Get information about a spell.
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  name, rank, icon, cost, isFunnel, powerType, castTime, minRange, maxRange  
  name, rank, icon, castTime, minRange, maxRange  
  = GetSpellInfo(spellId or spellName or spellLink)
  = GetSpellInfo(spellId or spellName or spellLink)


Line 15: Line 15:
:;spellName : String - The Name of the spell.
:;spellName : String - The Name of the spell.
:;[[SpellLink|spellLink]] : String - The formatted link to the spell [Note: this appears to be broken, see Discussion page]
:;[[SpellLink|spellLink]] : String - The formatted link to the spell [Note: this appears to be broken, see Discussion page]




== Returns ==
== Returns ==
:name, rank, icon, cost, isFunnel, powerType, castTime, minRange, maxRange
: name, rank, icon, cost, isFunnel, powerType, castTime, minRange, maxRange


:;name : String - The name of the spell.
:; name : String - The name of the spell.
:;rank : String - The rank of the spell. Returns as an empty string if there is no rank.
:; rank : String - The rank of the spell. Returns as an empty string if there is no rank.
{{cata-inline}} Returns a list of stances for warrior abilities.
{{cata-inline}}Returns a list of stances for warrior abilities.
:; icon : String - The interface path to the icon texture.
:; castTime : Number - The cast time, in milliseconds.
:; minRange : Number - The minimum range of the spell.
:; maxRange : Number - The maximum range of the spell.


:;icon : String - The interface path to the icon texture.
:;cost : Number - The cost of the spell in Mana/Rage/Energy/Focus.
:;isFunnel : Boolean - Returns true if the spell is a health funnel effect. Returns false 99% of the time.
:;powerType : Number - The power type required:
::* -2 for Health
::* 0 for Mana
::* 1 for Rage
::* 2 for Focus (hunter pets)
::* 3 for Energy
::* 4 for Happiness
::* 5 for Rune
::* 6 for Runic Power
:;castTime : Number - The cast time, in milliseconds.
:;minRange : Number - The minimum range of the spell.
:;maxRange : Number - The maximum range of the spell.


== Details ==
== Details ==
cost, powerType, and isFunnel was removed in 6.0
===Arguments===
===Arguments===
Using '''spellId''' as the argument will always return the info.  Using '''spellName''' or '''spellLink''' will only return the info if the spell is in your spellbook. Otherwise it will return nil.
Using '''spellId''' as the argument will always return the info.  Using '''spellName''' or '''spellLink''' will only return the info if the spell is in your spellbook. Otherwise it will return nil.
===isFunnel===
Currently the only spells isFunnel returns true on are a warlock's [[Health Funnel]] spells, and a few other miscellaneous NPC spells.
===PowerType===
It is unknown at this point, but unlikely, that Happyness (PowerType 4) is passed as a spell cost.

Revision as of 21:45, 29 October 2014

WoW API < GetSpellInfo

Get information about a spell.

name, rank, icon, castTime, minRange, maxRange 
= GetSpellInfo(spellId or spellName or spellLink)


Arguments

(spellId or spellName or spellLink
spellId
Integer - The global spell number, found on wowhead or through COMBAT_LOG_EVENT.
spellName
String - The Name of the spell.
spellLink
String - The formatted link to the spell [Note: this appears to be broken, see Discussion page]


Returns

name, rank, icon, cost, isFunnel, powerType, castTime, minRange, maxRange
name
String - The name of the spell.
rank
String - The rank of the spell. Returns as an empty string if there is no rank.

Template:Cata-inlineReturns a list of stances for warrior abilities.

icon
String - The interface path to the icon texture.
castTime
Number - The cast time, in milliseconds.
minRange
Number - The minimum range of the spell.
maxRange
Number - The maximum range of the spell.


Details

cost, powerType, and isFunnel was removed in 6.0

Arguments

Using spellId as the argument will always return the info. Using spellName or spellLink will only return the info if the spell is in your spellbook. Otherwise it will return nil.