BIS fnc returnChildren: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
(Fix argument description (optionality and default) & add reference to similar command)
 
(One intermediate revision by one other user not shown)
Line 12: Line 12:
|p1= config: [[Config]] - class which is searched
|p1= config: [[Config]] - class which is searched


|p2= depth: [[Number]] - Depth, (0 = return only subclasses, 1 = return subclasses of subclasses, and so on...
|p2= depth: [[Number]] - (Optional, default 0) depth, (0 = return only subclasses, 1 = return subclasses of subclasses, and so on...


|p3= lastTier: [[Boolean]] - (Optional, default [[true]]) [[false]] to return only the last one, [[true]] to return all classes
|p3= lastTier: [[Boolean]] - (Optional, default [[true]]) [[false]] to return only the last one, [[true]] to return all classes
Line 22: Line 22:
|x1= <sqf>[configFile >> "CfgFunctions", 2] call BIS_fnc_returnChildren; // returns config paths of all functions</sqf>
|x1= <sqf>[configFile >> "CfgFunctions", 2] call BIS_fnc_returnChildren; // returns config paths of all functions</sqf>


|seealso= [[BIS_fnc_returnParents]]
|seealso= [[BIS_fnc_returnParents]] [[configClasses]]
}}
}}

Latest revision as of 22:58, 24 June 2025

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 - (Optional, default 0) 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 configClasses

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