BIS fnc arrayUnShift: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(36 intermediate revisions by 3 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 UnShift


This function adds an element to the beginning of an array and returns the array.
|gr1= Arrays
The array is passed by reference so changes inside the function will be reflected
outside of it.


Example:
|descr= This function adds an element to the beginning of an array and returns the array.
array = [2,3,4]
The array is passed by reference so changes inside the function will be reflected outside of it.
[array, 1] call BIS_fnc_ArrayUnshift
array2 = [[6,7,8], 5] call BIS_fnc_ArrayUnshift


array is now [1,2,3,4]
|s1= [array, value] call [[BIS_fnc_arrayUnShift]]
array2 is now [5,6,7,8]
************************************************************/


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


| <!-- [] call [[BIS_fnc_arrayUnShift]]; --> |= Syntax
|p2= value: [[Anything]]


|p1= |= Parameter 1
|r1= [[Array]] - ''array'' reference


| |= Return value
|x1= <sqf>private _array = [2,3,4];
____________________________________________________________________________________________
[_array, 1] call BIS_fnc_arrayUnShift; // _array is now [1,2,3,4]</sqf>


|x1= <code></code> |=
|x2= <sqf>private _array = [[2,3,4], 1] call BIS_fnc_arrayUnShift; // _array is now [1,2,3,4]</sqf>
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_arrayShift]] [[pushBack]] [[select]] [[set]]
}}
}}
<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:arrayUnShift}}]]
[[Category:Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:arrayUnShift}}]]

Latest revision as of 23:16, 12 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 adds an element to the beginning of an array and returns the array. The array is passed by reference so changes inside the function will be reflected outside of it.
Execution:
call
Groups:
Arrays

Syntax

Syntax:
[array, value] call BIS_fnc_arrayUnShift
Parameters:
array: Array
value: Anything
Return Value:
Array - array reference

Examples

Example 1:
private _array = [2,3,4]; [_array, 1] call BIS_fnc_arrayUnShift; // _array is now [1,2,3,4]
Example 2:
private _array = [[2,3,4], 1] call BIS_fnc_arrayUnShift; // _array is now [1,2,3,4]

Additional Information

See also:
BIS_fnc_arrayShift pushBack select set

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_arrayUnShift&oldid=327477"