WoW:API ToggleFriendsFrame: 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/FriendsFrame.lua.

ToggleFriendsFrame(tabIndex)

Opens/closes the friends pane.

tabIndex

Number - (optional) picks a specific tab in the friends frame

ToggleFriendsFrame(3)

If the friends frame was already open, this closes the frame.

If it was not already open, it is opened at the guild tab.

@@ Line 1: / Line 1: @@
- <center>'''ToggleFriendsFrame''' ''-Documentation by AlexanderYoshi-''</center>
+<br>{{framexmlfunc|FrameXML/FriendsFrame.lua}} __NOTOC__
+ ToggleFriendsFrame(tabIndex)
 Opens/closes the friends pane.
- ToggleFriendsFrame();
-----
+== Parameters ==
-;''Arguments''
+===Arguments===
-:''none''
+:;''tabIndex'' : Number - (optional) picks a specific tab in the friends frame
+::* 1 = friends tab
+::* 2 = who tab
+::* 3 = guild tab
+::* 4 = raid tab
+::* default = last open tab
-----
+===Returns===
-;''Returns''
 :;nil
-----
+==Example==
-;''Example''
+  ToggleFriendsFrame(3)
-  ToggleFriendsFrame();
-;''Result''
-----
-;''Description''
-: Opens/closes the friends pane.
+====Result====
-----
+: If the friends frame was already open, this closes the frame.
-{{Template:WoW API}}
+: If it was not already open, it is opened at the guild tab.