BIS fnc setNestedElement: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1= Arrays |GROUP1=
|gr1= Arrays


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


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


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


|p2= path: [[Array]] of [[Number|Numbers]] |Parameter 2=
|p2= path: [[Array]] of [[Number|Numbers]]


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


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


|x1= <code>_array = [[1, 2], [3, 4]];
|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=
_bool = [_array, [0, 0], 0] [[call]] [[BIS_fnc_setNestedElement]]; {{codecomment|// _array is now [[0, 2], [3, 4]]}}</code>


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



Revision as of 00:44, 18 January 2021

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

Bottom Section