BIS fnc removeNestedElement: Difference between revisions

Latest revision as of 23:34, 12 July 2022

1.00

1.50

1.00

0.50

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma2
-____________________________________________________________________________________________
+|version1= 1.00
-| arma2 |= Game name
+|game2= arma2oa
+|version2= 1.50
-|1.00|= Game version
+|game3= tkoh
-____________________________________________________________________________________________
+|version3= 1.00
-| <pre>
+|game4= arma3
-/*
+|version4= 0.50
-	File: fn_removeNestedElement.sqf
-	Description:
+|gr1= Arrays
-	Function to remove an item in a nested array.
-	Example:
-	_array = [[1, 2], [3, 4]];
-	_bool = [_array, 3] call BIS_fnc_removeNestedElement; //Expected result: [[0, 2], [4]]
-	Parameter(s):
+|descr= Function to remove an item in a nested array. Modifies the array by reference.
-	_this select 0: Array
-	_this select 1: new value (Any Value)
-	Returns:
-	Boolean success flag
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|s1= [array, itemToRemove] call [[BIS_fnc_removeNestedElement]]
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_removeNestedElement]]; --> |= Syntax
+|p1= array: [[Array]]
-|p1= |= Parameter 1
+|p2= itemToRemove: [[Anything]]
-| |= Return value
+|r1= [[Boolean]] - [[true]] on success, [[false]] on failure
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|x1= <sqf>
-____________________________________________________________________________________________
+private _array = [[1, 2], [3, 3, 4]];
+private _success = [_array, 3] call BIS_fnc_removeNestedElement; // _array is now [[1, 2], [4]]
-| |= See also
+</sqf>
+|seealso= [[BIS_fnc_findNestedElement]] [[BIS_fnc_findAllNestedElements]] [[BIS_fnc_returnNestedElement]] [[BIS_fnc_setNestedElement]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Arrays|{{uc:removeNestedElement}}]]
-[[Category:Functions|{{uc:removeNestedElement}}]]
-[[Category:{{Name|arma2}}: Functions|{{uc:removeNestedElement}}]]
-[[Category:{{Name|arma2oa}}: Functions|{{uc:removeNestedElement}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:removeNestedElement}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:removeNestedElement}}]]