Banner Image

Module Ops.Commander

Ops - Commander of Airwings, Brigades and Fleets.

Main Features:

  • Manages AIRWINGS, BRIGADEs and FLOTILLAs
  • Handles missions (AUFTRAG) and finds the best assets for the job

Author: funkyfranky

Global(s)

Global COMMANDER

He who has never leared to obey cannot be a good commander -- Aristotle


The COMMANDER Concept

A commander is the head of legions.

#COMMANDER COMMANDER

He who has never leared to obey cannot be a good commander -- Aristotle


The COMMANDER Concept

A commander is the head of legions.

He/she will find the best LEGIONs to perform an assigned AUFTRAG (mission) or OPSTRANSPORT. A legion can be an AIRWING, BRIGADE or FLEET.

Constructor

A new COMMANDER object is created with the COMMANDER.New(Coalition, Alias) function, where the parameter Coalition is the coalition side. It can be coalition.side.RED, coalition.side.BLUE or coalition.side.NEUTRAL. This parameter is mandatory!

The second parameter Alias is optional and can be used to give the COMMANDER a "name", which is used for output in the dcs.log file.

local myCommander=COMANDER:New(coalition.side.BLUE, "General Patton")

Adding Legions

Legions, i.e. AIRWINGS, BRIGADES and FLEETS can be added via the COMMANDER.AddLegion(Legion) command:

myCommander:AddLegion(myLegion)

Adding Airwings

It is also possible to use COMMANDER.AddAirwing(myAirwing) function. This does the same as the AddLegion function but might be a bit more intuitive.

Adding Brigades

It is also possible to use COMMANDER.AddBrigade(myBrigade) function. This does the same as the AddLegion function but might be a bit more intuitive.

Adding Fleets

It is also possible to use COMMANDER.AddFleet(myFleet) function. This does the same as the AddLegion function but might be a bit more intuitive.

Adding Missions

Mission can be added via the COMMANDER.AddMission(myMission) function.

Adding OPS Transports

Transportation assignments can be added via the COMMANDER.AddOpsTransport(myTransport) function.

Adding CAP Zones

A CAP zone can be added via the COMMANDER.AddCapZone() function.

Adding Rearming Zones

A rearming zone can be added via the COMMANDER.AddRearmingZone() function.

Adding Refuelling Zones

A refuelling zone can be added via the COMMANDER.AddRefuellingZone() function.

FSM Events

The COMMANDER will

OPSGROUP on Mission

Whenever an OPSGROUP (FLIGHTGROUP, ARMYGROUP or NAVYGROUP) is send on a mission, the OnAfterOpsOnMission() event is triggered. Mission designers can hook into the event with the COMMANDER.OnAfterOpsOnMission() function

function myCommander:OnAfterOpsOnMission(From, Event, To, OpsGroup, Mission)
  -- Your code
end

Canceling a Mission

A mission can be cancelled with the COMMMANDER.MissionCancel() function

myCommander:MissionCancel(myMission)

or

myCommander:__MissionCancel(5*60, myMission)

The last commander cancels the mission after 5 minutes (300 seconds).

The cancel command will be forwarded to all assigned legions and OPS groups, which will abort their mission or remove it from their queue.

Type(s)

COMMANDER , extends Core.Fsm#FSM , extends Core.Base#BASE
Fields and Methods inherited from COMMANDER Description

COMMANDER:AddAirwing(Airwing)

Add an AIRWING to the commander.

COMMANDER:AddAwacsZone(Zone, Altitude, Speed, Heading, Leg)

Add an AWACS zone.

COMMANDER:AddBrigade(Brigade)

Add an BRIGADE to the commander.

COMMANDER:AddCapZone(Zone, Altitude, Speed, Heading, Leg)

Add a CAP zone.

COMMANDER:AddGciCapZone(Zone, Altitude, Speed, Heading, Leg)

Add a GCICAP zone.

COMMANDER:AddLegion(Legion)

Add a LEGION to the commander.

COMMANDER:AddMission(Mission)

Add mission to mission queue.

COMMANDER:AddOpsTransport(Transport)

