BIS fnc findNestedElement: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(33 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_findNestedElement.sqf


Description:
|gr1= Arrays
Function to find item in nested arrays and return a path to the first match.
Example:
_array = [[1, 2], [3, 4]];
_path = [_array, 3] call BIS_fnc_findNestedElement; //Expected result: [1, 0]


Parameter(s):
|descr= Function to find item in nested arrays and return a path to the first match.
_this select 0: Array
{{Feature|arma3|In some cases [[findIf]] might be the better way of finding a nested element. It is a lot faster!}}
_this select 1: queried element (Any Value)
Returns:
Array path to the element
*/


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


| <!-- [] call [[BIS_fnc_findNestedElement]]; --> |= Syntax
|p1= array: [[Array]] - array to explore


|p1= |= Parameter 1
|p2= query: [[Anything]] - wanted item


| |= Return value
|r1= [[Array]] of [[Number]]s - path to the first occurence of ''query''
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <sqf>
____________________________________________________________________________________________
private _array = [[1, 2], [3, 4]];
 
_path = [_array, 3] call BIS_fnc_findNestedElement; // expected result: [1, 0]
| |= See also
// ((_array select 1) select 0) == 3
</sqf>


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

Latest revision as of 12:17, 13 July 2022

Hover & click on the images for description

Description

Description:
Function to find item in nested arrays and return a path to the first match.
Arma 3
In some cases findIf might be the better way of finding a nested element. It is a lot faster!
Execution:
call
Groups:
Arrays

Syntax

Syntax:
[array, query] call BIS_fnc_findNestedElement
Parameters:
array: Array - array to explore
query: Anything - wanted item
Return Value:
Array of Numbers - path to the first occurence of query

Examples

Example 1:
private _array = [[1, 2], [3, 4]]; _path = [_array, 3] call BIS_fnc_findNestedElement; // expected result: [1, 0] // ((_array select 1) select 0) == 3

Additional Information

See also:
BIS_fnc_findAllNestedElements BIS_fnc_removeNestedElement BIS_fnc_returnNestedElement 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