WoW:API GetSpellName: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(upgraded deprecated template)
Line 1: Line 1:
{{wowapi}}
Retrieves the spell name and spell rank for a spell in the player's spellbook. If you're trying to read the spell book at login, register for the [[Events P (Party, Petition, Pet, PlayerBank, Player)#PLAYER_LOGIN|PLAYER_LOGIN]] event.
Retrieves the spell name and spell rank for a spell in the player's spellbook. If you're trying to read the spell book at login, register for the [[Events P (Party, Petition, Pet, PlayerBank, Player)#PLAYER_LOGIN|PLAYER_LOGIN]] event.


Line 37: Line 38:
----
----
--[[User:Sahazhe|Sahazhe]] 07:52, 24 Feb 2005 (EST)
--[[User:Sahazhe|Sahazhe]] 07:52, 24 Feb 2005 (EST)
----
{{Template:WoW API}}

Revision as of 18:05, 6 January 2007

WoW API < GetSpellName

Retrieves the spell name and spell rank for a spell in the player's spellbook. If you're trying to read the spell book at login, register for the PLAYER_LOGIN event.

spellName, spellRank = GetSpellName( spellId, bookType );

Arguments
spellId
Integer - Spell ID. Valid values are 1 through total number of spells in the spellbook on all pages and all tabs, ignoring empty slots.
bookType
String - Either BOOKTYPE_SPELL ("spell") or BOOKTYPE_PET ("pet").

Returns
spellName
String - Name of the spell as it appears in the spellbook, eg. "Lesser Heal"
spellRank
String - The spell rank or type, eg. "Rank 3", "Racial Passive". This can be an empty string. Note: for the Enchanting trade skill at rank Apprentice, the returned string contains a trailing space, ie. "Apprentice ". This might be the case for other trade skills and ranks also.

Example
local i = 1
while true do
   local spellName, spellRank = GetSpellName(i, BOOKTYPE_SPELL)
   if not spellName then
      do break end
   end
   
   -- use spellName and spellRank here
   DEFAULT_CHAT_FRAME:AddMessage( spellName .. '(' .. spellRank .. ')' )
   
   i = i + 1
end
Result
Displays every spell in the player's spellbook, on all pages and all tabs, in the format required by CastSpellByName.

--Sahazhe 07:52, 24 Feb 2005 (EST)