sortInitiative: Difference between revisions

VisualWikitext

Latest revision as of 17:44, 14 March 2023

This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

sortInitiative() Function

Note: This function can only be used in a Trusted Macro

• Introduced in version 1.3b41

Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel.

The Default sort order is descending, with any non-numeric values coming after any numbers, and any blank values coming last.
Since 1.8: If the reverseOrder parameter is 1, this order is reversed - blank values come first, and any non-numeric strings (in ascending lexical order) come before numbers (in ascending order).

Usage

sortInitiative()
sortInitiative(reverseOrder)

Parameters

reverseOrder - Since 1.8. Whether the list should be sorted in Reverse (ascending) order - defaults to false (0)

Example

Examples showing each sort order:

	Default Order	Reverse Order
Command	`sortInitiative()` `sortInitiative(0)`	`sortInitiative(1)`
Result

Version Changes

1.3b41 - Added function.
1.8 - Added optional param to control the order used when sorting

@@ Line 1: / Line 1: @@
-==Function sortInitiative==
+{{stub}}
-{{GMOnlyFunction}}
+{{MacroFunction
-Sorts the [[Initiative:Initiative Panel|Initiative Panel]] [[Token:Token|Token]]s and returns the number of [[Token:Token|Token]]s in the [[Initiative:Initiative Panel|Initiative Panel]].
+|name=sortInitiative
+|trusted=true
+|version=1.3b41
+|description=
+Sorts the [[Initiative:Initiative Panel|Initiative Panel]] [[Token]]s and returns the number of [[Token]]s in the [[Initiative:Initiative Panel|Initiative Panel]].
+* The Default sort order is ''descending'', with any non-numeric values coming after any numbers, and any blank values coming last.
+* ''Since 1.8'': If the {{code|reverseOrder}} parameter is {{code|1}}, this order is reversed - blank values come first, and any non-numeric strings (in ascending lexical order) come before numbers (in ascending order).
-===Usage===
+|usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: numTokens = sortInitiative()]
+sortInitiative()
-</source>
+sortInitiative(reverseOrder)
+</syntaxhighlight>
+'''Parameters'''
+{{param|reverseOrder|''Since 1.8''. Whether the list should be sorted in Reverse (ascending) order - defaults to {{code|false}} ({{code|0}})}}
+|example=
+Examples showing each sort order:
+{{{!}} class="wikitable"
+{{!}}-
+!
+!Default Order
+!Reverse Order
+{{!}}-
+!Command
+{{!}}{{code|sortInitiative()}}<br/>{{code|sortInitiative(0)}}
+{{!}}{{code|sortInitiative(1)}}
+{{!}}-
+!Result
+{{!}}[[File:InitiativePanel_DefaultOrder.png]]
+{{!}}[[File:InitiativePanel_ReverseOrder.png]]
+{{!}}}
+|changes=
+* '''1.3b41''' - Added function.
+* '''1.8''' - Added optional param to control the order used when sorting
+}}
+[[Category:Initiative Function]]