Add transport to queue.

COMMANDER:AddRearmingZone(RearmingZone)

Add a rearming zone.

COMMANDER:AddRefuellingZone(RefuellingZone)

Add a refuelling zone.

COMMANDER:AddTankerZone(Zone, Altitude, Speed, Heading, Leg, RefuelSystem)

Add a refuelling tanker zone.

COMMANDER:CheckMissionQueue()

Check mission queue and assign ONE planned mission.

COMMANDER:CheckTransportQueue()

Check transport queue and assign ONE planned transport.

COMMANDER.ClassName

Name of the class.

COMMANDER:CountAssets(InStock, MissionTypes, Attributes)

Count assets of all assigned legions.

COMMANDER:GetAssets(InStock, Legions, MissionTypes, Attributes)

Count assets of all assigned legions.

COMMANDER:GetAssetsOnMission(MissionTypes)

Get assets on given mission or missions.

COMMANDER:GetCoalition()

Get coalition.

COMMANDER:GetLegionsForMission(Mission)

Check all legions if they are able to do a specific mission type at a certain location with a given number of assets.

COMMANDER:IsMission(Mission)

Check if this mission is already in the queue.

COMMANDER:MissionAssign(Mission, Legions)

Triggers the FSM event "MissionAssign".

COMMANDER:MissionCancel(Mission)

Triggers the FSM event "MissionCancel".

COMMANDER:New(Coalition, Alias)

Create a new COMMANDER object and start the FSM.

COMMANDER:OnAfterMissionAssign(From, Event, To, Mission, Legions)

On after "MissionAssign" event.

COMMANDER:OnAfterMissionCancel(From, Event, To, Mission)

On after "MissionCancel" event.

COMMANDER:OnAfterOpsOnMission(From, Event, To, OpsGroup, Mission)

On after "OpsOnMission" event.

COMMANDER:OnAfterTransportAssign(From, Event, To, Transport, Legions)

On after "TransportAssign" event.

COMMANDER:OnAfterTransportCancel(From, Event, To, Transport)

On after "TransportCancel" event.

COMMANDER:OpsOnMission(OpsGroup, Mission)

Triggers the FSM event "OpsOnMission".

COMMANDER:RecruitAssetsForEscort(Mission, Assets)

Recruit assets performing an escort mission for a given asset.

COMMANDER:RecruitAssetsForMission(Mission)

Recruit assets for a given mission.

COMMANDER:RecruitAssetsForTransport(Transport, CargoWeight)

Recruit assets for a given OPS transport.

COMMANDER:RemoveMission(Mission)

Remove mission from queue.

COMMANDER:RemoveTransport(Transport)

Remove transport from queue.

COMMANDER:SetVerbosity(VerbosityLevel)

Set verbosity level.

COMMANDER:Start()

Triggers the FSM event "Start".

COMMANDER:Status()

Triggers the FSM event "Status".

COMMANDER:TransportAssign(Transport, Legions)

Triggers the FSM event "TransportAssign".

COMMANDER:TransportCancel(Transport)

Triggers the FSM event "TransportCancel".

COMMANDER:__MissionAssign(delay, Mission, Legions)

Triggers the FSM event "MissionAssign" after a delay.

COMMANDER:__MissionCancel(delay, Mission)

Triggers the FSM event "MissionCancel" after a delay.

COMMANDER:__OpsOnMission(delay, OpsGroup, Mission)

Triggers the FSM event "OpsOnMission" after a delay.

COMMANDER:__Start(delay)

Triggers the FSM event "Start" after a delay.

COMMANDER:__Status(delay)

Triggers the FSM event "Status" after a delay.

COMMANDER:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

COMMANDER:__TransportAssign(delay, Transport, Legions)

Triggers the FSM event "TransportAssign" after a delay.

COMMANDER:__TransportCancel(delay, Transport)

Triggers the FSM event "TransportCancel" after a delay.

COMMANDER.alias

Alias name.

COMMANDER.awacsZones

AWACS zones. Each element is of type #AIRWING.PatrolZone.

COMMANDER.capZones

CAP zones. Each element is of type #AIRWING.PatrolZone.

