Module AI.AI_A2A_Cap
AI - Models the process of Combat Air Patrol (CAP) for airplanes.
This is a class used in the AI.AI_A2A_Dispatcher.
Author: FlightControl
Global(s)
Global AI_A2A_CAP |
The AI_A2A_CAP class implements the core functions to patrol a Core.Zone by an AI Wrapper.Group or Wrapper.Group and automatically engage any airborne enemies that are within a certain range or within a certain zone. |
The AI_A2A_CAP class implements the core functions to patrol a Core.Zone by an AI Wrapper.Group or Wrapper.Group and automatically engage any airborne enemies that are within a certain range or within a certain zone.
The AI_A2A_CAP is assigned a Wrapper.Group and this must be done before the AI_A2A_CAP process can be started using the Start event.
The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits. Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
This cycle will continue.
During the patrol, the AI will detect enemy targets, which are reported through the Detected event.
When enemies are detected, the AI will automatically engage the enemy.
Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB. When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
1. AI_A2A_CAP constructor
- AI_A2A_CAP.New(): Creates a new AI_A2A_CAP object.
2. AI_A2A_CAP is a FSM
2.1 AI_A2A_CAP States
- None ( Group ): The process is not started yet.
- Patrolling ( Group ): The AI is patrolling the Patrol Zone.
- Engaging ( Group ): The AI is engaging the bogeys.
- Returning ( Group ): The AI is returning to Base..
2.2 AI_A2A_CAP Events
- **AI.AI_Patrol#AI_PATROL_ZONE.Start**: Start the process.
- **AI.AI_Patrol#AI_PATROL_ZONE.Route**: Route the AI to a new random 3D point within the Patrol Zone.
- **AI_A2A_CAP.Engage**: Let the AI engage the bogeys.
- **AI_A2A_CAP.Abort**: Aborts the engagement and return patrolling in the patrol zone.
- **AI.AI_Patrol#AI_PATROL_ZONE.RTB**: Route the AI to the home base.
- **AI.AI_Patrol#AI_PATROL_ZONE.Detect**: The AI is detecting targets.
- **AI.AI_Patrol#AI_PATROL_ZONE.Detected**: The AI has detected new targets.
- **AI_A2A_CAP.Destroy**: The AI has destroyed a bogey Wrapper.Unit.
- **AI_A2A_CAP.Destroyed**: The AI has destroyed all bogeys Wrapper.Units assigned in the CAS task.
- Status ( Group ): The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
3. Set the Range of Engagement
An optional range can be set in meters, that will define when the AI will engage with the detected airborne enemy targets. The range can be beyond or smaller than the range of the Patrol Zone. The range is applied at the position of the AI. Use the method AI_A2A_CAP.SetEngageRange() to define that range.
4. Set the Zone of Engagement
An optional Core.Zone can be set, that will define when the AI will engage with the detected airborne enemy targets. Use the method AI_A2A_CAP.SetEngageZone() to define that Zone.
Developer Note
Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE Therefore, this class is considered to be deprecated
Type(s)
| Fields and Methods inherited from AI_A2A_CAP | Description |
|---|---|
AI_A2A_CAP:CreateAttackUnitTasks(AttackSetUnit, DefenderGroup, EngageAltitude) |
Evaluate the attack and create an AttackUnitTask list. |
|
Creates a new AI_A2A_CAP object |
|
|
Creates a new AI_A2A_CAP object |
|
|
Set the Engage Range when the AI will engage with airborne enemies. |
|
|
Set the Engage Zone which defines where the AI will engage bogies. |
|
|
onafter State Transition for Event Patrol. |
| Fields and Methods inherited from AI_AIR_PATROL | Description |
|---|---|
|
Creates a new AI_AIR_PATROL object |
|
|
OnAfter Transition Handler for Event Patrol. |
|
|
OnAfter Transition Handler for Event PatrolRoute. |
|
|
OnBefore Transition Handler for Event Patrol. |
|
|
OnBefore Transition Handler for Event PatrolRoute. |
|
|
OnEnter Transition Handler for State Patrolling. |
|
|
OnLeave Transition Handler for State Patrolling. |
|
|
Synchronous Event Trigger for Event Patrol. |
|
|
Synchronous Event Trigger for Event PatrolRoute. |
|
|
Resumes the AIPatrol |
|
|
Set the Engage Range when the AI will engage with airborne enemies. |
|
|
Set race track parameters. |
|
|
Asynchronous Event Trigger for Event Patrol. |
|
|
Asynchronous Event Trigger for Event PatrolRoute. |
|
|
This static method is called from the route path within the last task at the last waypoint of the AIPatrol. |
|
|
Defines a new patrol route using the AI.AI_Patrol#AI_PATROL_ZONE parameters and settings. |
|
|
Defines a new patrol route using the AI.AI_Patrol#AI_PATROL_ZONE parameters and settings. |
|
| Fields and Methods inherited from AI_AIR | Description |
|---|---|
|
Creates a new AI_AIR process. |
|
|
OnAfter Transition Handler for Event RTB. |
|
|
Refuel Handler OnAfter for AI_AIR |
|
|
Start Handler OnAfter for AI_AIR |
|
|
OnAfter Transition Handler for Event Status. |
|
|
OnAfter Transition Handler for Event Stop. |
|
|
OnBefore Transition Handler for Event RTB. |
|
|
Refuel Handler OnBefore for AI_AIR |
|
|
Start Handler OnBefore for AI_AIR |
|
|
OnBefore Transition Handler for Event Status. |
|
|
OnBefore Transition Handler for Event Stop. |
|
|
OnEnter Transition Handler for State Returning. |
|
|
OnEnter Transition Handler for State Stopped. |
|
|
OnLeave Transition Handler for State Returning. |
|
|
OnLeave Transition Handler for State Stopped. |
|
|
Synchronous Event Trigger for Event RTB. |
|
|
Refuel Trigger for AI_AIR |
|
AI_A2A_CAP:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude) |
Sets the floor and ceiling altitude of the patrol. |
|
When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base. |
|
|
Sets the disengage range, that when engaging a target beyond the specified range, the engagement will be cancelled and the plane will RTB. |
|
AI_A2A_CAP:SetFuelThreshold(FuelThresholdPercentage, OutOfFuelOrbitTime) |
When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base. |
|
Sets the home airbase. |
|
|
Sets (modifies) the minimum and maximum RTB speed of the patrol. |
|
|
Set the min and max factors on RTB speed. |
|
|
Sets (modifies) the minimum and maximum speed of the patrol. |
|
|
Set the status checking off. |
|
|
Sets to refuel at the given tanker. |
|
|
Start Trigger for AI_AIR |
|
|
Synchronous Event Trigger for Event Status. |
|
|
Synchronous Event Trigger for Event Stop. |
|
|
Asynchronous Event Trigger for Event RTB. |
|
|
Refuel Asynchronous Trigger for AI_AIR |
|
|
Start Asynchronous Trigger for AI_AIR |
|
|
Asynchronous Event Trigger for Event Status. |
|
|
Asynchronous Event Trigger for Event Stop. |
|
|
Coordinates the approriate returning action. |
|
|
Defines a new patrol route using the AI.AI_Patrol#AI_PATROL_ZONE parameters and settings. |
|
Field(s)
Function(s)
Evaluate the attack and create an AttackUnitTask list.
Defined in:
AI_A2A_CAP
Parameters:
Core.Set#SET_UNIT AttackSetUnit
The set of units to attack.
Wrapper.Group#GROUP DefenderGroup
The group of defenders.
#number EngageAltitude
The altitude to engage the targets.
Return value:
self
Creates a new AI_A2A_CAP object
Defined in:
AI_A2A_CAP
Parameters:
Wrapper.Group#GROUP AICap
Core.Zone#ZONE_BASE PatrolZone
The Core.Zone where the patrol needs to be executed.
DCS#Altitude PatrolFloorAltitude
The lowest altitude in meters where to execute the patrol.
DCS#Altitude PatrolCeilingAltitude
The highest altitude in meters where to execute the patrol.
DCS#Speed PatrolMinSpeed
The minimum speed of the Wrapper.Group in km/h.
DCS#Speed PatrolMaxSpeed
The maximum speed of the Wrapper.Group in km/h.
DCS#Speed EngageMinSpeed
The minimum speed of the Wrapper.Group in km/h when engaging a target.
DCS#Speed EngageMaxSpeed
The maximum speed of the Wrapper.Group in km/h when engaging a target.
DCS#AltitudeType PatrolAltType
The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
Return value:
Creates a new AI_A2A_CAP object
Defined in:
AI_A2A_CAP
Parameters:
Wrapper.Group#GROUP AICap
DCS#Speed EngageMinSpeed
The minimum speed of the Wrapper.Group in km/h when engaging a target.
DCS#Speed EngageMaxSpeed
The maximum speed of the Wrapper.Group in km/h when engaging a target.
DCS#Altitude EngageFloorAltitude
The lowest altitude in meters where to execute the engagement.
DCS#Altitude EngageCeilingAltitude
The highest altitude in meters where to execute the engagement.
DCS#AltitudeType EngageAltType
The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
Core.Zone#ZONE_BASE PatrolZone
The Core.Zone where the patrol needs to be executed.
DCS#Speed PatrolMinSpeed
The minimum speed of the Wrapper.Group in km/h.
DCS#Speed PatrolMaxSpeed
The maximum speed of the Wrapper.Group in km/h.
DCS#Altitude PatrolFloorAltitude
The lowest altitude in meters where to execute the patrol.
DCS#Altitude PatrolCeilingAltitude
The highest altitude in meters where to execute the patrol.
DCS#AltitudeType PatrolAltType
The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
Return value:
Set the Engage Range when the AI will engage with airborne enemies.
Defined in:
AI_A2A_CAP
Parameter:
#number EngageRange
The Engage Range.
Return value:
self
Set the Engage Zone which defines where the AI will engage bogies.
Defined in:
AI_A2A_CAP
Parameter:
Core.Zone#ZONE EngageZone
The zone where the AI is performing CAP.
Return value:
self
onafter State Transition for Event Patrol.
Defined in:
AI_A2A_CAP
Parameters:
Wrapper.Group#GROUP AICap
The AI Group managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Field(s)
Function(s)
Creates a new AI_AIR_PATROL object
Defined in:
Parameters:
AI.AI_Air#AI_AIR AI_Air
The AI_AIR FSM.
Wrapper.Group#GROUP AIGroup
The AI group.
Core.Zone#ZONE_BASE PatrolZone
The Core.Zone where the patrol needs to be executed.
DCS#Altitude PatrolFloorAltitude
(optional, default = 1000m ) The lowest altitude in meters where to execute the patrol.
DCS#Altitude PatrolCeilingAltitude
(optional, default = 1500m ) The highest altitude in meters where to execute the patrol.
DCS#Speed PatrolMinSpeed
(optional, default = 50% of max speed) The minimum speed of the Wrapper.Group in km/h.
DCS#Speed PatrolMaxSpeed
(optional, default = 75% of max speed) The maximum speed of the Wrapper.Group in km/h.
DCS#AltitudeType PatrolAltType
The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO.
Return value:
OnAfter Transition Handler for Event Patrol.
Defined in:
Parameters:
Wrapper.Group#GROUP AIPatrol
The Group Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnAfter Transition Handler for Event PatrolRoute.
Defined in:
Parameters:
Wrapper.Group#GROUP AIPatrol
The Group Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnBefore Transition Handler for Event Patrol.
Defined in:
Parameters:
Wrapper.Group#GROUP AIPatrol
The Group Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
OnBefore Transition Handler for Event PatrolRoute.
Defined in:
Parameters:
Wrapper.Group#GROUP AIPatrol
The Group Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
OnEnter Transition Handler for State Patrolling.
Defined in:
Parameters:
Wrapper.Group#GROUP AIPatrol
The Group Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnLeave Transition Handler for State Patrolling.
Defined in:
Parameters:
Wrapper.Group#GROUP AIPatrol
The Group Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
Synchronous Event Trigger for Event Patrol.
Defined in:
Synchronous Event Trigger for Event PatrolRoute.
Defined in:
Resumes the AIPatrol
Set the Engage Range when the AI will engage with airborne enemies.
Defined in:
Parameter:
#number EngageRange
The Engage Range.
Return value:
self
Set race track parameters.
CAP flights will perform race track patterns rather than randomly patrolling the zone.
Defined in:
Parameters:
#number LegMin
Min Length of the race track leg in meters. Default 10,000 m.
#number LegMax
Max length of the race track leg in meters. Default 15,000 m.
#number HeadingMin
Min heading of the race track in degrees. Default 0 deg, i.e. from South to North.
#number HeadingMax
Max heading of the race track in degrees. Default 180 deg, i.e. from South to North.
#number DurationMin
(Optional) Min duration before switching the orbit position. Default is keep same orbit until RTB or engage.
#number DurationMax
(Optional) Max duration before switching the orbit position. Default is keep same orbit until RTB or engage.
#table CapCoordinates
Table of coordinates of first race track point. Second point is determined by leg length and heading.
Return value:
self
Asynchronous Event Trigger for Event Patrol.
Asynchronous Event Trigger for Event PatrolRoute.
This static method is called from the route path within the last task at the last waypoint of the AIPatrol.
Note that this method is required, as triggers the next route when patrolling for the AIPatrol.
Defines a new patrol route using the AI.AI_Patrol#AI_PATROL_ZONE parameters and settings.
Defined in:
Parameters:
Wrapper.Group#GROUP AIPatrol
The Group Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
self
Defines a new patrol route using the AI.AI_Patrol#AI_PATROL_ZONE parameters and settings.
Defined in:
Parameters:
Wrapper.Group#GROUP AIPatrol
The Group managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Field(s)
Function(s)
Defined in:
Defined in:
Creates a new AI_AIR process.
Defined in:
Parameter:
Wrapper.Group#GROUP AIGroup
The group object to receive the A2G Process.
Return value:
OnAfter Transition Handler for Event RTB.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Refuel Handler OnAfter for AI_AIR
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
#string Event
#string To
Start Handler OnAfter for AI_AIR
OnAfter Transition Handler for Event Status.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnAfter Transition Handler for Event Stop.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnBefore Transition Handler for Event RTB.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
Refuel Handler OnBefore for AI_AIR
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
#string Event
#string To
Return value:
#boolean:
Start Handler OnBefore for AI_AIR
Defined in:
Parameters:
#string From
#string Event
#string To
Return value:
#boolean:
OnBefore Transition Handler for Event Status.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
OnBefore Transition Handler for Event Stop.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
@param #AI_AIR self @param Core.Event#EVENTDATA EventData
@param #AI_AIR self @param Core.Event#EVENTDATA EventData
OnEnter Transition Handler for State Returning.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnEnter Transition Handler for State Stopped.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
OnLeave Transition Handler for State Returning.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
OnLeave Transition Handler for State Stopped.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
#boolean:
Return false to cancel Transition.
@param #AI_AIR self @param Core.Event#EVENTDATA EventData
@param Wrapper.Group#GROUP AIGroup
@param Wrapper.Group#GROUP AIGroup
@param Wrapper.Group#GROUP AIGroup
Sets the floor and ceiling altitude of the patrol.
Defined in:
Parameters:
DCS#Altitude PatrolFloorAltitude
The lowest altitude in meters where to execute the patrol.
DCS#Altitude PatrolCeilingAltitude
The highest altitude in meters where to execute the patrol.
Return value:
self
When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.
However, damage cannot be foreseen early on. Therefore, when the damage threshold is reached, the AI will return immediately to the home base (RTB). Note that for groups, the average damage of the complete group will be calculated. So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage threshold will be 0.25.
Defined in:
Parameter:
#number PatrolDamageThreshold
The threshold in percentage (between 0 and 1) when the AI is considered to be damaged.
Return value:
self
Sets the disengage range, that when engaging a target beyond the specified range, the engagement will be cancelled and the plane will RTB.
Defined in:
Parameter:
#number DisengageRadius
The disengage range.
Return value:
self
When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated. When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targeted to the AI_AIR. Once the time is finished, the old AI will return to the base.
Defined in:
Parameters:
#number FuelThresholdPercentage
The threshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
#number OutOfFuelOrbitTime
The amount of seconds the out of fuel AIControllable will orbit before returning to the base.
Return value:
self
Sets the home airbase.
Sets (modifies) the minimum and maximum RTB speed of the patrol.
Defined in:
Parameters:
DCS#Speed RTBMinSpeed
The minimum speed of the Wrapper.Controllable in km/h.
DCS#Speed RTBMaxSpeed
The maximum speed of the Wrapper.Controllable in km/h.
Return value:
self
Set the min and max factors on RTB speed.
Use this, if your planes are heading back to base too fast. Default values are 0.5 and 0.6. The RTB speed is calculated as the max speed of the unit multiplied by MinFactor (lower bracket) and multiplied by MaxFactor (upper bracket). A random value in this bracket is then applied in the waypoint routing generation.
Defined in:
Parameters:
#number MinFactor
Lower bracket factor. Defaults to 0.5.
#number MaxFactor
Upper bracket factor. Defaults to 0.6.
Return value:
self
Sets (modifies) the minimum and maximum speed of the patrol.
Defined in:
Parameters:
DCS#Speed PatrolMinSpeed
The minimum speed of the Wrapper.Controllable in km/h.
DCS#Speed PatrolMaxSpeed
The maximum speed of the Wrapper.Controllable in km/h.
Return value:
self
Set the status checking off.
Sets to refuel at the given tanker.
Defined in:
Parameter:
Wrapper.Group#GROUP TankerName
The group name of the tanker as defined within the Mission Editor or spawned.
Return value:
self
Asynchronous Event Trigger for Event RTB.
Refuel Asynchronous Trigger for AI_AIR
Start Asynchronous Trigger for AI_AIR
Asynchronous Event Trigger for Event Status.
Asynchronous Event Trigger for Event Stop.
@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup
@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup
@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup
@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup
Coordinates the approriate returning action.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
self
Defines a new patrol route using the AI.AI_Patrol#AI_PATROL_ZONE parameters and settings.
Defined in:
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
The From State string.
#string Event
The Event string.
#string To
The To State string.
Return value:
self