BIS fnc returnNestedElement: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[[cC]ategory:[fF]unctions\|\{\{uc:[a-z A-Z_]*\}\}\]\]" to "")
m (codecomment → cc)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma2
|game1= arma2


|1.00
|version1= 1.00


|gr1= Arrays
|gr1= Arrays


| Function to return an item at a path in an array.
|descr= Function to return an item at a path in an array.


| [array, path] call [[BIS_fnc_returnNestedElement]]
|s1= [array, path] call [[BIS_fnc_returnNestedElement]]


|p1= array: [[Array]]
|p1= array: [[Array]]
Line 15: Line 15:
|p2= path: [[Array]] of [[Number|Numbers]]
|p2= path: [[Array]] of [[Number|Numbers]]


| [[Anything]] - [[nil]] if path is incorrect
|r1= [[Anything]] - [[nil]] if path is incorrect


|x1= <code>_array = [[1, 2], [3, 4]];
|x1= <code>_array = [[1, 2], [3, 4]];
_value = [_array, [0, 1]] [[call]] [[BIS_fnc_returnNestedElement]]; {{codecomment|// returns 2}}</code>
_value = [_array, [0, 1]] [[call]] [[BIS_fnc_returnNestedElement]]; {{cc|returns 2}}</code>


| [[BIS_fnc_findNestedElement]], [[BIS_fnc_findAllNestedElements]], [[BIS_fnc_removeNestedElement]], [[BIS_fnc_setNestedElement]]
|seealso= [[BIS_fnc_findNestedElement]], [[BIS_fnc_findAllNestedElements]], [[BIS_fnc_removeNestedElement]], [[BIS_fnc_setNestedElement]]
}}
}}



Revision as of 16:59, 7 February 2021

Hover & click on the images for description

Description

Description:
Function to return an item at a path in an array.
Execution:
call
Groups:
Arrays

Syntax

Syntax:
[array, path] call BIS_fnc_returnNestedElement
Parameters:
array: Array
path: Array of Numbers
Return Value:
Anything - nil if path is incorrect

Examples

Example 1:
_array = [[1, 2], [3, 4]]; _value = [_array, [0, 1]] call BIS_fnc_returnNestedElement; // returns 2

Additional Information

See also:
BIS_fnc_findNestedElementBIS_fnc_findAllNestedElementsBIS_fnc_removeNestedElementBIS_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