Module Ops.Commander

Ops.AirWing#AIRWING.PatrolZone:

self

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

Add an AWACS zone.

Defined in:

COMMANDER

Parameters:

Core.Zone#ZONE Zone

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.

COMMANDER:AddBrigade(Brigade)

Add a BRIGADE to the commander.

Defined in:

COMMANDER

Parameter:

Ops.Brigade#BRIGADE Brigade

The brigade to add.

Return value:

Ops.AirWing#AIRWING.PatrolZone:

self

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

Add a CAP zone.

Defined in:

COMMANDER

Parameters:

Core.Zone#ZONE Zone

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.

COMMANDER:AddFleet(Fleet)

Add a FLEET to the commander.

Defined in:

COMMANDER

Parameter:

Ops.Fleet#FLEET Fleet

The fleet to add.

Return value:

Ops.AirWing#AIRWING.PatrolZone:

self

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

Add a GCICAP zone.

Defined in:

COMMANDER

Parameters:

Core.Zone#ZONE Zone

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.

COMMANDER:AddLegion(Legion)

Add a LEGION to the commander.

Defined in:

COMMANDER

Parameter:

Ops.Legion#LEGION Legion

The legion to add.

Return value:

self

COMMANDER:AddMission(Mission)

Add mission to mission queue.

Defined in:

COMMANDER

Parameter:

Ops.Auftrag#AUFTRAG Mission

Mission to be added.

Return value:

self

COMMANDER:AddOperation(Operation)

Add operation.

Defined in:

COMMANDER

Parameter:

Ops.Operation#OPERATION Operation

The operation to be added.

Return value:

self

COMMANDER:AddOpsTransport(Transport)

Add transport to queue.

Defined in:

COMMANDER

Parameter:

Ops.OpsTransport#OPSTRANSPORT Transport

The OPS transport to be added.

Return value:

Ops.Brigade#BRIGADE.SupplyZone:

self

COMMANDER:AddRearmingZone(RearmingZone)

Add a rearming zone.

Defined in:

COMMANDER

Parameter:

Core.Zone#ZONE RearmingZone

Rearming zone.

Return value:

The rearming zone data.

COMMANDER:AddRefuellingZone(RefuellingZone)

Add a refuelling zone.

Defined in:

COMMANDER

Parameter:

Core.Zone#ZONE RefuellingZone

Refuelling zone.

Return value:

Ops.Brigade#BRIGADE.SupplyZone:

The refuelling zone data.

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

Add a refuelling tanker zone.

Defined in:

COMMANDER

Parameters:

Core.Zone#ZONE Zone

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:

Ops.AirWing#AIRWING.TankerZone:

The tanker zone data.

COMMANDER:AddTarget(Target)

Add target.

Defined in:

COMMANDER

Parameter:

Ops.Target#TARGET Target

Target object to be added.

Return value:

self

COMMANDER:CheckMissionQueue()

Check mission queue and assign ONE planned mission.

Defined in:

COMMANDER

COMMANDER:CheckOpsQueue()

Check OPERATIONs queue.

Defined in:

COMMANDER

COMMANDER:CheckTargetQueue()

Check target queue and assign ONE valid target by adding it to the mission queue of the COMMANDER.

Defined in:

COMMANDER

COMMANDER:CheckTransportQueue()

Check transport queue and assign ONE planned transport.

Defined in:

COMMANDER

COMMANDER:CountAssets(InStock, MissionTypes, Attributes)

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.

COMMANDER:CountMissions(MissionTypes, OnlyRunning)

Count assets of all assigned legions.

Defined in:

COMMANDER

Parameters:

#table MissionTypes

(Optional) Count only missions of these types. Default is all types.

#boolean OnlyRunning

If true, only count running missions.

Return value:

#number:

Amount missions.

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

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.

COMMANDER:GetAssetsOnMission(MissionTypes)

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.

COMMANDER:GetCoalition()

Get coalition.

Defined in:

COMMANDER

Return value:

#number:

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.

Defined in:

COMMANDER

Parameter:

Ops.Auftrag#AUFTRAG Mission

The mission.

Return value:

#table:

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

