BIS fnc sortBy: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - " |GROUP1 ____________________________________________________________________________________________" to " |GROUP1= ____________________________________________________________________________________________") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= Arrays |GROUP1= | |gr1= Arrays |GROUP1= | ||
| Sorts an array according to given algorithm. See [[sort]] for simple sorts. |Description= | | Sorts an array according to given algorithm. See [[sort]] for simple sorts. |Description= | ||
| [array, parameters, algorithm, direction, filter] call [[BIS_fnc_sortBy]] |Syntax= | | [array, parameters, algorithm, direction, filter] call [[BIS_fnc_sortBy]] |Syntax= | ||
| Line 32: | Line 29: | ||
| [[Array]] - sorted array |Return value= | | [[Array]] - sorted array |Return value= | ||
|x1= <code>{{cc|sort numbers from lowest to highest}} | |x1= <code>{{cc|sort numbers from lowest to highest}} | ||
| Line 42: | Line 38: | ||
|x3= <code>{{cc|sort enemy by distance from friendly unit (referenced by local variable), the furthest first}} | |x3= <code>{{cc|sort enemy by distance from friendly unit (referenced by local variable), the furthest first}} | ||
_furtherstEnemy = [<nowiki/>[_enemy1,_enemy2,_enemy3], [_friendly], { _input0 [[distance]] _x }, "DESCEND", { [[canMove]] _x }] [[call]] [[BIS_fnc_sortBy]];</code> |Example 3= | _furtherstEnemy = [<nowiki/>[_enemy1,_enemy2,_enemy3], [_friendly], { _input0 [[distance]] _x }, "DESCEND", { [[canMove]] _x }] [[call]] [[BIS_fnc_sortBy]];</code> |Example 3= | ||
| [[BIS_fnc_sortAlphabetically]], [[BIS_fnc_sortNum]], [[sort]] |See also= | | [[BIS_fnc_sortAlphabetically]], [[BIS_fnc_sortNum]], [[sort]] |See also= | ||
Revision as of 00:46, 17 January 2021
Description
- Description:
- Sorts an array according to given algorithm. See sort for simple sorts.
- Execution:
- call
- Groups:
- Arrays
Syntax
- Syntax:
- [array, parameters, algorithm, direction, filter] call BIS_fnc_sortBy
- Parameters:
- array: Array - any unsorted array. Can contain any types
- parameters: Array
- used in the eval algorithm
- input params are referenced in the sorting algorithm by _input0..9
- a maximum of 10 input params is supported (0-9)
- algorithm: Code - (Optional, default { _x })
- direction: String - (Optional, default "ASCEND") case-insensitive
- "ASCEND" for ascending sorting
- "DESCEND" (or anything else) for descending sorting
- filter: Code - (Optional, default { true }) code that needs to evaluate true for the array item to be sorted, otherwise item is removed
- Return Value:
- Array - sorted array
Examples
- Example 1:
// sort numbers from lowest to highest _sortedNumbers = [[1,-80,0,480,15,-40], [], {_x}, "ASCEND"] call BIS_fnc_sortBy;- Example 2:
// sort helicopters by distance from player _closestHelicopters = [[_heli1,_heli2,_heli3], [], { player distance _x }, "ASCEND"] call BIS_fnc_sortBy;- Example 3:
// sort enemy by distance from friendly unit (referenced by local variable), the furthest first _furtherstEnemy = [[_enemy1,_enemy2,_enemy3], [_friendly], { _input0 distance _x }, "DESCEND", { canMove _x }] call BIS_fnc_sortBy;
Additional Information
Notes
-
Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note