BIS fnc arrayShift: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(32 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


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


| [array] call [[BIS_fnc_arrayShift]] |SYNTAX=
|game4= arma3
|version4= 0.50


|p1= array: [[Array]] - '''NOTE:''' given array must be within an array (e.g {{Inline code|<nowiki>[</nowiki>[10, 20, 30]] call BIS_fnc_arrayShift}}) |= Parameter 1
|gr1= Arrays


| [[Anything]] - the removed element |RETURNVALUE=
|descr= 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.


|x1= <code>_myArray = ["2", "report", "status"];
{{Feature|arma3|In {{arma3}}, use <sqf inline>array deleteAt 0</sqf>.}}
_removedElement = [_myArray] [[call]] [[BIS_fnc_arrayShift]]; {{codecomment|// array is '''within an array'''}}
_removedElement == "2"; {{codecomment|// true}}
_myArray [[isEqualTo]] ["report", "status"]; {{codecomment|// true}}</code> |= Example 1
____________________________________________________________________________________________


| [[deleteAt]], [[pushBack]] |SEEALSO=
|s1= [array] 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>)


<h3 style="display:none">Notes</h3>
|r1= [[Anything]] - the removed element
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>
</dl>
private _myArray = ["2", "report", "status"];
_removedElement = [_myArray] call BIS_fnc_arrayShift; // array is -within an array-
_removedElement == "2"; // true
_myArray isEqualTo ["report", "status"]; // true
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[deleteAt]] [[pushBack]]
[[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 13: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"