BIS fnc arrayShift: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - " |GROUP1" to "|GROUP1=") |
m (Text replacement - "\[\[Category\:Function Group\: Arrays(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "") |
||
| Line 39: | Line 39: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Functions|{{uc:arrayShift}}]] | [[Category:Functions|{{uc:arrayShift}}]] | ||
[[Category:{{Name|arma2}}: Functions|{{uc:arrayShift}}]] | [[Category:{{Name|arma2}}: Functions|{{uc:arrayShift}}]] | ||
Revision as of 12:16, 12 October 2020
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:
- Arrays
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