WoW:API ToggleFriendsFrame: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 3: Line 3:
Opens/closes the friends pane.
Opens/closes the friends pane.


  ToggleFriendsFrame(tabIndex);
  ToggleFriendsFrame(tabIndex)


----
== Parameters ==
;''Arguments''
===Arguments===


:''tabIndex'' optional - picks a specific tab in the friends frame
:;''tabIndex'' : Number - (optional) picks a specific tab in the friends frame
: 1 = friends tab
::* 1 = friends tab
: 2 = who tab
::* 2 = who tab
: 3 = guild tab
::* 3 = guild tab
: 4 = raid tab
::* 4 = raid tab
: default = last open tab
::* default = last open tab


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


:;nil
:;nil


----
==Example==
;''Example''
  ToggleFriendsFrame(3)
  ToggleFriendsFrame(3);


;''Result''
====Result====
: If the friends frame was already open, this closes the frame.
: If the friends frame was already open, this closes the frame.
: If it was not already open, it is opened at the guild tab.
: If it was not already open, it is opened at the guild tab.
----
;''Description''
: Opens/closes the friends pane.


----
----
{{WoW API}}
{{WoW API}}
__NOTOC__

Revision as of 19:56, 7 January 2006

ToggleFriendsFrame -Documentation by AlexanderYoshi, updated by Suru-

Opens/closes the friends pane.

ToggleFriendsFrame(tabIndex)

Parameters

Arguments

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

nil

Example

ToggleFriendsFrame(3)

Result

If the friends frame was already open, this closes the frame.
If it was not already open, it is opened at the guild tab.

Template:WoW API