isKindOf: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Command " to "{{RV|type=command ")
(added example)
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= ofpe
|version1= 1.00


|1.00
|game2= arma1
|version2= 1.00
 
|game3= arma2
|version3= 1.00
 
|game4= arma2oa
|version4= 1.50
 
|game5= tkoh
|version5= 1.00
 
|game6= arma3
|version6= 0.50


|gr1= Object Manipulation
|gr1= Object Manipulation


| Checks whether the object is (a subtype) of the given type. While main and alternative syntaxes support only '''CfgVehicles''', '''CfgAmmo''' and '''CfgNonAIVehicles''', alternative syntax 2 allows to specify any config, including [[missionConfigFile|mission config]].
|descr= Checks whether the given object or type is (a subtype) of the given type.<br>
While {{Link|#Syntax 1}} and {{Link|#Syntax 2}} only support '''CfgVehicles''', {{GVI|arma2|1.00|size= 0.75}}'''CfgAmmo''' and '''CfgNonAIVehicles''', {{Link|#Syntax 3}} can be used with any config, including the [[missionConfigFile|mission config]].


| object [[isKindOf]] typeName
|s1= object [[isKindOf]] typeName


|p1= object: [[Object]]
|p1= object: [[Object]]
Line 15: Line 30:
|p2= typeName: [[String]]
|p2= typeName: [[String]]


| [[Boolean]]
|r1= [[Boolean]]


|s2= typeName1 [[isKindOf]] typeName2
|s2= class1 [[isKindOf]] class2


|p21= typeName1: [[String]] |PARAMETER21=
|p21= class1: [[String]]


|p22= typeName2: [[String]] |PARAMETER22=
|p22= class2: [[String]]


|r2= [[Boolean]]
|r2= [[Boolean]]


|s3= typeName1 [[isKindOf]] [typeName2, targetConfig] {{Since|arma3|1.47|y}} |Alternative Syntax2=
|s3= class1 [[isKindOf]] [class2, targetConfig]


|p41= typeName1: [[String]]|PARAMETER41=
|s3since= arma3 1.48


|p42= typeName2: [[String]]|PARAMETER42=
|p41= class1: [[String]]


|p43= targetConfig: [[Config]]|PARAMETER43=
|p42= class2: [[String]]
 
|p43= targetConfig: [[Config]]


|r3= [[Boolean]]
|r3= [[Boolean]]
 
|x1= <code>[[vehicle]] [[player]] [[isKindOf]] "Tank";</code>
|x2= <code>"BMP2" [[isKindOf]] "Tank";</code>


|x3= <code>[[currentWeapon]] [[player]] [[isKindOf]] ["Rifle", [[configFile]] >> "CfgWeapons"];</code>
|x1= <sqf>vehicle player isKindOf "Tank";</sqf>


| [[countType]], [[typeOf]], [[inheritsFrom]], [[configHierarchy]], [[ArmA_2:_CfgVehicles | Arma 2 CfgVehicles]]
|x2= <sqf>"BMP2" isKindOf "Tank";</sqf>
}}


<dl class="command_description">
|x3= <sqf>currentWeapon player isKindOf ["Rifle", configFile >> "CfgWeapons"];</sqf>
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on April 23, 2007 - 16:34</dd>
|x4= <sqf>private _isSoldier = player isKindOf "CAManBase";</sqf>
<dt class="note">[[User:Kronzky|Kronzky]]</dt>
<dd class="note">This command can be used on the whole [[ArmA: CfgVehicles|hierarchical class tree]] (i.e. when checking a [[ArmA:_Vehicles#Wheeled|HMMWV]], one could test for "HMMWV50", "Car", "LandVehicle", etc., all of which would return [[true]].)</dd>


<dd class="notedate">Posted on 16 Apr, 2008</dd>
|seealso= [[typeOf]] [[countType]] [[inheritsFrom]] [[configHierarchy]]
<dt class="note">[[User:Dr_Eyeball|Dr_Eyeball]]</dt>
}}
<dd class="note">It appears [[isKindOf]] is limited to the [[ArmA:_CfgVehicles|CfgVehicles]] branch of the class hierachy.<br>
So CfgWeapons, CfgMagazines, etc will return [[false]] for checks like:
("M9" isKindOf "Pistol") returns false
</dd>


<dd class="notedate">Posted on 8 Nov, 2009</dd>
<dt class="note">[[User:WGL.Q|.kju]]</dt>
<dd class="note">In a2 [[isKindOf]] also works for CfgAmmo in addition to CfgVehicles: ("M_9M311_AA" isKindOf "MissileBase") returns true. NOT for CfgWeapons, CfgMagazines and others..
</dd>


<dd class="notedate">Posted on June 16, 2015 - 17:54 (UTC)</dd>
{{Note
<dt class="note">[[User:James|James]]</dt>
|user= Kronzky
<dd class="note">
|timestamp= 20070423163400
In case you cannot use [[isKindOf]] because of the reasons stated, just use [[BIS fnc returnParents]] with class names as return value:
|text= This command can be used on the whole [[ArmA: CfgVehicles|hierarchical class tree]] (i.e. when checking a [[ArmA:_Vehicles#Wheeled|HMMWV]], one could test for "HMMWV50", "Car", "LandVehicle", etc., all of which would return [[true]].)
<code>_isKindOf = "Rifle" [[in]] [([[configFile]] >> "CfgWeapons" >> "BWA3_G36K"), [[true]]<nowiki>]</nowiki> [[call]] [[BIS_fnc_returnParents]]; {{cc|is true`}}</code>
}}
</dd>


<dd class="notedate">Posted on September 6, 2015 - 22:21 (UTC)</dd>
{{Note
<dt class="note">[[User:Basstard|Basstard]]</dt>
|user= James
<dd class="note">
|timestamp= 20150616175400
In A3 [[isKindOf]] works well with CfgWeapons and CfgMagazines using the syntax from example 3.<br>
|text= In case you cannot use [[isKindOf]] because of the reasons stated, just use [[BIS_fnc_returnParents]] with class names as return value:
It should be prefered to James' solution as it performs more than 25x faster. Tested in debug console with the following code snippets:<br>
<sqf>_isKindOf = "Rifle" in [configFile >> "CfgWeapons" >> "BWA3_G36K", true] call BIS_fnc_returnParents; // is true</sqf>
<code>bool = "CA_Magazine" in ([([[configFile]] >> "CfgMagazines" >> "HandGrenade"),true] [[call]] [[BIS_fnc_returnParents]]); -->  0.12111ms</code>
}}
<code>bool = "HandGrenade" [[isKindOf]] ["CA_Magazine", [[configFile]] >> "CfgMagazines"];  -->  0.00439453ms</code>
When checking in [[CfgVehicles]] the syntax from example 2 performs a little faster.
</dd>


<!-- Note Section END -->
{{Note
</dl>
|user= Basstard
 
|timestamp= 20150906222100
{{GameCategory|ofpe|Scripting Commands}}
|text= In {{arma3}} [[isKindOf]] works well with CfgWeapons and CfgMagazines using the syntax from example 3.<br>
{{GameCategory|arma1|Scripting Commands}}
It should be prefered to James' solution as it performs more than 25x faster. Tested in debug console with the following code snippets:
{{GameCategory|arma2|Scripting Commands}}
<sqf>
{{GameCategory|arma3|Scripting Commands}}
"CA_Magazine" in ([configFile >> "CfgMagazines" >> "HandGrenade", true] call BIS_fnc_returnParents); // 0.12111 ms
{{GameCategory|tkoh|Scripting Commands}}
"HandGrenade" isKindOf ["CA_Magazine", configFile >> "CfgMagazines"]; // 0.00439453 ms
</sqf>
When checking in [[CfgVehicles]] the syntax from {{Link|#Example 2}} performs a little faster.
}}

Latest revision as of 11:50, 18 May 2023

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Checks whether the given object or type is (a subtype) of the given type.
While Syntax 1 and Syntax 2 only support CfgVehicles, Logo A2.png1.00CfgAmmo and CfgNonAIVehicles, Syntax 3 can be used with any config, including the mission config.
Groups:
Object Manipulation

Syntax 1

Syntax:
object isKindOf typeName
Parameters:
object: Object
typeName: String
Return Value:
Boolean

Syntax 2

Syntax:
class1 isKindOf class2
Parameters:
class1: String
class2: String
Return Value:
Boolean

Syntax 3

Syntax:
class1 isKindOf [class2, targetConfig]
Parameters:
class1: String
class2: String
targetConfig: Config
Return Value:
Boolean

Examples

Example 1:
vehicle player isKindOf "Tank";
Example 2:
"BMP2" isKindOf "Tank";
Example 3:
currentWeapon player isKindOf ["Rifle", configFile >> "CfgWeapons"];
Example 4:
private _isSoldier = player isKindOf "CAManBase";

Additional Information

See also:
typeOf countType inheritsFrom configHierarchy

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 Apr 23, 2007 - 16:34 (UTC)
This command can be used on the whole hierarchical class tree (i.e. when checking a HMMWV, one could test for "HMMWV50", "Car", "LandVehicle", etc., all of which would return true.)
James - c
Posted on Jun 16, 2015 - 17:54 (UTC)
In case you cannot use isKindOf because of the reasons stated, just use BIS_fnc_returnParents with class names as return value:
_isKindOf = "Rifle" in [configFile >> "CfgWeapons" >> "BWA3_G36K", true] call BIS_fnc_returnParents; // is true
Basstard - c
Posted on Sep 06, 2015 - 22:21 (UTC)
In Arma 3 isKindOf works well with CfgWeapons and CfgMagazines using the syntax from example 3.
It should be prefered to James' solution as it performs more than 25x faster. Tested in debug console with the following code snippets:
"CA_Magazine" in ([configFile >> "CfgMagazines" >> "HandGrenade", true] call BIS_fnc_returnParents); // 0.12111 ms "HandGrenade" isKindOf ["CA_Magazine", configFile >> "CfgMagazines"]; // 0.00439453 ms
When checking in CfgVehicles the syntax from Example 2 performs a little faster.
Retrieved from "https://community.bistudio.com/wiki?title=isKindOf&oldid=341247"