BIS fnc setNestedElement: 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 set an item in a nested array using a path. Modifies the array by reference. |Description=
/*
____________________________________________________________________________________________
File: fn_setNestedElement.sqf
 
Description:
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):
| [array, path, value] call [[BIS_fnc_setNestedElement]] |Syntax=
_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
|p1= array: [[Array]] |Parameter 1=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_setNestedElement]]; --> |= Syntax
|p2= path: [[Array]] of [[Number|Numbers]] |Parameter 2=


|p1= |= Parameter 1
|p3= value: [[Anything]] |Parameter 3=


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


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


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


Line 53: Line 36:


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

Revision as of 23:26, 5 June 2018

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

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:
_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_findNestedElementBIS_fnc_findAllNestedElementsBIS_fnc_removeNestedElementBIS_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

Notes

Bottom Section