Banner Image

Module AI.AI_Air_Engage

AI - Models the process of air to ground engagement for airplanes and helicopters.

This is a class used in the AI.AI_A2G_Dispatcher.


Author: FlightControl


Global(s)

Global AI_AIR_ENGAGE

Implements the core functions to intercept intruders.

#AI_AIR_ENGAGE AI_AIR_ENGAGE

Implements the core functions to intercept intruders.

Use the Engage trigger to intercept intruders.

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

The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits. Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.

This cycle will continue.

During the patrol, the AI will detect enemy targets, which are reported through the Detected event.

When enemies are detected, the AI will automatically engage the enemy.

Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB. When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.

1. AI_AIR_ENGAGE constructor

2. Set the Zone of Engagement

An optional Core.Zone can be set, that will define when the AI will engage with the detected airborne enemy targets. Use the method AI.AI_CAP#AI_AIR_ENGAGE.SetEngageZone() to define that Zone.

Developer Note

Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE Therefore, this class is considered to be deprecated

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

AI_AIR_ENGAGE:Abort()

Synchronous Event Trigger for Event Abort.

AI_AIR_ENGAGE:Accomplish()

Synchronous Event Trigger for Event Accomplish.

AI_AIR_ENGAGE.Accomplished

AI_AIR_ENGAGE.AttackSetUnit

AI_AIR_ENGAGE:Destroy()

Synchronous Event Trigger for Event Destroy.

AI_AIR_ENGAGE:Engage()

Synchronous Event Trigger for Event Engage.

AI_AIR_ENGAGE.EngageAltType

AI_AIR_ENGAGE.EngageCeilingAltitude

AI_AIR_ENGAGE.EngageFloorAltitude

AI_AIR_ENGAGE.EngageMaxSpeed

AI_AIR_ENGAGE.EngageMinSpeed

AI_AIR_ENGAGE:EngageRoute()

Synchronous Event Trigger for Event EngageRoute.

AI_AIR_ENGAGE.Engaging

AI_AIR_ENGAGE:Fired()

Synchronous Event Trigger for Event Fired.

AI_AIR_ENGAGE:New(AI_Air, AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType)

Creates a new AI_AIR_ENGAGE object

AI_AIR_ENGAGE:OnAfterAbort(AIGroup, From, Event, To)

OnAfter Transition Handler for Event Abort.

AI_AIR_ENGAGE:OnAfterAccomplish(AIGroup, From, Event, To)

OnAfter Transition Handler for Event Accomplish.

AI_AIR_ENGAGE:OnAfterDestroy(AIGroup, From, Event, To)

OnAfter Transition Handler for Event Destroy.

AI_AIR_ENGAGE:OnAfterEngage(AIGroup, From, Event, To)

OnAfter Transition Handler for Event Engage.

AI_AIR_ENGAGE:OnAfterEngageRoute(AIGroup, From, Event, To)

OnAfter Transition Handler for Event EngageRoute.

AI_AIR_ENGAGE:OnAfterFired(AIGroup, From, Event, To)

OnAfter Transition Handler for Event Fired.

AI_AIR_ENGAGE:OnBeforeAbort(AIGroup, From, Event, To)

OnBefore Transition Handler for Event Abort.

AI_AIR_ENGAGE:OnBeforeAccomplish(AIGroup, From, Event, To)

OnBefore Transition Handler for Event Accomplish.

AI_AIR_ENGAGE:OnBeforeDestroy(AIGroup, From, Event, To)

OnBefore Transition Handler for Event Destroy.

AI_AIR_ENGAGE:OnBeforeEngage(AIGroup, From, Event, To)

OnBefore Transition Handler for Event Engage.

AI_AIR_ENGAGE:OnBeforeEngageRoute(AIGroup, From, Event, To)

OnBefore Transition Handler for Event EngageRoute.

AI_AIR_ENGAGE:OnBeforeFired(AIGroup, From, Event, To)

OnBefore Transition Handler for Event Fired.

AI_AIR_ENGAGE:OnEnterEngaging(AIGroup, From, Event, To)

OnEnter Transition Handler for State Engaging.

