BIS fnc removeNestedElement: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |= Game name
| arma2 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| Function to remove an item in a nested array. Modifies the array by reference. |Description=
/*
____________________________________________________________________________________________
File: fn_removeNestedElement.sqf
 
Description:
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):
_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
| [array, itemToRemove] call [[BIS_fnc_removeNestedElement]] |Syntax=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_removeNestedElement]]; --> |= Syntax
|p1= array: [[Array]] |Parameter 1=


|p1= |= Parameter 1
|p2= itemToRemove: [[Anything]] |Parameter 2=


| |= Return value
| [[Boolean]] - [[true]] on success, [[false]] on failure |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| |= See also
| [[BIS_fnc_findNestedElement]], [[BIS_fnc_findAllNestedElements]], [[BIS_fnc_returnNestedElement]], [[BIS_fnc_setNestedElement]] |See also=
 
}}
}}


Line 52: Line 34:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:removeNestedElement}}]]
[[Category:Function Group: Arrays|{{uc:removeNestedElement}}]]
[[Category:Function Group: Arrays|{{uc:removeNestedElement}}]]
[[Category:Functions|{{uc:removeNestedElement}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:removeNestedElement}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:removeNestedElement}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:removeNestedElement}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:removeNestedElement}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:removeNestedElement}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:removeNestedElement}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:removeNestedElement}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:removeNestedElement}}]]

Revision as of 23:11, 5 June 2018

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:
Uncategorised

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

Notes

Bottom Section