BIS fnc returnParents: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(35 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


Description:
|gr1= Configs
Returns list of all parent classes
Parameter(s):
_this select 0: starting config class (Config)
_this select 1: true if you want to return only classnames (Boolean)
Returns:
Array - List of all classes (including starting one)
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_returnParents]]; --> |= Syntax
|descr= Returns list of all parent classes.


|p1= |= Parameter 1
|s1= [config, onlyClassNames] call [[BIS_fnc_returnParents]]


| |= Return value
|p1= config: [[Config]] - starting config class
____________________________________________________________________________________________


|x1= <code></code> |=
|p2= onlyClassNames: [[Boolean]] - (Optional, default [[false]]) [[true]] to return only class names
____________________________________________________________________________________________


| |= See also
|r1= [[Array]] - list of all classes (including starting one)


|x1= <sqf>[configFile >> "CfgVehicles" >> "Land_FirePlace_F", true] call BIS_fnc_returnParents;
//Returns ["Land_FirePlace_F","House_F","House","HouseBase","NonStrategic","Building","Static","All"]</sqf>
|seealso= [[configFile]] [[BIS_fnc_returnChildren]]
}}
}}
<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: Configs|{{uc:returnParents}}]]
[[Category:Functions|{{uc:returnParents}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:returnParents}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:returnParents}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:returnParents}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:returnParents}}]]

Latest revision as of 17:27, 8 November 2023

Hover & click on the images for description

Description

Description:
Returns list of all parent classes.
Execution:
call
Groups:
Configs

Syntax

Syntax:
[config, onlyClassNames] call BIS_fnc_returnParents
Parameters:
config: Config - starting config class
onlyClassNames: Boolean - (Optional, default false) true to return only class names
Return Value:
Array - list of all classes (including starting one)

Examples

Example 1:
[configFile >> "CfgVehicles" >> "Land_FirePlace_F", true] call BIS_fnc_returnParents; //Returns ["Land_FirePlace_F","House_F","House","HouseBase","NonStrategic","Building","Static","All"]

Additional Information

See also:
configFile BIS_fnc_returnChildren

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