listSort: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
(4 intermediate revisions by 3 users not shown)
Line 2: Line 2:
{{MacroFunction
{{MacroFunction
|name=listSort
|name=listSort
|description
|description=
Returns a sorted list.
Returns a sorted list.


Line 8: Line 8:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[listSort(list, sortType)]
[listSort(list, sortType)]
[listSort(list, sortType, delim)]
</source>
</source>
'''Parameters'''
{{param|list|The list that is sorted.}}
{{param|sortType|The direction that this list is sorted. "A+" - alpha ascending, "A-" - alpha descending, "N-" - padded ending numbers descending alpha}}
{{param|delim|The delimiter used in the separate the list, defaults to {{code|","}}.}}
The sortType determines the type of sort to use.
The sortType determines the type of sort to use.
If sortType is "A", normal alphabetic sorting is used, and "Monster11" comes before "Monster3". (Default behavior)
If sortType is "A", normal alphabetic sorting is used, and "Monster11" comes before "Monster3". (Default behavior)
If sortType is "N", the first number in each entry is effectively padded to 4 digits, so that "Monster3" comes before "Monster11".
If sortType is "N", the first number in each entry is effectively padded to 4 digits, so that "Monster3" comes before "Monster11".
The sortType can have a second character of "+" or "-" to specify an ascending or descending sort.
The sortType can have a second character of "+" or "-" to specify an ascending or descending sort.
|example=
<source lang="mtmacro" line>
[h: UnsortedList = "Monster11,Monster3,Monster12,Monster66,Monster87,Monster71"]
[h: SortedList = listSort(UnsortedList,'N')]
Unsorted list: [r: UnsortedList]<br>
Sorted list: [r: SortedList]
</source>
Returns:
  Unsorted list: Monster11,Monster3,Monster12,Monster66,Monster87,Monster71
  Sorted list: Monster3, Monster11, Monster12, Monster66, Monster71, Monster87
}}
}}
[[Category:String List Function]]
[[Category:String List Function]]

Revision as of 19:58, 11 December 2019

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

listSort() Function

Returns a sorted list.

Usage

[listSort(list, sortType)]
[listSort(list, sortType, delim)]

Parameters

  • list - The list that is sorted.
  • sortType - The direction that this list is sorted. "A+" - alpha ascending, "A-" - alpha descending, "N-" - padded ending numbers descending alpha
  • delim - The delimiter used in the separate the list, defaults to ",".

The sortType determines the type of sort to use. If sortType is "A", normal alphabetic sorting is used, and "Monster11" comes before "Monster3". (Default behavior) If sortType is "N", the first number in each entry is effectively padded to 4 digits, so that "Monster3" comes before "Monster11". The sortType can have a second character of "+" or "-" to specify an ascending or descending sort.

Example

[h: UnsortedList = "Monster11,Monster3,Monster12,Monster66,Monster87,Monster71"]
[h: SortedList = listSort(UnsortedList,'N')]

Unsorted list: [r: UnsortedList]<br>
Sorted list: [r: SortedList]

Returns:

 Unsorted list: Monster11,Monster3,Monster12,Monster66,Monster87,Monster71
Sorted list: Monster3, Monster11, Monster12, Monster66, Monster71, Monster87