BIS_fnc_arrayShift

1.00

Hover & click on the images for description

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.

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

See also:

deleteAtpushBack

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