BIS fnc setNestedElement: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
 
(27 intermediate revisions by 3 users not shown)
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_setNestedElement.sqf


Description:
|gr1= Arrays
Function to set an item in a nested array using a path.
Example:
_array = [[1, 2], [3, 4]];
_bool = [_array, [0, 0], 0] call BIS_fnc_setNestedElement; //Expected result: [[0, 2], [3, 4]]


Parameter(s):
|descr= Function to set an item in a nested array using a path. Modifies the array by reference.
_this select 0: Array
_this select 1: path to the element (Array)
_this select 2: 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, path, value] call [[BIS_fnc_setNestedElement]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_setNestedElement]]; --> |= Syntax
|p1= array: [[Array]]


|p1= |= Parameter 1
|p2= path: [[Array]] of [[Number]]s


| |= Return value
|p3= value: [[Anything]]
____________________________________________________________________________________________


|x1= <code></code> |=
|r1= [[Boolean]] - [[true]] on success, [[false]] on failure
____________________________________________________________________________________________


| |= See also
|x1= <sqf>
private _array = [[1, 2], [3, 4]];
_bool = [_array, [0, 0], 0] call BIS_fnc_setNestedElement; // _array is now [[0, 2], [3, 4]]
</sqf>


|seealso= [[BIS_fnc_findNestedElement]] [[BIS_fnc_findAllNestedElements]] [[BIS_fnc_removeNestedElement]] [[BIS_fnc_returnNestedElement]]
}}
}}
<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:setNestedElement}}]]
[[Category:Functions|{{uc:setNestedElement}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:setNestedElement}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:setNestedElement}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:setNestedElement}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setNestedElement}}]]

Latest revision as of 13:00, 1 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 set an item in a nested array using a path. Modifies the array by reference.
Execution:
call
Groups:
Arrays

Syntax

Syntax:
[array, path, value] call BIS_fnc_setNestedElement
Parameters:
array: Array
path: Array of Numbers
value: Anything
Return Value:
Boolean - true on success, false on failure

Examples

Example 1:
private _array = [[1, 2], [3, 4]]; _bool = [_array, [0, 0], 0] call BIS_fnc_setNestedElement; // _array is now [[0, 2], [3, 4]]

Additional Information

See also:
BIS_fnc_findNestedElement BIS_fnc_findAllNestedElements BIS_fnc_removeNestedElement BIS_fnc_returnNestedElement

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_setNestedElement&oldid=324401"