BIS fnc arrayShift: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
m (template:command argument fix) |
||
| Line 15: | Line 15: | ||
| [array] call [[BIS_fnc_arrayShift]] |SYNTAX= | | [array] call [[BIS_fnc_arrayShift]] |SYNTAX= | ||
|p1= array: [[Array]] - '''NOTE:''' given array must be within an array (e.g {{Inline code|<nowiki>[</nowiki>[10, 20, 30]] call BIS_fnc_arrayShift}}) |= | |p1= array: [[Array]] - '''NOTE:''' given array must be within an array (e.g {{Inline code|<nowiki>[</nowiki>[10, 20, 30]] call BIS_fnc_arrayShift}}) |PARAMETER1= | ||
| [[Anything]] - the removed element |RETURNVALUE= | | [[Anything]] - the removed element |RETURNVALUE= | ||
| Line 23: | Line 23: | ||
_removedElement = [_myArray] [[call]] [[BIS_fnc_arrayShift]]; {{codecomment|// array is '''within an array'''}} | _removedElement = [_myArray] [[call]] [[BIS_fnc_arrayShift]]; {{codecomment|// array is '''within an array'''}} | ||
_removedElement == "2"; {{codecomment|// true}} | _removedElement == "2"; {{codecomment|// true}} | ||
_myArray [[isEqualTo]] ["report", "status"]; {{codecomment|// true}}</code> |= | _myArray [[isEqualTo]] ["report", "status"]; {{codecomment|// true}}</code> |EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 14:28, 7 April 2019
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