BIS fnc returnNestedElement: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "Numbers" to "Numbers")
 
(29 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_returnNestedElement.sqf


Description:
|gr1= Arrays
Function to return an item at a path in an array.
Example:
_array = [[1, 2], [3, 4]];
_value = [_array, [0, 1]] call BIS_fnc_returnNestedElement; //Expected result: 2


Parameter(s):
|descr= Function to return an item at a path in an array.
_this select 0: Array
_this select 1: path to the element (Array)
Returns:
Any Value found element
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|s1= [array, path] call [[BIS_fnc_returnNestedElement]]
____________________________________________________________________________________________


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


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


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


|x1= <code></code> |=
|x1= <sqf>private _array = [[1, 2], [3, 4]];
____________________________________________________________________________________________
_value = [_array, [0, 1]] call BIS_fnc_returnNestedElement; // returns 2</sqf>
 
| |= See also


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

Latest revision as of 23:38, 12 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 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:
private _array = [[1, 2], [3, 4]]; _value = [_array, [0, 1]] call BIS_fnc_returnNestedElement; // returns 2

Additional Information

See also:
BIS_fnc_findNestedElement BIS_fnc_findAllNestedElements BIS_fnc_removeNestedElement BIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_returnNestedElement&oldid=327552"