API GetSpellLink

Main Menu
WoW API Lua API FrameXML util Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Get chat-link for a spell.

link = GetSpellLink(spellId)
link = GetSpellLink(spellName[, spellRank])
link = GetSpellLink(spellNum, spellBook)

Arguments

(spellId)

spellId

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

or

(spellName[, spellRank])

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. (useful for things like GetSpellLink("Faerie Fire (Feral)") which would return nil unless you use GetSpellLink("Faerie Fire (Feral)", "")

or

(spellNum, spellBook)

spellNum

Integer - Valid values are 1 through total number of spells in the spellbook on all pages and all tabs, ignoring empty slots.

spellBook

String - BOOKTYPE_SPELL or BOOKTYPE_PET depending on whether you wish to query the player or pet spellbook.

Returns

link

String - A link to the spell

spellID

Integer - ID number of the Spell

Details

Notes

• This 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")

• This function returns the actual link for the spell in your spell book (i.e. the link you get when shift-clicking that spell) if given a spell name with no rank even if you got the spell name from a lower level spellID (e.g. GetSpellLink((GetSpellInfo(7411))) will return the link for Grand Master Enchanting, if known, despite 7411 being the spellID for Apprentice Enchanting).