Banner Image

Module AI.AI_CAS

AI - Perform Close Air Support (CAS) near friendlies.

Features:

  • Hold and standby within a patrol zone.
  • Engage upon command the enemies within an engagement zone.
  • Loop the zone until all enemies are eliminated.
  • Trigger different events upon the results achieved.
  • After combat, return to the patrol zone and hold.
  • RTB when commanded or after fuel.

Demo Missions


YouTube Playlist


Author: FlightControl

Contributions:

  • Quax: Concept, Advice & Testing.
  • Pikey: Concept, Advice & Testing.
  • Gunterlund: Test case revision.

Global(s)

Global AI_CAS_ZONE

Implements the core functions to provide Close Air Support in an Engage Core.Zone by an AIR Wrapper.Controllable or Wrapper.Group.

#AI_CAS_ZONE AI_CAS_ZONE

Implements the core functions to provide Close Air Support in an Engage Core.Zone by an AIR Wrapper.Controllable or Wrapper.Group.

The AI_CAS_ZONE runs a process. It holds an AI in a Patrol Zone and when the AI is commanded to engage, it will fly to an Engage Zone.

HoldAndEngage

The AI_CAS_ZONE is assigned a Wrapper.Group and this must be done before the AI_CAS_ZONE process can be started through the Start event.

Start Event

Upon started, The AI will Route itself towards the random 3D point within a 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 until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.

Route Event

When the AI is commanded to provide Close Air Support (through the event Engage), the AI will fly towards the Engage Zone. Any target that is detected in the Engage Zone will be reported and will be destroyed by the AI.

Engage Event

The AI will detect the targets and will only destroy the targets within the Engage Zone.

Engage Event

Every target that is destroyed, is reported< by the AI.

Engage Event

Note that the AI does not know when the Engage Zone is cleared, and therefore will keep circling in the zone.

Engage Event

Until it is notified through the event Accomplish, which is to be triggered by an observing party:

  • a FAC
  • a timed event
  • a menu option selected by a human
  • a condition
  • others ...

Engage Event

When the AI has accomplished the CAS, it will fly back to the Patrol Zone.

Engage Event

It will keep patrolling there, until it is notified to RTB or move to another CAS Zone. It can be notified to go RTB through the RTB event.

When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.

Engage Event

AI_CAS_ZONE constructor

AI_CAS_ZONE is a FSM

Process

2.1. AI_CAS_ZONE 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 targets in the Engage Zone, executing CAS.
  • Returning ( Group ): The AI is returning to Base..

2.2. AI_CAS_ZONE Events

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_CAS_ZONE Description

AI_CAS_ZONE.AIControllable

The Wrapper.Controllable patrolling.

AI_CAS_ZONE:Abort()

Synchronous Event Trigger for Event Abort.

AI_CAS_ZONE:Accomplish()

Synchronous Event Trigger for Event Accomplish.

AI_CAS_ZONE.Accomplished

AI_CAS_ZONE:Destroy()

Synchronous Event Trigger for Event Destroy.

AI_CAS_ZONE:Engage(EngageSpeed, EngageAltitude, EngageWeaponExpend, EngageAttackQty, EngageDirection)

Synchronous Event Trigger for Event Engage.

AI_CAS_ZONE.EngageRoute(EngageGroup, Fsm)

AI_CAS_ZONE.EngageZone

AI_CAS_ZONE:Fired()

Synchronous Event Trigger for Event Fired.

AI_CAS_ZONE:New(PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageZone, PatrolAltType)

Creates a new AI_CAS_ZONE object

AI_CAS_ZONE:OnAfterAbort(Controllable, From, Event, To)

OnAfter Transition Handler for Event Abort.

AI_CAS_ZONE:OnAfterAccomplish(Controllable, From, Event, To)

OnAfter Transition Handler for Event Accomplish.

AI_CAS_ZONE:OnAfterDestroy(Controllable, From, Event, To)

