WoW:API GetSpellInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
Line 14: Line 14:
:;spellId : Integer - The global spell number, found on wowhead or through [[API_COMBAT_LOG_EVENT|COMBAT_LOG_EVENT]].
:;spellId : Integer - The global spell number, found on wowhead or through [[API_COMBAT_LOG_EVENT|COMBAT_LOG_EVENT]].
:;spellName : String - The Name of the spell.
:;spellName : String - The Name of the spell.
:;[[SpellLink|spellLink]] : String - The formatted link to the spell
:;[[SpellLink|spellLink]] : String - The formatted link to the spell [Note: this appears to be broken, see Discussion page]
 





Revision as of 23:19, 17 March 2009

WoW API < GetSpellInfo

Get information about a spell.

name, rank, icon, cost, isFunnel, powerType, 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.
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

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.

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.