BIS fnc arrayPop: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (Some wiki formatting)
 
(29 intermediate revisions by 2 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 last (rightmost) 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. |DESCRIPTION=
|version3= 1.00
____________________________________________________________________________________________


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


|p1= array: [[Array]] |PARAMETER1=
|gr1= Arrays


| [[Anything]] - the removed array element |RETURNVALUE=
|descr= This function removes the last (rightmost) 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>_array = [1,2,3,4];
|s1= array call [[BIS_fnc_arrayPop]]
_removedElement = _array [[call]] [[BIS_fnc_arrayPop]]; {{codecomment|// _array is now [1,2,3] and _removedElement {{=}} 4}}</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[deleteAt]], [[resize]] |SEEALSO=
|p1= array: [[Array]]
}}


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


<!-- Note Section END -->
|x1= <sqf>
</dl>
private _array = [1,2,3,4];
_removedElement = _array call BIS_fnc_arrayPop; // _array is now [1,2,3] and _removedElement = 4
</sqf>


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

Latest revision as of 23:31, 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 removes the last (rightmost) element of an array and returns it.
The array is passed by reference so changes inside the function will be reflected outside of it.
Execution:
call
Groups:
Arrays

Syntax

Syntax:
array call BIS_fnc_arrayPop
Parameters:
array: Array
Return Value:
Anything - the removed array element

Examples

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

Additional Information

See also:
deleteAt resize

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_arrayPop&oldid=327524"