isClass: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (<code> tidy)
m (Some wiki formatting)
 
(68 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Check if config entry represents config class.  |= Description
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| [[Boolean]] <nowiki>=</nowiki> '''isClass''' config |= Syntax
|game4= tkoh
|p1 = config: [[Config]]
|version4= 1.00
| [[Boolean]] |= Return value
____________________________________________________________________________________________


|x1 = <code>_ok = [[isClass]] ([[configFile]] [[gtgt|>>]] "CfgVehicles");</code> Result is [[true]]. |= Example 1
|game5= arma3
|version5= 0.50


| [[configFile]], [[config/name]], [[configName]], [[count]], [[getArray]], [[getText]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isNumber]], [[isText]], [[select]] |= See also
|gr1= Config


|descr= Check if config entry represents config class.
|s1= [[isClass]] config
|p1= config: [[Config]]
|r1= [[Boolean]]
|x1= <sqf>_ok = isClass (configFile >> "CfgVehicles");</sqf> Result is [[true]].
|seealso= [[configFile]] [[a / b]] [[configName]] [[count]] [[getArray]] [[getText]] [[getNumber]] [[inheritsFrom]] [[isArray]] [[isNumber]] [[isText]] [[select]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Kronzky
<!-- Note Section BEGIN -->
|timestamp= 20070302011700
<dd class="notedate">Posted on March 2, 2007 - 01:17
|text= This command allows you to check for the presence of an addon.
<dt class="note">'''[[User:Kronzky|Kronzky]]'''<dd class="note">This command allows you to check for the presence of an addon.
  isClass (configFile >> "cfgVehicles" >> "MyCustomCar")  
  isClass (configFile >> "cfgVehicles" >> "MyCustomCar")  
will return [[true]] if the addon "MyCustomCar" is installed, and [[false]] if it is not installed.  
will return [[true]] if the addon "MyCustomCar" is installed, and [[false]] if it is not installed.  


''You will have to know under which class the addon is categorized (in this case "cfgVehicles") to be able to use the right config path.''
''You will have to know under which class the addon is categorized (in this case "cfgVehicles") to be able to use the right config path.''
<dd class="notedate">Posted on Mar 31, 2014 - 15:45
}}
<dt class="note">'''[[User:ffur2007slx2_5|ffur2007slx2_5]]'''<dd class="note">
In ArmA3 ver 1.14. It is also recommended to use [[BIS_fnc_getCfgIsClass]] as a replacement of [[isClass]] especially working on custom config in description.ext. E.g.
<code>["Something"] call bis_fnc_getCfgIsClass //Same as isClass (missionconfigfile >> "Something")</code>
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|ISCLASSCONFIG]]
|user= ffur2007slx2_5
[[Category:Scripting Commands ArmA|ISCLASSCONFIG]]
|timestamp= 20140331154500
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
|text= ({{arma3}} ver 1.14) According to BI Dev Karel Mořický, [[BIS_fnc_getCfgIsClass]] provides a comfortable workaround with custom config under description.ext compared with [[isClass]].
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
(But as a function created specifically for A3 campaign, it is in no way intended as a replacement for [[isClass]].
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
So it is not suggested to use it for [[configFile]] classes. But [[isClass]] instead.)
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
E.g.
<sqf>["Something1", "Something2", "Something3"] call BIS_fnc_getCfgIsClass; // same as isClass (missionConfigFile >> "Something1" >> "Something2" >> "Something3")</sqf>
}}

Latest revision as of 23:33, 13 May 2023

Hover & click on the images for description

Description

Description:
Check if config entry represents config class.
Groups:
Config

Syntax

Syntax:
isClass config
Parameters:
config: Config
Return Value:
Boolean

Examples

Example 1:
_ok = isClass (configFile >> "CfgVehicles");
Result is true.

Additional Information

See also:
configFile a / b configName count getArray getText getNumber inheritsFrom isArray isNumber isText select

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
Kronzky - c
Posted on Mar 02, 2007 - 01:17 (UTC)
This command allows you to check for the presence of an addon. isClass (configFile >> "cfgVehicles" >> "MyCustomCar") will return true if the addon "MyCustomCar" is installed, and false if it is not installed. You will have to know under which class the addon is categorized (in this case "cfgVehicles") to be able to use the right config path.
ffur2007slx2_5 - c
Posted on Mar 31, 2014 - 15:45 (UTC)
(Arma 3 ver 1.14) According to BI Dev Karel Mořický, BIS_fnc_getCfgIsClass provides a comfortable workaround with custom config under description.ext compared with isClass. (But as a function created specifically for A3 campaign, it is in no way intended as a replacement for isClass. So it is not suggested to use it for configFile classes. But isClass instead.) E.g.
["Something1", "Something2", "Something3"] call BIS_fnc_getCfgIsClass; // same as isClass (missionConfigFile >> "Something1" >> "Something2" >> "Something3")