BIS fnc arrayUnShift: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) 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 | {{Function | ||
| arma2 | | arma2 | ||
|1.00 | |1.00 | ||
|gr1= Arrays | |gr1= Arrays | ||
| This function adds an element to the beginning of an array and returns the array. | | This function adds an element to the beginning of an array and returns the array. | ||
The array is passed by reference so changes inside the function will be reflected outside of it. | The array is passed by reference so changes inside the function will be reflected outside of it. | ||
| [array, value] call [[BIS_fnc_arrayUnShift]] | | [array, value] call [[BIS_fnc_arrayUnShift]] | ||
|p1= array: [[Array]] | |p1= array: [[Array]] | ||
|p2= value: [[Anything]] | |p2= value: [[Anything]] | ||
| [[Array]] - ''array'' reference | | [[Array]] - ''array'' reference | ||
|x1= <code>_array = [2,3,4]; | |x1= <code>_array = [2,3,4]; | ||
[_array, 1] [[call]] [[BIS_fnc_arrayUnShift]]; {{codecomment|// _array is now [1,2,3,4]}}</code> | [_array, 1] [[call]] [[BIS_fnc_arrayUnShift]]; {{codecomment|// _array is now [1,2,3,4]}}</code> | ||
|x2= <code>_array = [<nowiki/>[2,3,4], 1] [[call]] [[BIS_fnc_arrayUnShift]]; {{codecomment|// _array is now [1,2,3,4]}}</code> | |x2= <code>_array = [<nowiki/>[2,3,4], 1] [[call]] [[BIS_fnc_arrayUnShift]]; {{codecomment|// _array is now [1,2,3,4]}}</code> | ||
| [[BIS_fnc_arrayShift]], [[pushBack]], [[select]], [[set]] | | [[BIS_fnc_arrayShift]], [[pushBack]], [[select]], [[set]] | ||
}} | }} | ||
Revision as of 22:38, 17 January 2021
Description
- Description:
- This function adds an element to the beginning of an array and returns the array. The array is passed by reference so changes inside the function will be reflected outside of it.
- Execution:
- call
- Groups:
- Arrays
Syntax
- Syntax:
- [array, value] call BIS_fnc_arrayUnShift
- Parameters:
- array: Array
- value: Anything
- Return Value:
- Array - array reference
Examples
- Example 1:
_array = [2,3,4]; [_array, 1] call BIS_fnc_arrayUnShift; // _array is now [1,2,3,4]- Example 2:
_array = [[2,3,4], 1] call BIS_fnc_arrayUnShift; // _array is now [1,2,3,4]
Additional Information
- See also:
- BIS_fnc_arrayShiftpushBackselectset
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