WoW API: GetSpellBookItemInfo

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < GetSpellBookItemInfo

Synopsis

Retrieves information about a specific SpellBook item

skillType, contextualID = GetSpellBookItemInfo(entryName)

or

skillType, contextualID = GetSpellBookItemInfo(index, spellBookType)

Arguments

entryName

String - The name of the spell, flyout, or pet ability you want to query

index

Number - The index into the spellbook

spellBookType

String - "pet" - which will search pull the entry from the pet spellbook or any other string (even an empty string - but not nil) which will pull the entry from the player's main spellbook.

Returns

skillType

String - The type of the spell (known values: "SPELL", "PETACTION", "FUTURESPELL", "FLYOUT")

contextualID

Number - For SPELL and FUTURESPELL this is the spellID. For PetAction is it an integer value that is troublesome to use outside of two functions related solely to the PetBarUI. For Flyout, it is the FlyoutID.

If nothing is found or invalid parameters were supplied, nil is returned