AI_AIR_ENGAGE:OnEventDead(EventData)

AI_AIR_ENGAGE:OnLeaveEngaging(AIGroup, From, Event, To)

OnLeave Transition Handler for State Engaging.

AI_AIR_ENGAGE.Resume(AIEngage, Fsm)

AI_AIR_ENGAGE:__Abort(Delay)

Asynchronous Event Trigger for Event Abort.

AI_AIR_ENGAGE:__Accomplish(Delay)

Asynchronous Event Trigger for Event Accomplish.

AI_AIR_ENGAGE:__Destroy(Delay)

Asynchronous Event Trigger for Event Destroy.

AI_AIR_ENGAGE:__Engage(Delay)

Asynchronous Event Trigger for Event Engage.

AI_AIR_ENGAGE:__EngageRoute(Delay)

Asynchronous Event Trigger for Event EngageRoute.

AI_AIR_ENGAGE:__Fired(Delay)

Asynchronous Event Trigger for Event Fired.

AI_AIR_ENGAGE.___Engage(AIControllable, AIGroup, Fsm, AttackSetUnit)

AI_AIR_ENGAGE.___EngageRoute(AIControllable, AIGroup, Fsm, AttackSetUnit)

AI_AIR_ENGAGE:onafterAbort(AIGroup, From, Event, To)

onafter event handler for Abort event.

AI_AIR_ENGAGE:onafterAccomplish(AIGroup, From, Event, To)

AI_AIR_ENGAGE:onafterDestroy(AIGroup, From, Event, To, EventData)

AI_AIR_ENGAGE:onafterEngage(AIGroup, From, Event, To)

onafter event handler for Engage event.

AI_AIR_ENGAGE:onafterEngageRoute(DefenderGroup, From, Event, To, AttackSetUnit)

AI_AIR_ENGAGE:onafterStart(AIGroup, From, Event, To)

onafter event handler for Start event.

AI_AIR_ENGAGE:onbeforeEngage(AIGroup, From, Event, To)

onbefore event handler for Engage event.

Fields and Methods inherited from AI_AIR Description

AI_AIR_ENGAGE.CheckStatus

AI_AIR_ENGAGE:ClearTargetDistance()

AI_AIR_ENGAGE.DisengageRadius

AI_AIR_ENGAGE.FuelThresholdPercentage

AI_AIR_ENGAGE:GetDispatcher()

AI_AIR_ENGAGE.HomeAirbase

AI_AIR_ENGAGE.IdleCount

AI_AIR_ENGAGE:New(AIGroup)

Creates a new AI_AIR process.

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

OnAfter Transition Handler for Event RTB.

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

Refuel Handler OnAfter for AI_AIR

AI_AIR_ENGAGE:OnAfterStart(From, Event, To)

Start Handler OnAfter for AI_AIR

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

OnAfter Transition Handler for Event Status.

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

OnAfter Transition Handler for Event Stop.

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

OnBefore Transition Handler for Event RTB.

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

Refuel Handler OnBefore for AI_AIR

AI_AIR_ENGAGE:OnBeforeStart(From, Event, To)

Start Handler OnBefore for AI_AIR

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

OnBefore Transition Handler for Event Status.

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

OnBefore Transition Handler for Event Stop.

AI_AIR_ENGAGE:OnCrash(EventData)

AI_AIR_ENGAGE:OnEjection(EventData)

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

OnEnter Transition Handler for State Returning.

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

OnEnter Transition Handler for State Stopped.

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

OnLeave Transition Handler for State Returning.

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

OnLeave Transition Handler for State Stopped.

AI_AIR_ENGAGE:OnPilotDead(EventData)

AI_AIR_ENGAGE.OutOfFuelOrbitTime

AI_AIR_ENGAGE.PatrolCeilingAltitude

AI_AIR_ENGAGE.PatrolDamageThreshold

AI_AIR_ENGAGE.PatrolFloorAltitude

AI_AIR_ENGAGE.PatrolManageDamage

AI_AIR_ENGAGE.PatrolMaxSpeed

AI_AIR_ENGAGE.PatrolMinSpeed

