Module AI.AI_Air
AI - Models the process of AI air operations.
Author: FlightControl
Global(s)
Global AI_AIR |
The AI_AIR class implements the core functions to operate an AI Wrapper.Group. |
The AI_AIR class implements the core functions to operate an AI Wrapper.Group.
1) AI_AIR constructor
- AI_AIR.New(): Creates a new AI_AIR object.
2) AI_AIR is a Finite State Machine.
This section must be read as follows. Each of the rows indicate a state transition, triggered through an event, and with an ending state of the event was executed. The first column is the From state, the second column the Event, and the third column the To state.
So, each of the rows have the following structure.
- From => Event => To
Important to know is that an event can only be executed if the current state is the From state. This, when an Event that is being triggered has a From state that is equal to the Current state of the state machine, the event will be executed, and the resulting state will be the To state.
These are the different possible state transitions of this state machine implementation:
- Idle => Start => Monitoring
2.1) AI_AIR States.
- Idle: The process is idle.
2.2) AI_AIR Events.
- Start: Start the transport process.
- Stop: Stop the transport process.
- Monitor: Monitor and take action.
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_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_AIR: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_AIR: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. |
|
| Fields and Methods inherited from FSM_CONTROLLABLE | Description |
|---|---|
|
Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs. |
|
|
Creates a new FSM_CONTROLLABLE object. |
|
|
OnAfter Transition Handler for Event Stop. |
|
|
OnBefore Transition Handler for Event Stop. |
|
|
OnEnter Transition Handler for State Stopped. |
|
|
OnLeave Transition Handler for State Stopped. |
|
|
Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs. |
|
|
Synchronous Event Trigger for Event Stop. |
|
|
Asynchronous Event Trigger for Event Stop. |
|
Field(s)
The delay of each task given to the AI.
Function(s)
Defined in:
AI_AIR
Defined in:
AI_AIR
Creates a new AI_AIR process.
Defined in:
AI_AIR
Parameter:
Wrapper.Group#GROUP AIGroup
The group object to receive the A2G Process.
Return value:
OnAfter Transition Handler for Event RTB.
Defined in:
AI_AIR
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:
AI_AIR
Parameters:
Wrapper.Controllable#CONTROLLABLE Controllable
The Controllable Object managed by the FSM.
#string From
#string Event
#string To
Start Handler OnAfter for AI_AIR
Defined in:
AI_AIR
Parameters:
#string From
#string Event
#string To
OnAfter Transition Handler for Event Status.
Defined in:
AI_AIR
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:
AI_AIR
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:
AI_AIR
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:
AI_AIR
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:
AI_AIR
Parameters:
#string From
#string Event
#string To
Return value:
#boolean:
OnBefore Transition Handler for Event Status.
Defined in:
AI_AIR
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:
AI_AIR
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
Defined in:
AI_AIR
Parameter:
EventData
@param #AI_AIR self @param Core.Event#EVENTDATA EventData
Defined in:
AI_AIR
Parameter:
EventData
OnEnter Transition Handler for State Returning.
Defined in:
AI_AIR
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:
AI_AIR
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:
AI_AIR
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:
AI_AIR
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
Defined in:
AI_AIR
Parameter:
EventData
@param Wrapper.Group#GROUP AIGroup
Defined in:
AI_AIR
Parameters:
AIGroup
Fsm
@param Wrapper.Group#GROUP AIGroup
Defined in:
AI_AIR
Parameters:
AIGroup
Fsm
@param Wrapper.Group#GROUP AIGroup
Defined in:
AI_AIR
Parameters:
AIGroup
Fsm
Sets the floor and ceiling altitude of the patrol.
Defined in:
AI_AIR
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:
AI_AIR
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:
AI_AIR
Parameter:
#number DisengageRadius
The disengage range.
Return value:
self
Defined in:
AI_AIR
Parameter:
Dispatcher
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:
AI_AIR
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:
AI_AIR
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:
AI_AIR
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:
AI_AIR
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
Sets to refuel at the given tanker.
Defined in:
AI_AIR
Parameter:
Wrapper.Group#GROUP TankerName
The group name of the tanker as defined within the Mission Editor or spawned.
Return value:
self
Defined in:
AI_AIR
Parameter:
Coordinate
Asynchronous Event Trigger for Event RTB.
Defined in:
AI_AIR
Parameter:
#number Delay
The delay in seconds.
Refuel Asynchronous Trigger for AI_AIR
Defined in:
AI_AIR
Parameter:
#number Delay
Start Asynchronous Trigger for AI_AIR
Defined in:
AI_AIR
Parameter:
#number Delay
Asynchronous Event Trigger for Event Status.
Defined in:
AI_AIR
Parameter:
#number Delay
The delay in seconds.
Asynchronous Event Trigger for Event Stop.
Defined in:
AI_AIR
Parameter:
#number Delay
The delay in seconds.
@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup
Defined in:
AI_AIR
Parameters:
AIGroup
From
Event
To
HoldTime
@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup
Defined in:
AI_AIR
Parameters:
AIGroup
From
Event
To
@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup
Defined in:
AI_AIR
Parameters:
AIGroup
From
Event
To
@param #AI_AIR self @param Wrapper.Group#GROUP AIGroup
Defined in:
AI_AIR
Parameters:
AIGroup
From
Event
To
Coordinates the approriate returning action.
Defined in:
AI_AIR
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:
AI_AIR
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
Field(s)
The delay of each task given to the AI.
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
Wrapper.Controllable#CONTROLLABLE Controllable
(optional) The CONTROLLABLE object that the FSM_CONTROLLABLE governs.
Return value:
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 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.
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 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.
Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.
Asynchronous Event Trigger for Event Stop.