WoW:API ToggleSpellBook: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
({{framexmlfunc|FrameXML/SpellBookFrame.lua}} __NOTOC__)
Line 1: Line 1:
<center>'''ToggleSpellBook''' ''-Documentation by [[User:The_Nerd_Wonder|The Nerd Wonder]]-''</center>
{{framexmlfunc|FrameXML/SpellBookFrame.lua}} __NOTOC__


Show/Hide the Spellbook.


  ToggleSpellBook(bookType);
  ToggleSpellBook(bookType);


----
Shows/Hides the Spellbook.
;''Arguments''
 
 
== Parameters ==
=== Arguments ===


:bookType
:;bookType: string containing which spellbook to open. Valid choices are "spell" and "pet"
:;bookType: string containing which spellbook to open. Valid choices are "spell" and "pet"


----
 
;''Returns''
=== Returns ===


:;nil
:;nil


----
 
;''Example''
== Example ==
  ToggleSpellBook("spell");
  ToggleSpellBook("spell");


;''Result''


----
== Details ==
;''Description''


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

Revision as of 14:19, 5 September 2006

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" and "pet"


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.