AI_AIR_ENGAGE:RTB()

Synchronous Event Trigger for Event RTB.

AI_AIR_ENGAGE.RTBHold(AIGroup, Fsm)

AI_AIR_ENGAGE.RTBMaxSpeed

AI_AIR_ENGAGE.RTBMinSpeed

AI_AIR_ENGAGE.RTBRoute(AIGroup, Fsm)

AI_AIR_ENGAGE.RTBSpeedMaxFactor

AI_AIR_ENGAGE.RTBSpeedMinFactor

AI_AIR_ENGAGE:Refuel()

Refuel Trigger for AI_AIR

AI_AIR_ENGAGE.Resume(AIGroup, Fsm)

AI_AIR_ENGAGE:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude)

Sets the floor and ceiling altitude of the patrol.

AI_AIR_ENGAGE:SetDamageThreshold(PatrolDamageThreshold)

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

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

AI_AIR_ENGAGE: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_ENGAGE:SetHomeAirbase(HomeAirbase)

Sets the home airbase.

AI_AIR_ENGAGE:SetRTBSpeed(RTBMinSpeed, RTBMaxSpeed)

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

AI_AIR_ENGAGE:SetRTBSpeedFactors(MinFactor, MaxFactor)

Set the min and max factors on RTB speed.

AI_AIR_ENGAGE:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed)

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

AI_AIR_ENGAGE:SetStatusOff()

Set the status checking off.

AI_AIR_ENGAGE:SetTanker(TankerName)

Sets to refuel at the given tanker.

AI_AIR_ENGAGE:SetTargetDistance(Coordinate)

AI_AIR_ENGAGE:Start()

Start Trigger for AI_AIR

AI_AIR_ENGAGE:Status()

Synchronous Event Trigger for Event Status.

AI_AIR_ENGAGE:Stop()

Synchronous Event Trigger for Event Stop.

AI_AIR_ENGAGE.TankerName

AI_AIR_ENGAGE.TaskDelay

AI_AIR_ENGAGE:__RTB(Delay)

Asynchronous Event Trigger for Event RTB.

AI_AIR_ENGAGE:__Refuel(Delay)

Refuel Asynchronous Trigger for AI_AIR

AI_AIR_ENGAGE:__Start(Delay)

Start Asynchronous Trigger for AI_AIR

AI_AIR_ENGAGE:__Status(Delay)

Asynchronous Event Trigger for Event Status.

AI_AIR_ENGAGE:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

AI_AIR_ENGAGE:onafterDead()

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

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

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

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

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

Coordinates the approriate returning action.

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

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

AI_AIR_ENGAGE:onafterStatus()

AI_AIR_ENGAGE:onbeforeStatus()

Fields and Methods inherited from FSM_CONTROLLABLE Description

AI_AIR_ENGAGE.Controllable

AI_AIR_ENGAGE:GetControllable()

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_AIR_ENGAGE:New(FSMT, Controllable)

Creates a new FSM_CONTROLLABLE object.

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

OnAfter Transition Handler for Event Stop.

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

OnBefore Transition Handler for Event Stop.

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

OnEnter Transition Handler for State Stopped.

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

OnLeave Transition Handler for State Stopped.

AI_AIR_ENGAGE:SetControllable(FSMControllable)

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_AIR_ENGAGE:Stop()

Synchronous Event Trigger for Event Stop.

AI_AIR_ENGAGE:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

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

Fields and Methods inherited from FSM Description

AI_AIR_ENGAGE:AddEndState(State)

Adds an End state.

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

Set the default #FSM_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_ENGAGE:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

AI_AIR_ENGAGE:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

AI_AIR_ENGAGE.CallScheduler

Call scheduler.

AI_AIR_ENGAGE.ClassName

Name of the class.

AI_AIR_ENGAGE.Events

AI_AIR_ENGAGE:GetCurrentState()

Get current state.

AI_AIR_ENGAGE:GetEndStates()

Returns the End states.

AI_AIR_ENGAGE:GetProcess(From, Event)

AI_AIR_ENGAGE:GetProcesses()

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

AI_AIR_ENGAGE:GetScores()