COMMANDER.chief

Chief of staff.

COMMANDER.coalition

Coalition side of the commander.

COMMANDER.gcicapZones

GCICAP zones. Each element is of type #AIRWING.PatrolZone.

COMMANDER.legions

Table of legions which are commanded.

COMMANDER.lid

Class id string for output to DCS log file.

COMMANDER.missionqueue

Mission queue.

COMMANDER:onafterMissionAssign(From, Event, To, Mission, Legions)

On after "MissionAssign" event.

COMMANDER:onafterMissionCancel(From, Event, To, Mission)

On after "MissionCancel" event.

COMMANDER:onafterOpsOnMission(From, Event, To, OpsGroup, Mission)

On after "OpsOnMission".

COMMANDER:onafterStart(Group, From, Event, To)

On after Start event.

COMMANDER:onafterStatus(Group, From, Event, To)

On after "Status" event.

COMMANDER:onafterTransportAssign(From, Event, To, Transport, Legions)

On after "TransportAssign" event.

COMMANDER:onafterTransportCancel(From, Event, To, Transport)

On after "TransportCancel" event.

COMMANDER.rearmingZones

Rearming zones. Each element is of type #BRIGADE.SupplyZone.

COMMANDER.refuellingZones

Refuelling zones. Each element is of type #BRIGADE.SupplyZone.

COMMANDER.tankerZones

Tanker zones. Each element is of type #AIRWING.TankerZone.

COMMANDER.transportqueue

Transport queue.

COMMANDER.verbose

Verbosity level.

COMMANDER.version

COMMANDER class version.

Fields and Methods inherited from FSM Description

COMMANDER:AddEndState(State)

Adds an End state.

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

COMMANDER:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

COMMANDER:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

COMMANDER.CallScheduler

Call scheduler.

COMMANDER.ClassName

Name of the class.

COMMANDER.Events

COMMANDER:GetCurrentState()

Get current state.

COMMANDER:GetEndStates()

Returns the End states.

COMMANDER:GetProcess(From, Event)

COMMANDER:GetProcesses()

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

COMMANDER:GetScores()

Returns a table with the scores defined.

COMMANDER:GetStartState()

Returns the start state of the FSM.

COMMANDER:GetState()

Get current state.

COMMANDER:GetSubs()

Returns a table with the Subs defined.

COMMANDER:GetTransitions()

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

COMMANDER:Is(State)

Check if FSM is in state.

COMMANDER:LoadCallBacks(CallBackTable)

Load call backs.

COMMANDER:New()

Creates a new FSM object.

COMMANDER.Scores

Scores.

COMMANDER:SetProcess(From, Event, Fsm)

COMMANDER:SetStartState(State)

Sets the start state of the FSM.

COMMANDER._EndStates

COMMANDER._EventSchedules

COMMANDER._Processes

COMMANDER._Scores

COMMANDER._StartState

COMMANDER._Transitions

COMMANDER:_add_to_map(Map, Event)

Add to map.

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

Call handler.

COMMANDER:_create_transition(EventName)

Create transition.

COMMANDER:_delayed_transition(EventName)

Delayed transition.

COMMANDER:_eventmap(Events, EventStructure)

Event map.

COMMANDER:_gosub(ParentFrom, ParentEvent)

Go sub.

COMMANDER:_handler(EventName, ...)

Handler.

COMMANDER:_isendstate(Current)

Is end state.

COMMANDER:_submap(subs, sub, name)

Sub maps.

COMMANDER:can(e)

Check if can do an event.

COMMANDER:cannot(e)

Check if cannot do an event.

COMMANDER.current

Current state name.

COMMANDER.endstates

COMMANDER:is(State, state)

Check if FSM is in state.

COMMANDER.options

Options.

COMMANDER.subs

Subs.

Fields and Methods inherited from BASE Description

COMMANDER.ClassID

The ID number of the class.

COMMANDER.ClassName

The name of the class.

COMMANDER.ClassNameAndID

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

COMMANDER:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

COMMANDER:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

COMMANDER:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

COMMANDER:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

COMMANDER:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

