BIS fnc subSelect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (Some wiki formatting)
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Returns a sub-selection of the passed array. |Description=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| [array, start, endOrLength] call [[BIS_fnc_subSelect]] |Syntax=
|game4= arma3
|version4= 0.50


|p1= array: [[Array]] array to select sub array from |Parameter 1=
|gr1= Arrays


|p2= start: [[Number]] index of array to begin sub-array. '''If negative''', index is counted from the end of array |Parameter 2=
|descr= Returns a sub-selection of the passed array.


|p3= 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) |Parameter 3=
|s1= [array, start, endOrLength] call [[BIS_fnc_subSelect]]


| [[Array]] |Return value=
|p1= array: [[Array]] array to select sub array from
____________________________________________________________________________________________


|x1= <code>_array = ["a","b",[[true]],3,8];
|p2= start: [[Number]] index of array to begin sub-array. '''If negative''', index is counted from the end of array
[_array, 2] [[call]] [[BIS_fnc_subSelect]]; {{codecomment|// returns [true,3,8]}}</code> |Example 1=


|x2= <code>[_array, -2] [[call]] [[BIS_fnc_subSelect]]; {{codecomment|// returns [3,8]}}</code> |Example 2=
|p3= 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)


|x3= <code>[_array, 1, 3] [[call]] [[BIS_fnc_subSelect]]; {{codecomment|// returns ["b",true,3]}}</code> |Example 3=
|r1= [[Array]]


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


| [[select]], [[count]], [[selectRandom]], [[BIS_fnc_arrayShuffle]], [[BIS_fnc_randomIndex]] |See also=
|x2= <sqf>[_array, -2] call BIS_fnc_subSelect; // returns [3,8]</sqf>
}}


<h3 style="display:none">Notes</h3>
|x3= <sqf>[_array, 1, 3] call BIS_fnc_subSelect; // returns ["b",true,3]</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x4= <sqf>[_array, 1, -2] call BIS_fnc_subSelect; // returns ["b",true]</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[select]] [[count]] [[selectRandom]] [[BIS_fnc_arrayShuffle]] [[BIS_fnc_randomIndex]]
[[Category:Functions|{{uc:subSelect}}]]
}}
[[Category:Function Group: Arrays|{{uc:subSelect}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:subSelect}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:subSelect}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:subSelect}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:subSelect}}]]

Latest revision as of 00:02, 13 July 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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:
private _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:
select count selectRandom BIS_fnc_arrayShuffle BIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_subSelect&oldid=327163"