BIS fnc arrayPop: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "<br />" to "<br>")
(6 intermediate revisions by 2 users not shown)
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 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=
Array Pop
 
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.
 
Example:
array = [1,2,3,4]
element = array call BIS_fnc_arrayPop
 
array is now [1,2,3]
element is now 4
************************************************************/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_arrayPop]]; --> |= Syntax
| array call [[BIS_fnc_arrayPop]] |SYNTAX=


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


| |= Return value
| [[Anything]] - the removed array element |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|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=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


Revision as of 11:58, 19 March 2020

Logo A2.png1.00
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:
Uncategorised

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_arrayPop&oldid=149577"