Returns a table with the scores defined.

AI_AIR_ENGAGE:GetStartState()

Returns the start state of the FSM.

AI_AIR_ENGAGE:GetState()

Get current state.

AI_AIR_ENGAGE:GetSubs()

Returns a table with the Subs defined.

AI_AIR_ENGAGE:GetTransitions()

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

AI_AIR_ENGAGE:Is(State)

Check if FSM is in state.

AI_AIR_ENGAGE:LoadCallBacks(CallBackTable)

Load call backs.

AI_AIR_ENGAGE:New()

Creates a new FSM object.

AI_AIR_ENGAGE.Scores

Scores.

AI_AIR_ENGAGE:SetProcess(From, Event, Fsm)

AI_AIR_ENGAGE:SetStartState(State)

Sets the start state of the FSM.

AI_AIR_ENGAGE._EndStates

AI_AIR_ENGAGE._EventSchedules

AI_AIR_ENGAGE._Processes

AI_AIR_ENGAGE._Scores

AI_AIR_ENGAGE._StartState

AI_AIR_ENGAGE._Transitions

AI_AIR_ENGAGE:_add_to_map(Map, Event)

Add to map.

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

Call handler.

AI_AIR_ENGAGE:_create_transition(EventName)

Create transition.

AI_AIR_ENGAGE:_delayed_transition(EventName)

Delayed transition.

AI_AIR_ENGAGE:_eventmap(Events, EventStructure)

Event map.

AI_AIR_ENGAGE:_gosub(ParentFrom, ParentEvent)

Go sub.

AI_AIR_ENGAGE:_handler(EventName, ...)

Handler.

AI_AIR_ENGAGE:_isendstate(Current)

Is end state.

AI_AIR_ENGAGE:_submap(subs, sub, name)

Sub maps.

AI_AIR_ENGAGE:can(e)

Check if can do an event.

AI_AIR_ENGAGE:cannot(e)

Check if cannot do an event.

AI_AIR_ENGAGE.current

Current state name.

AI_AIR_ENGAGE.endstates

AI_AIR_ENGAGE:is(State, state)

Check if FSM is in state.

AI_AIR_ENGAGE.options

Options.

AI_AIR_ENGAGE.subs

Subs.

Fields and Methods inherited from BASE Description

AI_AIR_ENGAGE.ClassID

The ID number of the class.

AI_AIR_ENGAGE.ClassName

The name of the class.

AI_AIR_ENGAGE.ClassNameAndID

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

AI_AIR_ENGAGE:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

AI_AIR_ENGAGE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

AI_AIR_ENGAGE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

AI_AIR_ENGAGE:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

AI_AIR_ENGAGE:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

AI_AIR_ENGAGE:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

AI_AIR_ENGAGE:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

AI_AIR_ENGAGE:E(Arguments)

Log an exception which will be traced always.

AI_AIR_ENGAGE:EventDispatcher()

Returns the event dispatcher

AI_AIR_ENGAGE:EventRemoveAll()

Remove all subscribed events

AI_AIR_ENGAGE:F(Arguments)

Trace a function call.

AI_AIR_ENGAGE:F2(Arguments)

Trace a function call level 2.

AI_AIR_ENGAGE:F3(Arguments)

Trace a function call level 3.

AI_AIR_ENGAGE:GetClassID()

Get the ClassID of the class instance.

AI_AIR_ENGAGE:GetClassName()

Get the ClassName of the class instance.

AI_AIR_ENGAGE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

AI_AIR_ENGAGE:GetEventPriority()

Get the Class Core.Event processing Priority.

AI_AIR_ENGAGE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

AI_AIR_ENGAGE:GetState(Object, Key)

Get a Value given a Key from the Object.

AI_AIR_ENGAGE:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

AI_AIR_ENGAGE:I(Arguments)

Log an information which will be traced always.

AI_AIR_ENGAGE:Inherit(Child, Parent)

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

AI_AIR_ENGAGE:IsInstanceOf(ClassName)

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

AI_AIR_ENGAGE:IsTrace()

Enquires if tracing is on (for the class).

