WoW:API GetSpellLink: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Move page script moved page API GetSpellLink to API GetSpellLink without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
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)
  link = GetSpellLink(spellId or spellName)
link = GetSpellLink(spellName[, spellRank])
  link = GetSpellLink(spellNum, spellBook)




== Arguments ==
== Arguments ==
<!-- List each argument, together with its type -->
(spellId)
(spellId/spellName, spellRank)
:;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]].
:;spellId : Integer - The global spell number, found on wowhead 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.  (useful for things like GetSpellLink("Faerie Fire (Feral)") which would return nil unless you use GetSpellLink("Faerie Fire (Feral)", "")


or


:;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)", "")
(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 ==
== 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 ==
===Returns===
===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:
Note that this link does not contain any ranks, for instance if you request a link for fireball rank 10 it would look like:
[Fireball]
{{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");

Latest revision as of 04:46, 15 August 2023

← WoW API < GetSpellLink

Get chat-link for a spell. 

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


Arguments[edit]

(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[edit]

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

Details[edit]

Returns[edit]

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");
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetSpellLink&oldid=19313"