BIS fnc getCfgIsClass: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "[[BIS fnc " to "[[BIS_fnc_")
 
(43 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
____________________________________________________________________________________________


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


| configEntry call [[BIS_fnc_getCfgIsClass]] |SYNTAX=
|s1= configEntry call [[BIS_fnc_getCfgIsClass]]


|p1= configEntry: [[Config]] |= Parameter 1
|p1= configEntry: [[Config]]


| [[Boolean]] - [[true]] if it is a class |RETURNVALUE=
|r1= [[Boolean]] - [[true]] if it is a class


|s2= classNames [[call]] [[BIS_fnc_getCfgIsClass]] |SYNTAX=
|s2= classNames call [[BIS_fnc_getCfgIsClass]]


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


|r2= [[Boolean]] - [[true]] if it is a class |RETURNVALUE=
|r2= [[Boolean]] - [[true]] if it is a class
____________________________________________________________________________________________


|x1= <code>_isClass = ([[missionConfigFile]] >> "Hubs" >> "A1" >> "QuickStart") [[call]] [[BIS_fnc_getCfgIsClass]];</code> |= Example 1
|x1= <sqf>private _isClass = (missionConfigFile >> "Hubs" >> "A1" >> "QuickStart") call BIS_fnc_getCfgIsClass;</sqf>


|x2= <code>_isClass = ["Hubs"] [[call]] [[BIS_fnc_getCfgIsClass]];</code> |= Example 2
|x2= <sqf>private _isClass = ["Hubs"] call BIS_fnc_getCfgIsClass;</sqf>
____________________________________________________________________________________________


| [[BIS fnc getCfg]], [[BIS fnc getCfgData]], [[BIS fnc getCfgDataArray]], [[BIS fnc getCfgDataBool]], [[BIS fnc getCfgDataObject]], [[BIS fnc getCfgDataPool]], [[BIS fnc getCfgSubClasses]] |SEEALSO=
|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"