Changes: API ToggleGameMenu

Revision as of 00:41, 15 July 2008

This function is implemented in FrameXML/UIParent.lua.

ToggleGameMenu();

Opens/closes the game menu.

none

ToggleGameMenu();

The function itself is not protected; it calls the following protected functions which trigger the ACTION_BLOCKED event:
- SpellStopCasting()
- SpellStopTargeting()
- ClearTarget()
The name of this function is a bit of a misnomer, it's actually a handler that fires when the user presses the Escape key.

@@ Line 1: / Line 1: @@
+{{protectedapi|2.0.1|}}
-{{framexml}}
+<br>{{framexmlfunc|FrameXML/UIParent.lua}} __NOTOC__
- <center>'''ToggleGameMenu''' ''-Documentation by AlexanderYoshi-''</center>
-Opens/closes the game menu.
  ToggleGameMenu();
+Opens/closes the game menu.
-----
-;''Arguments''
+== Parameters ==
+=== Arguments ===
 :''none''
+=== Returns ===
-----
-;''Returns''
 :;nil
-----
-;''Example''
- ToggleGameMenu();
+== Example ==
-;''Result''
+ ToggleGameMenu();
+==Note==
-: Opens/closes the game menu.
+* The function itself is not protected; it calls the following protected functions which trigger the ACTION_BLOCKED event:<br />
+**[[API_SpellStopCasting|SpellStopCasting]]()<br />
+**[[API_SpellStopTargeting|SpellStopTargeting]]()<br />
+**[[API_ClearTarget|ClearTarget]]()
+* The name of this function is a bit of a misnomer, it's actually a handler that fires when the user presses the Escape key.