WoW:API GetSpellLink: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
Line 2: | Line 2: | ||
Get chat-link for a spell. | Get chat-link for a spell. | ||
link = GetSpellLink(spellId | link = GetSpellLink(spellId) | ||
link = GetSpellLink(spellName[, spellRank]) | |||
link = GetSpellLink(spellNum, spellBook) | |||
== Arguments == | == Arguments == | ||
(spellId | (spellId) | ||
:;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 [http://www.wowhead.com wowhead], [http://wow.allakhazam.com allakhazam], or [http://thottbot.com thottbot] or through [[API_COMBAT_LOG_EVENT|COMBAT_LOG_EVENT]]. | ||
or | or | ||
(spellName[, spellRank]) | |||
:;spellName : String - The name of the spell (Rank may be specified, defaults to highest if omitted) | :;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. ( | :;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 | 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. | :;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. | :;spellBook : String - BOOKTYPE_SPELL or BOOKTYPE_PET depending on whether you wish to query the player or pet spellbook. | ||
Line 25: | Line 29: | ||
== Details == | == Details == | ||
===Returns=== | ===Returns=== | ||
Note that this | Note that this link does not contain any ranks, for instance if you request a link for fireball rank 10 it would look like: | ||
{{ability|Fireball}} | |||
If you wish to display rank use [[API GetSpellInfo | GetSpellInfo]] and output using the following code: | If you wish to display rank use [[API GetSpellInfo | GetSpellInfo]] and output using the following code: | ||
local name, rank = GetSpellInfo(SpellID); | local name, rank = GetSpellInfo(SpellID); | ||
DEFAULT_CHAT_FRAME:AddMessage("Spell: |Hspell:" .. SpellID .."|h|r|cff71d5ff[" .. name .. " " .. rank .. "]|r|h"); | DEFAULT_CHAT_FRAME:AddMessage("Spell: |Hspell:" .. SpellID .."|h|r|cff71d5ff[" .. name .. " " .. rank .. "]|r|h"); |
Revision as of 00:17, 15 July 2010
← WoW API < GetSpellLink
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, allakhazam, or thottbot 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
- TradeSkillLink
- String - A link to the tradeskill if available, otherwise nil. (3.0.1+)
Details
Returns
Note that this link does not contain any ranks, for instance if you request a link for fireball rank 10 it would look like: Template:Ability
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");