WoW:API GetSpellLink - Revision history

Move page script: Move page script moved page API GetSpellLink to WoW:API GetSpellLink without leaving a redirect

2023-08-15T04:46:28Z

Move page script moved page API GetSpellLink to API GetSpellLink without leaving a redirect

← Older revision	Revision as of 04:46, 15 August 2023
(No difference)

WoWWiki>Egingell at 00:17, 15 July 2010

2010-07-15T00:17:47Z

← Older revision		Revision as of 00:17, 15 July 2010
Line 2:		Line 2:

	Get chat-link for a spell.		Get chat-link for a spell.
	link = GetSpellLink(spellId or spellName)		link = GetSpellLink(spellId)
			link = GetSpellLink(spellName[, spellRank])
			link = GetSpellLink(spellNum, spellBook)


	== Arguments ==		== Arguments ==
	(spellId~~/spellName, spellRank~~)		(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. (~~usefull~~ for things like GetSpellLink("Faerie Fire (Feral)") which would return nil unless you use GetSpellLink("Faerie Fire (Feral)", "")		:;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 ~~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");

WoWWiki>WoWWiki-Waldo: /* Arguments */

2008-09-26T04:43:43Z

Arguments

← Older revision		Revision as of 04:43, 26 September 2008
Line 8:		Line 8:
	(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]].

	or		or

	:;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. (usefull 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 : 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 ==

WoWWiki>Adys at 07:44, 23 September 2008

2008-09-23T07:44:40Z

← Older revision		Revision as of 07:44, 23 September 2008
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 ==

WoWWiki>Apoco: /* Arguments */

2008-05-17T19:34:02Z

Arguments

← Older revision		Revision as of 19:34, 17 May 2008
Line 9:		Line 9:
	== Arguments ==		== Arguments ==
	<!-- List each argument, together with its type -->		<!-- List each argument, together with its type -->
			(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]].
	or		or
	:;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. (usefull for things like GetSpellLink("Faerie Fire (Feral)") which would return nil unless you use GetSpellLink("Faerie Fire (Feral)", "")

	== Returns ==		== Returns ==

WoWWiki>WoWWiki-Stewart: correct the function name in the top code box and add second option for argument

2008-05-16T01:25:40Z

correct the function name in the top code box and add second option for argument

← Older revision		Revision as of 01:25, 16 May 2008
Line 2:		Line 2:

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


Line 11:		Line 11:

	:;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]].
			or
			:;spellName : String - The name of the spell (Rank may be specified, defaults to highest if omitted)

	== Returns ==		== Returns ==

WoWWiki>Ansman: Page created

2008-04-13T14:01:31Z

Page created

New page

{{wowapi}} __NOTOC__


Get information about a spell.

link = GetSpellInfo(spellId)

== Arguments ==


:;spellId : Integer - The global spell number, found on wowhead or through [[API_COMBAT_LOG_EVENT|COMBAT_LOG_EVENT]].

== Returns ==


:;link: String - A link to the spell, can be outputed directly though AddMessage()

== 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 [[API GetSpellInfo | 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");