BIS fnc removeNestedElement: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - " |GROUP1 ____________________________________________________________________________________________" to " |GROUP1= ____________________________________________________________________________________________") |
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= | ||
| Function to remove an item in a nested array. Modifies the array by reference. |Description= | | Function to remove an item in a nested array. Modifies the array by reference. |Description= | ||
| [array, itemToRemove] call [[BIS_fnc_removeNestedElement]] |Syntax= | | [array, itemToRemove] call [[BIS_fnc_removeNestedElement]] |Syntax= | ||
| Line 19: | Line 16: | ||
| [[Boolean]] - [[true]] on success, [[false]] on failure |Return value= | | [[Boolean]] - [[true]] on success, [[false]] on failure |Return value= | ||
|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> |Example 1= | _bool = [_array, 3] [[call]] [[BIS_fnc_removeNestedElement]]; {{codecomment|// _array is now [<nowiki/>[1, 2], [4]]}}</code> |Example 1= | ||
| [[BIS_fnc_findNestedElement]], [[BIS_fnc_findAllNestedElements]], [[BIS_fnc_returnNestedElement]], [[BIS_fnc_setNestedElement]] |See also= | | [[BIS_fnc_findNestedElement]], [[BIS_fnc_findAllNestedElements]], [[BIS_fnc_returnNestedElement]], [[BIS_fnc_setNestedElement]] |See also= | ||
Revision as of 00:50, 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