BIS fnc arrayUnShift: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |= Game name
| arma2 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| 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. |Description=
Array UnShift
____________________________________________________________________________________________


This function adds an element to the beginning of an array and returns the array.
| [array, value] call [[BIS_fnc_arrayUnShift]] |Syntax=
The array is passed by reference so changes inside the function will be reflected
outside of it.


Example:
|p1= array: [[Array]] |Parameter 1=
array = [2,3,4]
[array, 1] call BIS_fnc_ArrayUnshift
array2 = [[6,7,8], 5] call BIS_fnc_ArrayUnshift


array is now [1,2,3,4]
|p2= value: [[Anything]] |Parameter 2=
array2 is now [5,6,7,8]
************************************************************/


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


| <!-- [] call [[BIS_fnc_arrayUnShift]]; --> |= Syntax
|x1= <code>_array = [2,3,4];
 
[_array, 1] [[call]] [[BIS_fnc_arrayUnShift]]; {{codecomment|// _array is now [1,2,3,4]}}</code> |Example 1=
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________


|x1= <code></code> |=  
|x2= <code>_array = <nowiki>[</nowiki>[2,3,4], 1] [[call]] [[BIS_fnc_arrayUnShift]]; {{codecomment|// _array is now [1,2,3,4]}}</code> |Example 2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[BIS_fnc_arrayShift]], [[pushBack]], [[select]], [[set]] |See also=
 
}}
}}


Line 50: Line 37:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:arrayUnShift}}]]
[[Category:Function Group: Arrays|{{uc:arrayUnShift}}]]
[[Category:Function Group: Arrays|{{uc:arrayUnShift}}]]
[[Category:Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:arrayUnShift}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:arrayUnShift}}]]

Revision as of 00:28, 6 June 2018

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

Syntax

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

Examples

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

Additional Information

See also:
BIS_fnc_arrayShiftpushBackselectset

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