COMMANDER:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

COMMANDER:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

COMMANDER:E(Arguments)

Log an exception which will be traced always.

COMMANDER:EventDispatcher()

Returns the event dispatcher

COMMANDER:EventRemoveAll()

Remove all subscribed events

COMMANDER:F(Arguments)

Trace a function call.

COMMANDER:F2(Arguments)

Trace a function call level 2.

COMMANDER:F3(Arguments)

Trace a function call level 3.

COMMANDER:GetClassID()

Get the ClassID of the class instance.

COMMANDER:GetClassName()

Get the ClassName of the class instance.

COMMANDER:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

COMMANDER:GetEventPriority()

Get the Class Event processing Priority.

COMMANDER:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

COMMANDER:GetState(Object, Key)

Get a Value given a Key from the Object.

COMMANDER:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

COMMANDER:I(Arguments)

Log an information which will be traced always.

COMMANDER:Inherit(Child, Parent)

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

COMMANDER:IsInstanceOf(ClassName)

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

COMMANDER:IsTrace()

Enquires if tracing is on (for the class).

COMMANDER:New()

BASE constructor.

COMMANDER:OnEvent(EventData)

Occurs when an Event for an object is triggered.

COMMANDER:OnEventBDA(EventData)

BDA.

COMMANDER:OnEventBaseCaptured(EventData)

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

COMMANDER:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

COMMANDER:OnEventCrash(EventData)

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

COMMANDER:OnEventDead(EventData)

Occurs when an object is dead.

COMMANDER:OnEventDetailedFailure(EventData)

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

COMMANDER:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

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

COMMANDER:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

COMMANDER:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

COMMANDER:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

COMMANDER:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

COMMANDER:OnEventKill(EventData)

Occurs on the death of a unit.

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

COMMANDER:OnEventLandingAfterEjection(EventData)

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

COMMANDER:OnEventLandingQualityMark(EventData)

Landing quality mark.

COMMANDER:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

COMMANDER:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

COMMANDER:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

COMMANDER:OnEventMissionEnd(EventData)

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

COMMANDER:OnEventMissionStart(EventData)

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

COMMANDER:OnEventParatrooperLanding(EventData)

Weapon add.

COMMANDER:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

COMMANDER:OnEventPlayerEnterAircraft(EventData)

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

COMMANDER:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

COMMANDER:OnEventPlayerLeaveUnit(EventData)

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

COMMANDER:OnEventRefueling(EventData)

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

COMMANDER:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

COMMANDER:OnEventScore(EventData)

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

COMMANDER:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

COMMANDER:OnEventShootingStart(EventData)

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

COMMANDER:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

COMMANDER:OnEventTakeoff(EventData)

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

COMMANDER:OnEventTriggerZone(EventData)

Trigger zone.

COMMANDER:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

COMMANDER:ScheduleStop(SchedulerID)

Stops the Schedule.

COMMANDER.Scheduler

COMMANDER:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

COMMANDER:SetState(Object, Key, Value)

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

COMMANDER:T(Arguments)

Trace a function logic level 1.

COMMANDER:T2(Arguments)

Trace a function logic level 2.

COMMANDER:T3(Arguments)

Trace a function logic level 3.

COMMANDER:TraceAll(TraceAll)

Trace all methods in MOOSE

COMMANDER:TraceClass(Class)

Set tracing for a class

COMMANDER:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

COMMANDER:TraceLevel(Level)

Set trace level

COMMANDER:TraceOff()

Set trace off.

COMMANDER:TraceOn()

Set trace on.

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

COMMANDER:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

COMMANDER._

COMMANDER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

COMMANDER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

COMMANDER.__

COMMANDER:onEvent(event)

The main event handling function...

COMMANDER class.

Field(s)

#string COMMANDER.ClassName

Name of the class.

#string COMMANDER.alias

Alias name.

#table COMMANDER.awacsZones

AWACS zones. Each element is of type #AIRWING.PatrolZone.

#table COMMANDER.capZones

CAP zones. Each element is of type #AIRWING.PatrolZone.

#number COMMANDER.coalition

