Banner Image

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.

#AI_AIR AI_AIR

The AI_AIR class implements the core functions to operate an AI Wrapper.Group.

1) AI_AIR constructor

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.

Type(s)

Fields and Methods inherited from AI_AIR Description

AI_AIR.CheckStatus

AI_AIR:ClearTargetDistance()

AI_AIR.DisengageRadius

AI_AIR.FuelThresholdPercentage

AI_AIR:GetDispatcher()

AI_AIR.HomeAirbase

AI_AIR.IdleCount

AI_AIR:New(AIGroup)

Creates a new AI_AIR process.

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

OnAfter Transition Handler for Event RTB.

AI_AIR:OnAfterRefuel(Controllable, From, Event, To)

Refuel Handler OnAfter for AI_AIR

AI_AIR:OnAfterStart(From, Event, To)

Start Handler OnAfter for AI_AIR

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

OnAfter Transition Handler for Event Status.

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

OnAfter Transition Handler for Event Stop.

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

OnBefore Transition Handler for Event RTB.

AI_AIR:OnBeforeRefuel(Controllable, From, Event, To)

Refuel Handler OnBefore for AI_AIR

AI_AIR:OnBeforeStart(From, Event, To)

Start Handler OnBefore for AI_AIR

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

OnBefore Transition Handler for Event Status.

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

OnBefore Transition Handler for Event Stop.

AI_AIR:OnCrash(EventData)

AI_AIR:OnEjection(EventData)

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

OnEnter Transition Handler for State Returning.

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

OnEnter Transition Handler for State Stopped.

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

OnLeave Transition Handler for State Returning.

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

OnLeave Transition Handler for State Stopped.

AI_AIR:OnPilotDead(EventData)

AI_AIR.OutOfFuelOrbitTime

AI_AIR.PatrolCeilingAltitude

AI_AIR.PatrolDamageThreshold

AI_AIR.PatrolFloorAltitude

AI_AIR.PatrolManageDamage

AI_AIR.PatrolMaxSpeed

AI_AIR.PatrolMinSpeed

AI_AIR:RTB()

Synchronous Event Trigger for Event RTB.

AI_AIR.RTBHold(AIGroup, Fsm)

AI_AIR.RTBMaxSpeed

AI_AIR.RTBMinSpeed

AI_AIR.RTBRoute(AIGroup, Fsm)

AI_AIR:Refuel()

Refuel Trigger for AI_AIR

AI_AIR.Resume(AIGroup, Fsm)

AI_AIR:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude)

Sets the floor and ceiling altitude of the patrol.

AI_AIR:SetDamageThreshold(PatrolDamageThreshold)

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

AI_AIR:SetDisengageRadius(DisengageRadius)

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:SetDispatcher(Dispatcher)

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.

AI_AIR:SetHomeAirbase(HomeAirbase)

Sets the home airbase.

AI_AIR:SetRTBSpeed(RTBMinSpeed, RTBMaxSpeed)

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

AI_AIR:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed)

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

AI_AIR:SetStatusOff()

Set the status checking off.

AI_AIR:SetTanker(TankerName)

Sets to refuel at the given tanker.

AI_AIR:SetTargetDistance(Coordinate)

AI_AIR:Start()

Start Trigger for AI_AIR

AI_AIR:Status()

Synchronous Event Trigger for Event Status.

AI_AIR:Stop()

Synchronous Event Trigger for Event Stop.

AI_AIR.TankerName

AI_AIR.TaskDelay

AI_AIR:__RTB(Delay)

Asynchronous Event Trigger for Event RTB.

AI_AIR:__Refuel(Delay)

Refuel Asynchronous Trigger for AI_AIR

AI_AIR:__Start(Delay)

Start Asynchronous Trigger for AI_AIR

AI_AIR:__Status(Delay)

Asynchronous Event Trigger for Event Status.

AI_AIR:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

AI_AIR:onafterDead()

AI_AIR:onafterHold(AIGroup, From, Event, To, HoldTime)

AI_AIR:onafterHome(AIGroup, From, Event, To)

AI_AIR:onafterRTB(AIGroup, From, Event, To)

AI_AIR:onafterRefuel(AIGroup, From, Event, To)

