BIS fnc arrayShift: Difference between revisions

Latest revision as of 13:29, 27 July 2022

Hover & click on the images for 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.
In Arma 3, use array deleteAt 0.
Execution:: call
Groups:: Arrays

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

Example 1:: private _myArray = ["2", "report", "status"]; _removedElement = [_myArray] call BIS_fnc_arrayShift; // array is -within an array- _removedElement == "2"; // true _myArray isEqualTo ["report", "status"]; // true

: 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

@@ Line 5: / Line 5: @@
 |game2= arma2oa
-|version3= 1.50
+|version2= 1.50
 |game3= tkoh
@@ Line 18: / Line 18: @@
 The array is passed by reference so changes inside the function will be reflected outside of it.
-{{Feature|arma3|In {{arma3}}, use {{ic|array [[deleteAt]] 0}}.}}
+{{Feature|arma3|In {{arma3}}, use <sqf inline>array deleteAt 0</sqf>.}}
 |s1= [array] call [[BIS_fnc_arrayShift]]
-|p1= array: [[Array]] - '''NOTE:''' given array must be within an array (e.g {{ic|[<nowiki/>[10, 20, 30]] [[call]] [[BIS_fnc_arrayShift]]}})
+|p1= array: [[Array]] - '''NOTE:''' given array must be within an array (e.g <sqf inline>[[10, 20, 30]] call BIS_fnc_arrayShift</sqf>)
 |r1= [[Anything]] - the removed element
-|x1= <code>_myArray = ["2", "report", "status"];
+|x1= <sqf>
-_removedElement = [_myArray] [[call]] [[BIS_fnc_arrayShift]];	{{cc|array is '''within an array'''}}
+private _myArray = ["2", "report", "status"];
-_removedElement == "2";									{{cc|true}}
+_removedElement = [_myArray] call BIS_fnc_arrayShift;	// array is -within an array-
-_myArray [[isEqualTo]] ["report", "status"];				{{cc|true}}</code>
+_removedElement == "2";									// true
+_myArray isEqualTo ["report", "status"];				// true
+</sqf>
-|seealso= [[deleteAt]], [[pushBack]]
+|seealso= [[deleteAt]] [[pushBack]]
 }}
-[[Category:{{Name|arma2oa}}: Functions|{{uc:arrayShift}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:arrayShift}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:arrayShift}}]]