COMMANDER:IsMission(Mission)

Check if this mission is already in the queue.

Defined in:

COMMANDER

Parameter:

Ops.Auftrag#AUFTRAG Mission

The mission.

Return value:

#boolean:

If true, this mission is in the queue.

COMMANDER:IsTarget(Target)

Check if a TARGET is already in the queue.

Defined in:

COMMANDER

Parameter:

Ops.Target#TARGET Target

Target object to be added.

Return value:

#boolean:

If true, target exists in the target queue.

COMMANDER:LegionLost(Legion, Coalition, Country)

Triggers the FSM event "LegionLost".

Defined in:

COMMANDER

Parameters:

Ops.Legion#LEGION Legion

The legion that was lost.

DCS#coalition.side Coalition

which captured the warehouse.

DCS#country.id Country

which has captured the warehouse.

COMMANDER:MissionAssign(Mission, Legions)

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:

Ops.Auftrag#AUFTRAG Mission

The mission.

#table Legions

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

COMMANDER:MissionCancel(Mission)

Triggers the FSM event "MissionCancel".

Defined in:

COMMANDER

Parameter:

Ops.Auftrag#AUFTRAG Mission

The mission.

COMMANDER:New(Coalition, Alias)

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

COMMANDER:OnAfterLegionLost(From, Event, To, Legion, Coalition, Country)

On after "LegionLost" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.Legion#LEGION Legion

The legion that was lost.

DCS#coalition.side Coalition

which captured the warehouse.

DCS#country.id Country

which has captured the warehouse.

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

On after "MissionAssign" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.Auftrag#AUFTRAG Mission

The mission.

#table Legions

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

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

On after "MissionCancel" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.Auftrag#AUFTRAG Mission

The mission.

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

On after "OpsOnMission" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.OpsGroup#OPSGROUP OpsGroup

The OPS group on mission.

Ops.Auftrag#AUFTRAG Mission

The mission.

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

On after "TransportAssign" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.OpsTransport#OPSTRANSPORT Transport

The transport.

#table Legions

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

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

On after "TransportCancel" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.OpsTransport#OPSTRANSPORT Transport

The transport.

COMMANDER:OpsOnMission(OpsGroup, Mission)

Triggers the FSM event "OpsOnMission".

Defined in:

COMMANDER

Parameters:

Ops.OpsGroup#OPSGROUP OpsGroup

The OPS group on mission.

Ops.Auftrag#AUFTRAG Mission

The mission.

COMMANDER:RecruitAssetsForEscort(Mission, Assets)

Recruit assets performing an escort mission for a given asset.

Defined in:

COMMANDER

Parameters:

Ops.Auftrag#AUFTRAG Mission

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.

COMMANDER:RecruitAssetsForMission(Mission)

Recruit assets for a given mission.

Defined in:

COMMANDER

Parameter:

Ops.Auftrag#AUFTRAG Mission

The mission.

Return values:

#boolean:

If true enough assets could be recruited.

#table:

Recruited assets.

#table:

Legions that have recruited assets.

COMMANDER:RecruitAssetsForTarget(Target, MissionType, NassetsMin, NassetsMax)

Recruit assets for a given TARGET.

Defined in:

COMMANDER

Parameters:

Ops.Target#TARGET Target

The target.

#string MissionType

Mission Type.

#number NassetsMin

Min number of required assets.

#number NassetsMax

Max number of required assets.

Return values:

#boolean:

If true enough assets could be recruited.

#table:

Assets that have been recruited from all legions.

#table:

Legions that have recruited assets.

COMMANDER:RecruitAssetsForTransport(Transport, CargoWeight, TotalWeight)

Recruit assets for a given OPS transport.

Defined in:

COMMANDER

Parameters:

Ops.OpsTransport#OPSTRANSPORT Transport

The OPS transport.

#number CargoWeight

Weight of the heaviest cargo group.

#number TotalWeight

Total weight of all cargo groups.

Return values:

#boolean:

If true, enough assets could be recruited.

#table:

Recruited assets.

#table:

Legions that have recruited assets.

COMMANDER:RelocateCohort(Cohort, Legion, Delay, NcarriersMin, NcarriersMax, TransportLegions)

