Formatting
No edit summary |
(Formatting) |
||
| Line 1: | Line 1: | ||
{{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. | ||
== Parameters == | |||
=== 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 === | |||
: SortWho appears to always return ''nil''. | : SortWho appears to always return ''nil''. | ||
'''''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. | ||
== 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. | ||