AI_AIR:onafterReturn(Controllable, From, Event, To)

Coordinates the approriate returning action.

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

Defines a new patrol route using the Process_PatrolZone parameters and settings.

AI_AIR:onafterStatus()

AI_AIR:onbeforeStatus()

Fields and Methods inherited from FSM_CONTROLLABLE Description

AI_AIR.Controllable

AI_AIR:GetControllable()

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_AIR:New(FSMT, Controllable)

Creates a new FSM_CONTROLLABLE object.

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

OnAfter Transition Handler for Event Stop.

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

OnBefore Transition Handler for Event Stop.

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

OnEnter Transition Handler for State Stopped.

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

OnLeave Transition Handler for State Stopped.

AI_AIR:SetControllable(FSMControllable)

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_AIR:Stop()

Synchronous Event Trigger for Event Stop.

AI_AIR:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

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

Fields and Methods inherited from FSM Description

AI_AIR:AddEndState(State)

Adds an End state.

AI_AIR:AddProcess(From, Event, Process, ReturnEvents)

Set the default Process template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

AI_AIR:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

AI_AIR:AddScoreProcess(From, Event, State, ScoreText, Score)

Adds a score for the FSM_PROCESS to be achieved.

AI_AIR:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

AI_AIR.CallScheduler

AI_AIR.Events

AI_AIR:GetCurrentState()

AI_AIR:GetEndStates()

Returns the End states.

AI_AIR:GetProcess(From, Event)

AI_AIR:GetProcesses()

Returns a table of the SubFSM rules defined within the FSM.

AI_AIR:GetScores()

Returns a table with the scores defined.

AI_AIR:GetStartState()

Returns the start state of the FSM.

AI_AIR:GetState()

AI_AIR:GetSubs()

Returns a table with the Subs defined.

AI_AIR:GetTransitions()

Returns a table of the transition rules defined within the FSM.

AI_AIR:Is(State)

AI_AIR:LoadCallBacks(CallBackTable)

AI_AIR:New()

Creates a new FSM object.

AI_AIR.Scores

AI_AIR:SetProcess(From, Event, Fsm)

AI_AIR:SetStartState(State)

Sets the start state of the FSM.

AI_AIR._EndStates

AI_AIR._EventSchedules

AI_AIR._Processes

AI_AIR._Scores

AI_AIR._StartState

AI_AIR._Transitions

AI_AIR:_add_to_map(Map, Event)

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

AI_AIR:_create_transition(EventName)

AI_AIR:_delayed_transition(EventName)

AI_AIR:_eventmap(Events, EventStructure)

AI_AIR:_gosub(ParentFrom, ParentEvent)

AI_AIR:_handler(EventName, ...)

AI_AIR:_isendstate(Current)

AI_AIR:_submap(subs, sub, name)

AI_AIR:can(e)

AI_AIR:cannot(e)

AI_AIR.current

AI_AIR.endstates

AI_AIR:is(state)

AI_AIR.options

AI_AIR.subs

Fields and Methods inherited from BASE Description

AI_AIR.ClassID

The ID number of the class.

AI_AIR.ClassName

The name of the class.

AI_AIR.ClassNameAndID

The name of the class concatenated with the ID number of the class.

AI_AIR:ClearState(Object, StateName)

Clear the state of an object.

AI_AIR:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

Creation of a Birth Event.

AI_AIR:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

AI_AIR:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

AI_AIR:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

AI_AIR:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

AI_AIR:E(Arguments)

Log an exception which will be traced always.

AI_AIR:EventDispatcher()

Returns the event dispatcher

AI_AIR:EventRemoveAll()

Remove all subscribed events

AI_AIR:F(Arguments)

Trace a function call.

AI_AIR:F2(Arguments)

Trace a function call level 2.

AI_AIR:F3(Arguments)

Trace a function call level 3.

AI_AIR:GetClassID()

Get the ClassID of the class instance.

AI_AIR:GetClassName()

Get the ClassName of the class instance.

AI_AIR:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

AI_AIR:GetEventPriority()

Get the Class Event processing Priority.

AI_AIR:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

AI_AIR:GetState(Object, Key)

Get a Value given a Key from the Object.

AI_AIR:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

AI_AIR:I(Arguments)

