checkAIFeature: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?]]" to "{{GameCategory|tkoh|Scripting Commands}}")
No edit summary
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.05


|1.05|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= Object Manipulation |GROUP1=
|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}} |DESCRIPTION=
____________________________________________________________________________________________


| '''checkAIFeature''' feature |SYNTAX=
|gr1= AI Behaviour


|p1= feature: [[String]] (see description) |PARAMETER1=
|descr= Checks if the given AI feature is currently enabled.


| [[Boolean]] - [[true]] if is enabled|RETURNVALUE=
|s1= [[checkAIFeature]] feature


|s2= unit '''checkAIFeature''' feature {{since|arma3|1.95.145843|y}} |SYNTAX2=
|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


|r2=[[Boolean]] - [[true]] if is enabled |RETURNVALUE2=
|s2since= arma3 1.96
____________________________________________________________________________________________


|x1 = <code>_featureUsed = [[checkAIFeature]] "AwareFormationSoft";</code>|EXAMPLE1=
|p21= unit: [[Object]] - unit to test AI feature for


|x2 = <code>_autotargetOn = bob [[checkAIFeature]] "AUTOTARGET";</code>|EXAMPLE2=
|p22= feature: [[String]] - [[disableAI]] / [[enableAI]] feature


| [[enableAIFeature]], [[enableAI]], [[disableAI]] |SEEALSO=
|r2=[[Boolean]] - [[true]] if is enabled
}}
 
|x1= <sqf>_featureUsed = checkAIFeature "AwareFormationSoft";</sqf>


<h3 style="display:none">Notes</h3>
|x2= <sqf>_autotargetOn = bob checkAIFeature "AUTOTARGET";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[enableAIFeature]] [[enableAI]] [[getUnitState]] [[disableAI]]
{{GameCategory|arma3|Scripting Commands}}
}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 13:51, 22 October 2024

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:
Return Value:
Boolean - true if is enabled

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