Relocate a cohort to another legion.

Assets in stock are spawned and routed to the new legion. If assets are spawned, running missions will be cancelled. Cohort assets will not be available until relocation is finished.

Defined in:

COMMANDER

Parameters:

Ops.Cohort#COHORT Cohort

The cohort to be relocated.

Ops.Legion#LEGION Legion

The legion where the cohort is relocated to.

#number Delay

Delay in seconds before relocation takes place. Default nil, i.e. ASAP.

#number NcarriersMin

Min number of transport carriers in case the troops should be transported. Default nil for no transport.

#number NcarriersMax

Max number of transport carriers.

#table TransportLegions

Legion(s) assigned for transportation. Default is all legions of the commander.

Return value:

self

COMMANDER:RemoveAwacsZone(Zone)

Remove a AWACS zone.

Defined in:

COMMANDER

Parameter:

Core.Zone#ZONE Zone

Zone, where the flight orbits.

COMMANDER:RemoveGciCapZone(Zone)

Remove a GCI CAP.

Defined in:

COMMANDER

Parameter:

Core.Zone#ZONE Zone

Zone, where the flight orbits.

COMMANDER:RemoveLegion(Legion)

Remove a LEGION to the commander.

Defined in:

COMMANDER

Parameter:

Ops.Legion#LEGION Legion

The legion to be removed.

Return value:

self

COMMANDER:RemoveMission(Mission)

Remove mission from queue.

Defined in:

COMMANDER

Parameter:

Ops.Auftrag#AUFTRAG Mission

Mission to be removed.

Return value:

self

COMMANDER:RemoveTankerZone(Zone)

Remove a refuelling tanker zone.

Defined in:

COMMANDER

Parameter:

Core.Zone#ZONE Zone

Zone, where the flight orbits.

COMMANDER:RemoveTarget(Target)

Remove target from queue.

Defined in:

COMMANDER

Parameter:

Ops.Target#TARGET Target

The target.

Return value:

self

COMMANDER:RemoveTransport(Transport)

Remove transport from queue.

Defined in:

COMMANDER

Parameter:

Ops.OpsTransport#OPSTRANSPORT Transport

The OPS transport to be removed.

Return value:

self

COMMANDER:SetLimitMission(Limit, MissionType)

Set limit for number of total or specific missions to be executed simultaniously.

Defined in:

COMMANDER

Parameters:

#number Limit

Number of max. mission of this type. Default 10.

#string MissionType

Type of mission, e.g. AUFTRAG.Type.BAI. Default "Total" for total number of missions.

Return value:

self

COMMANDER:SetVerbosity(VerbosityLevel)

Set verbosity level.

Defined in:

COMMANDER

Parameter:

#number VerbosityLevel

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

Return value:

self

COMMANDER:Start()

Triggers the FSM event "Start".

Starts the COMMANDER.

Defined in:

COMMANDER

COMMANDER:Status()

Triggers the FSM event "Status".

Defined in:

COMMANDER

COMMANDER:TransportAssign(Transport, Legions)

Triggers the FSM event "TransportAssign".

Defined in:

COMMANDER

Parameters:

Ops.OpsTransport#OPSTRANSPORT Transport

The transport.

#table Legions

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

COMMANDER:TransportCancel(Transport)

Triggers the FSM event "TransportCancel".

Defined in:

COMMANDER

Parameter:

Ops.OpsTransport#OPSTRANSPORT Transport

The transport.

COMMANDER:_CheckMissionLimit(MissionType)

Check if limit of missions has been reached.

Defined in:

COMMANDER

Parameter:

#string MissionType

Type of mission.

Return value:

#boolean:

If true, mission limit has not been reached. If false, limit has been reached.

COMMANDER:_GetCohorts(Legions, Cohorts, Operation)

Get cohorts.

Defined in:

COMMANDER

Parameters:

#table Legions

Special legions.

#table Cohorts

Special cohorts.

Ops.Operation#OPERATION Operation

Operation.

Return value:

#table:

Cohorts.

COMMANDER:__LegionLost(delay, Legion, Coalition, Country)