Log an information which will be traced always.

AI_AIR:Inherit(Child, Parent)

This is the worker method to inherit from a parent class.

AI_AIR:IsInstanceOf(ClassName)

This is the worker method to check if an object is an (sub)instance of a class.

AI_AIR:IsTrace()

Enquires if tracing is on (for the class).

AI_AIR:New()

BASE constructor.

AI_AIR:OnEvent(EventData)

Occurs when an object is completely destroyed.

AI_AIR:OnEventBaseCaptured(EventData)

Occurs when a ground unit captures either an airbase or a farp.

AI_AIR:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

AI_AIR:OnEventCrash(EventData)

Occurs when any aircraft crashes into the ground and is completely destroyed.

AI_AIR:OnEventDead(EventData)

Occurs when an object is dead.

AI_AIR:OnEventDetailedFailure(EventData)

Unknown precisely what creates this event, likely tied into newer damage model.

AI_AIR:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected

AI_AIR:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

AI_AIR:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

AI_AIR:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

AI_AIR:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

AI_AIR:OnEventKill(EventData)

Occurs on the death of a unit.

AI_AIR:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

AI_AIR:OnEventLandingAfterEjection(EventData)

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

AI_AIR:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

AI_AIR:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

AI_AIR:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

AI_AIR:OnEventMissionEnd(EventData)

Occurs when a mission ends

AI_AIR:OnEventMissionStart(EventData)

Occurs when a mission starts

AI_AIR:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

AI_AIR:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

AI_AIR:OnEventPlayerLeaveUnit(EventData)

Occurs when any player relieves control of a unit to the AI.

AI_AIR:OnEventRefueling(EventData)

Occurs when an aircraft connects with a tanker and begins taking on fuel.

AI_AIR:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

AI_AIR:OnEventScore(EventData)

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

AI_AIR:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

AI_AIR:OnEventShootingStart(EventData)

Occurs when any unit begins firing a weapon that has a high rate of fire.

AI_AIR:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

AI_AIR:OnEventTakeoff(EventData)

Occurs when an aircraft takes off from an airbase, farp, or ship.

AI_AIR:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

AI_AIR:ScheduleOnce(Start, SchedulerFunction, ...)

Schedule a new time event.

AI_AIR:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

Schedule a new time event.

AI_AIR:ScheduleStop(SchedulerFunction)

Stops the Schedule.

AI_AIR.Scheduler

AI_AIR:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

AI_AIR:SetState(Object, Key, Value)

Set a state or property of the Object given a Key and a Value.

AI_AIR:T(Arguments)

Trace a function logic level 1.

AI_AIR:T2(Arguments)

Trace a function logic level 2.

AI_AIR:T3(Arguments)

Trace a function logic level 3.

AI_AIR:TraceAll(TraceAll)

Trace all methods in MOOSE

AI_AIR:TraceClass(Class)

Set tracing for a class

AI_AIR:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

AI_AIR:TraceLevel(Level)

Set trace level

AI_AIR:TraceOff()

Set trace off.

AI_AIR:TraceOn()

Set trace on.

AI_AIR:TraceOnOff(TraceOnOff)

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

AI_AIR:UnHandleEvent(Event)

UnSubscribe to a DCS event.

AI_AIR._

AI_AIR:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

AI_AIR:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

AI_AIR.__

AI_AIR:onEvent(event)

Field(s)

#number AI_AIR.TaskDelay

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:

The group object to receive the A2G Process.

Return value:

OnAfter Transition Handler for Event RTB.

Defined in:

AI_AIR

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.

Refuel Handler OnAfter for AI_AIR

Defined in:

AI_AIR

Parameters:

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:

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:

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:

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:

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:

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:

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.

Defined in:

AI_AIR

Parameter:

Defined in:

AI_AIR

Parameter:

OnEnter Transition Handler for State Returning.

Defined in:

AI_AIR

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:

AI_AIR

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

Defined in:

AI_AIR

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:

AI_AIR

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.

Defined in:

AI_AIR

Parameter:

Synchronous Event Trigger for Event RTB.

Defined in:

AI_AIR

Defined in:

AI_AIR

Parameters:

Fsm

Defined in:

AI_AIR

Parameters:

Fsm

Refuel Trigger for AI_AIR

Defined in:

AI_AIR

Defined in:

AI_AIR

Parameters:

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 treshold, it is required that the AI returns to the home base.

However, damage cannot be foreseen early on. Therefore, when the damage treshold 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 treshold will be 0.25.

Defined in:

AI_AIR

Parameter:

#number PatrolDamageThreshold

The treshold 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 treshold is calculated. When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted 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 treshold 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.

Defined in:

AI_AIR

Parameter:

Return value:

self

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

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

Set the status checking off.

Defined in:

AI_AIR

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

Start Trigger for AI_AIR

Defined in:

AI_AIR

Synchronous Event Trigger for Event Status.

Defined in:

AI_AIR

Synchronous Event Trigger for Event Stop.

Defined in:

AI_AIR

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.

Defined in:

AI_AIR

Defined in:

AI_AIR

Parameters:

From

Event

To

HoldTime

Defined in:

AI_AIR

Parameters:

From

Event

To

Defined in:

AI_AIR

Parameters:

From

Event

To

Defined in:

AI_AIR

Parameters:

From

Event

To

Coordinates the approriate returning action.

Defined in:

AI_AIR

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:

self

Defines a new patrol route using the Process_PatrolZone parameters and settings.

Defined in:

AI_AIR

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:

self

Defined in:

AI_AIR

Defined in:

AI_AIR

Field(s)

#number AI_AIR.TaskDelay

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

(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

Field(s)

#number AI_AIR.TaskDelay

The delay of each task given to the AI.

Function(s)

Adds an End state.

Defined in:

Parameter:

State

Set the default Process template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

#string To

The To state.

Returns the End states.

Defined in:

Defined in:

Parameters:

From

Event

Returns a table of the SubFSM rules defined within the FSM.

Defined in:

Return value:

#table:

Returns a table with the scores defined.

Defined in:

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Returns a table with the Subs defined.

Defined in:

Returns a table of the transition rules defined within the FSM.

Defined in:

Return value:

#table:

Defined in:

Parameter:

State

Defined in:

Parameter:

CallBackTable

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Defined in:

Parameters:

Map

Event

Defined in:

Parameters:

step

trigger

params

EventName

Defined in:

Parameter:

EventName

Defined in:

Parameter:

EventName

Defined in:

Parameters:

Events

EventStructure

Defined in:

Parameters:

ParentFrom

ParentEvent

Defined in:

Parameters:

EventName

...

Defined in:

Parameter:

Current

Defined in:

Parameters:

subs

sub

name

Defined in:

Parameter:

e

Defined in:

Parameter:

e

Defined in:

Parameter:

state

Field(s)

#number AI_AIR.TaskDelay

The delay of each task given to the AI.

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

Get a Value given a Key from the Object.

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

Return value:

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

(optional) The function to be called when the event occurs for the unit.

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

This is the worker method to inherit from a parent class.

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

This is the worker method to check if an object is an (sub)instance of a class.

Examples:

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

ClassName

is the name of the class or the class itself to run the check against

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

function EVENT:New()
  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
  return self
end
  

Defined in:

Return value:

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Occurs when a ground unit captures either an airbase or a farp.

initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft crashes into the ground and is completely destroyed.

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

Unknown precisely what creates this event, likely tied into newer damage model.

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.

  • initiator: The unit that killed the target
  • target: Target Object
  • weapon: Weapon Object

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.

  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
  • subplace: is always 0 for unknown reasons.

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

Occurs when any player relieves control of a unit to the AI.

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft connects with a tanker and begins taking on fuel.

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit begins firing a weapon that has a high rate of fire.

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft takes off from an airbase, farp, or ship.

initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#number Repeat

Specifies the interval in seconds when the scheduler will call the event function.

#number RandomizeFactor

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

#number Stop

Specifies the amount of seconds when the scheduler will be stopped.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

Set the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

Set a state or property of the Object given a Key and a Value.

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that will hold the Value set by the Key.

Key

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

-- Switch the tracing On
BASE:TraceOnOff( true )

-- Switch the tracing Off
BASE:TraceOnOff( false )

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class. @param #BASE self @param DCS#Event event

Defined in:

Parameter:

event