WoW:API ToggleSpellBook: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
({{framexmlfunc|FrameXML/SpellBookFrame.lua}} __NOTOC__)
mNo edit summary
Line 10: Line 10:
=== Arguments ===
=== Arguments ===


:;bookType: string containing which spellbook to open. Valid choices are "spell" and "pet"
:;bookType: string containing which spellbook to open. Valid choices are "spell", "pet", "general", or any spec name (e.g. "assasination", "fire", etc). Only "spell" and "pet" will open the full spellbook (with all the tabs to click on), the rest will open only that tab (with no tabs to click on).





Revision as of 02:40, 29 May 2008

WoW API < ToggleSpellBook

"I" iconThis function is implemented in Lua here FrameXML/SpellBookFrame.lua.


ToggleSpellBook(bookType);

Shows/Hides the Spellbook.


Parameters

Arguments

bookType
string containing which spellbook to open. Valid choices are "spell", "pet", "general", or any spec name (e.g. "assasination", "fire", etc). Only "spell" and "pet" will open the full spellbook (with all the tabs to click on), the rest will open only that tab (with no tabs to click on).


Returns

nil


Example

ToggleSpellBook("spell");


Details

Shows the Spellbook. Equivalent to pressing 'P'. Note that if you do not have any pet spells, passing in "pet" will do nothing.