BIS fnc returnChildren: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed the example)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *D([a-z])" to "$1 - d$2")
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Configs
____________________________________________________________________________________________


| Returns all subclasses within given class.|Description=
|descr= Returns all subclasses within given class.
____________________________________________________________________________________________


| [config,depth,lastTier,firstTier]] call [[BIS_fnc_returnChildren]] |Syntax=
|s1= [config, depth, lastTier, firstTier] call [[BIS_fnc_returnChildren]]


|p1= config: [[Config]] - class which is searched


|p1= config: [[Config]] - Class which is searched |Parameter 1=
|p2= depth: [[Number]] - depth, (0 = return only subclasses, 1 = return subclasses of subclasses, and so on...


|p2= depth: [[Number]] - Depth, (0 = return only subclasses, 1 = return subclasses of subclasses, and so on...|Parameter 2=
|p3= lastTier: [[Boolean]] - (Optional, default [[true]]) [[false]] to return only the last one, [[true]] to return all classes


|p3= lastTier: [[Boolean]] - (Optional, default [[true]]) [[True]] to return only the last one, [[false]] to return all classes |Parameter 3=
|p4= firstTier: [[Boolean]] - (Optional, default [[true]]) [[true]] to return the first class, [[false]] to return only the last one


|p4= firstTier: [[String]] - (Optional, default [[true]]) [[True]] to return the first class, [[false]] to return only the last one |Parameter 4=
|r1= [[Array]] - classes


| [[Array]] - Classes |Return value=
|x1= <sqf>[configFile >> "CfgFunctions", 2] call BIS_fnc_returnChildren; // returns config paths of all functions</sqf>


<!---
|seealso= [[BIS_fnc_returnParents]]
|exec= spawn |= Execution
--->
____________________________________________________________________________________________
 
|x1= <code>[ [[configFile]] >> "CfgFunctions", 2 ] [[call]] [[BIS_fnc_returnChildren]];//Return config paths of all functions</code>|Example 1=
____________________________________________________________________________________________
 
| [[BIS_fnc_returnParents]] |See also=
}}
}}

Latest revision as of 14:01, 8 November 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Returns all subclasses within given class.
Execution:
call
Groups:
Configs

Syntax

Syntax:
[config, depth, lastTier, firstTier] call BIS_fnc_returnChildren
Parameters:
config: Config - class which is searched
depth: Number - depth, (0 = return only subclasses, 1 = return subclasses of subclasses, and so on...
lastTier: Boolean - (Optional, default true) false to return only the last one, true to return all classes
firstTier: Boolean - (Optional, default true) true to return the first class, false to return only the last one
Return Value:
Array - classes

Examples

Example 1:
[configFile >> "CfgFunctions", 2] call BIS_fnc_returnChildren; // returns config paths of all functions

Additional Information

See also:
BIS_fnc_returnParents

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_returnChildren&oldid=348507"