BIS fnc arrayShift: 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|= Comments | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 8: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | This function removes the first (leftmost) element of an array and returns it.<br /> | ||
The array is passed by reference so changes inside the function will be reflected outside of it.<br /> | |||
<br /> | |||
Similar to {{Inline code|array [[deleteAt]] 0}}. |= Description | |||
This function removes the first (leftmost) element of an array and returns it. | |||
The array is passed by reference so changes inside the function will be reflected | |||
outside of it. | |||
</ | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [array] call [[BIS_fnc_arrayShift]] |= Syntax | ||
|p1= |= Parameter 1 | |p1= array: [[Array]] - '''NOTE:''' given array must be within an array (e.g {{Inline code|<nowiki>[</nowiki>[10, 20, 30]] call BIS_fnc_arrayShift}}) |= Parameter 1 | ||
| |= Return value | | [[Anything]] - the removed element |= Return value | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code></code> |= | |x1= <code>_myArray = ["2", "report", "status"]; | ||
_removedElement = [_myArray] [[call]] [[BIS_fnc_arrayShift]]; {{codecomment|// array is '''within an array'''}} | |||
_removedElement == "2"; {{codecomment|// true}} | |||
_myArray [[isEqualTo]] ["report", "status"]; {{codecomment|// true}}</code> |= Example 1 | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| |= See also | | [[deleteAt]], [[pushBack]] |= See also | ||
}} | }} | ||
Revision as of 20:18, 5 May 2018
Description
- Description:
- This function removes the first (leftmost) element of an array and returns it.
The array is passed by reference so changes inside the function will be reflected outside of it.
Similar toarray deleteAt 0. - Execution:
- call
- Groups:
- Uncategorised
Syntax
- Syntax:
- [array] call BIS_fnc_arrayShift
- Parameters:
- array: Array - NOTE: given array must be within an array (e.g
[[10, 20, 30]] call BIS_fnc_arrayShift) - Return Value:
- Anything - the removed element
Examples
- Example 1:
_myArray = ["2", "report", "status"]; _removedElement = [_myArray] call BIS_fnc_arrayShift; // array is within an array _removedElement == "2"; // true _myArray isEqualTo ["report", "status"]; // 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