BIS_fnc_arrayShift

From Bohemia Interactive Community
Jump to navigation Jump to search
Introduced with Arma 2 version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Arma 2
Version:
1.00

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 to array deleteAt 0.

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

Execution:
call
Multiplayer:
-
See also:
deleteAtpushBack

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section