AI_AIR_ENGAGE:New()

BASE constructor.

AI_AIR_ENGAGE:OnEvent(EventData)

Occurs when an Event for an object is triggered.

AI_AIR_ENGAGE:OnEventBDA(EventData)

BDA.

AI_AIR_ENGAGE:OnEventBaseCaptured(EventData)

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

AI_AIR_ENGAGE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

AI_AIR_ENGAGE:OnEventCrash(EventData)

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

AI_AIR_ENGAGE:OnEventDead(EventData)

Occurs when an object is dead.

AI_AIR_ENGAGE:OnEventDetailedFailure(EventData)

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

AI_AIR_ENGAGE:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

AI_AIR_ENGAGE:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

AI_AIR_ENGAGE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

AI_AIR_ENGAGE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

AI_AIR_ENGAGE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

AI_AIR_ENGAGE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

AI_AIR_ENGAGE:OnEventKill(EventData)

Occurs on the death of a unit.

AI_AIR_ENGAGE:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.

AI_AIR_ENGAGE:OnEventLandingAfterEjection(EventData)

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

AI_AIR_ENGAGE:OnEventLandingQualityMark(EventData)

Landing quality mark.

AI_AIR_ENGAGE:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

AI_AIR_ENGAGE:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

AI_AIR_ENGAGE:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

AI_AIR_ENGAGE:OnEventMissionEnd(EventData)

Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.

AI_AIR_ENGAGE:OnEventMissionStart(EventData)

Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.

AI_AIR_ENGAGE:OnEventParatrooperLanding(EventData)

Weapon add.

AI_AIR_ENGAGE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

AI_AIR_ENGAGE:OnEventPlayerEnterAircraft(EventData)

Occurs when a player enters a slot and takes control of an aircraft.

AI_AIR_ENGAGE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

AI_AIR_ENGAGE:OnEventPlayerLeaveUnit(EventData)

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

AI_AIR_ENGAGE:OnEventRefueling(EventData)

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

AI_AIR_ENGAGE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

AI_AIR_ENGAGE:OnEventScore(EventData)

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

AI_AIR_ENGAGE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

AI_AIR_ENGAGE:OnEventShootingStart(EventData)

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

AI_AIR_ENGAGE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

AI_AIR_ENGAGE:OnEventTakeoff(EventData)

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

AI_AIR_ENGAGE:OnEventTriggerZone(EventData)

Trigger zone.

AI_AIR_ENGAGE:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

AI_AIR_ENGAGE:ScheduleStop(SchedulerID)

Stops the Schedule.

AI_AIR_ENGAGE.Scheduler

AI_AIR_ENGAGE:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

AI_AIR_ENGAGE:SetState(Object, Key, Value)

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

AI_AIR_ENGAGE:T(Arguments)

Trace a function logic level 1.

AI_AIR_ENGAGE:T2(Arguments)

Trace a function logic level 2.

AI_AIR_ENGAGE:T3(Arguments)

Trace a function logic level 3.

AI_AIR_ENGAGE:TraceAll(TraceAll)

Trace all methods in MOOSE

AI_AIR_ENGAGE:TraceClass(Class)

Set tracing for a class

AI_AIR_ENGAGE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

AI_AIR_ENGAGE:TraceLevel(Level)

Set trace level

AI_AIR_ENGAGE:TraceOff()

Set trace off.

AI_AIR_ENGAGE:TraceOn()

Set trace on.

AI_AIR_ENGAGE: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_ENGAGE:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

AI_AIR_ENGAGE._

AI_AIR_ENGAGE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

AI_AIR_ENGAGE:_Serialize(Arguments)

(Internal) Serialize arguments

AI_AIR_ENGAGE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

AI_AIR_ENGAGE.__

AI_AIR_ENGAGE:onEvent(event)

The main event handling function...

Field(s)

AI_AIR_ENGAGE.AttackSetUnit

Kept in memory in case of resume from refuel in air!

Function(s)

Synchronous Event Trigger for Event Abort.

Defined in:

AI_AIR_ENGAGE

Synchronous Event Trigger for Event Accomplish.

Defined in:

AI_AIR_ENGAGE

Synchronous Event Trigger for Event Destroy.

Defined in:

AI_AIR_ENGAGE

Synchronous Event Trigger for Event Engage.

Defined in:

AI_AIR_ENGAGE

Synchronous Event Trigger for Event EngageRoute.

Defined in:

AI_AIR_ENGAGE

Synchronous Event Trigger for Event Fired.

Defined in:

AI_AIR_ENGAGE

Creates a new AI_AIR_ENGAGE object

Defined in:

AI_AIR_ENGAGE

Parameters:

The AI_AIR FSM.

The AI group.

DCS#Speed EngageMinSpeed

(optional, default = 50% of max speed) The minimum speed of the Wrapper.Group in km/h when engaging a target.

DCS#Speed EngageMaxSpeed

(optional, default = 75% of max speed) The maximum speed of the Wrapper.Group in km/h when engaging a target.

DCS#Altitude EngageFloorAltitude

(optional, default = 1000m ) The lowest altitude in meters where to execute the engagement.

DCS#Altitude EngageCeilingAltitude

(optional, default = 1500m ) The highest altitude in meters where to execute the engagement.

DCS#AltitudeType EngageAltType

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

Return value:

OnAfter Transition Handler for Event Abort.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event Accomplish.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event Destroy.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event Engage.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event EngageRoute.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event Fired.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnBefore Transition Handler for Event Abort.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

OnBefore Transition Handler for Event Accomplish.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

OnBefore Transition Handler for Event Destroy.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

OnBefore Transition Handler for Event Engage.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

OnBefore Transition Handler for Event EngageRoute.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

OnBefore Transition Handler for Event Fired.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

OnEnter Transition Handler for State Engaging.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Defined in:

AI_AIR_ENGAGE

Parameter:

OnLeave Transition Handler for State Engaging.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

Defined in:

AI_AIR_ENGAGE

Parameters:

Fsm

Asynchronous Event Trigger for Event Abort.

Defined in:

AI_AIR_ENGAGE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Accomplish.

Defined in:

AI_AIR_ENGAGE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Destroy.

Defined in:

AI_AIR_ENGAGE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Engage.

Defined in:

AI_AIR_ENGAGE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event EngageRoute.

Defined in:

AI_AIR_ENGAGE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Fired.

Defined in:

AI_AIR_ENGAGE

Parameter:

#number Delay

The delay in seconds.

Defined in:

AI_AIR_ENGAGE

Parameters:

Wrapper.Group#GROUP AIControllable

AIGroup

Fsm

AttackSetUnit

Defined in:

AI_AIR_ENGAGE

Parameters:

Wrapper.Group#GROUP AIControllable

AIGroup

Fsm

AttackSetUnit

onafter event handler for Abort event.

Defined in:

AI_AIR_ENGAGE

Parameters:

The AI Group managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Defined in:

AI_AIR_ENGAGE

Parameters:

The Group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

onafter event handler for Engage event.

Defined in:

AI_AIR_ENGAGE

Parameters:

The AI Group managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Defined in:

AI_AIR_ENGAGE

Parameters:

Wrapper.Group#GROUP DefenderGroup

The GroupGroup managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Core.Set#SET_UNIT AttackSetUnit

Unit set to be attacked.

onafter event handler for Start event.

Defined in:

AI_AIR_ENGAGE

Parameters:

The AI group managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

onbefore event handler for Engage event.

Defined in:

AI_AIR_ENGAGE

Parameters:

The group Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Field(s)

AI_AIR_ENGAGE.AttackSetUnit

Kept in memory in case of resume from refuel in air!

Function(s)

Creates a new AI_AIR process.

Defined in:

Parameter:

The group object to receive the A2G Process.

Return value:

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.

Refuel Handler OnAfter for AI_AIR

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

#string Event

#string To

Start Handler OnAfter for AI_AIR

Defined in:

Parameters:

#string From

#string Event

#string To

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

Refuel Handler OnBefore for AI_AIR

Defined in:

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:

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

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.

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

Synchronous Event Trigger for Event RTB.

Defined in:

