BIS fnc arrayShift: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (Text replacement - "<br />" to "<br>")
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| This function removes the first (leftmost) element of an array and returns it.<br />
| 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 />
The array is passed by reference so changes inside the function will be reflected outside of it.<br>
<br />
<br>
Similar to {{Inline code|array [[deleteAt]] 0}}. |DESCRIPTION=
Similar to {{Inline code|array [[deleteAt]] 0}}. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 12:39, 19 March 2020

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:
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

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

Notes

Bottom Section