BIS fnc arrayShift: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(35 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/************************************************************
|version4= 0.50
Array Shift


This function removes the first (leftmost) element of an array and returns it.
|gr1= Arrays
The array is passed by reference so changes inside the function will be reflected
outside of it.


Example:
|descr= This function removes the first (leftmost) element of an array and returns it.<br>
array = [1,2,3,4]
The array is passed by reference so changes inside the function will be reflected outside of it.
element = [array] call BIS_fnc_arrayShift


array is now [2,3,4]
{{Feature|arma3|In {{arma3}}, use <sqf inline>array deleteAt 0</sqf>.}}
element is now 1
************************************************************/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|s1= [array] call [[BIS_fnc_arrayShift]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_arrayShift]]; --> |= Syntax
|p1= array: [[Array]] - '''NOTE:''' given array must be within an array (e.g <sqf inline>[[10, 20, 30]] call BIS_fnc_arrayShift</sqf>)


|p1= |= Parameter 1
|r1= [[Anything]] - the removed element


| |= Return value
|x1= <sqf>
____________________________________________________________________________________________
private _myArray = ["2", "report", "status"];
 
_removedElement = [_myArray] call BIS_fnc_arrayShift; // array is -within an array-
|x1= <code></code> |=
_removedElement == "2"; // true
____________________________________________________________________________________________
_myArray isEqualTo ["report", "status"]; // true
 
</sqf>
| |= See also


|seealso= [[deleteAt]] [[pushBack]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Arrays|{{uc:arrayShift}}]]
[[Category:Functions|{{uc:arrayShift}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:arrayShift}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:arrayShift}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:arrayShift}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:arrayShift}}]]

Latest revision as of 14:29, 27 July 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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.
Arma 3
In Arma 3, use 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:
private _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:
deleteAt pushBack

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_arrayShift&oldid=329366"