BIS fnc sortBy: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 0.58


|arma3 |= Game name
|gr1= Arrays


|0.58|= Game version
|descr= Sorts an array according to given algorithm. See [[sort]] for simple sorts.
____________________________________________________________________________________________


|Sorts an array according to given algorithm.|= Description
|s1= [array, parameters, algorithm, direction, filter] call [[BIS_fnc_sortBy]]
____________________________________________________________________________________________
|[] call [[BIS_fnc_sortBy]]; |= Syntax
____________________________________________________________________________________________
|p1= [[Array]] - Unsorted array which can contain any types ([[object]]/[[numbers]]/[[strings]] ..) |= Parameter 1
|p2= [[Array]] - - used in the eval algorithm (object/numbers/strings ..)
                - input params are referenced in the sorting algorithm by _input0, _input1 .. _input9
                - max. number of 10 input params is supported (0-9)|= Parameter 2


|p3= [[Code]] - sorted algorithm [optional: default {_x}] |= Parameter 3
|p1= array: [[Array]] - any unsorted array. Can contain any types


|p4= [[String]] -sort direction [optional: default "ASCEND"]
|p2= parameters: [[Array]]
"ASCEND": sorts array in ascending direction (from lowest value to highest)
* used in the eval algorithm
"DESCEND": sorts array in descending direction |= Parameter 4
* input params are referenced in the sorting algorithm by _input0..9
* a maximum of 10 input params is supported (0-9)


|p3= algorithm: [[Code]] - (Optional, default <sqf inline>{ _x }</sqf>)
* needs to return [[String]], [[Number]] or [[Array]] - see [[sort]]
* [[Magic Variables#x|_x]] refers to array item


|p5= [[Code]] - filter default {true}] - code that needs to evaluate true for the array item to be sorted, otherwise item is removed |= Parameter 5
|p4= direction: [[String]] - (Optional, default "ASCEND") case-insensitive
* "ASCEND" for ascending sorting
* "DESCEND" (or anything else) for descending sorting


____________________________________________________________________________________________
|p5= filter: [[Code]] - (Optional, default <sqf inline>{ true }</sqf>) code that needs to evaluate true for the array item to be sorted, otherwise item is removed
|[[Array]]|= Return value
____________________________________________________________________________________________


|r1= [[Array]] - sorted array


____________________________________________________________________________________________
|x1= <sqf>
// sort numbers from lowest to highest
_sortedNumbers = [[1,-80,0,480,15,-40], [], {_x}, "ASCEND"] call BIS_fnc_sortBy;
</sqf>


|x2= <sqf>
// sort helicopters by distance from player
_closestHelicopters = [[_heli1,_heli2,_heli3], [], { player distance _x }, "ASCEND"] call BIS_fnc_sortBy;
</sqf>


| [[BIS_fnc_sortAlphabetically]], [[BIS_fnc_sortNum]], [[sort]] |= See also
|x3= <sqf>
// 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;
</sqf>


|seealso= [[BIS_fnc_sortAlphabetically]] [[BIS_fnc_sortNum]] [[sort]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Arrays|{{uc:sortBy}}]]
[[Category:Functions|{{uc:sortBy}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sortBy}}]]

Latest revision as of 15:57, 13 July 2022

Arma 3 logo black.png0.58
Hover & click on the images for description

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

See also:
BIS_fnc_sortAlphabetically BIS_fnc_sortNum sort

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_sortBy&oldid=327964"