BIS fnc removeNestedElement: 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 | ||
| Function to remove an item in a nested array. Modifies the array by reference. | | Function to remove an item in a nested array. Modifies the array by reference. | ||
| [array, itemToRemove] call [[BIS_fnc_removeNestedElement]] | | [array, itemToRemove] call [[BIS_fnc_removeNestedElement]] | ||
|p1= array: [[Array]] | |p1= array: [[Array]] | ||
|p2= itemToRemove: [[Anything]] | |p2= itemToRemove: [[Anything]] | ||
| [[Boolean]] - [[true]] on success, [[false]] on failure | | [[Boolean]] - [[true]] on success, [[false]] on failure | ||
|x1= <code>_array = [[1, 2], [3, 3, 4]]; | |x1= <code>_array = [[1, 2], [3, 3, 4]]; | ||
_bool = [_array, 3] [[call]] [[BIS_fnc_removeNestedElement]]; {{codecomment|// _array is now [<nowiki/>[1, 2], [4]]}}</code> | _bool = [_array, 3] [[call]] [[BIS_fnc_removeNestedElement]]; {{codecomment|// _array is now [<nowiki/>[1, 2], [4]]}}</code> | ||
| [[BIS_fnc_findNestedElement]], [[BIS_fnc_findAllNestedElements]], [[BIS_fnc_returnNestedElement]], [[BIS_fnc_setNestedElement]] | | [[BIS_fnc_findNestedElement]], [[BIS_fnc_findAllNestedElements]], [[BIS_fnc_returnNestedElement]], [[BIS_fnc_setNestedElement]] | ||
}} | }} | ||
Revision as of 23:40, 17 January 2021
Description
- Description:
- Function to remove an item in a nested array. Modifies the array by reference.
- Execution:
- call
- Groups:
- Arrays
Syntax
- Syntax:
- [array, itemToRemove] call BIS_fnc_removeNestedElement
- Parameters:
- array: Array
- itemToRemove: Anything
- Return Value:
- Boolean - true on success, false on failure
Examples
- Example 1:
_array = [[1, 2], [3, 3, 4]]; _bool = [_array, 3] call BIS_fnc_removeNestedElement; // _array is now [[1, 2], [4]]
Additional Information
- See also:
- BIS_fnc_findNestedElementBIS_fnc_findAllNestedElementsBIS_fnc_returnNestedElementBIS_fnc_setNestedElement
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