OnAfter Transition Handler for Event Destroy.

AI_CAS_ZONE:OnAfterEngage(Controllable, From, Event, To)

OnAfter Transition Handler for Event Engage.

AI_CAS_ZONE:OnAfterFired(Controllable, From, Event, To)

OnAfter Transition Handler for Event Fired.

AI_CAS_ZONE:OnBeforeAbort(Controllable, From, Event, To)

OnBefore Transition Handler for Event Abort.

AI_CAS_ZONE:OnBeforeAccomplish(Controllable, From, Event, To)

OnBefore Transition Handler for Event Accomplish.

AI_CAS_ZONE:OnBeforeDestroy(Controllable, From, Event, To)

OnBefore Transition Handler for Event Destroy.

AI_CAS_ZONE:OnBeforeEngage(Controllable, From, Event, To)

OnBefore Transition Handler for Event Engage.

AI_CAS_ZONE:OnBeforeFired(Controllable, From, Event, To)

OnBefore Transition Handler for Event Fired.

AI_CAS_ZONE:OnEnterEngaging(Controllable, From, Event, To)

OnEnter Transition Handler for State Engaging.

AI_CAS_ZONE:OnEventDead(EventData)

AI_CAS_ZONE:OnLeaveEngaging(Controllable, From, Event, To)

OnLeave Transition Handler for State Engaging.

AI_CAS_ZONE:SetEngageZone(EngageZone)

Set the Engage Zone where the AI is performing CAS.

AI_CAS_ZONE.TargetZone

The Core.Zone where the patrol needs to be executed.

AI_CAS_ZONE:__Abort(Delay)

Asynchronous Event Trigger for Event Abort.

AI_CAS_ZONE:__Accomplish(Delay)

Asynchronous Event Trigger for Event Accomplish.

AI_CAS_ZONE:__Destroy(Delay)

Asynchronous Event Trigger for Event Destroy.

AI_CAS_ZONE:__Engage(Delay, EngageSpeed, EngageAltitude, EngageWeaponExpend, EngageAttackQty, EngageDirection)

Asynchronous Event Trigger for Event Engage.

AI_CAS_ZONE:__Fired(Delay)

Asynchronous Event Trigger for Event Fired.

AI_CAS_ZONE:onafterAbort(Controllable, From, Event, To)

AI_CAS_ZONE:onafterAccomplish(Controllable, From, Event, To)

AI_CAS_ZONE:onafterDestroy(Controllable, From, Event, To, EventData)

AI_CAS_ZONE:onafterEngage(Controllable, From, Event, To, EngageSpeed, EngageAltitude, EngageWeaponExpend, EngageAttackQty, EngageDirection)

AI_CAS_ZONE:onafterStart(Controllable, From, Event, To)

onafter State Transition for Event Start.

AI_CAS_ZONE:onafterTarget(Controllable, From, Event, To)

AI_CAS_ZONE:onbeforeEngage(Controllable, From, Event, To)

Fields and Methods inherited from AI_PATROL_ZONE Description

AI_CAS_ZONE.AIControllable

The Wrapper.Controllable patrolling.

AI_CAS_ZONE.CheckStatus

AI_CAS_ZONE:ClearDetectedUnits()

Clears the list of Wrapper.Unit#UNITs that were detected by the AI.

AI_CAS_ZONE.CoordTest

AI_CAS_ZONE:Detect()

Synchronous Event Trigger for Event Detect.

AI_CAS_ZONE.DetectActivated

AI_CAS_ZONE.DetectInterval

AI_CAS_ZONE.DetectOn

AI_CAS_ZONE.DetectZone

AI_CAS_ZONE:Detected()

Synchronous Event Trigger for Event Detected.

AI_CAS_ZONE.DetectedUnits

AI_CAS_ZONE:GetDetectedUnits()

Gets a list of Wrapper.Unit#UNITs that were detected by the AI.

AI_CAS_ZONE:ManageDamage(PatrolDamageThreshold)

When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.

AI_CAS_ZONE:ManageFuel(PatrolFuelThresholdPercentage, PatrolOutOfFuelOrbitTime)

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.

AI_CAS_ZONE:New(PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType)

Creates a new AI_PATROL_ZONE object

AI_CAS_ZONE:OnAfterDetect(Controllable, From, Event, To)

OnAfter Transition Handler for Event Detect.

AI_CAS_ZONE:OnAfterDetected(Controllable, From, Event, To)

OnAfter Transition Handler for Event Detected.

AI_CAS_ZONE:OnAfterRTB(Controllable, From, Event, To)

OnAfter Transition Handler for Event RTB.

AI_CAS_ZONE:OnAfterRoute(Controllable, From, Event, To)

OnAfter Transition Handler for Event Route.

AI_CAS_ZONE:OnAfterStart(Controllable, From, Event, To)

OnAfter Transition Handler for Event Start.

AI_CAS_ZONE:OnAfterStatus(Controllable, From, Event, To)

OnAfter Transition Handler for Event Status.

AI_CAS_ZONE:OnAfterStop(Controllable, From, Event, To)

OnAfter Transition Handler for Event Stop.

AI_CAS_ZONE:OnBeforeDetect(Controllable, From, Event, To)

OnBefore Transition Handler for Event Detect.

AI_CAS_ZONE:OnBeforeDetected(Controllable, From, Event, To)

OnBefore Transition Handler for Event Detected.

AI_CAS_ZONE:OnBeforeRTB(Controllable, From, Event, To)

OnBefore Transition Handler for Event RTB.

AI_CAS_ZONE:OnBeforeRoute(Controllable, From, Event, To)

OnBefore Transition Handler for Event Route.

AI_CAS_ZONE:OnBeforeStart(Controllable, From, Event, To)

OnBefore Transition Handler for Event Start.

AI_CAS_ZONE:OnBeforeStatus(Controllable, From, Event, To)

OnBefore Transition Handler for Event Status.

AI_CAS_ZONE:OnBeforeStop(Controllable, From, Event, To)

OnBefore Transition Handler for Event Stop.

AI_CAS_ZONE:OnCrash(EventData)

AI_CAS_ZONE:OnEjection(EventData)

AI_CAS_ZONE:OnEnterPatrolling(Controllable, From, Event, To)

OnEnter Transition Handler for State Patrolling.

AI_CAS_ZONE:OnEnterReturning(Controllable, From, Event, To)

OnEnter Transition Handler for State Returning.

AI_CAS_ZONE:OnEnterStopped(Controllable, From, Event, To)

OnEnter Transition Handler for State Stopped.

AI_CAS_ZONE:OnLeavePatrolling(Controllable, From, Event, To)

OnLeave Transition Handler for State Patrolling.

AI_CAS_ZONE:OnLeaveReturning(Controllable, From, Event, To)

OnLeave Transition Handler for State Returning.

AI_CAS_ZONE:OnLeaveStopped(Controllable, From, Event, To)

OnLeave Transition Handler for State Stopped.

AI_CAS_ZONE:OnPilotDead(EventData)

AI_CAS_ZONE.PatrolAltType

AI_CAS_ZONE.PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

AI_CAS_ZONE.PatrolDamageThreshold

AI_CAS_ZONE.PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

AI_CAS_ZONE.PatrolFuelThresholdPercentage

AI_CAS_ZONE.PatrolManageDamage

AI_CAS_ZONE.PatrolMaxSpeed

The maximum speed of the Wrapper.Controllable in km/h.

AI_CAS_ZONE.PatrolMinSpeed

The minimum speed of the Wrapper.Controllable in km/h.

AI_CAS_ZONE.PatrolOutOfFuelOrbitTime

AI_CAS_ZONE.PatrolZone

The Core.Zone where the patrol needs to be executed.

AI_CAS_ZONE:RTB()

Synchronous Event Trigger for Event RTB.

AI_CAS_ZONE:Route()

Synchronous Event Trigger for Event Route.

AI_CAS_ZONE:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude)

Sets the floor and ceiling altitude of the patrol.

AI_CAS_ZONE:SetDetectionActivated()

Activate the detection.

AI_CAS_ZONE:SetDetectionDeactivated()

Deactivate the detection.

AI_CAS_ZONE:SetDetectionOff()

Set the detection off.

AI_CAS_ZONE:SetDetectionOn()

Set the detection on.

AI_CAS_ZONE:SetDetectionZone(DetectionZone)

Set the detection zone where the AI is detecting targets.

AI_CAS_ZONE:SetRefreshTimeInterval(Seconds)

Set the interval in seconds between each detection executed by the AI.

AI_CAS_ZONE:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed)

Sets (modifies) the minimum and maximum speed of the patrol.

AI_CAS_ZONE:SetStatusOff()

Set the status checking off.

AI_CAS_ZONE:Start()

Synchronous Event Trigger for Event Start.

AI_CAS_ZONE:Status()

Synchronous Event Trigger for Event Status.

AI_CAS_ZONE:Stop()

Synchronous Event Trigger for Event Stop.

AI_CAS_ZONE:_NewPatrolRoute(AIControllable)

AI_CAS_ZONE:__Detect(Delay)

Asynchronous Event Trigger for Event Detect.

AI_CAS_ZONE:__Detected(Delay)

Asynchronous Event Trigger for Event Detected.

AI_CAS_ZONE:__RTB(Delay)

Asynchronous Event Trigger for Event RTB.

AI_CAS_ZONE:__Route(Delay)

Asynchronous Event Trigger for Event Route.

AI_CAS_ZONE:__Start(Delay)

Asynchronous Event Trigger for Event Start.

AI_CAS_ZONE:__Status(Delay)

Asynchronous Event Trigger for Event Status.

AI_CAS_ZONE:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

AI_CAS_ZONE:onafterDead()

AI_CAS_ZONE:onafterDetect(Controllable, From, Event, To)

AI_CAS_ZONE:onafterRTB()

AI_CAS_ZONE:onafterRoute(Controllable, From, Event, To)

Defines a new patrol route using the #AI_PATROL_ZONE parameters and settings.

AI_CAS_ZONE:onafterStart(Controllable, From, Event, To)

Defines a new patrol route using the #AI_PATROL_ZONE parameters and settings.

AI_CAS_ZONE:onafterStatus()

AI_CAS_ZONE:onbeforeDetect(Controllable, From, Event, To)

AI_CAS_ZONE:onbeforeStatus()

Fields and Methods inherited from FSM_CONTROLLABLE Description

AI_CAS_ZONE.Controllable

AI_CAS_ZONE:GetControllable()

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_CAS_ZONE:New(FSMT, Controllable)

Creates a new FSM_CONTROLLABLE object.

AI_CAS_ZONE:OnAfterStop(Controllable, From, Event, To)

OnAfter Transition Handler for Event Stop.

AI_CAS_ZONE:OnBeforeStop(Controllable, From, Event, To)

OnBefore Transition Handler for Event Stop.

AI_CAS_ZONE:OnEnterStopped(Controllable, From, Event, To)

OnEnter Transition Handler for State Stopped.

AI_CAS_ZONE:OnLeaveStopped(Controllable, From, Event, To)

OnLeave Transition Handler for State Stopped.

AI_CAS_ZONE:SetControllable(FSMControllable)

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_CAS_ZONE:Stop()

Synchronous Event Trigger for Event Stop.

AI_CAS_ZONE:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

AI_CAS_ZONE:_call_handler(step, trigger, params, EventName)

AI_CAS_ZONE class

Field(s)

Core.Zone#ZONE_BASE AI_CAS_ZONE.TargetZone

The Core.Zone where the patrol needs to be executed.

Function(s)

