sortInitiative
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.
- Coming in 1.8: If the
reverseOrderparameter is1, 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()Options Coming in 1.8
sortInitiative(reverseOrder)Parameters
reverseOrder- Coming in 1.8. Whether the list should be sorted in Reverse (ascending) order - defaults tofalse(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