Coalition side of the commander.

#table COMMANDER.gcicapZones

GCICAP zones. Each element is of type #AIRWING.PatrolZone.

#table COMMANDER.legions

Table of legions which are commanded.

#string COMMANDER.lid

Class id string for output to DCS log file.

#table COMMANDER.missionqueue

Mission queue.

#table COMMANDER.rearmingZones

Rearming zones. Each element is of type #BRIGADE.SupplyZone.

#table COMMANDER.refuellingZones

Refuelling zones. Each element is of type #BRIGADE.SupplyZone.

#table COMMANDER.tankerZones

Tanker zones. Each element is of type #AIRWING.TankerZone.

#table COMMANDER.transportqueue

Transport queue.

#number COMMANDER.verbose

Verbosity level.

#string COMMANDER.version

COMMANDER class version.

Function(s)

Add an AIRWING to the commander.

Defined in:

COMMANDER

Parameter:

The airwing to add.

Return value:

self

Add an AWACS zone.

Defined in:

COMMANDER

Parameters:

Zone.

#number Altitude

Orbit altitude in feet. Default is 12,0000 feet.

#number Speed

Orbit speed in KIAS. Default 350 kts.

#number Heading

Heading of race-track pattern in degrees. Default 270 (East to West).

#number Leg

Length of race-track in NM. Default 30 NM.

Return value:

The AWACS zone data.

Add an BRIGADE to the commander.

Defined in:

COMMANDER

Parameter:

The brigade to add.

Return value:

self

Add a CAP zone.

Defined in:

COMMANDER

Parameters:

CapZone Zone.

#number Altitude

Orbit altitude in feet. Default is 12,0000 feet.

#number Speed

Orbit speed in KIAS. Default 350 kts.

#number Heading

Heading of race-track pattern in degrees. Default 270 (East to West).

#number Leg

Length of race-track in NM. Default 30 NM.

Return value:

The CAP zone data.

Add a GCICAP zone.

Defined in:

COMMANDER

Parameters:

CapZone Zone.

#number Altitude

Orbit altitude in feet. Default is 12,0000 feet.

#number Speed

Orbit speed in KIAS. Default 350 kts.

#number Heading

Heading of race-track pattern in degrees. Default 270 (East to West).

#number Leg

Length of race-track in NM. Default 30 NM.

Return value:

The CAP zone data.

Add a LEGION to the commander.

Defined in:

COMMANDER

Parameter:

The legion to add.

Return value:

self

Add mission to mission queue.

Defined in:

COMMANDER

Parameter:

Mission to be added.

Return value:

self

Add transport to queue.

Defined in:

COMMANDER

Parameter:

The OPS transport to be added.

Return value:

self

Add a rearming zone.

Defined in:

COMMANDER

Parameter:

Core.Zone#ZONE RearmingZone

Rearming zone.

Return value:

The rearming zone data.

Add a refuelling zone.

Defined in:

COMMANDER

Parameter:

Core.Zone#ZONE RefuellingZone

Refuelling zone.

Return value:

The refuelling zone data.

Add a refuelling tanker zone.

Defined in:

COMMANDER

Parameters:

Zone.

#number Altitude

Orbit altitude in feet. Default is 12,0000 feet.

#number Speed

Orbit speed in KIAS. Default 350 kts.

#number Heading

Heading of race-track pattern in degrees. Default 270 (East to West).

#number Leg

Length of race-track in NM. Default 30 NM.

#number RefuelSystem

Refuelling system.

Return value:

The tanker zone data.

Check mission queue and assign ONE planned mission.

Defined in:

COMMANDER

Check transport queue and assign ONE planned transport.

Defined in:

COMMANDER

Count assets of all assigned legions.

Defined in:

COMMANDER

Parameters:

#boolean InStock

If true, only assets that are in the warehouse stock/inventory are counted.

#table MissionTypes

(Optional) Count only assest that can perform certain mission type(s). Default is all types.

#table Attributes

(Optional) Count only assest that have a certain attribute(s), e.g. WAREHOUSE.Attribute.AIR_BOMBER.

Return value:

#number:

Amount of asset groups.

