WoW:API SortWho: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API SortWho to API SortWho without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<center>'''''SortWho''''' - ''Documentation by [[User:Plynx|Plynx]]''</center>
{{wowapi}} __NOTOC__
 
SortWho(sortType)


Sorts an existing /who list; displays the Who List frame if not visible.
Sorts an existing /who list; displays the Who List frame if not visible.


<pre>SortWho(sortType)</pre>
----
'''''Arguments'''''
: (string sortType)


: '''sortType'''
== Parameters ==
:: The type of sort you wish to apply to the who list.  This can be anything you could normally sort by clicking column headers in the Who frame:


=== Arguments ===
:(string sortType)
:;sortType:String - The type of sort you wish to apply to the who list.  This can be anything you could normally sort by clicking column headers in the Who frame:
::* "Name"
::* "Name"
::* "Level" (note that the column header is labeled Lvl)
::* "Level" (note that the column header is labeled Lvl)
Line 20: Line 21:
:: Any other value (but nil) for sortType is treated the same as "Name".
:: Any other value (but nil) for sortType is treated the same as "Name".


----
=== Returns ===
'''''Returns'''''
: SortWho appears to always return ''nil''.
: SortWho appears to always return ''nil''.


----
'''''Example'''''
<pre>SortWho("Level");</pre>


'''''Result'''''
== Triggers Events ==
 
{{Stub/API}}
''The API doesn't actually show the who list frame. It triggers an event that causes the frame to show. &nbsp; --[[User:Mikk|<span style="border-bottom: 1px dotted; cursor: help;" title="Mikk is a WoWWiki Admin">Mikk</span>]] <small>([[User talk:Mikk|T]])</small> 18:41, 22 September 2006 (EDT)''
 
 
== Example==
SortWho("Level");
 
=== Result ===
: Displays the current who frame and applies a sort by level, reversing the sort if the frame was previously sorted by level.
: Displays the current who frame and applies a sort by level, reversing the sort if the frame was previously sorted by level.
----
 
'''''Notes'''''
 
== Details ==
:* Calling the same sort twice will reverse the sort.
:* Calling the same sort twice will reverse the sort.


Line 37: Line 44:


:* Calling SortWho will display the who frame if it is not currently visible and apply the sort.
:* Calling SortWho will display the who frame if it is not currently visible and apply the sort.
----
{{template:WoW API}}

Latest revision as of 04:47, 15 August 2023

← WoW API < SortWho 

SortWho(sortType)

Sorts an existing /who list; displays the Who List frame if not visible.


Parameters[edit]

Arguments[edit]

(string sortType)
sortType
String - The type of sort you wish to apply to the who list. This can be anything you could normally sort by clicking column headers in the Who frame:
  • "Name"
  • "Level" (note that the column header is labeled Lvl)
  • "Class"
  • "Zone"
  • "Guild"
  • "Race"
Any other value (but nil) for sortType is treated the same as "Name".

Returns[edit]

SortWho appears to always return nil.


Triggers Events[edit]

The API doesn't actually show the who list frame. It triggers an event that causes the frame to show.   --Mikk (T) 18:41, 22 September 2006 (EDT)


Example[edit]

SortWho("Level");

Result[edit]

Displays the current who frame and applies a sort by level, reversing the sort if the frame was previously sorted by level.


Details[edit]

  • Calling the same sort twice will reverse the sort.
  • You may sort by Guild, Race, or Zone even if it is not the currently selected second column on the who frame.
  • Calling SortWho will display the who frame if it is not currently visible and apply the sort.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_SortWho&oldid=19876"