BIS fnc removeNestedElement: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|+$" to "")
m (Some wiki formatting)
 
(6 intermediate revisions by the same user not shown)
Line 17: Line 17:
|descr= Function to remove an item in a nested array. Modifies the array by reference.
|descr= Function to remove an item in a nested array. Modifies the array by reference.


|s1=[array, itemToRemove] call [[BIS_fnc_removeNestedElement]]
|s1= [array, itemToRemove] call [[BIS_fnc_removeNestedElement]]


|p1= array: [[Array]]
|p1= array: [[Array]]
Line 23: Line 23:
|p2= itemToRemove: [[Anything]]
|p2= itemToRemove: [[Anything]]


|r1=[[Boolean]] - [[true]] on success, [[false]] on failure
|r1= [[Boolean]] - [[true]] on success, [[false]] on failure


|x1= <code>_array = [[1, 2], [3, 3, 4]];
|x1= <sqf>
_bool = [_array, 3] [[call]] [[BIS_fnc_removeNestedElement]]; {{codecomment|// _array is now [<nowiki/>[1, 2], [4]]}}</code>
private _array = [[1, 2], [3, 3, 4]];
private _success = [_array, 3] call BIS_fnc_removeNestedElement; // _array is now [[1, 2], [4]]
</sqf>


|seealso= [[BIS_fnc_findNestedElement]], [[BIS_fnc_findAllNestedElements]], [[BIS_fnc_returnNestedElement]], [[BIS_fnc_setNestedElement]]
|seealso= [[BIS_fnc_findNestedElement]] [[BIS_fnc_findAllNestedElements]] [[BIS_fnc_returnNestedElement]] [[BIS_fnc_setNestedElement]]
}}
}}

Latest revision as of 23:34, 12 July 2022

Hover & click on the images for description

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:
private _array = [[1, 2], [3, 3, 4]]; private _success = [_array, 3] call BIS_fnc_removeNestedElement; // _array is now [[1, 2], [4]]

Additional Information

See also:
BIS_fnc_findNestedElement BIS_fnc_findAllNestedElements BIS_fnc_returnNestedElement BIS_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