combatMode: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(ERROR is another return)
mNo edit summary
 
(67 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.00


|1.00|= Game version
|game2= ofpe
|version2= 1.00


|arg= global |= Arguments in MP
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Returns the combat mode of the given unit. See [[setCombatMode]] for more information about combat modes. |= Description
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| [[String]] <nowiki>=</nowiki> '''combatMode''' grp|= Syntax
|game5= arma2oa
|version5= 1.50


|p1= grp: [[Object]] or [[Group]] |= Parameter 1
|game6= tkoh
|version6= 1.00


| [[String]] - 
|game7= arma3
One of "BLUE", "GREEN", "WHITE", "YELLOW" and "RED" or "ERROR" |= Return value
|version7= 0.50
____________________________________________________________________________________________
 
|x1= <code>[[if]] (([[combatMode]] _grp1) == "BLUE") [[then]] {_grp1 [[setCombatMode]] "GREEN"};</code> |= Example 1
____________________________________________________________________________________________


| [[Mission_Editor:_Waypoints#Combat_Mode|combat mode description]], [[ArmA:_AI_Combat_Modes|AI Combat Modes]], [[setCombatMode]], [[behaviour]], [[setBehaviour]], [[skill]], [[setSkill array]], [[CfgAISkill]] |= See also
|arg= global


}}
|gr1= Groups


<h3 style="display:none">Notes</h3>
|gr2= AI Behaviour
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on August 3, 2006 - 14:25
|descr= Returns the combat mode of the given AI [[Group | group]]. See [[setCombatMode]] for more information about combat modes.
<dt class="note">'''[[User:Hardrock|hardrock]]'''<dd class="note">''Notes from before the conversion:''


Use [[setCombatMode]] to set the combat mode. The definitions of the colours are given under that command.
|s1= [[combatMode]] group


<dd class="notedate">
|p1= group: One of
<dt class="note">'''[[User:Ceeeb|Ceeeb]]'''
* [[Group]]
<dd class="note">
* [[Object]] of type [[Object|Unit]] - if the argument is unit [[Object]], unit's current group is used.
In '''OFP v1.96''', combatMode return value does not change when unit's combat mode is set with radio commands, ie troops under the player's command.


<!-- Note Section END -->
|r1= [[String]] - one of:
</dl>
* "BLUE"
* "GREEN"
* "WHITE"
* "YELLOW"
* "RED"
* "ERROR"


<h3 style="display:none">Bottom Section</h3>
|x1= <sqf>if (combatMode _grp1 == "BLUE") then {_grp1 setCombatMode "GREEN"};</sqf>


|seealso= [[Combat Modes]] [[setCombatMode]] [[behaviour]] [[setBehaviour]] [[skill]] [[setSkill]] [[Arma 3: AI Skill]] [[setUnitCombatMode]] [[unitCombatMode]] [[setCombatBehaviour]] [[combatBehaviour]]
}}


<dl class="command_description">


<dt><dt>
<dd class="notedate">
<dt class="note">[[User:Ceeeb|Ceeeb]]</dt>
<dd class="note">
In '''OFP v1.96''', combatMode return value does not change when unit's combat mode is set with radio commands, i.e troops under the player's command.


[[Category:Scripting Commands|COMBATMODE]]
</dl>
[[Category:Scripting Commands OFP 1.99|COMBATMODE]]
[[Category:Scripting Commands OFP 1.96|COMBATMODE]]
[[Category:Scripting Commands OFP 1.46|COMBATMODE]]
[[Category:Scripting Commands ArmA|COMBATMODE]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 09:46, 16 June 2024

Hover & click on the images for description

Description

Description:
Returns the combat mode of the given AI group. See setCombatMode for more information about combat modes.
Groups:
GroupsAI Behaviour

Syntax

Syntax:
combatMode group
Parameters:
group: One of
Return Value:
String - one of:
  • "BLUE"
  • "GREEN"
  • "WHITE"
  • "YELLOW"
  • "RED"
  • "ERROR"

Examples

Example 1:
if (combatMode _grp1 == "BLUE") then {_grp1 setCombatMode "GREEN"};

Additional Information

See also:
Combat Modes setCombatMode behaviour setBehaviour skill setSkill Arma 3: AI Skill setUnitCombatMode unitCombatMode setCombatBehaviour combatBehaviour

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
Ceeeb
In OFP v1.96, combatMode return value does not change when unit's combat mode is set with radio commands, i.e troops under the player's command.