API GetSpellBookItemName

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

Retrieves the spell name and spell rank for a spell in the player's spell book.

spellName, spellSubName, spellID = GetSpellBookItemName(spellName)
                                 = GetSpellBookItemName(index, bookType)

Arguments

spellName

string - Spell book item name.

---

index

number - Spellbook slot index, ranging from 1 through total number of spells in the spell book on all pages and tabs.

bookType

string - BOOKTYPE_SPELL or BOOKTYPE_PET depending on if you wish to query the player or pet spellbook. Internally the game only tests if this is equal to "pet" and treats any other string value as "spell".

Constant	Value	Description
BOOKTYPE_SPELL	"spell"	The General, Class, Specs and Professions tabs[1]
BOOKTYPE_PET	"pet"	The Pet tab

Returns

spellName

string - Name of the spell as it appears in the spell book, e.g. "Lesser Heal"

spellSubName

string - The spell rank or sub type, e.g. "Grand Master", "Racial Passive". This can be an empty string. Note: for the Enchanting trade skill at rank Apprentice, the returned string contains a trailing space, i.e. "Apprentice ". This might be the case for other trade skills and ranks also. Not readily available on function call, see SpellMixin:ContinueOnSpellLoad()

spellID

number

Details

• This function will return nested flyout spells, but the names returned may not be functional (a hunter will see "Call <petname>" instead of "Call Pet 1" but "/cast Call <petname>" will not function in a macro or from the command line). Use care with the results returned..
• Use in conjunction with GetSpellBookItemInfo to determine if a player knows this spell.
• Spell book information is first available after the SPELLS_CHANGED event fires.

Example

Prints all spells in the spellbook for the player, except the profession tab ones.

for i = 1, GetNumSpellTabs() do
	local _, _, offset, numSlots = GetSpellTabInfo(i)
	for j = offset+1, offset+numSlots do
		print(i, j, GetSpellBookItemName(j, BOOKTYPE_SPELL))
	end
end

Patch changes

• Patch 4.0.1 (2010-10-12): Added. Replaces GetSpellName()