isKindOf: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(alt syntax WIP)
(added example)
 
(65 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


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


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


| Checks whether the object is (a subtype) of the given type. While main syntax and alt syntax support only CfgVehicles, CfgAmmo and CfgNonAIVehicles, alt syntax 2 allows to specify any config, including mission config. |= Description
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


| object '''isKindOf''' typeName |= Syntax
|game4= arma2oa
|version4= 1.50


|p1= object: [[Object]] |= Parameter 1
|game5= tkoh
|version5= 1.00


|p2= typeName: [[String]] |= Parameter 2
|game6= arma3
|version6= 0.50


| [[Boolean]] |= Return value
|gr1= Object Manipulation


|s2= typeName1 '''isKindOf''' typeName2 |= Alternative Syntax
|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]].


|p21= typeName1: [[String]]|= Parameter 1
|s1= object [[isKindOf]] typeName


|p22= typeName2: [[String]]|= Parameter 2
|p1= object: [[Object]]


|r2= [[Boolean]] |= Return value
|p2= typeName: [[String]]


|s3= typeName1 '''isKindOf''' [typeName2, targetConfig] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''since Arma 3 v1.47'') |= Alternative Syntax
|r1= [[Boolean]]


|p41= typeName1: [[String]]|= Parameter 1
|s2= class1 [[isKindOf]] class2


|p42 = [typeName2, targetConfig]: - [[Array]]|= Parameter 1
|p21= class1: [[String]]


|p43= typeName2: [[String]]|= Parameter 2
|p22= class2: [[String]]


|p43= targetConfig: [[Config]]|= Parameter 2
|r2= [[Boolean]]


|r3= [[Boolean]] |= Return value
|s3= class1 [[isKindOf]] [class2, targetConfig]
____________________________________________________________________________________________
 
|x1= <code>[[vehicle]] [[player]] [[isKindOf]] "Tank";</code> |= Example 1


|x2= <code>"BMP2" [[isKindOf]] "Tank";</code> |= Example 2
|s3since= arma3 1.48


|x3= <code>[[currentWeapon]] [[player]] [[isKindOf]] ["Rifle", [[configFile]] >> "CfgWeapons"];</code> |= Example 2
|p41= class1: [[String]]


____________________________________________________________________________________________
|p42= class2: [[String]]


| [[countType]], [[typeOf]], [[inheritsFrom]], [[ArmA_2:_CfgVehicles | Arma 2 CfgVehicles]] |= See also
|p43= targetConfig: [[Config]]


}}
|r3= [[Boolean]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>vehicle player isKindOf "Tank";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on April 23, 2007 - 16:34
|x2= <sqf>"BMP2" isKindOf "Tank";</sqf>
<dt class="note">'''[[User:Kronzky|Kronzky]]'''
<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 class="notedate">Posted on 16 Apr, 2008
|x3= <sqf>currentWeapon player isKindOf ["Rifle", configFile >> "CfgWeapons"];</sqf>
<dt class="note">[[User:Dr_Eyeball|Dr_Eyeball]]
<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
<br>


|x4= <sqf>private _isSoldier = player isKindOf "CAManBase";</sqf>


<dd class="notedate">Posted on 8 Nov, 2009
|seealso= [[typeOf]] [[countType]] [[inheritsFrom]] [[configHierarchy]]
<dt class="note">[[User:WGL.Q|.kju]]
}}
<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..
<br>




<!-- Note Section END -->
{{Note
</dl>
|user= Kronzky
|timestamp= 20070423163400
|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]].)
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|ISKINDOF]]
|user= James
[[Category:Scripting Commands OFP Elite |ISKINDOF]]
|timestamp= 20150616175400
[[Category:Scripting Commands ArmA|ISKINDOF]]
|text= In case you cannot use [[isKindOf]] because of the reasons stated, just use [[BIS_fnc_returnParents]] with class names as return value:
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
<sqf>_isKindOf = "Rifle" in [configFile >> "CfgWeapons" >> "BWA3_G36K", true] call BIS_fnc_returnParents; // is true</sqf>
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Basstard
<dd class="notedate">Posted on June 16, 2015 - 17:54 (UTC)</dd>
|timestamp= 20150906222100
<dt class="note">[[User:James|James]]</dt>
|text= In {{arma3}} [[isKindOf]] works well with CfgWeapons and CfgMagazines using the syntax from example 3.<br>
<dd class="note">
It should be prefered to James' solution as it performs more than 25x faster. Tested in debug console with the following code snippets:
In case you cannot use [[isKindOf]] because of the reasons stated, just use [[BIS fnc returnParents]] with class names as return value:
<sqf>
<code> _isKindOf = "Rifle" [[in]] [([[configFile]] >> "CfgWeapons" >> "BWA3_G36K"),[[true]]<nowiki>]</nowiki> [[call]] [[BIS_fnc_returnParents]]; // is true</code>
"CA_Magazine" in ([configFile >> "CfgMagazines" >> "HandGrenade", true] call BIS_fnc_returnParents); // 0.12111 ms
</dd>
"HandGrenade" isKindOf ["CA_Magazine", configFile >> "CfgMagazines"]; // 0.00439453 ms
</dl>
</sqf>
<!-- DISCONTINUE Notes -->
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"