BIS fnc subSelect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |GROUP1 ____________________________________________________________________________________________" to " |GROUP1= ____________________________________________________________________________________________")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma2 |Game name=
| arma2 |Game name=
Line 7: Line 6:


|gr1= Arrays |GROUP1=
|gr1= Arrays |GROUP1=
____________________________________________________________________________________________


| Returns a sub-selection of the passed array. |Description=
| Returns a sub-selection of the passed array. |Description=
____________________________________________________________________________________________


| [array, start, endOrLength] call [[BIS_fnc_subSelect]] |Syntax=
| [array, start, endOrLength] call [[BIS_fnc_subSelect]] |Syntax=
Line 21: Line 18:


| [[Array]] |Return value=
| [[Array]] |Return value=
____________________________________________________________________________________________


|x1= <code>_array = ["a","b",[[true]],3,8];
|x1= <code>_array = ["a","b",[[true]],3,8];
Line 31: Line 27:


|x4= <code>[_array, 1, -2] [[call]] [[BIS_fnc_subSelect]]; {{codecomment|// returns ["b",true]}}</code> |Example 4=
|x4= <code>[_array, 1, -2] [[call]] [[BIS_fnc_subSelect]]; {{codecomment|// returns ["b",true]}}</code> |Example 4=
____________________________________________________________________________________________


| [[select]], [[count]], [[selectRandom]], [[BIS_fnc_arrayShuffle]], [[BIS_fnc_randomIndex]] |See also=
| [[select]], [[count]], [[selectRandom]], [[BIS_fnc_arrayShuffle]], [[BIS_fnc_randomIndex]] |See also=

Revision as of 23:54, 16 January 2021

Hover & click on the images for description

Description

Description:
Returns a sub-selection of the passed array.
Execution:
call
Groups:
Arrays

Syntax

Syntax:
[array, start, endOrLength] call BIS_fnc_subSelect
Parameters:
array: Array array to select sub array from
start: Number index of array to begin sub-array. If negative, index is counted from the end of array
endOrLength: Number - index of array to end the sub-array. If ommitted, remainder of the array will be selected. If negative, it specifies the length of the sub-array (in absolute form)
Return Value:
Array

Examples

Example 1:
_array = ["a","b",true,3,8]; [_array, 2] call BIS_fnc_subSelect; // returns [true,3,8]
Example 2:
[_array, -2] call BIS_fnc_subSelect; // returns [3,8]
Example 3:
[_array, 1, 3] call BIS_fnc_subSelect; // returns ["b",true,3]
Example 4:
[_array, 1, -2] call BIS_fnc_subSelect; // returns ["b",true]

Additional Information

See also:
selectcountselectRandomBIS_fnc_arrayShuffleBIS_fnc_randomIndex

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

Notes

Bottom Section