WoW:API GetSpellLink: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__


<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
Get chat-link for a spell.
Get chat-link for a spell.
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  link = GetSpellLink(spellId or spellName)
  link = GetSpellLink(spellId or spellName)




== Arguments ==
== Arguments ==
<!-- List each argument, together with its type -->
(spellId/spellName, spellRank)
(spellId/spellName, spellRank)
:;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]].
Line 18: Line 15:


== Returns ==
== Returns ==
<!-- List each return value, together with its type -->
:;link: String - A link to the spell
 
:;TradeSkillLink: String - A link to the tradeskill if available, otherwise nil. (3.0.1+)
:;link: String - A link to the spell, can be outputed directly though AddMessage()


== Details ==
== Details ==

Revision as of 07:44, 23 September 2008

WoW API < GetSpellLink

Get chat-link for a spell.

link = GetSpellLink(spellId or spellName)


Arguments

(spellId/spellName, spellRank)

spellId
Integer - The global spell number, found on wowhead or through COMBAT_LOG_EVENT.

or

spellName
String - The name of the spell (Rank may be specified, defaults to highest if omitted)


spellRank
String - The rank of the spell "Rank 1" etc. You can use "" and still get a response of the highest rank known. (usefull for things like GetSpellLink("Faerie Fire (Feral)") which would return nil unless you use GetSpellLink("Faerie Fire (Feral)", "")

Returns

link
String - A link to the spell
TradeSkillLink
String - A link to the tradeskill if available, otherwise nil. (3.0.1+)

Details

Returns

Note that this does link does not contain any ranks, for instance if you request a link for fireball rank 10 it would look like: [Fireball]

If you wish to display rank use GetSpellInfo and output using the following code:

local name, rank = GetSpellInfo(SpellID);
DEFAULT_CHAT_FRAME:AddMessage("Spell: |Hspell:" .. SpellID .."|h|r|cff71d5ff[" .. name .. " " .. rank .. "]|r|h");