Count assets of all assigned legions.

Defined in:

COMMANDER

Parameters:

#boolean InStock

If true, only assets that are in the warehouse stock/inventory are counted.

#table Legions

(Optional) Table of legions. Default is all legions.

#table MissionTypes

(Optional) Count only assest that can perform certain mission type(s). Default is all types.

#table Attributes

(Optional) Count only assest that have a certain attribute(s), e.g. WAREHOUSE.Attribute.AIR_BOMBER.

Return value:

#number:

Amount of asset groups.

Get assets on given mission or missions.

Defined in:

COMMANDER

Parameter:

#table MissionTypes

Types on mission to be checked. Default all.

Return value:

#table:

Assets on pending requests.

Get coalition.

Defined in:

COMMANDER

Return value:

#number:

Coalition.

Check all legions if they are able to do a specific mission type at a certain location with a given number of assets.

Defined in:

COMMANDER

Parameter:

The mission.

Return value:

#table:

Table of LEGIONs that can do the mission and have at least one asset available right now.

Check if this mission is already in the queue.

Defined in:

COMMANDER

Parameter:

The mission.

Return value:

#boolean:

If true, this mission is in the queue.

Triggers the FSM event "MissionAssign".

Mission is added to a LEGION mission queue and already requested. Needs assets to be added to the mission!

Defined in:

COMMANDER

Parameters:

The mission.

#table Legions

The Legion(s) to which the mission is assigned.

Triggers the FSM event "MissionCancel".

Defined in:

COMMANDER

Parameter:

The mission.

Create a new COMMANDER object and start the FSM.

Defined in:

COMMANDER

Parameters:

#number Coalition

Coaliton of the commander.

#string Alias

Some name you want the commander to be called.

Return value:

self

On after "MissionAssign" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

#table Legions

The Legion(s) to which the mission is assigned.

On after "MissionCancel" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "OpsOnMission" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The OPS group on mission.

The mission.

On after "TransportAssign" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The transport.

#table Legions

The legion(s) to which this transport is assigned.

On after "TransportCancel" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The transport.

Triggers the FSM event "OpsOnMission".

Defined in:

COMMANDER

Parameters:

The OPS group on mission.

The mission.

Recruit assets performing an escort mission for a given asset.

Defined in:

COMMANDER

Parameters:

The mission.

#table Assets

Table of assets to be escorted.

Return value:

#boolean:

If true, enough assets could be recruited or no escort was required in the first place.

Recruit assets for a given mission.

Defined in:

COMMANDER

Parameter:

The mission.

Return values:

#boolean:

If true enough assets could be recruited.

#table:

Recruited assets.

#table:

Legions that have recruited assets.

Recruit assets for a given OPS transport.

Defined in:

COMMANDER

Parameters:

The OPS transport.

CargoWeight

Return values:

#boolean:

If true, enough assets could be recruited.

#table:

Recruited assets.

#table:

Legions that have recruited assets.

Remove mission from queue.

Defined in:

COMMANDER

Parameter:

Mission to be removed.

Return value:

self

Remove transport from queue.

Defined in:

COMMANDER

Parameter:

The OPS transport to be removed.

Return value:

self

Set verbosity level.

Defined in:

COMMANDER

Parameter:

#number VerbosityLevel

Level of output (higher=more). Default 0.

Return value:

self

Triggers the FSM event "Start".

Starts the COMMANDER.

Defined in:

COMMANDER

Triggers the FSM event "Status".

Defined in:

COMMANDER

Triggers the FSM event "TransportAssign".

Defined in:

COMMANDER

Parameters:

The transport.

#table Legions

The legion(s) to which this transport is assigned.

Triggers the FSM event "TransportCancel".

Defined in:

COMMANDER

Parameter:

The transport.

Triggers the FSM event "MissionAssign" after a delay.

Mission is added to a LEGION mission queue and already requested. Needs assets to be added to the mission!

Defined in:

COMMANDER

Parameters:

#number delay

Delay in seconds.

The mission.

#table Legions

The Legion(s) to which the mission is assigned.

Triggers the FSM event "MissionCancel" after a delay.

