BIS fnc getCfgIsClass: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Return true if it's a class. Can by called in two ways:
 
* first way (general) works for any config
Description:
* second way is for comfortable working with mission description.ext |= Description
Return true if it's a class.
____________________________________________________________________________________________
 
Remark(s):
* Can by called 2 ways:
* 1st way (general) works for any config.
* 2nd way is for comfortable working with mission description.ext.
 
Parameter(s):
_this: CFG
_this: ARRAY of STRINGS - missionConfigFile classes and an attribute.
 
Example:


* 1st way of calling:
| configEntry call [[BIS_fnc_getCfgIsClass]] |= Syntax


_isClass = (missionconfigfile >> "Hubs" >> "A1" >> "QuickStart") call Bis_fnc_getCfgIsClass;
|p1= configEntry: [[Config]] |= Parameter 1


* 2nd way of calling:
| [[Boolean]] - [[true]] if it is a class |= Return value


_isClass = ["Hubs"] call Bis_fnc_getCfgIsClass;
|s2= classNames [[call]] [[BIS_fnc_getCfgIsClass]] |= Syntax


Returns:
|p21= classNames: [[Array]] of [[String]] - [[missionConfigFile]] classes and an attribute |= Parameter 21
BOOL - true if it's a class
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|r2= [[Boolean]] - [[true]] if it is a class |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


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


|p1= |= Parameter 1
|x2= <code>_isClass = ["Hubs"] [[call]] [[BIS_fnc_getCfgIsClass]];</code> |= Example 2
 
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=
| [[BIS fnc getCfg]], [[BIS fnc getCfgData]], [[BIS fnc getCfgDataArray]], [[BIS fnc getCfgDataBool]], [[BIS fnc getCfgDataObject]], [[BIS fnc getCfgDataPool]], [[BIS fnc getCfgSubClasses]] |= See also
____________________________________________________________________________________________
 
| |= See also
 
}}
}}


Revision as of 20:09, 3 May 2018

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

Description

Description:
Return true if it's 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:
Uncategorised

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:
_isClass = (missionConfigFile >> "Hubs" >> "A1" >> "QuickStart") call BIS_fnc_getCfgIsClass;
Example 2:
_isClass = ["Hubs"] call BIS_fnc_getCfgIsClass;

Additional Information

See also:
BIS fnc getCfgBIS fnc getCfgDataBIS fnc getCfgDataArrayBIS fnc getCfgDataBoolBIS fnc getCfgDataObjectBIS fnc getCfgDataPoolBIS 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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_getCfgIsClass&oldid=107097"