checkAIFeature: Difference between revisions

Latest revision as of 13:51, 22 October 2024

1.05

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:: Checks if the given AI feature is currently enabled.
Groups:: AI Behaviour

Syntax

Syntax:

checkAIFeature feature

Parameters:

feature: String - can be one of:

"AwareFormationSoft"
"CombatFormationSoft"
AI skill - see disableAI - Syntax 1 (since Arma 3 v1.96)

Return Value:

Boolean - true if is enabled

1.96

Alternative Syntax

Syntax:: unit checkAIFeature feature
Parameters:: unit: Object - unit to test AI feature for
: feature: String - disableAI / enableAI feature
Return Value:: Boolean - true if is enabled

Examples

Example 1:: _featureUsed = checkAIFeature "AwareFormationSoft";
Example 2:: _autotargetOn = bob checkAIFeature "AUTOTARGET";

Additional Information

See also:: enableAIFeature enableAI getUnitState disableAI

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

@@ Line 1: / Line 1: @@
-{{Command
+{{RV|type=command
-| arma2
+|game1= arma2
+|version1= 1.05
-|1.05
+|game2= arma2oa
+|version2= 1.50
-|gr1= Object Manipulation
+|game3= tkoh
+|version3= 1.00
-| Checks if the given AI feature is currently enabled. Feature may be one of:
+|game4= arma3
-* <tt>"AwareFormationSoft"</tt>
+|version4= 0.50
-* <tt>"CombatFormationSoft"</tt>
-* [[disableAI]]/[[enableAI]] AI skill {{Since|arma3|1.95.145843|y}}
-| '''checkAIFeature''' feature
+|gr1= AI Behaviour
-|p1= feature: [[String]] (see description)
+|descr= Checks if the given AI feature is currently enabled.
-| [[Boolean]] - [[true]] if is enabled
+|s1= [[checkAIFeature]] feature
-|s2= unit '''checkAIFeature''' feature {{Since|arma3|1.95.145843|y}}
+|p1= feature: [[String]] - can be one of:
+* {{hl|"AwareFormationSoft"}}
+* {{hl|"CombatFormationSoft"}}
+* AI skill - see {{Link|disableAI#Syntax 1}} (since {{arma3}} v1.96)
-|p21= unit: [[Object]] - unit to test AI feature for |PARAMETER21=
+|r1= [[Boolean]] - [[true]] if is enabled
-|p22= feature: [[String]] - [[disableAI]] / [[enableAI]] feature |PARAMETER22=
+|s2= unit [[checkAIFeature]] feature
+|s2since= arma3 1.96
+|p21= unit: [[Object]] - unit to test AI feature for
+|p22= feature: [[String]] - [[disableAI]] / [[enableAI]] feature
 |r2=[[Boolean]] - [[true]] if is enabled
-|x1 = <code>_featureUsed = [[checkAIFeature]] "AwareFormationSoft";</code>
+|x1= <sqf>_featureUsed = checkAIFeature "AwareFormationSoft";</sqf>
-|x2 = <code>_autotargetOn = bob [[checkAIFeature]] "AUTOTARGET";</code>
+|x2= <sqf>_autotargetOn = bob checkAIFeature "AUTOTARGET";</sqf>
-| [[enableAIFeature]], [[enableAI]], [[disableAI]]
+|seealso= [[enableAIFeature]] [[enableAI]] [[getUnitState]] [[disableAI]]
 }}
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}