Defined in:

COMMANDER

Parameters:

#number delay

Delay in seconds.

The mission.

Triggers the FSM event "OpsOnMission" after a delay.

Defined in:

COMMANDER

Parameters:

#number delay

Delay in seconds.

The OPS group on mission.

The mission.

Triggers the FSM event "Start" after a delay.

Starts the COMMANDER.

Defined in:

COMMANDER

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Status" after a delay.

Defined in:

COMMANDER

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Stop" after a delay.

Stops the COMMANDER.

Defined in:

COMMANDER

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "TransportAssign" after a delay.

Defined in:

COMMANDER

Parameters:

#number delay

Delay in seconds.

The transport.

#table Legions

The legion(s) to which this transport is assigned.

Triggers the FSM event "TransportCancel" after a delay.

Defined in:

COMMANDER

Parameters:

#number delay

Delay in seconds.

The transport.

On after "MissionAssign" event.

Mission is added to a LEGION mission queue and already requested. Needs assets to be added to the mission already.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

#table Legions

The Legion(s) to which the mission is assigned.

On after "MissionCancel" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "OpsOnMission".

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops group on mission

The requested mission.

On after Start event.

Starts the FLIGHTGROUP FSM and event handlers.

Defined in:

COMMANDER

Parameters:

Flight group.

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Status" event.

Defined in:

COMMANDER

Parameters:

Flight group.

#string From

From state.

#string Event

Event.

#string To

To state.

On after "TransportAssign" event.

Transport is added to a LEGION mission queue.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The transport.

#table Legions

The legion(s) to which this transport is assigned.

On after "TransportCancel" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The transport.

Field(s)

#string COMMANDER.ClassName

Name of the class.

#string COMMANDER.alias

Alias name.

#table COMMANDER.awacsZones

AWACS zones. Each element is of type #AIRWING.PatrolZone.

#table COMMANDER.capZones

CAP zones. Each element is of type #AIRWING.PatrolZone.

#number COMMANDER.coalition

Coalition side of the commander.

#table COMMANDER.gcicapZones

GCICAP zones. Each element is of type #AIRWING.PatrolZone.

#table COMMANDER.legions

Table of legions which are commanded.

#string COMMANDER.lid

Class id string for output to DCS log file.

#table COMMANDER.missionqueue

Mission queue.

#table COMMANDER.rearmingZones

Rearming zones. Each element is of type #BRIGADE.SupplyZone.

#table COMMANDER.refuellingZones

Refuelling zones. Each element is of type #BRIGADE.SupplyZone.

#table COMMANDER.tankerZones

Tanker zones. Each element is of type #AIRWING.TankerZone.

#table COMMANDER.transportqueue

Transport queue.

#number COMMANDER.verbose

Verbosity level.

#string COMMANDER.version

COMMANDER class version.

Function(s)

Adds an End state.

Defined in:

Parameter:

#string State

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

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)

#string COMMANDER.ClassName

Name of the class.

#string COMMANDER.alias

Alias name.

#table COMMANDER.awacsZones

AWACS zones. Each element is of type #AIRWING.PatrolZone.

#table COMMANDER.capZones

CAP zones. Each element is of type #AIRWING.PatrolZone.

#number COMMANDER.coalition

Coalition side of the commander.

#table COMMANDER.gcicapZones

GCICAP zones. Each element is of type #AIRWING.PatrolZone.

#table COMMANDER.legions

Table of legions which are commanded.

#string COMMANDER.lid

Class id string for output to DCS log file.

#table COMMANDER.missionqueue

Mission queue.

#table COMMANDER.rearmingZones

Rearming zones. Each element is of type #BRIGADE.SupplyZone.

#table COMMANDER.refuellingZones

Refuelling zones. Each element is of type #BRIGADE.SupplyZone.

#table COMMANDER.tankerZones

Tanker zones. Each element is of type #AIRWING.TankerZone.

#table COMMANDER.transportqueue

Transport queue.

#number COMMANDER.verbose

Verbosity level.

#string COMMANDER.version

COMMANDER class version.

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

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

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

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