WoW:API ToggleGameMenu: Difference between revisions

Latest revision as of 04:47, 15 August 2023

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

This function is implemented in Lua here 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: @@
- <center>'''ToggleGameMenu''' ''-Documentation by AlexanderYoshi-''</center>
+{{protectedapi|2.0.1|}}
+<br>{{framexmlfunc|FrameXML/UIParent.lua}} __NOTOC__
+ ToggleGameMenu();
 Opens/closes the game menu.
- ToggleGameMenu();
-----
+== Parameters ==
-;''Arguments''
+=== Arguments ===
 :''none''
-----
+=== Returns ===
-;''Returns''
 :;nil
-----
-;''Example''
+== Example ==
   ToggleGameMenu();
-;''Result''
+==Note==
+* The function itself is not protected; it calls the following protected functions which trigger the ACTION_BLOCKED event:<br />
-----
+**[[API_SpellStopCasting|SpellStopCasting]]()<br />
-;''Description''
+**[[API_SpellStopTargeting|SpellStopTargeting]]()<br />
+**[[API_ClearTarget|ClearTarget]]()
-: Opens/closes the game menu.
+* 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.
-----
-{{WoW API}}