BIS fnc getCfgIsClass: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "[[BIS fnc " to "[[BIS_fnc_")
 
(45 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Configs


|1.00|= Game version
|descr= Return true if it is a class. Can by called in two ways:
____________________________________________________________________________________________
* first way (general) works for any config
* second way is for comfortable working with mission description.ext


| <pre>/*
|s1= configEntry call [[BIS_fnc_getCfgIsClass]]


Description:
|p1= configEntry: [[Config]]
Return true if it's a class.


Remark(s):
|r1= [[Boolean]] - [[true]] if it is a class
* Can by called 2 ways:
* 1st way (general) works for any config.
* 2nd way is for comfortable working with mission description.ext.


Parameter(s):
|s2= classNames call [[BIS_fnc_getCfgIsClass]]
_this: CFG
_this: ARRAY of STRINGS - missionConfigFile classes and an attribute.


Example:
|p21= classNames: [[Array]] of [[String]] - [[missionConfigFile]] classes and an attribute


* 1st way of calling:
|r2= [[Boolean]] - [[true]] if it is a class


_isClass = (missionconfigfile >> "Hubs" >> "A1" >> "QuickStart") call Bis_fnc_getCfgIsClass;
|x1= <sqf>private _isClass = (missionConfigFile >> "Hubs" >> "A1" >> "QuickStart") call BIS_fnc_getCfgIsClass;</sqf>


* 2nd way of calling:
|x2= <sqf>private _isClass = ["Hubs"] call BIS_fnc_getCfgIsClass;</sqf>
 
_isClass = ["Hubs"] call Bis_fnc_getCfgIsClass;
 
Returns:
BOOL - true if it's a class
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_getCfgIsClass]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso=    [[BIS_fnc_getCfg]] [[BIS_fnc_getCfgData]] [[BIS_fnc_getCfgDataArray]] [[BIS_fnc_getCfgDataBool]] [[BIS_fnc_getCfgDataObject]] [[BIS_fnc_getCfgDataPool]] [[BIS_fnc_getCfgSubClasses]]
}}
}}
<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:getCfgIsClass}}]]
[[Category:Functions|{{uc:getCfgIsClass}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getCfgIsClass}}]]

Latest revision as of 18:04, 13 July 2022

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

Description

Description:
Return true if it is a class. Can by called in two ways:
  • first way (general) works for any config
  • second way is for comfortable working with mission description.ext
Execution:
call
Groups:
Configs

Syntax

Syntax:
configEntry call BIS_fnc_getCfgIsClass
Parameters:
configEntry: Config
Return Value:
Boolean - true if it is a class

Alternative Syntax

Syntax:
classNames call BIS_fnc_getCfgIsClass
Parameters:
classNames: Array of String - missionConfigFile classes and an attribute
Return Value:
Boolean - true if it is a class

Examples

Example 1:
private _isClass = (missionConfigFile >> "Hubs" >> "A1" >> "QuickStart") call BIS_fnc_getCfgIsClass;
Example 2:
private _isClass = ["Hubs"] call BIS_fnc_getCfgIsClass;

Additional Information

See also:
BIS_fnc_getCfg BIS_fnc_getCfgData BIS_fnc_getCfgDataArray BIS_fnc_getCfgDataBool BIS_fnc_getCfgDataObject BIS_fnc_getCfgDataPool BIS_fnc_getCfgSubClasses

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_getCfgIsClass&oldid=328662"