Triggers the FSM event "LegionLost".

Defined in:

COMMANDER

Parameters:

#number delay

Delay in seconds.

Ops.Legion#LEGION Legion

The legion that was lost.

DCS#coalition.side Coalition

which captured the warehouse.

DCS#country.id Country

which has captured the warehouse.

COMMANDER:__MissionAssign(delay, Mission, Legions)

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.

Ops.Auftrag#AUFTRAG Mission

The mission.

#table Legions

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

COMMANDER:__MissionCancel(delay, Mission)

Triggers the FSM event "MissionCancel" after a delay.

Defined in:

COMMANDER

Parameters:

#number delay

Delay in seconds.

Ops.Auftrag#AUFTRAG Mission

The mission.

COMMANDER:__OpsOnMission(delay, OpsGroup, Mission)

Triggers the FSM event "OpsOnMission" after a delay.

Defined in:

COMMANDER

Parameters:

#number delay

Delay in seconds.

Ops.OpsGroup#OPSGROUP OpsGroup

The OPS group on mission.

Ops.Auftrag#AUFTRAG Mission

The mission.

COMMANDER:__Start(delay)

Triggers the FSM event "Start" after a delay.

Starts the COMMANDER.

Defined in:

COMMANDER

Parameter:

#number delay

Delay in seconds.

COMMANDER:__Status(delay)

Triggers the FSM event "Status" after a delay.

Defined in:

COMMANDER

Parameter:

#number delay

Delay in seconds.

COMMANDER:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

Stops the COMMANDER.

Defined in:

COMMANDER

Parameter:

#number delay

Delay in seconds.

COMMANDER:__TransportAssign(delay, Transport, Legions)

Triggers the FSM event "TransportAssign" after a delay.

Defined in:

COMMANDER

Parameters:

#number delay

Delay in seconds.

Ops.OpsTransport#OPSTRANSPORT Transport

The transport.

#table Legions

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

COMMANDER:__TransportCancel(delay, Transport)

Triggers the FSM event "TransportCancel" after a delay.

Defined in:

COMMANDER

Parameters:

#number delay

Delay in seconds.

Ops.OpsTransport#OPSTRANSPORT Transport

The transport.

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

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.

Ops.Auftrag#AUFTRAG Mission

The mission.

#table Legions

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

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

On after "MissionCancel" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.Auftrag#AUFTRAG Mission

The mission.

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

On after "OpsOnMission".

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.OpsGroup#OPSGROUP OpsGroup

Ops group on mission

Ops.Auftrag#AUFTRAG Mission

The requested mission.

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

On after Start event.

Starts the FLIGHTGROUP FSM and event handlers.

Defined in:

COMMANDER

Parameters:

Wrapper.Group#GROUP Group

Flight group.

#string From

From state.

#string Event

Event.

#string To

To state.

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

On after "Status" event.

Defined in:

COMMANDER

Parameters:

Wrapper.Group#GROUP Group

Flight group.

#string From

From state.

#string Event

Event.

#string To

To state.

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

On after "TransportAssign" event.

Transport is added to a LEGION transport queue.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.OpsTransport#OPSTRANSPORT Transport

The transport.

#table Legions

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

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

On after "TransportCancel" event.

Defined in:

COMMANDER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.OpsTransport#OPSTRANSPORT Transport

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.

Ops.Chief#CHIEF COMMANDER.chief

Chief of staff.

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

Table of limits for mission types.

#table COMMANDER.missionqueue

Mission queue.

#table COMMANDER.opsqueue

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

Target queue.

#table COMMANDER.transportqueue

Transport queue.

#number COMMANDER.verbose

Verbosity level.

#string COMMANDER.version

COMMANDER class version.

Function(s)

COMMANDER:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

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

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.

Core.Fsm#FSM_PROCESS Process

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:

Core.Fsm#FSM_PROCESS:

The SubFSM.

COMMANDER:AddScore(State, ScoreText, Score)

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

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

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

COMMANDER:AddTransition(From, Event, To)

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.

COMMANDER:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

COMMANDER:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

COMMANDER:GetProcess(From, Event)

Defined in:

Parameters:

From

Event

COMMANDER:GetProcesses()

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

Defined in:

Return value:

#table:

Sub processes.

COMMANDER:GetScores()

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

COMMANDER:GetStartState()

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

COMMANDER:GetState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

COMMANDER:GetSubs()

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

COMMANDER:GetTransitions()

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

Defined in:

Return value:

#table:

Transitions.

COMMANDER:Is(State)

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

COMMANDER:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

COMMANDER:New()

Creates a new FSM object.

Defined in:

Return value:

#FSM:

COMMANDER:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Event

Fsm

COMMANDER:SetStartState(State)

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

COMMANDER:_add_to_map(Map, Event)

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

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

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.

COMMANDER:_create_transition(EventName)

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

COMMANDER:_delayed_transition(EventName)

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

COMMANDER:_eventmap(Events, EventStructure)

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

COMMANDER:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

COMMANDER:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

COMMANDER:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

COMMANDER:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

COMMANDER:can(e)

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.

COMMANDER:cannot(e)

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

COMMANDER:is(State, state)

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.

Ops.Chief#CHIEF COMMANDER.chief

Chief of staff.

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

Table of limits for mission types.

#table COMMANDER.missionqueue

Mission queue.

#table COMMANDER.opsqueue

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

Target queue.

#table COMMANDER.transportqueue

Transport queue.

#number COMMANDER.verbose

Verbosity level.

#string COMMANDER.version

COMMANDER class version.

Function(s)

COMMANDER:ClearState(Object, StateName)

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.

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

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

COMMANDER:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

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

COMMANDER:CreateEventDead(EventTime, Initiator, 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

COMMANDER:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

COMMANDER:CreateEventRemoveUnit(EventTime, Initiator)

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.

COMMANDER:CreateEventTakeoff(EventTime, Initiator)

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.

COMMANDER:CreateEventUnitLost(EventTime, Initiator)

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.

COMMANDER:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

COMMANDER:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

COMMANDER:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

COMMANDER:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

COMMANDER:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

COMMANDER:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

COMMANDER:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

COMMANDER:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

COMMANDER:GetClassNameAndID()

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.

COMMANDER:GetEventPriority()

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.

COMMANDER:GetParent(Child, FromClass)

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:

COMMANDER:GetState(Object, Key)

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.

COMMANDER:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS EventID

Event ID.

#function EventFunction

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

Return value:

COMMANDER:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

COMMANDER:Inherit(Child, Parent)

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

COMMANDER:IsInstanceOf(ClassName)

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:

COMMANDER:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

COMMANDER:New()

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:

COMMANDER:OnEvent(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventBDA(EventData)

BDA.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventBaseCaptured(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventBirth(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventCrash(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventDead(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventDetailedFailure(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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.

initiator : The unit that has ejected

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventEngineShutdown(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventEngineStartup(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventHit(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventHumanFailure(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventKill(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

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.

initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventLandingAfterEjection(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventLandingQualityMark(EventData)

Landing quality mark.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventMarkAdded(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventMarkChange(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventMarkRemoved(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventMissionEnd(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventMissionStart(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventParatrooperLanding(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventPilotDead(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventPlayerEnterAircraft(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventPlayerEnterUnit(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventPlayerLeaveUnit(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventRefueling(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventRefuelingStop(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventScore(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventShootingEnd(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventShootingStart(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventShot(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventTakeoff(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventTriggerZone(EventData)

Trigger zone.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

COMMANDER:OnEventUnitLost(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

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

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.

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

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.

COMMANDER:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

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

COMMANDER:SetEventPriority(EventPriority)

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

COMMANDER:SetState(Object, Key, Value)

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.

COMMANDER:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

COMMANDER:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

COMMANDER:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

COMMANDER:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

COMMANDER:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

COMMANDER:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

COMMANDER:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

COMMANDER:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

COMMANDER:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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.

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 )

COMMANDER:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

COMMANDER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

COMMANDER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

COMMANDER:onEvent(event)

The main event handling function...

This function captures all events generated for the class.

Defined in: