BIS fnc arrayPop: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1= Arrays|GROUP1=
|gr1= Arrays


| This function removes the last (rightmost) element of an array and returns it.<br>
| 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. |DESCRIPTION=
'''The array is passed by reference''' so changes inside the function will be reflected outside of it.


| array call [[BIS_fnc_arrayPop]] |SYNTAX=
| array call [[BIS_fnc_arrayPop]]


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


| [[Anything]] - the removed array element |RETURNVALUE=
| [[Anything]] - the removed array element


|x1= <code>_array = [1,2,3,4];
|x1= <code>_array = [1,2,3,4];
_removedElement = _array [[call]] [[BIS_fnc_arrayPop]]; {{codecomment|// _array is now [1,2,3] and _removedElement {{=}} 4}}</code> |EXAMPLE1=
_removedElement = _array [[call]] [[BIS_fnc_arrayPop]]; {{codecomment|// _array is now [1,2,3] and _removedElement {{=}} 4}}</code>


| [[deleteAt]], [[resize]] |SEEALSO=
| [[deleteAt]], [[resize]]
}}
}}



Revision as of 22:38, 17 January 2021

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:
_array = [1,2,3,4]; _removedElement = _array call BIS_fnc_arrayPop; // _array is now [1,2,3] and _removedElement = 4

Additional Information

See also:
deleteAtresize

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


Bottom Section