BIS fnc returnChildren: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= Configs |GROUP1=
|gr1= Configs


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


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


|p1= config: [[Config]] - Class which is searched |Parameter 1=
|p1= config: [[Config]] - Class which is searched


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


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


| [[Array]] - Classes |Return value=
| [[Array]] - Classes


<!---
<!---
Line 25: Line 25:
--->
--->


|x1= <code>[<nowiki/>[[configFile]] >> "CfgFunctions", 2] [[call]] [[BIS_fnc_returnChildren]]; {{cc|returns config paths of all functions}}</code> |Example 1=
|x1= <code>[<nowiki/>[[configFile]] >> "CfgFunctions", 2] [[call]] [[BIS_fnc_returnChildren]]; {{cc|returns config paths of all functions}}</code>


| [[BIS_fnc_returnParents]] |See also=
| [[BIS_fnc_returnParents]]
}}
}}

Revision as of 23:39, 17 January 2021

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