BIS fnc arrayUnShift: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Arrays(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma2 |Game name= | | arma2 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= Arrays|GROUP1= | |gr1= Arrays|GROUP1= | ||
| 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. |Description= | The array is passed by reference so changes inside the function will be reflected outside of it. |Description= | ||
| [array, value] call [[BIS_fnc_arrayUnShift]] |Syntax= | | [array, value] call [[BIS_fnc_arrayUnShift]] |Syntax= | ||
| Line 20: | Line 17: | ||
| [[Array]] - ''array'' reference |Return value= | | [[Array]] - ''array'' reference |Return value= | ||
|x1= <code>_array = [2,3,4]; | |x1= <code>_array = [2,3,4]; | ||
| Line 26: | Line 22: | ||
|x2= <code>_array = [<nowiki/>[2,3,4], 1] [[call]] [[BIS_fnc_arrayUnShift]]; {{codecomment|// _array is now [1,2,3,4]}}</code> |Example 2= | |x2= <code>_array = [<nowiki/>[2,3,4], 1] [[call]] [[BIS_fnc_arrayUnShift]]; {{codecomment|// _array is now [1,2,3,4]}}</code> |Example 2= | ||
| [[BIS_fnc_arrayShift]], [[pushBack]], [[select]], [[set]] |See also= | | [[BIS_fnc_arrayShift]], [[pushBack]], [[select]], [[set]] |See also= | ||
Revision as of 22:40, 16 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