BIS fnc removeNestedElement: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (Some wiki formatting)
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Function to remove an item in a nested array. Modifies the array by reference. |Description=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| [array, itemToRemove] call [[BIS_fnc_removeNestedElement]] |Syntax=
|game4= arma3
|version4= 0.50


|p1= array: [[Array]] |Parameter 1=
|gr1= Arrays


|p2= itemToRemove: [[Anything]] |Parameter 2=
|descr= Function to remove an item in a nested array. Modifies the array by reference.


| [[Boolean]] - [[true]] on success, [[false]] on failure |Return value=
|s1= [array, itemToRemove] call [[BIS_fnc_removeNestedElement]]
____________________________________________________________________________________________


|x1= <code>_array = [[1, 2], [3, 3, 4]];
|p1= array: [[Array]]
_bool = [_array, 3] [[call]] [[BIS_fnc_removeNestedElement]]; {{codecomment|// _array is now <nowiki>[</nowiki>[1, 2], [4]]}}</code> |Example 1=
____________________________________________________________________________________________


| [[BIS_fnc_findNestedElement]], [[BIS_fnc_findAllNestedElements]], [[BIS_fnc_returnNestedElement]], [[BIS_fnc_setNestedElement]] |See also=
|p2= itemToRemove: [[Anything]]
}}


<h3 style="display:none">Notes</h3>
|r1= [[Boolean]] - [[true]] on success, [[false]] on failure
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>
</dl>
private _array = [[1, 2], [3, 3, 4]];
private _success = [_array, 3] call BIS_fnc_removeNestedElement; // _array is now [[1, 2], [4]]
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[BIS_fnc_findNestedElement]] [[BIS_fnc_findAllNestedElements]] [[BIS_fnc_returnNestedElement]] [[BIS_fnc_setNestedElement]]
[[Category:Functions|{{uc:removeNestedElement}}]]
}}
[[Category:Function Group: Arrays|{{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}}]]

Latest revision as of 00:34, 13 July 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_removeNestedElement&oldid=327527"