Module Ops.Commander
Ops - Commander of Airwings, Brigades and Fleets.
Main Features:
- Manages AIRWINGS, BRIGADEs and FLEETs
- 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 ConceptA commander is the head of legions. |
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)
| Fields and Methods inherited from COMMANDER | Description |
|---|---|
|
Add an AIRWING to the commander. |
|
|
Add an AWACS zone. |
|
|
Add a BRIGADE to the commander. |
|
|
Add a CAP zone. |
|
|
Add a FLEET to the commander. |
|
COMMANDER:AddGciCapZone(Zone, Altitude, Speed, Heading, Leg) |
Add a GCICAP zone. |
|
Add a LEGION to the commander. |
|
|
Add mission to mission queue. |
|
|
Add operation. |
|
|
Add transport to queue. |
|
|
Add a rearming zone. |
|
|
Add a refuelling zone. |
|
COMMANDER:AddTankerZone(Zone, Altitude, Speed, Heading, Leg, RefuelSystem) |
Add a refuelling tanker zone. |
|
Add target. |
|
|
Check mission queue and assign ONE planned mission. |
|
|
Check OPERATIONs queue. |
|
|
Check target queue and assign ONE valid target by adding it to the mission queue of the COMMANDER. |
|
|
Check transport queue and assign ONE planned transport. |
|
|
Name of the class. |
|
|
Count assets of all assigned legions. |
|
|
Count assets of all assigned legions. |
|
COMMANDER:GetAssets(InStock, Legions, MissionTypes, Attributes) |
Count assets of all assigned legions. |
|
Get assets on given mission or missions. |
|
|
Get coalition. |
|
|
Check all legions if they are able to do a specific mission type at a certain location with a given number of assets. |
|
|
Check if this mission is already in the queue. |
|
|
Check if a TARGET is already in the queue. |
|
|
Triggers the FSM event "LegionLost". |
|
|
Triggers the FSM event "MissionAssign". |
|
|
Triggers the FSM event "MissionCancel". |
|
|
Create a new COMMANDER object and start the FSM. |
|
COMMANDER:OnAfterLegionLost(From, Event, To, Legion, Coalition, Country) |
On after "LegionLost" event. |
COMMANDER:OnAfterMissionAssign(From, Event, To, Mission, Legions) |
On after "MissionAssign" event. |
|
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. |
|
Triggers the FSM event "OpsOnMission". |
|
|
Recruit assets performing an escort mission for a given asset. |
|
|
Recruit assets for a given mission. |
|
COMMANDER:RecruitAssetsForTarget(Target, MissionType, NassetsMin, NassetsMax) |
Recruit assets for a given TARGET. |
COMMANDER:RecruitAssetsForTransport(Transport, CargoWeight, TotalWeight) |
Recruit assets for a given OPS transport. |
COMMANDER:RelocateCohort(Cohort, Legion, Delay, NcarriersMin, NcarriersMax, TransportLegions) |
Relocate a cohort to another legion. |
|
Remove a AWACS zone. |
|
|
Remove a GCI CAP. |
|
|
Remove a LEGION to the commander. |
|
|
Remove mission from queue. |
|
|
Remove a refuelling tanker zone. |
|
|
Remove target from queue. |
|
|
Remove transport from queue. |
|
|
Set limit for number of total or specific missions to be executed simultaniously. |
|
|
Set verbosity level. |
|
|
Triggers the FSM event "Start". |
|
|
Triggers the FSM event "Status". |
|
|
Triggers the FSM event "TransportAssign". |
|
|
Triggers the FSM event "TransportCancel". |
|
|
Check if limit of missions has been reached. |
|
|
Get cohorts. |
|
|
Triggers the FSM event "LegionLost". |
|
|
Triggers the FSM event "MissionAssign" after a delay. |
|
|
Triggers the FSM event "MissionCancel" after a delay. |
|
|
Triggers the FSM event "OpsOnMission" after a delay. |
|
|
Triggers the FSM event "Start" after a delay. |
|
|
Triggers the FSM event "Status" after a delay. |
|
|
Triggers the FSM event "Stop" after a delay. |
|
|
Triggers the FSM event "TransportAssign" after a delay. |
|
|
Triggers the FSM event "TransportCancel" after a delay. |
|
|
Alias name. |
|
|
AWACS zones. Each element is of type |
|
|
CAP zones. Each element is of type |
|
|
Chief of staff. |
|
|
Coalition side of the commander. |
|
|
GCICAP zones. Each element is of type |
|
|
Table of legions which are commanded. |
|
|
Class id string for output to DCS log file. |
|
|
Table of limits for mission types. |
|
|
Mission queue. |
|
COMMANDER:onafterMissionAssign(From, Event, To, Mission, Legions) |
On after "MissionAssign" event. |
|
On after "MissionCancel" event. |
|
COMMANDER:onafterOpsOnMission(From, Event, To, OpsGroup, Mission) |
On after "OpsOnMission". |
|
On after Start event. |
|
|
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. |
|
Operations queue. |
|
|
Rearming zones. Each element is of type |
|
|
Refuelling zones. Each element is of type |
|
|
Tanker zones. Each element is of type |
|
|
Target queue. |
|
|
Transport queue. |
|
|
Verbosity level. |
|
|
COMMANDER class version. |
| Fields and Methods inherited from FSM | Description |
|---|---|
|
Adds an End state. |
|
|
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task. |
|
|
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. |
|
Add a new transition rule to the FSM. |
|
|
Get current state. |
|
|
Returns the End states. |
|
|
Returns a table of the SubFSM rules defined within the FSM. |
|
|
Returns a table with the scores defined. |
|
|
Returns the start state of the FSM. |
|
|
Get current state. |
|
|
Returns a table with the Subs defined. |
|
|
Returns a table of the transition rules defined within the FSM. |
|
|
Check if FSM is in state. |
|
|
Load call backs. |
|
|
Creates a new FSM object. |
|
|
Sets the start state of the FSM. |
|
|
Add to map. |
|
|
Call handler. |
|
|
Create transition. |
|
|
Delayed transition. |
|
|
Event map. |
|
|
Go sub. |
|
|
Handler. |
|
|
Is end state. |
|
|
Sub maps. |
|
|
Check if can do an event. |
|
|
Check if cannot do an event. |
|
|
Check if FSM is in state. |
|
COMMANDER class.
Field(s)
Name of the class.
Alias name.
AWACS zones. Each element is of type #AIRWING.PatrolZone.
CAP zones. Each element is of type #AIRWING.PatrolZone.
Coalition side of the commander.
GCICAP zones. Each element is of type #AIRWING.PatrolZone.
Table of legions which are commanded.
Class id string for output to DCS log file.
Table of limits for mission types.
Mission queue.
Operations queue.
Rearming zones. Each element is of type #BRIGADE.SupplyZone.
Refuelling zones. Each element is of type #BRIGADE.SupplyZone.
Tanker zones. Each element is of type #AIRWING.TankerZone.
Target queue.
Transport queue.
Verbosity level.
COMMANDER class version.
Function(s)
Add an AIRWING to the commander.
Add an AWACS zone.
Defined in:
COMMANDER
Parameters:
Core.Zone#ZONE Zone
Zone.
#number Altitude
Orbit altitude in feet. Default is 12,000 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 a BRIGADE to the commander.
Add a CAP zone.
Defined in:
COMMANDER
Parameters:
Core.Zone#ZONE Zone
CapZone Zone.
#number Altitude
Orbit altitude in feet. Default is 12,000 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 FLEET to the commander.
Add a GCICAP zone.
Defined in:
COMMANDER
Parameters:
Core.Zone#ZONE Zone
CapZone Zone.
#number Altitude
Orbit altitude in feet. Default is 12,000 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.
Add mission to mission queue.
Defined in:
COMMANDER
Parameter:
Ops.Auftrag#AUFTRAG Mission
Mission to be added.
Return value:
self
Add operation.
Defined in:
COMMANDER
Parameter:
Ops.Operation#OPERATION Operation
The operation to be added.
Return value:
self
Add transport to queue.
Defined in:
COMMANDER
Parameter:
Ops.OpsTransport#OPSTRANSPORT Transport
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:
Core.Zone#ZONE Zone
Zone.
#number Altitude
Orbit altitude in feet. Default is 12,000 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.
Add target.
Defined in:
COMMANDER
Parameter:
Ops.Target#TARGET Target
Target object to be added.
Return value:
self
Check mission queue and assign ONE planned mission.
Defined in:
COMMANDER
Check target queue and assign ONE valid target by adding it to the mission queue of the COMMANDER.
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:
#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.
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.
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.
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.
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.
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.
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.
Triggers the FSM event "MissionCancel".
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 "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.
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.
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.
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.
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.
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.
Triggers the FSM event "OpsOnMission".
Defined in:
COMMANDER
Parameters:
Ops.OpsGroup#OPSGROUP OpsGroup
The OPS group on mission.
Ops.Auftrag#AUFTRAG Mission
The mission.
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.
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.
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.
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.
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
Remove a AWACS zone.
Remove a GCI CAP.
Remove a LEGION to the commander.
Defined in:
COMMANDER
Parameter:
Ops.Legion#LEGION Legion
The legion to be removed.
Return value:
self
Remove mission from queue.
Defined in:
COMMANDER
Parameter:
Ops.Auftrag#AUFTRAG Mission
Mission to be removed.
Return value:
self
Remove a refuelling tanker zone.
Remove target from queue.
Remove transport from queue.
Defined in:
COMMANDER
Parameter:
Ops.OpsTransport#OPSTRANSPORT Transport
The OPS transport to be removed.
Return value:
self
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
Set verbosity level.
Defined in:
COMMANDER
Parameter:
#number VerbosityLevel
Level of output (higher=more). Default 0.
Return value:
self
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.
Triggers the FSM event "TransportCancel".
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.
Get cohorts.
Defined in:
COMMANDER
Parameters:
#table Legions
Special legions.
#table Cohorts
Special cohorts.
Ops.Operation#OPERATION Operation
Operation.
Return value:
#table:
Cohorts.
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.
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.
Triggers the FSM event "MissionCancel" after a delay.
Defined in:
COMMANDER
Parameters:
#number delay
Delay in seconds.
Ops.Auftrag#AUFTRAG Mission
The 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.
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.
Ops.OpsTransport#OPSTRANSPORT Transport
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.
Ops.OpsTransport#OPSTRANSPORT Transport
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.
Ops.Auftrag#AUFTRAG Mission
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.
Ops.Auftrag#AUFTRAG Mission
The 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.
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.
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.
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.
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)
Name of the class.
Alias name.
AWACS zones. Each element is of type #AIRWING.PatrolZone.
CAP zones. Each element is of type #AIRWING.PatrolZone.
Coalition side of the commander.
GCICAP zones. Each element is of type #AIRWING.PatrolZone.
Table of legions which are commanded.
Class id string for output to DCS log file.
Table of limits for mission types.
Mission queue.
Operations queue.
Rearming zones. Each element is of type #BRIGADE.SupplyZone.
Refuelling zones. Each element is of type #BRIGADE.SupplyZone.
Tanker zones. Each element is of type #AIRWING.TankerZone.
Target queue.
Transport queue.
Verbosity level.
COMMANDER class version.
Function(s)
Adds an End state.
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
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:
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.
Returns the End states.
Returns a table of the SubFSM rules defined within the FSM.
Returns a table with the scores defined.
Returns the start state of the FSM.
Get current state.
Returns a table with the Subs defined.
Returns a table of the transition rules defined within the FSM.
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.
Sets the start state of the FSM.
Add to map.
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.
Go sub.
Defined in:
Parameters:
#string ParentFrom
Parent from state.
#string ParentEvent
Parent event name.
Return value:
#table:
Subs.
Handler.
Is end state.
Defined in:
Parameter:
#string Current
Current state name.
Return values:
#table:
FSM parent.
#string:
Event name.
Sub maps.
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.