BIS fnc subSelect: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
Lou Montana (talk | contribs) (Page filling) |
||
Line 1: | Line 1: | ||
{{Function|Comments= | |||
{{Function|= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| arma2 | | | arma2 |Game name= | ||
|1.00| | |1.00|Game version= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | Returns a sub-selection of the passed array. |Description= | ||
____________________________________________________________________________________________ | |||
Returns a sub-selection of the passed array. | |||
array | | [array, start, endOrLength] call [[BIS_fnc_subSelect]] |Syntax= | ||
|p1= array: [[Array]] array to select sub array from |Parameter 1= | |||
|p2= start: [[Number]] index of array to begin sub-array. '''If negative''', index is counted from the end of array |Parameter 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) |Parameter 3= | |||
| [[Array]] |Return value= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| < | |x1= <code>_array = ["a","b",[[true]],3,8]; | ||
[_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= | ||
| |= | |x3= <code>[_array, 1, 3] [[call]] [[BIS_fnc_subSelect]]; {{codecomment|// returns ["b",true,3]}}</code> |Example 3= | ||
| | |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= | ||
}} | }} | ||
Line 60: | Line 42: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Functions|{{uc:subSelect}}]] | |||
[[Category:Function Group: Arrays|{{uc:subSelect}}]] | [[Category:Function Group: Arrays|{{uc:subSelect}}]] | ||
[[Category:{{Name|arma2}}: Functions|{{uc:subSelect}}]] | [[Category:{{Name|arma2}}: Functions|{{uc:subSelect}}]] | ||
[[Category:{{Name|arma2oa}}: Functions|{{uc:subSelect}}]] | [[Category:{{Name|arma2oa}}: Functions|{{uc:subSelect}}]] | ||
[[Category:{{Name|tkoh}}: Functions|{{uc:subSelect}}]] | [[Category:{{Name|tkoh}}: Functions|{{uc:subSelect}}]] | ||
[[Category:{{Name|arma3}}: Functions|{{uc:subSelect}}]] | [[Category:{{Name|arma3}}: Functions|{{uc:subSelect}}]] |
Revision as of 14:21, 1 June 2018
Description
- Description:
- Returns a sub-selection of the passed array.
- Execution:
- call
- Groups:
- Uncategorised
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
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