BIS fnc arrayPush: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(36 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 adds an element to the end of an array and returns the array.<br />
|game3= tkoh
'''The array is passed by reference''' so changes inside the function will be reflected outside of it.
|version3= 1.00


{{Feature arma3|Use [[append]] or [[pushBack]] instead.}} |DESCRIPTION=
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| [array, element] call [[BIS_fnc_arrayPush]] |SYNTAX=
|gr1= Arrays


|p1= array: [[Array]] |= Parameter 1
|descr= This function adds an element to the end of an array and returns the array.<br>
'''The array is passed by reference''' so changes inside the function will be reflected outside of it.


|p2= element: [[Anything]] |= Parameter 2
{{Feature|arma3|Use [[append]] or [[pushBack]] instead.}}


| [[Array]] - modified ''array'' |RETURNVALUE=
|s1= [array, element] call [[BIS_fnc_arrayPush]]
____________________________________________________________________________________________


|x1= <code><nowiki>_newArray = [</nowiki>[0,1,2], 3] [[call]] [[BIS_fnc_arrayPush]]; {{codecomment|// _newArray is [0,1,2,3]}}</code> |= Example 1
|p1= array: [[Array]]


|x2= <code>_array = [0,1,2]; [_array, [3]] [[call]] [[BIS_fnc_arrayPush]]; {{codecomment|// _array is [0,1,2,[3]]}}</code> |= Example 2
|p2= element: [[Anything]]
____________________________________________________________________________________________


| [[append]], [[pushBack]], [[BIS_fnc_arrayPushStack]] |SEEALSO=
|r1= [[Array]] - modified ''array''
}}


<h3 style="display:none">Notes</h3>
|x1= <sqf>_newArray = [[0,1,2], 3] call BIS_fnc_arrayPush; // _newArray is [0,1,2,3]</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>private _array = [0,1,2]; [_array, [3]] call BIS_fnc_arrayPush; // _array is [0,1,2,[3]]</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[append]] [[pushBack]] [[BIS_fnc_arrayPushStack]]
[[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 23:09, 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 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"