WoW:API SortWho - Revision history

Move page script: Move page script moved page API SortWho to WoW:API SortWho without leaving a redirect

2023-08-15T04:47:26Z

Move page script moved page API SortWho to API SortWho without leaving a redirect

← Older revision

Revision as of 04:47, 15 August 2023

WoWWiki>Mikk: Formatting

2006-09-22T22:41:57Z

Formatting

← Older revision		Revision as of 22:41, 22 September 2006
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.   --[[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}}~~

WoWWiki>Plynx at 12:55, 22 September 2006

2006-09-22T12:55:01Z

New page

<center>'''''SortWho''''' - ''Documentation by [[User:Plynx|Plynx]]''</center>

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

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

: '''sortType'''
:: 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'''''
: SortWho appears to always return ''nil''.

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

'''''Result'''''
: Displays the current who frame and applies a sort by level, reversing the sort if the frame was previously sorted by level.
----
'''''Notes'''''
:* 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.

----
{{template:WoW API}}