BIS fnc arrayShift: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\{\{ *codecomment *\| *\/\/ *([^ ]+) *\}\} " to "{{cc|$1}}") |
Lou Montana (talk | contribs) m (revert + fix) Tag: Undo |
||
| Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma2 | |game1= arma2 | ||
|1.00 | |version1= 1.00 | ||
|gr1= Arrays | |gr1= Arrays | ||
| This function removes the first (leftmost) element of an array and returns it.<br> | |descr= This function removes the first (leftmost) 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 | The array is passed by reference so changes inside the function will be reflected outside of it. | ||
| | {{Feature|arma3|In {{arma3}}, use {{Inline code|array [[deleteAt]] 0}}.}} | ||
| | |s1= [array] call [[BIS_fnc_arrayShift]] | ||
| [[Anything]] - the removed element | |p1= array: [[Array]] - '''NOTE:''' given array must be within an array (e.g {{Inline code|[<nowiki/>[10, 20, 30]] [[call]] [[BIS_fnc_arrayShift]]}}) | ||
|r1= [[Anything]] - the removed element | |||
|x1= <code>_myArray = ["2", "report", "status"]; | |x1= <code>_myArray = ["2", "report", "status"]; | ||
_removedElement = [_myArray] [[call]] [[BIS_fnc_arrayShift]]; {{cc| array is '''within an array'''}}_removedElement == "2"; {{cc| true}}_myArray [[isEqualTo]] ["report", "status"]; {{ | _removedElement = [_myArray] [[call]] [[BIS_fnc_arrayShift]]; {{cc|array is '''within an array'''}} | ||
_removedElement == "2"; {{cc|true}} | |||
_myArray [[isEqualTo]] ["report", "status"]; {{cc|true}}</code> | |||
| [[deleteAt]], [[pushBack]] | |seealso= [[deleteAt]], [[pushBack]] | ||
}} | }} | ||
[[Category:{{Name|arma2oa}}: Functions|{{uc:arrayShift}}]] | [[Category:{{Name|arma2oa}}: Functions|{{uc:arrayShift}}]] | ||
[[Category:{{Name|tkoh}}: Functions|{{uc:arrayShift}}]] | [[Category:{{Name|tkoh}}: Functions|{{uc:arrayShift}}]] | ||
[[Category:{{Name|arma3}}: Functions|{{uc:arrayShift}}]] | [[Category:{{Name|arma3}}: Functions|{{uc:arrayShift}}]] | ||
Revision as of 21:35, 29 January 2021
Description
- Description:
- This function removes the first (leftmost) element of an array and returns it.
The array is passed by reference so changes inside the function will be reflected outside of it.
In Arma 3, usearray deleteAt 0. - Execution:
- call
- Groups:
- Arrays
Syntax
- Syntax:
- [array] call BIS_fnc_arrayShift
- Parameters:
- array: Array - NOTE: given array must be within an array (e.g
[[10, 20, 30]] call BIS_fnc_arrayShift) - Return Value:
- Anything - the removed element
Examples
- Example 1:
_myArray = ["2", "report", "status"]; _removedElement = [_myArray] call BIS_fnc_arrayShift; // array is within an array _removedElement == "2"; // true _myArray isEqualTo ["report", "status"]; // true
Additional Information
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