Refuel Trigger for AI_AIR

Defined in:

Sets the floor and ceiling altitude of the patrol.

Defined in:

Parameters:

DCS#Altitude PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

DCS#Altitude PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

Return value:

self

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

However, damage cannot be foreseen early on. Therefore, when the damage threshold is reached, the AI will return immediately to the home base (RTB). Note that for groups, the average damage of the complete group will be calculated. So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage threshold will be 0.25.

Defined in:

Parameter:

#number PatrolDamageThreshold

The threshold in percentage (between 0 and 1) when the AI is considered to be damaged.

Return value:

self

Sets the disengage range, that when engaging a target beyond the specified range, the engagement will be cancelled and the plane will RTB.

Defined in:

Parameter:

#number DisengageRadius

The disengage range.

Return value:

self

Defined in:

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:

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.

Defined in:

Parameter:

Return value:

self

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

Defined in:

Parameters:

DCS#Speed RTBMinSpeed

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

DCS#Speed RTBMaxSpeed

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

Return value:

self

Set the min and max factors on RTB speed.

Use this, if your planes are heading back to base too fast. Default values are 0.5 and 0.6. The RTB speed is calculated as the max speed of the unit multiplied by MinFactor (lower bracket) and multiplied by MaxFactor (upper bracket). A random value in this bracket is then applied in the waypoint routing generation.

Defined in:

Parameters:

#number MinFactor

Lower bracket factor. Defaults to 0.5.

#number MaxFactor

Upper bracket factor. Defaults to 0.6.

Return value:

self

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

Defined in:

Parameters:

DCS#Speed PatrolMinSpeed

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

DCS#Speed PatrolMaxSpeed

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

Return value:

self

Set the status checking off.

Defined in:

Return value:

self

Sets to refuel at the given tanker.

Defined in:

Parameter:

Wrapper.Group#GROUP TankerName

The group name of the tanker as defined within the Mission Editor or spawned.

Return value:

self

Start Trigger for AI_AIR

Defined in:

Synchronous Event Trigger for Event Status.

Defined in:

Synchronous Event Trigger for Event Stop.

Defined in:

Asynchronous Event Trigger for Event RTB.

Defined in:

Parameter:

#number Delay

The delay in seconds.

Refuel Asynchronous Trigger for AI_AIR

Defined in:

Parameter:

#number Delay

Start Asynchronous Trigger for AI_AIR

Defined in:

Parameter:

#number Delay

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.

Coordinates the approriate returning action.

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:

self

Defines a new patrol route using the AI.AI_Patrol#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:

self

Field(s)

AI_AIR_ENGAGE.AttackSetUnit

Kept in memory in case of resume from refuel in air!

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.

Field(s)

AI_AIR_ENGAGE.AttackSetUnit

Kept in memory in case of resume from refuel in air!

Function(s)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

Set the default #FSM_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.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns the End states.

Defined in:

Return value:

#table:

End states.

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Sub processes.

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

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

Defined in:

Return value:

#table:

Transitions.

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

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.

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

Call handler.

Defined in:

Parameters:

#string step

Step "onafter", "onbefore", "onenter", "onleave".

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

AI_AIR_ENGAGE.AttackSetUnit

Kept in memory in case of resume from refuel in air!

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.

IniObjectCategory

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.

IniObjectCategory

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

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.

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.

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 Core.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 Core.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, set to nil, 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:

Event ID.

#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 Event for an object is triggered.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.

Defined in:

Parameter:

The EventData structure.

BDA.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Discard chair after ejection.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

  • 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 Have a look at the class Core.Event#EVENT as these are just the prototypes.

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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

Landing quality mark.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.

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. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

Occurs when a player enters a slot and takes control of an aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. 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. Have a look at the class Core.Event#EVENT as these are just the prototypes. 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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Trigger zone.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

  • 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:

#string:

The Schedule ID 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:

#string:

The Schedule ID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

Set the Class Core.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 Core.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, set to nil, 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

Class name.

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

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:

Event ID.

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

(Internal) Serialize arguments

Defined in:

Parameter:

#table Arguments

Return value:

#string:

Text

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event