Synchronous Event Trigger for Event Abort.

Defined in:

AI_CAS_ZONE

Synchronous Event Trigger for Event Accomplish.

Defined in:

AI_CAS_ZONE

Synchronous Event Trigger for Event Destroy.

Defined in:

AI_CAS_ZONE

Synchronous Event Trigger for Event Engage.

Defined in:

AI_CAS_ZONE

Parameters:

#number EngageSpeed

(optional) The speed the Group will hold when engaging to the target zone.

DCS#Distance EngageAltitude

(optional) Desired altitude to perform the unit engagement.

DCS#AI.Task.WeaponExpend EngageWeaponExpend

(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion. Use the structure DCS#AI.Task.WeaponExpend to define the amount of weapons to be release at each attack.

#number EngageAttackQty

(optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.

DCS#Azimuth EngageDirection

(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.

@param AI.AI_CAS#AI_CAS_ZONE @param Wrapper.Group#GROUP EngageGroup

Defined in:

AI_CAS_ZONE

Parameters:

EngageGroup

Fsm

Synchronous Event Trigger for Event Fired.

Defined in:

AI_CAS_ZONE

Creates a new AI_CAS_ZONE object

Defined in:

AI_CAS_ZONE

Parameters:

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.Controllable in km/h.

DCS#Speed PatrolMaxSpeed

The maximum speed of the Wrapper.Controllable in km/h.

Core.Zone#ZONE_BASE EngageZone

The zone where the engage will happen.

DCS#AltitudeType PatrolAltType

The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO

Return value:

self

OnAfter Transition Handler for Event Abort.

Defined in:

AI_CAS_ZONE

Parameters:

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 Accomplish.

Defined in:

AI_CAS_ZONE

Parameters:

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 Destroy.

Defined in:

AI_CAS_ZONE

Parameters:

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 Engage.

Defined in:

AI_CAS_ZONE

Parameters:

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 Fired.

Defined in:

AI_CAS_ZONE

Parameters:

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 Abort.

Defined in:

AI_CAS_ZONE

Parameters:

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 Accomplish.

Defined in:

AI_CAS_ZONE

Parameters:

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 Destroy.

Defined in:

AI_CAS_ZONE

Parameters:

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 Engage.

Defined in:

AI_CAS_ZONE

Parameters:

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 Fired.

Defined in:

AI_CAS_ZONE

Parameters:

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.

OnEnter Transition Handler for State Engaging.

Defined in:

AI_CAS_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

@param #AI_CAS_ZONE self @param Core.Event#EVENTDATA EventData

Defined in:

AI_CAS_ZONE

Parameter:

EventData

OnLeave Transition Handler for State Engaging.

Defined in:

AI_CAS_ZONE

Parameters:

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.

Set the Engage Zone where the AI is performing CAS.

Note that if the EngageZone is changed, the AI needs to re-detect targets.

Defined in:

AI_CAS_ZONE

Parameter:

Core.Zone#ZONE EngageZone

The zone where the AI is performing CAS.

Return value:

self

Asynchronous Event Trigger for Event Abort.

Defined in:

AI_CAS_ZONE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Accomplish.

Defined in:

AI_CAS_ZONE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Destroy.

Defined in:

AI_CAS_ZONE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Engage.

Defined in:

AI_CAS_ZONE

Parameters:

#number Delay

The delay in seconds.

#number EngageSpeed

(optional) The speed the Group will hold when engaging to the target zone.

DCS#Distance EngageAltitude

(optional) Desired altitude to perform the unit engagement.

DCS#AI.Task.WeaponExpend EngageWeaponExpend

(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion. Use the structure DCS#AI.Task.WeaponExpend to define the amount of weapons to be release at each attack.

#number EngageAttackQty

(optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.

DCS#Azimuth EngageDirection

(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.

Asynchronous Event Trigger for Event Fired.

Defined in:

AI_CAS_ZONE

Parameter:

#number Delay

The delay in seconds.

@param #AI_CAS_ZONE self @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. @param #string From The From State string. @param #string Event The Event string. @param #string To The To State string.

Defined in:

AI_CAS_ZONE

Parameters:

Controllable

From

Event

To

@param #AI_CAS_ZONE self @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. @param #string From The From State string. @param #string Event The Event string. @param #string To The To State string.

Defined in:

AI_CAS_ZONE

Parameters:

Controllable

From

Event

To

@param #AI_CAS_ZONE self @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. @param #string From The From State string. @param #string Event The Event string. @param #string To The To State string. @param Core.Event#EVENTDATA EventData

Defined in:

AI_CAS_ZONE

Parameters:

Controllable

From

Event

To

EventData

@param #AI_CAS_ZONE self @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. @param #string From The From State string. @param #string Event The Event string. @param #string To The To State string. @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone. @param DCS#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement. @param DCS#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion. @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo. @param DCS#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.

Defined in:

AI_CAS_ZONE

Parameters:

Controllable

From

Event

To

EngageSpeed

EngageAltitude

EngageWeaponExpend

EngageAttackQty

EngageDirection

onafter State Transition for Event Start.

Defined in:

AI_CAS_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

@param #AI_CAS_ZONE self @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. @param #string From The From State string. @param #string Event The Event string. @param #string To The To State string.

Defined in:

AI_CAS_ZONE

Parameters:

Controllable

From

Event

To

@param #AI_CAS_ZONE self @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. @param #string From The From State string. @param #string Event The Event string. @param #string To The To State string.

Defined in:

AI_CAS_ZONE

Parameters:

Controllable

From

Event

To

Field(s)

Core.Zone#ZONE_BASE AI_CAS_ZONE.TargetZone

The Core.Zone where the patrol needs to be executed.

Function(s)

Clears the list of Wrapper.Unit#UNITs that were detected by the AI.

Synchronous Event Trigger for Event Detect.

Synchronous Event Trigger for Event Detected.

Gets a list of Wrapper.Unit#UNITs that were detected by the AI.

No filtering is applied, so, ANY detected UNIT can be in this list. It is up to the mission designer to use the Wrapper.Unit class and methods to filter the targets.

Defined in:

Return value:

#table:

The list of Wrapper.Unit#UNITs

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:

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_PATROL_ZONE. Once the time is finished, the old AI will return to the base.

Defined in:

Parameters:

#number PatrolFuelThresholdPercentage

The threshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.

#number PatrolOutOfFuelOrbitTime

The amount of seconds the out of fuel AIControllable will orbit before returning to the base.

Return value:

Creates a new AI_PATROL_ZONE object

Defined in:

Parameters:

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.Controllable in km/h.

DCS#Speed PatrolMaxSpeed

The maximum speed of the Wrapper.Controllable in km/h.

DCS#AltitudeType PatrolAltType

The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO

Return value:

Usage:

-- Define a new AI_PATROL_ZONE Object. This PatrolArea will patrol an AIControllable within PatrolZone between 3000 and 6000 meters, with a variying speed between 600 and 900 km/h.
PatrolZone = ZONE:New( 'PatrolZone' )
PatrolSpawn = SPAWN:New( 'Patrol Group' )
PatrolArea = AI_PATROL_ZONE:New( PatrolZone, 3000, 6000, 600, 900 )

OnAfter Transition Handler for Event Detect.

Defined in:

Parameters:

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 Detected.

Defined in:

Parameters:

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 RTB.

Defined in:

Parameters:

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 Route.

Defined in:

Parameters:

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 Start.

Defined in:

Parameters:

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 Status.

Defined in:

Parameters:

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:

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 Detect.

Defined in:

Parameters:

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 Detected.

Defined in:

Parameters:

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 RTB.

Defined in:

Parameters:

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 Route.

Defined in:

Parameters:

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 Start.

Defined in:

Parameters:

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 Status.

Defined in:

Parameters:

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:

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_PATROL_ZONE self @param Core.Event#EVENTDATA EventData

Defined in:

Parameter:

EventData

@param #AI_PATROL_ZONE self @param Core.Event#EVENTDATA EventData

Defined in:

Parameter:

EventData

OnEnter Transition Handler for State Patrolling.

Defined in:

Parameters:

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 Returning.

Defined in:

Parameters:

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:

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 Patrolling.

Defined in:

Parameters:

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 Returning.

Defined in:

Parameters:

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:

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_PATROL_ZONE self @param Core.Event#EVENTDATA EventData

Defined in:

Parameter:

EventData

Synchronous Event Trigger for Event RTB.

Synchronous Event Trigger for Event Route.

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:

Activate the detection.

The AI will detect for targets if the Detection is switched On.

Defined in:

Return value:

Deactivate the detection.

The AI will NOT detect for targets.

Defined in:

Return value:

Set the detection off.

The AI will NOT detect for targets. However, the list of already detected targets will be kept and can be enquired!

Defined in:

Return value:

Set the detection on.

The AI will detect for targets.

Defined in:

Return value:

Set the detection zone where the AI is detecting targets.

Defined in:

Parameter:

Core.Zone#ZONE DetectionZone

The zone where to detect targets.

Return value:

Set the interval in seconds between each detection executed by the AI.

The list of already detected targets will be kept and updated. Newly detected targets will be added, but already detected targets that were not detected in this cycle, will NOT be removed! The default interval is 30 seconds.

Defined in:

Parameter:

#number Seconds

The interval in seconds.

Return value:

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:

Set the status checking off.

Defined in:

Return value:

Synchronous Event Trigger for Event Start.

Synchronous Event Trigger for Event Status.

Synchronous Event Trigger for Event Stop.

@param Wrapper.Controllable#CONTROLLABLE AIControllable This static method is called from the route path within the last task at the last waypoint of the Controllable. Note that this method is required, as triggers the next route when patrolling for the Controllable.

Defined in:

Parameter:

AIControllable

Asynchronous Event Trigger for Event Detect.

Defined in:

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Detected.

Defined in:

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event RTB.

Defined in:

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Route.

Defined in:

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Start.

Defined in:

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Status.

Defined in:

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Stop.

Defined in:

Parameter:

#number Delay

The delay in seconds.

@param #AI_PATROL_ZONE self

@param #AI_PATROL_ZONE self @param Wrapper.Controllable#CONTROLLABLE Controllable

Defined in:

Parameters:

Controllable

From

Event

To

@param #AI_PATROL_ZONE self

Defines a new patrol route using the #AI_PATROL_ZONE parameters and settings.

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Defines a new patrol route using the #AI_PATROL_ZONE parameters and settings.

Defined in:

Parameters:

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:

@param #AI_PATROL_ZONE self

@param #AI_PATROL_ZONE self @param Wrapper.Controllable#CONTROLLABLE Controllable+

Defined in:

Parameters:

Controllable

From

Event

To

@param #AI_PATROL_ZONE self

Field(s)

Core.Zone#ZONE_BASE AI_CAS_ZONE.TargetZone

The Core.Zone where the patrol needs to be executed.

Function(s)

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Creates a new FSM_CONTROLLABLE object.

Defined in:

Parameters:

#table FSMT

Finite State Machine Table

(optional) The CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Return value:

OnAfter Transition Handler for Event Stop.

Defined in:

Parameters:

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 Stop.

Defined in:

Parameters:

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.

OnEnter Transition Handler for State Stopped.

Defined in:

Parameters:

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 Stopped.

Defined in:

Parameters:

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.

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Defined in:

Parameter:

Return value:

Synchronous Event Trigger for Event Stop.

Asynchronous Event Trigger for Event Stop.

Defined in:

Parameter:

#number Delay

The delay in seconds.

Defined in:

Parameters:

step

trigger

params

EventName