BIS fnc setNestedElement: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Function " to "{{RV|type=function ")
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma2
|game1= arma2
|version1= 1.00


|1.00
|game2= arma2oa
|version2= 1.50
 
|game3= tkoh
|version3= 1.00
 
|game4= arma3
|version4= 0.50


|gr1= Arrays
|gr1= Arrays


| Function to set an item in a nested array using a path. Modifies the array by reference.
|descr= Function to set an item in a nested array using a path. Modifies the array by reference.


| [array, path, value] call [[BIS_fnc_setNestedElement]]
|s1= [array, path, value] call [[BIS_fnc_setNestedElement]]


|p1= array: [[Array]]
|p1= array: [[Array]]


|p2= path: [[Array]] of [[Number|Numbers]]
|p2= path: [[Array]] of [[Number]]s


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


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


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


| [[BIS_fnc_findNestedElement]], [[BIS_fnc_findAllNestedElements]], [[BIS_fnc_removeNestedElement]], [[BIS_fnc_returnNestedElement]]
|seealso= [[BIS_fnc_findNestedElement]] [[BIS_fnc_findAllNestedElements]] [[BIS_fnc_removeNestedElement]] [[BIS_fnc_returnNestedElement]]
}}
}}
[[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 14:00, 1 July 2022

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