Module Ops.OpsTransport
Ops - Transport assignment for OPS groups and storage.
Main Features:
- Transport troops from A to B
- Transport of warehouse storage (fuel, weapons and equipment)
- Supports ground, naval and airborne (airplanes and helicopters) units as carriers
- Use combined forces (ground, naval, air) to transport the troops
- Additional FSM events to hook into and customize your mission design
Example Missions:
Demo missions can be found on github.
Author: funkyfranky
Global(s)
Global OPSTRANSPORT |
Victory is the beautiful, bright-colored flower; Transport is the stem without which it could never have blossomed -- Winston Churchill The OPSTRANSPORT ConceptThis class simulates troop transport using carriers such as APCs, ships, helicopters or airplanes. |
Victory is the beautiful, bright-colored flower; Transport is the stem without which it could never have blossomed -- Winston Churchill
The OPSTRANSPORT Concept
This class simulates troop transport using carriers such as APCs, ships, helicopters or airplanes.
The carriers and transported groups need to be OPSGROUPS (see ARMYGROUP, NAVYGROUP and FLIGHTGROUP classes).
IMPORTANT NOTES
- Cargo groups are not split and distributed into different carrier units. That means that the whole cargo group must fit into one of the carrier units.
- Cargo groups must be inside the pickup zones to be considered for loading. Groups not inside the pickup zone will not get the command to board.
Troop Transport
A new cargo transport assignment is created with the OPSTRANSPORT.New() function
local opstransport=OPSTRANSPORT:New(Cargo, PickupZone, DeployZone)
Here Cargo is an object of the troops to be transported. This can be a GROUP, OPSGROUP, SET_GROUP or SET_OPSGROUP object.
PickupZone is the zone where the troops are picked up by the transport carriers. Note that troops must be inside this zone to be considered for loading!
DeployZone is the zone where the troops are transported to.
Assign to Carrier(s)
A transport can be assigned to one or multiple carrier OPSGROUPS with this Ops.OpsGroup#OPSGROUP.AddOpsTransport() function
myopsgroup:AddOpsTransport(opstransport)
There is no restriction to the type of the carrier. It can be a ground group (e.g. an APC), a helicopter, an airplane or even a ship.
You can also mix carrier types. For instance, you can assign the same transport to APCs and helicopters. Or to helicopters and airplanes.
Storage Transport
An instance of the OPSTRANSPORT class is created similarly to the troop transport case. However, the first parameter is nil as not troops
are transported.
local storagetransport=OPSTRANSPORT:New(nil, PickupZone, DeployZone)
Defining Storage
The storage warehouses from which the cargo is taken and to which the cargo is delivered have to be specified
storagetransport:AddCargoStorage(berlinStorage, batumiStorage, STORAGE.Liquid.JETFUEL, 1000)
Here berlinStorage and batumiStorage are Wrapper.Storage#STORAGE objects of DCS warehouses.
Furthermore, that type of cargo (liquids or weapons/equipment) and the amount has to be specified. If weapons/equipment is the cargo, we also need to specify the weight per storage item as this cannot be retrieved from the DCS API and is not stored in any MOOSE database.
storagetransport:AddCargoStorage(berlinStorage, batumiStorage, ENUMS.Storage.weapons.bombs.Mk_82, 9, 230)
Finally, the transport is assigned to one or multiple groups, which carry out the transport
myopsgroup:AddOpsTransport(storagetransport)
Examples
A carrier group is assigned to transport infantry troops from zone "Zone Kobuleti X" to zone "Zone Alpha".
-- Carrier group.
local carrier=ARMYGROUP:New("TPz Fuchs Group")
-- Set of groups to transport.
local infantryset=SET_GROUP:New():FilterPrefixes("Infantry Platoon Alpha"):FilterOnce()
-- Cargo transport assignment.
local opstransport=OPSTRANSPORT:New(infantryset, ZONE:New("Zone Kobuleti X"), ZONE:New("Zone Alpha"))
-- Assign transport to carrier.
carrier:AddOpsTransport(opstransport)
Global _OPSTRANSPORTID |
Transport ID. |
Transport ID.
Type(s)
| Fields and Methods inherited from OPSTRANSPORT | Description |
|---|---|
|
Add carrier asset to transport. |
|
|
Add cargo asset. |
|
|
Add cargo groups to be transported. |
|
|
Add cargo warehouse storage to be transported. |
|
|
Add start condition. |
|
|
Add LEGION to the transport. |
|
OPSTRANSPORT:AddPathTransport(PathGroup, Radius, TransportZoneCombo, Reversed) |
Add path used for transportation from the pickup to the deploy zone. |
OPSTRANSPORT:AddTransportZoneCombo(CargoGroups, PickupZone, DeployZone) |
Add pickup and deploy zone combination. |
|
Triggers the FSM event "Cancel". |
|
|
Name of the class. |
|
|
Delete carrier asset from transport. |
|
|
Triggers the FSM event "Delivered". |
|
|
Check if all given condition are true. |
|
|
Triggers the FSM event "Executing". |
|
OPSTRANSPORT:FindTransferCarrierForCargo(CargoGroup, Zone, DisembarkCarriers, DeployAirbase) |
Find transfer carrier element for cargo group. |
OPSTRANSPORT:GetCargoOpsGroups(Delivered, Carrier, TransportZoneCombo) |
Get (all) cargo Ops.OpsGroup#OPSGROUPs. |
OPSTRANSPORT:GetCargoStorages(Delivered, Carrier, TransportZoneCombo) |
Get (all) cargo Ops.OpsGroup#OPSGROUPs. |
|
Get total weight. |
|
OPSTRANSPORT:GetCargos(TransportZoneCombo, Carrier, Delivered) |
Get cargos. |
|
Get carrier transport status. |
|
|
Get carriers. |
|
|
Get deploy zone. |
|
|
Get disembark activation. |
|
|
Get transfer carrier(s). |
|
|
Get disembark in utero. |
|
|
Get disembark zone. |
|
|
Get embark zone. |
|
|
Get LEGION transport status. |
|
|
Get number of delivered cargo groups. |
|
|
Get number of cargo groups. |
|
|
Get number of carrier groups assigned for this transport. |
|
|
Get pickup zone. |
|
|
Get required cargos. |
|
|
Get the number of required carrier groups for an OPSTRANSPORT assignment. |
|
|
Get transport zone combo of cargo group. |
|
|
Get unique ID of the transport assignment. |
|
|
Check if a cargo group was delivered. |
|
|
Check if an OPS group is assigned as carrier for this transport. |
|
|
Check if all cargo was delivered (or is dead). |
|
|
Check if state is EXECUTING. |
|
|
Check if state is PLANNED. |
|
|
Check if state is QUEUED. |
|
|
Check if transport is ready to be started. |
|
|
Check if state is REQUESTED. |
|
|
Check if state is SCHEDULED. |
|
OPSTRANSPORT:Loaded(OpsGroupCargo, OpsGroupCarrier, CarrierElement) |
Triggers the FSM event "Loaded". |
|
Total number of cargo groups. |
|
|
Totalnumber of dead cargo groups. |
|
|
Total number of assigned carriers. |
|
|
Total number of dead carrier groups |
|
|
Total number of cargo groups delivered. |
|
|
Create a new OPSTRANSPORT class object. |
|
|
On after "Cancel" event. |
|
|
On after "Delivered" event. |
|
|
On after "Executing" event. |
|
OPSTRANSPORT:OnAfterLoaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier, CarrierElement) |
On after "Loaded" event. |
|
On after "Planned" event. |
|
|
On after "Queued" event. |
|
|
On after "Requested" event. |
|
|
On after "Scheduled" event. |
|
OPSTRANSPORT:OnAfterUnloaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier) |
On after "Unloaded" event. |
|
Triggers the FSM event "Planned". |
|
|
Triggers the FSM event "Queued". |
|
|
Remove LEGION from transport. |
|
|
Triggers the FSM event "Requested". |
|
|
Triggers the FSM event "Scheduled". |
|
OPSTRANSPORT:SetCarrierTransportStatus(CarrierGroup, Status) |
Add a carrier assigned for this transport. |
|
Set deploy zone. |
|
OPSTRANSPORT:SetDisembarkActivation(Active, TransportZoneCombo) |
Set activation status of group when disembarked from transport carrier. |
OPSTRANSPORT:SetDisembarkCarriers(Carriers, TransportZoneCombo) |
Set/add transfer carrier(s). |
OPSTRANSPORT:SetDisembarkInUtero(InUtero, TransportZoneCombo) |
Set if group remains in utero after disembarkment from carrier. |
OPSTRANSPORT:SetDisembarkZone(DisembarkZone, TransportZoneCombo) |
Set disembark zone. |
|
Set embark zone. |
|
OPSTRANSPORT:SetFormationPickup(Formation, TransportZoneCombo) |
Set pickup formation. |
OPSTRANSPORT:SetFormationTransport(Formation, TransportZoneCombo) |
Set transport formation. |
|
Set LEGION transport status. |
|
|
Set pickup zone. |
|
|
Set mission priority and (optional) urgency. |
|
|
Set required cargo. |
|
OPSTRANSPORT:SetRequiredCarriers(NcarriersMin, NcarriersMax) |
Set number of required carrier groups for an OPSTRANSPORT assignment. |
|
Set transport start and stop time. |
|
|
Set verbosity. |
|
|
Triggers the FSM event "StatusUpdate". |
|
|
Start time in abs. seconds. |
|
|
Stop time in abs. seconds. Default |
|
|
Triggers the FSM event "Unloaded". |
|
|
Add a carrier assigned for this transport. |
|
|
Set/add transfer carrier(s). |
|
|
Check if all cargo of this transport assignment was delivered. |
|
OPSTRANSPORT:_CheckRequiredCargos(TransportZoneCombo, CarrierGroup) |
Check if all required cargos are loaded. |
OPSTRANSPORT:_CountCargosInZone(Zone, Delivered, Carrier, TransportZoneCombo) |
Count how many cargo groups are inside a zone. |
|
Create a cargo group data structure. |
|
|
Create a cargo group data structure. |
|
|
Remove group from the current carrier list/table. |
|
|
Get a list of alive carriers. |
|
|
Get pickup formation. |
|
OPSTRANSPORT:_GetFormationPickup(TransportZoneCombo, OpsGroup) |
Get pickup formation. |
OPSTRANSPORT:_GetFormationTransport(TransportZoneCombo, OpsGroup) |
Get transport formation. |
|
Get an OPSGROUP from a given OPSGROUP or GROUP object. |
|
OPSTRANSPORT:_GetPathTransport(Category, TransportZoneCombo) |
Get a path for transportation. |
|
Get a transport zone combination (TZC) for a carrier group. |
|
|
Triggers the FSM event "Cancel" after a delay. |
|
|
Triggers the FSM event "Delivered" after a delay. |
|
|
Triggers the FSM event "Executing" after a delay. |
|
OPSTRANSPORT:__Loaded(delay, OpsGroupCargo, OpsGroupCarrier, CarrierElement) |
Triggers the FSM event "Loaded" after a delay. |
|
Triggers the FSM event "Planned" after a delay. |
|
|
Triggers the FSM event "Queued" after a delay. |
|
|
Triggers the FSM event "Requested" after a delay. |
|
|
Triggers the FSM event "Scheduled" after a delay. |
|
|
Triggers the FSM event "Status" after a delay. |
|
OPSTRANSPORT:__Unloaded(delay, OpsGroupCargo, OpsGroupCarrier) |
Triggers the FSM event "Unloaded" after a delay. |
|
Warehouse assets assigned for this transport. |
|
|
Running number to generate cargo UIDs. |
|
|
Status of each carrier. |
|
|
Carriers assigned for this transport. |
|
|
Chief of the transport. |
|
|
Commander of the transport. |
|
|
Start conditions. |
|
|
Duration ( |
|
|
Default formation for ground vehicles. |
|
|
Default formation for helicopters. |
|
|
Default formation for airplanes. |
|
|
Importance of this transport. Smaller=higher. |
|
|
Assigned legions. |
|
|
Log ID. |
|
|
The mission attached to this transport. |
|
|
On after "Cancel" event. |
|
|
On after "DeadCarrierAll" event. |
|
OPSTRANSPORT:onafterDeadCarrierGroup(From, Event, To, OpsGroup) |
On after "DeadCarrierGroup" event. |
|
On after "Delivered" event. |
|
|
On after "Executing" event. |
|
OPSTRANSPORT:onafterLoaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier, CarrierElement) |
On after "Loaded" event. |
|
On after "Planned" event. |
|
|
On after "Scheduled" event. |
|
|
On after "StatusUpdate" event. |
|
OPSTRANSPORT:onafterUnloaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier) |
On after "Unloaded" event. |
|
On before "Delivered" event. |
|
|
OPS zone. |
|
|
Priority of this transport. Should be a number between 0 (high prio) and 100 (low prio). |
|
|
The ID of the queued warehouse request. Necessary to cancel the request if the transport was cancelled before the request is processed. |
|
|
Staus of the COMMANDER. |
|
|
Transport status of all assigned LEGIONs. |
|
|
Table of transport zone combos. Each element of the table is of type |
|
|
Running number of added transport zone combos. |
|
|
Default transport zone combo. |
|
|
Unique ID of the transport. |
|
|
If true, transport is urgent. |
|
|
Verbosity level. |
|
|
Army Group 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. |
|
OPSTRANSPORT: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. |
|
OPSTRANSPORT:_call_handler(step, trigger, params, EventName) |
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. |
|
| Fields and Methods inherited from OPSTRANSPORT.CargoType | Description |
|---|---|
|
Cargo is an OPSGROUP. |
|
|
Cargo is storage of DCS warehouse. |
| Fields and Methods inherited from OPSTRANSPORT.Condition | Description |
|---|---|
|
Optional arguments passed to the condition callback function. |
|
|
Callback function to check for a condition. Should return a #boolean. |
| Fields and Methods inherited from OPSTRANSPORT.Path | Description |
|---|---|
|
Category for which carriers this path is used. |
|
|
Radomization radius for waypoints in meters. Default 0 m. |
|
|
If |
|
|
Table of waypoints. |
| Fields and Methods inherited from OPSTRANSPORT.Status | Description |
|---|---|
|
Transport was cancelled. |
|
|
Transport was delivered. |
|
|
Transport is being executed. |
|
|
Transport failed. |
|
|
Planning state. |
|
|
Queued state. |
|
|
Requested state. |
|
|
Transport is scheduled in the cargo queue. |
|
|
Transport was a success. |
| Fields and Methods inherited from OPSTRANSPORT.Storage | Description |
|---|---|
|
Amount of cargo that should be transported. |
|
|
Amount of cargo that has been delivered. |
|
|
Amount of cargo that is loading. |
|
|
Amount of cargo that was lost. |
|
|
Amount of cargo that is reserved for a carrier group. |
|
|
Type of cargo. |
|
|
Weight of one single cargo item in kg. Default 1 kg. |
|
|
Storage from. |
|
|
Storage To. |
| Fields and Methods inherited from OPSTRANSPORT.TransportZoneCombo | Description |
|---|---|
|
Cargo groups of the TZ combo. Each element is of type |
|
|
Airbase for deploy. |
|
|
Deploy zone. |
|
|
Carriers where the cargo is directly disembarked to. |
|
|
Zone where the troops are disembared to. |
|
|
Embark zone if different from pickup zone. |
|
|
Number of cargos assigned. This is a running number and not decreased if cargo is delivered or dead. |
|
|
Number of carrier groups using this transport zone. |
|
|
Airbase for pickup. |
|
|
Formation used to pickup. |
|
|
Paths for pickup. |
|
|
Pickup zone. |
|
|
Required cargos. |
|
|
Formation used to transport. |
|
|
Path for Transport. Each elment of the table is of type |
|
|
Cargo assets. |
|
|
If true, troops are spawned in late activated state when disembarked from carrier. |
|
|
If true, troops are disembarked "in utero". |
|
|
If |
|
|
Unique ID of the TZ combo. |
OPSTRANSPORT class.
Field(s)
Name of the class.
Total number of cargo groups.
Totalnumber of dead cargo groups.
Total number of assigned carriers.
Total number of dead carrier groups
Total number of cargo groups delivered.
Time stamp.
Start time in abs. seconds.
Stop time in abs. seconds. Default #nil (never stops).
Warehouse assets assigned for this transport.
Running number to generate cargo UIDs.
Status of each carrier.
Carriers assigned for this transport.
Start conditions.
Duration (Tstop-Tstart) of the transport in seconds.
Default formation for ground vehicles.
Default formation for helicopters.
Default formation for airplanes.
Importance of this transport. Smaller=higher.
Assigned legions.
Log ID.
Priority of this transport. Should be a number between 0 (high prio) and 100 (low prio).
The ID of the queued warehouse request. Necessary to cancel the request if the transport was cancelled before the request is processed.
Staus of the COMMANDER.
Transport status of all assigned LEGIONs.
Table of transport zone combos. Each element of the table is of type #OPSTRANSPORT.TransportZoneCombo.
Running number of added transport zone combos.
Unique ID of the transport.
If true, transport is urgent.
Verbosity level.
Army Group version.
Function(s)
Add carrier asset to transport.
Defined in:
OPSTRANSPORT
Parameters:
The asset to be added.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Add cargo asset.
Defined in:
OPSTRANSPORT
Parameters:
The asset to be added.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Add cargo groups to be transported.
Defined in:
OPSTRANSPORT
Parameters:
Core.Set#SET_GROUP GroupSet
Set of groups to be transported. Can also be passed as a single GROUP or OPSGROUP object.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
#boolean DisembarkActivation
If true, cargo group is activated when disembarked. If false, cargo groups are late activated when disembarked. Default nil (usually activated).
Core.Zone#ZONE DisembarkZone
Zone where the groups disembark to.
Core.Set#SET_OPSGROUP DisembarkCarriers
Carrier groups where the cargo directly disembarks to.
Return value:
self
Add cargo warehouse storage to be transported.
This adds items such as fuel, weapons and other equipment, which is to be transported from one DCS warehouse to another. For weapons and equipment, the weight per item has to be specified explicitly as these cannot be retrieved by the DCS API. For liquids the default value of 1 kg per item should be used as the amount of liquid is already given in kg.
Defined in:
OPSTRANSPORT
Parameters:
Wrapper.Storage#STORAGE StorageFrom
Storage warehouse from which the cargo is taken.
Wrapper.Storage#STORAGE StorageTo
Storage warehouse to which the cargo is delivered.
#string CargoType
Type of cargo, e.g. "weapons.bombs.Mk_84" or liquid type as #number.
#number CargoAmount
Amount of cargo. Liquids in kg.
#number CargoWeight
Weight of a single cargo item in kg. Default 1 kg.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo if other than default.
Return value:
self
Add start condition.
Defined in:
OPSTRANSPORT
Parameters:
#function ConditionFunction
Function that needs to be true before the transport can be started. Must return a #boolean.
...
Condition function arguments if any.
Return value:
self
Add LEGION to the transport.
Add path used for transportation from the pickup to the deploy zone.
If multiple paths are defined, a random one is chosen. The path is retrieved from the waypoints of a given group. NOTE that the category group defines for which carriers this path is valid. For example, if you specify a GROUND group to provide the waypoints, only assigned GROUND carriers will use the path.
Defined in:
OPSTRANSPORT
Parameters:
Wrapper.Group#GROUP PathGroup
A (late activated) GROUP defining a transport path by their waypoints.
#number Radius
Randomization radius in meters. Default 0 m.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport Zone combo.
Reversed
Return value:
self
Add pickup and deploy zone combination.
Defined in:
OPSTRANSPORT
Parameters:
Core.Set#SET_GROUP CargoGroups
Groups to be transported as cargo. Can also be a single Wrapper.Group#GROUP or Ops.OpsGroup#OPSGROUP object.
Core.Zone#ZONE PickupZone
Zone where the troops are picked up.
Core.Zone#ZONE DeployZone
Zone where the troops are picked up.
Return value:
Transport zone table.
Delete carrier asset from transport.
Defined in:
OPSTRANSPORT
Parameter:
The asset to be removed.
Return value:
self
Check if all given condition are true.
Defined in:
OPSTRANSPORT
Parameter:
#table Conditions
Table of conditions.
Return value:
#boolean:
If true, all conditions were true. Returns false if at least one condition returned false.
Find transfer carrier element for cargo group.
Defined in:
OPSTRANSPORT
Parameters:
Ops.OpsGroup#OPSGROUP CargoGroup
The cargo group that needs to be loaded into a carrier unit/element of the carrier group.
Core.Zone#ZONE Zone
(Optional) Zone where the carrier must be in.
#table DisembarkCarriers
Disembark carriers.
Wrapper.Airbase#AIRBASE DeployAirbase
Airbase where to deploy.
Return values:
New carrier element for cargo or nil.
New carrier group for cargo or nil.
Get (all) cargo Ops.OpsGroup#OPSGROUPs.
Optionally, only delivered or undelivered groups can be returned.
Defined in:
OPSTRANSPORT
Parameters:
#boolean Delivered
If true, only delivered groups are returned. If false only undelivered groups are returned. If nil, all groups are returned.
Ops.OpsGroup#OPSGROUP Carrier
(Optional) Only count cargo groups that fit into the given carrier group. Current cargo is not a factor.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
#table:
Cargo Ops groups. Can be and empty table {}.
Get (all) cargo Ops.OpsGroup#OPSGROUPs.
Optionally, only delivered or undelivered groups can be returned.
Defined in:
OPSTRANSPORT
Parameters:
#boolean Delivered
If true, only delivered groups are returned. If false only undelivered groups are returned. If nil, all groups are returned.
Ops.OpsGroup#OPSGROUP Carrier
(Optional) Only count cargo groups that fit into the given carrier group. Current cargo is not a factor.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
#table:
Cargo Ops groups. Can be and empty table {}.
Get total weight.
Defined in:
OPSTRANSPORT
Parameters:
Cargo data.
#boolean IncludeReserved
Include reserved cargo.
Return value:
#number:
Weight in kg.
Get cargos.
Defined in:
OPSTRANSPORT
Parameters:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Ops.OpsGroup#OPSGROUP Carrier
Specific carrier.
#boolean Delivered
Delivered status.
Return value:
#table:
Cargos.
Get carrier transport status.
Defined in:
OPSTRANSPORT
Parameter:
Ops.OpsGroup#OPSGROUP CarrierGroup
Carrier OPSGROUP.
Return value:
#string:
Carrier status.
Get carriers.
Defined in:
OPSTRANSPORT
Return value:
#table:
Carrier Ops groups.
Get deploy zone.
Defined in:
OPSTRANSPORT
Parameter:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
Zone where the troops are deployed.
Get disembark activation.
Defined in:
OPSTRANSPORT
Parameter:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
#boolean:
If true, groups are spawned in late activated state.
Get transfer carrier(s).
These are carrier groups, where the cargo is directly loaded into when disembarked.
Defined in:
OPSTRANSPORT
Parameter:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
#table:
Table of carrier OPS groups.
Get disembark in utero.
Defined in:
OPSTRANSPORT
Parameter:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
#boolean:
If true, groups stay in utero after disembarkment.
Get disembark zone.
Defined in:
OPSTRANSPORT
Parameter:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
Zone where the troops are disembarked to.
Get embark zone.
Defined in:
OPSTRANSPORT
Parameter:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
Zone where the troops are embarked from.
Get LEGION transport status.
Defined in:
OPSTRANSPORT
Parameter:
Ops.Legion#LEGION Legion
The legion.
Return value:
#string:
status Current status.
Get number of delivered cargo groups.
Defined in:
OPSTRANSPORT
Return value:
#number:
Total number of delivered cargo groups.
Get number of cargo groups.
Defined in:
OPSTRANSPORT
Return value:
#number:
Total number of cargo groups.
Get number of carrier groups assigned for this transport.
Defined in:
OPSTRANSPORT
Return value:
#number:
Total number of carrier groups.
Get pickup zone.
Defined in:
OPSTRANSPORT
Parameter:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
Zone where the troops are picked up.
Get required cargos.
This is a list of cargo groups that need to be loaded before the first transport will start.
Defined in:
OPSTRANSPORT
Parameter:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
#table:
Table of required cargo ops groups.
Get the number of required carrier groups for an OPSTRANSPORT assignment.
Only used if transport is assigned at LEGION or higher level.
Defined in:
OPSTRANSPORT
Return values:
#number:
Number of carriers at least required.
#number:
Number of carriers at most used for transportation.
Get transport zone combo of cargo group.
Defined in:
OPSTRANSPORT
Parameter:
#string GroupName
Group name of cargo.
Return value:
TransportZoneCombo Transport zone combo.
Get unique ID of the transport assignment.
Defined in:
OPSTRANSPORT
Return value:
#number:
UID.
Check if a cargo group was delivered.
Defined in:
OPSTRANSPORT
Parameter:
#string GroupName
Name of the group.
Return value:
#boolean:
If true, cargo was delivered.
Check if an OPS group is assigned as carrier for this transport.
Defined in:
OPSTRANSPORT
Parameter:
Ops.OpsGroup#OPSGROUP CarrierGroup
Potential carrier OPSGROUP.
Return value:
#boolean:
If true, group is an assigned carrier.
Check if all cargo was delivered (or is dead).
Defined in:
OPSTRANSPORT
Parameter:
#number Nmin
Number of groups that must be actually delivered (and are not dead). Default 0.
Return value:
#boolean:
If true, all possible cargo was delivered.
Check if state is EXECUTING.
Defined in:
OPSTRANSPORT
Return value:
#boolean:
If true, status is EXECUTING.
Check if state is PLANNED.
Defined in:
OPSTRANSPORT
Return value:
#boolean:
If true, status is PLANNED.
Check if state is QUEUED.
Defined in:
OPSTRANSPORT
Parameter:
Ops.Legion#LEGION Legion
(Optional) Check if transport is queued at this legion.
Return value:
#boolean:
If true, status is QUEUED.
Check if transport is ready to be started.
- Start time passed.
- Stop time did not pass already.
- All start conditions are true.
Defined in:
OPSTRANSPORT
Return value:
#boolean:
If true, mission can be started.
Check if state is REQUESTED.
Defined in:
OPSTRANSPORT
Parameter:
Ops.Legion#LEGION Legion
(Optional) Check if transport is queued at this legion.
Return value:
#boolean:
If true, status is REQUESTED.
Check if state is SCHEDULED.
Defined in:
OPSTRANSPORT
Return value:
#boolean:
If true, status is SCHEDULED.
Triggers the FSM event "Loaded".
Defined in:
OPSTRANSPORT
Parameters:
Ops.OpsGroup#OPSGROUP OpsGroupCargo
OPSGROUP that was loaded into a carrier.
Ops.OpsGroup#OPSGROUP OpsGroupCarrier
OPSGROUP that was loaded into a carrier.
Ops.OpsGroup#OPSGROUP.Element CarrierElement
Carrier element.
Create a new OPSTRANSPORT class object.
Essential input are the troops that should be transported and the zones where the troops are picked up and deployed.
Defined in:
OPSTRANSPORT
Parameters:
Core.Set#SET_GROUP CargoGroups
Groups to be transported as cargo. Can also be a single Wrapper.Group#GROUP or Ops.OpsGroup#OPSGROUP object.
Core.Zone#ZONE PickupZone
Pickup zone. This is the zone, where the carrier is going to pickup the cargo. Important: only cargo is considered, if it is in this zone when the carrier starts loading!
Core.Zone#ZONE DeployZone
Deploy zone. This is the zone, where the carrier is going to drop off the cargo.
Return value:
self
On after "Cancel" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Delivered" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Executing" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Loaded" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Ops.OpsGroup#OPSGROUP OpsGroupCargo
OPSGROUP that was loaded into a carrier.
Ops.OpsGroup#OPSGROUP OpsGroupCarrier
OPSGROUP that was loaded into a carrier.
Ops.OpsGroup#OPSGROUP.Element CarrierElement
Carrier element.
On after "Planned" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Queued" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Requested" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Scheduled" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Unloaded" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Ops.OpsGroup#OPSGROUP OpsGroupCargo
Cargo OPSGROUP that was unloaded from a carrier.
Ops.OpsGroup#OPSGROUP OpsGroupCarrier
Carrier OPSGROUP that unloaded the cargo.
Remove LEGION from transport.
Add a carrier assigned for this transport.
Defined in:
OPSTRANSPORT
Parameters:
Ops.OpsGroup#OPSGROUP CarrierGroup
Carrier OPSGROUP.
#string Status
Carrier Status.
Return value:
self
Set deploy zone.
Defined in:
OPSTRANSPORT
Parameters:
Core.Zone#ZONE DeployZone
Zone where the troops are deployed.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Set activation status of group when disembarked from transport carrier.
Defined in:
OPSTRANSPORT
Parameters:
#boolean Active
If true or nil, group is activated when disembarked. If false, group is late activated and needs to be activated manually.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Set/add transfer carrier(s).
These are carrier groups, where the cargo is directly loaded into when disembarked.
Defined in:
OPSTRANSPORT
Parameters:
Core.Set#SET_GROUP Carriers
Carrier set. Can also be passed as a #GROUP, #OPSGROUP or #SET_OPSGROUP object.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Set if group remains in utero after disembarkment from carrier.
Can be used to directly load the group into another carrier. Similar to disembark in late activated state.
Defined in:
OPSTRANSPORT
Parameters:
#boolean InUtero
If true or nil, group remains in utero after disembarkment.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Set disembark zone.
Defined in:
OPSTRANSPORT
Parameters:
Core.Zone#ZONE DisembarkZone
Zone where the troops are disembarked.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Set embark zone.
Defined in:
OPSTRANSPORT
Parameters:
Core.Zone#ZONE EmbarkZone
Zone where the troops are embarked.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Set pickup formation.
Defined in:
OPSTRANSPORT
Parameters:
#number Formation
Pickup formation.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Set transport formation.
Defined in:
OPSTRANSPORT
Parameters:
#number Formation
Pickup formation.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Set LEGION transport status.
Defined in:
OPSTRANSPORT
Parameters:
Ops.Legion#LEGION Legion
The legion.
#string Status
New status.
Return value:
self
Set pickup zone.
Defined in:
OPSTRANSPORT
Parameters:
Core.Zone#ZONE PickupZone
Zone where the troops are picked up.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Set mission priority and (optional) urgency.
Urgent missions can cancel other running missions.
Defined in:
OPSTRANSPORT
Parameters:
#number Prio
Priority 1=high, 100=low. Default 50.
#number Importance
Number 1-10. If missions with lower value are in the queue, these have to be finished first. Default is nil.
#boolean Urgent
If true, another running mission might be cancelled if it has a lower priority.
Return value:
self
Set required cargo.
This is a list of cargo groups that need to be loaded before the first transport will start.
Defined in:
OPSTRANSPORT
Parameters:
Core.Set#SET_GROUP Cargos
Required cargo set. Can also be passed as a #GROUP, #OPSGROUP or #SET_OPSGROUP object.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
self
Set number of required carrier groups for an OPSTRANSPORT assignment.
Only used if transport is assigned at LEGION or higher level.
Defined in:
OPSTRANSPORT
Parameters:
#number NcarriersMin
Number of carriers at least required. Default 1.
#number NcarriersMax
Number of carriers at most used for transportation. Default is same as NcarriersMin.
Return value:
self
Set transport start and stop time.
Defined in:
OPSTRANSPORT
Parameters:
#string ClockStart
Time the transport is started, e.g. "05:00" for 5 am. If specified as a #number, it will be relative (in seconds) to the current mission time. Default is 5 seconds after mission was added.
#string ClockStop
(Optional) Time the transport is stopped, e.g. "13:00" for 1 pm. If mission could not be started at that time, it will be removed from the queue. If specified as a #number it will be relative (in seconds) to the current mission time.
Return value:
self
Set verbosity.
Defined in:
OPSTRANSPORT
Parameter:
#number Verbosity
Be more verbose. Default 0
Return value:
self
Triggers the FSM event "Unloaded".
Defined in:
OPSTRANSPORT
Parameters:
Ops.OpsGroup#OPSGROUP OpsGroupCargo
Cargo OPSGROUP that was unloaded from a carrier.
Ops.OpsGroup#OPSGROUP OpsGroupCarrier
Carrier OPSGROUP that unloaded the cargo.
Add a carrier assigned for this transport.
Defined in:
OPSTRANSPORT
Parameter:
Ops.OpsGroup#OPSGROUP CarrierGroup
Carrier OPSGROUP.
Return value:
self
Set/add transfer carrier(s).
These are carrier groups, where the cargo is directly loaded into when disembarked.
Defined in:
OPSTRANSPORT
Parameters:
Core.Set#SET_GROUP Carriers
Carrier set. Can also be passed as a #GROUP, #OPSGROUP or #SET_OPSGROUP object.
#table Table
the table to add.
Return value:
self
Check if all cargo of this transport assignment was delivered.
Defined in:
OPSTRANSPORT
Check if all required cargos are loaded.
Defined in:
OPSTRANSPORT
Parameters:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Ops.OpsGroup#OPSGROUP CarrierGroup
The carrier group asking.
Return value:
#boolean:
If true, all required cargos are loaded or there is no required cargo or asking carrier is full.
Count how many cargo groups are inside a zone.
Defined in:
OPSTRANSPORT
Parameters:
Core.Zone#ZONE Zone
The zone object.
#boolean Delivered
If true, only delivered groups are returned. If false only undelivered groups are returned. If nil, all groups are returned.
Ops.OpsGroup#OPSGROUP Carrier
(Optional) Only count cargo groups that fit into the given carrier group. Current cargo is not a factor.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
#number:
Number of cargo groups.
Create a cargo group data structure.
Defined in:
OPSTRANSPORT
Parameters:
Wrapper.Group#GROUP group
The GROUP or OPSGROUP object.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
#boolean DisembarkActivation
If true, cargo group is activated when disembarked.
Core.Zone#ZONE DisembarkZone
Disembark zone, where the cargo is spawned when delivered.
Core.Set#SET_OPSGROUP DisembarkCarriers
Disembark carriers cargo is directly loaded into when delivered.
Return value:
Cargo group data.
Create a cargo group data structure.
Defined in:
OPSTRANSPORT
Parameters:
Wrapper.Storage#STORAGE StorageFrom
Storage from.
Wrapper.Storage#STORAGE StorageTo
Storage to.
#string CargoType
Type of cargo.
#number CargoAmount
Total amount of cargo that should be transported. Liquids in kg.
#number CargoWeight
Weight of a single cargo item in kg. Default 1 kg.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Return value:
Cargo group data.
Remove group from the current carrier list/table.
Defined in:
OPSTRANSPORT
Parameters:
Ops.OpsGroup#OPSGROUP CarrierGroup
Carrier OPSGROUP.
#number Delay
Delay in seconds before the carrier is removed.
Return value:
self
Get a list of alive carriers.
Defined in:
OPSTRANSPORT
Return value:
#table:
Names of all carriers
Get pickup formation.
Defined in:
OPSTRANSPORT
Parameter:
Ops.OpsGroup#OPSGROUP OpsGroup
Return value:
#string:
Formation.
Get pickup formation.
Defined in:
OPSTRANSPORT
Parameters:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Ops.OpsGroup#OPSGROUP OpsGroup
Return value:
#number:
Formation.
Get transport formation.
Defined in:
OPSTRANSPORT
Parameters:
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport zone combo.
Ops.OpsGroup#OPSGROUP OpsGroup
Return value:
#number:
Formation.
Get an OPSGROUP from a given OPSGROUP or GROUP object.
If the object is a GROUP, an OPSGROUP is created automatically.
Defined in:
OPSTRANSPORT
Parameter:
Core.Base#BASE Object
The object, which can be a GROUP or OPSGROUP.
Return value:
Ops Group.
Get a path for transportation.
Defined in:
OPSTRANSPORT
Parameters:
#number Category
Group category.
#OPSTRANSPORT.TransportZoneCombo TransportZoneCombo
Transport Zone combo.
Return value:
The path object.
Get a transport zone combination (TZC) for a carrier group.
The pickup zone will be a zone, where the most cargo groups are located that fit into the carrier.
Defined in:
OPSTRANSPORT
Parameter:
Ops.OpsGroup#OPSGROUP Carrier
The carrier OPS group.
Return value:
Pickup zone or #nil.
Triggers the FSM event "Cancel" after a delay.
Defined in:
OPSTRANSPORT
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Delivered" after a delay.
Defined in:
OPSTRANSPORT
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Executing" after a delay.
Defined in:
OPSTRANSPORT
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Loaded" after a delay.
Defined in:
OPSTRANSPORT
Parameters:
#number delay
Delay in seconds.
Ops.OpsGroup#OPSGROUP OpsGroupCargo
OPSGROUP that was loaded into a carrier.
Ops.OpsGroup#OPSGROUP OpsGroupCarrier
OPSGROUP that was loaded into a carrier.
Ops.OpsGroup#OPSGROUP.Element CarrierElement
Carrier element.
Triggers the FSM event "Planned" after a delay.
Defined in:
OPSTRANSPORT
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Queued" after a delay.
Defined in:
OPSTRANSPORT
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Requested" after a delay.
Defined in:
OPSTRANSPORT
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Scheduled" after a delay.
Defined in:
OPSTRANSPORT
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Status" after a delay.
Defined in:
OPSTRANSPORT
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Unloaded" after a delay.
Defined in:
OPSTRANSPORT
Parameters:
#number delay
Delay in seconds.
Ops.OpsGroup#OPSGROUP OpsGroupCargo
Cargo OPSGROUP that was unloaded from a carrier.
Ops.OpsGroup#OPSGROUP OpsGroupCarrier
Carrier OPSGROUP that unloaded the cargo.
On after "Cancel" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "DeadCarrierAll" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "DeadCarrierGroup" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Ops.OpsGroup#OPSGROUP OpsGroup
Carrier OPSGROUP that is dead.
On after "Delivered" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Executing" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Loaded" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Ops.OpsGroup#OPSGROUP OpsGroupCargo
OPSGROUP that was loaded into a carrier.
Ops.OpsGroup#OPSGROUP OpsGroupCarrier
OPSGROUP that was loaded into a carrier.
Ops.OpsGroup#OPSGROUP.Element CarrierElement
Carrier element.
On after "Planned" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Scheduled" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "StatusUpdate" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Unloaded" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Ops.OpsGroup#OPSGROUP OpsGroupCargo
Cargo OPSGROUP that was unloaded from a carrier.
Ops.OpsGroup#OPSGROUP OpsGroupCarrier
Carrier OPSGROUP that unloaded the cargo.
On before "Delivered" event.
Defined in:
OPSTRANSPORT
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Field(s)
Name of the class.
Total number of cargo groups.
Totalnumber of dead cargo groups.
Total number of assigned carriers.
Total number of dead carrier groups
Total number of cargo groups delivered.
Time stamp.
Start time in abs. seconds.
Stop time in abs. seconds. Default #nil (never stops).
Warehouse assets assigned for this transport.
Running number to generate cargo UIDs.
Status of each carrier.
Carriers assigned for this transport.
Start conditions.
Duration (Tstop-Tstart) of the transport in seconds.
Default formation for ground vehicles.
Default formation for helicopters.
Default formation for airplanes.
Importance of this transport. Smaller=higher.
Assigned legions.
Log ID.
Priority of this transport. Should be a number between 0 (high prio) and 100 (low prio).
The ID of the queued warehouse request. Necessary to cancel the request if the transport was cancelled before the request is processed.
Staus of the COMMANDER.
Transport status of all assigned LEGIONs.
Table of transport zone combos. Each element of the table is of type #OPSTRANSPORT.TransportZoneCombo.
Running number of added transport zone combos.
Unique ID of the transport.
If true, transport is urgent.
Verbosity level.
Army Group 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.
Storage data.
Field(s)
Cargo is an OPSGROUP.
Cargo is storage of DCS warehouse.
Function(s)
Generic transport condition.
Field(s)
Optional arguments passed to the condition callback function.
Callback function to check for a condition. Should return a #boolean.
Function(s)
Path used for pickup or transport.
Field(s)
Category for which carriers this path is used.
Radomization radius for waypoints in meters. Default 0 m.
If true, path is used in reversed order.
Table of waypoints.
Function(s)
Cargo transport status.
Field(s)
Transport was cancelled.
Transport was delivered.
Transport is being executed.
Transport failed.
Planning state.
Queued state.
Requested state.
Transport is scheduled in the cargo queue.
Transport was a success.
Function(s)
Storage data.
Field(s)
Amount of cargo that should be transported.
Amount of cargo that has been delivered.
Amount of cargo that is loading.
Amount of cargo that was lost.
Amount of cargo that is reserved for a carrier group.
Type of cargo.
Weight of one single cargo item in kg. Default 1 kg.
Function(s)
Transport zone combination.
Field(s)
Cargo groups of the TZ combo. Each element is of type Ops.OpsGroup#OPSGROUP.CargoGroup.
Carriers where the cargo is directly disembarked to.
Zone where the troops are disembared to.
Embark zone if different from pickup zone.
Number of cargos assigned. This is a running number and not decreased if cargo is delivered or dead.
Number of carrier groups using this transport zone.
Formation used to pickup.
Paths for pickup.
Required cargos.
Formation used to transport.
Path for Transport. Each elment of the table is of type #OPSTRANSPORT.Path.
Cargo assets.
If true, troops are spawned in late activated state when disembarked from carrier.
If true, troops are disembarked "in utero".
If true, cargo is supposed to embark to another carrier.
Unique ID of the TZ combo.