BIS fnc arrayPush: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (description)
m (Some wiki formatting)
 
(38 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 Push


This function adds an element to the end 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 end of an array and returns the array.<br>
array = [1,2,3]
'''The array is passed by reference''' so changes inside the function will be reflected outside of it.
[array, 4] call BIS_fnc_arrayPush
array2 = [[5,6,7], [8]] call BIS_fnc_arrayPush


array is now [1,2,3,4]
{{Feature|arma3|Use [[append]] or [[pushBack]] instead.}}
array2 is now [5,6,7,[8]]
************************************************************/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small>
|s1= [array, element] call [[BIS_fnc_arrayPush]]
{{Feature arma3|Use [[pushBack]] instead.}} |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_arrayPush]]; --> |= Syntax
|p1= array: [[Array]]


|p1= |= Parameter 1
|p2= element: [[Anything]]


| |= Return value
|r1= [[Array]] - modified ''array''
____________________________________________________________________________________________


|x1= <code></code> |=
|x1= <sqf>_newArray = [[0,1,2], 3] call BIS_fnc_arrayPush; // _newArray is [0,1,2,3]</sqf>
____________________________________________________________________________________________


| [[pushBack]], [[BIS_fnc_arrayPushStack]] |= See also
|x2= <sqf>private _array = [0,1,2]; [_array, [3]] call BIS_fnc_arrayPush; // _array is [0,1,2,[3]]</sqf>


|seealso= [[append]] [[pushBack]] [[BIS_fnc_arrayPushStack]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on Aug 1, 2014 - 21:15
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]<dd class="note">
(A3 1.26) It is recommended to use [[pushBack]] instead of [[BIS_fnc_arrayPush]].
<code>_array = [1,2,3];
_array [[pushBack]] 4; //same as [_array, 4] [[call]] [[BIS_fnc_arrayPush]];
</code>
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Arrays|{{uc:arrayPush}}]]
[[Category:Functions|{{uc:arrayPush}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:arrayPush}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:arrayPush}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:arrayPush}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:arrayPush}}]]

Latest revision as of 00:09, 13 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 end of an array and returns the array.
The array is passed by reference so changes inside the function will be reflected outside of it.
Arma 3
Use append or pushBack instead.
Execution:
call
Groups:
Arrays

Syntax

Syntax:
[array, element] call BIS_fnc_arrayPush
Parameters:
array: Array
element: Anything
Return Value:
Array - modified array

Examples

Example 1:
_newArray = [[0,1,2], 3] call BIS_fnc_arrayPush; // _newArray is [0,1,2,3]
Example 2:
private _array = [0,1,2]; [_array, [3]] call BIS_fnc_arrayPush; // _array is [0,1,2,[3]]

Additional Information

See also:
append pushBack BIS_fnc_arrayPushStack

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_arrayPush&oldid=327182"