Banner Image

Module Ops.OpsTransport

Ops - Troop transport assignment for OPS groups.

Main Features:

  • Transport troops from A to B
  • 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 Concept

This class simulates troop transport using carriers such as APCs, ships, helicopters or airplanes.

#OPSTRANSPORT OPSTRANSPORT

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.

Constructor

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.

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.

#number _OPSTRANSPORTID

Transport ID.

Type(s)

Fields and Methods inherited from OPSTRANSPORT Description

OPSTRANSPORT:AddAsset(Asset, TransportZoneCombo)

Add carrier asset to transport.

OPSTRANSPORT:AddAssetCargo(Asset, TransportZoneCombo)

Add cargo asset.

OPSTRANSPORT:AddCargoGroups(GroupSet, TransportZoneCombo, DisembarkActivation)

Add cargo groups to be transported.

OPSTRANSPORT:AddConditionStart(ConditionFunction, ...)

Add start condition.

OPSTRANSPORT:AddLegion(Legion)

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.

OPSTRANSPORT:Cancel()

Triggers the FSM event "Cancel".

OPSTRANSPORT.ClassName

Name of the class.

OPSTRANSPORT:DelAsset(Asset)

Delete carrier asset from transport.

OPSTRANSPORT:Delivered()

Triggers the FSM event "Delivered".

OPSTRANSPORT:EvalConditionsAll(Conditions)

Check if all given condition are true.

OPSTRANSPORT:Executing()

Triggers the FSM event "Executing".

OPSTRANSPORT:FindTransferCarrierForCargo(CargoGroup, Zone, TransportZoneCombo)

Find transfer carrier element for cargo group.

OPSTRANSPORT:GetCargoOpsGroups(Delivered, Carrier, TransportZoneCombo)

Get (all) cargo Ops.OpsGroup#OPSGROUPs.

OPSTRANSPORT:GetCargos(TransportZoneCombo)

Get cargos.

OPSTRANSPORT:GetCarrierTransportStatus(CarrierGroup)

Get carrier transport status.

OPSTRANSPORT:GetCarriers()

Get carriers.

OPSTRANSPORT:GetDeployZone(TransportZoneCombo)

Get deploy zone.

OPSTRANSPORT:GetDisembarkActivation(TransportZoneCombo)

Get disembark activation.

OPSTRANSPORT:GetDisembarkCarriers(TransportZoneCombo)

Get transfer carrier(s).

OPSTRANSPORT:GetDisembarkInUtero(TransportZoneCombo)

Get disembark in utero.

OPSTRANSPORT:GetDisembarkZone(TransportZoneCombo)

Get disembark zone.

OPSTRANSPORT:GetEmbarkZone(TransportZoneCombo)

Get embark zone.

OPSTRANSPORT:GetLegionStatus(Legion)

Get LEGION transport status.

OPSTRANSPORT:GetNcargoDelivered()

Get number of delivered cargo groups.

OPSTRANSPORT:GetNcargoTotal()

Get number of cargo groups.

OPSTRANSPORT:GetNcarrier()

Get number of carrier groups assigned for this transport.

OPSTRANSPORT:GetPickupZone(TransportZoneCombo)

Get pickup zone.

OPSTRANSPORT:GetRequiredCargos(TransportZoneCombo)

Get required cargos.

OPSTRANSPORT:GetRequiredCarriers()

Get the number of required carrier groups for an OPSTRANSPORT assignment.

OPSTRANSPORT:GetTZCofCargo(GroupName)

Get transport zone combo of cargo group.

OPSTRANSPORT:GetUID()

Get unique ID of the transport assignment.

OPSTRANSPORT:IsCargoDelivered(GroupName)

Check if a cargo group was delivered.

OPSTRANSPORT:IsCarrier(CarrierGroup)

Check if an OPS group is assigned as carrier for this transport.

OPSTRANSPORT:IsDelivered(Nmin)

Check if all cargo was delivered (or is dead).

OPSTRANSPORT:IsExecuting()

Check if state is EXECUTING.

OPSTRANSPORT:IsPlanned()

Check if state is PLANNED.

OPSTRANSPORT:IsQueued(Legion)

Check if state is QUEUED.

OPSTRANSPORT:IsReadyToGo()

Check if transport is ready to be started.

OPSTRANSPORT:IsRequested(Legion)

Check if state is REQUESTED.

OPSTRANSPORT:IsScheduled()

Check if state is SCHEDULED.

OPSTRANSPORT:Loaded(OpsGroupCargo, OpsGroupCarrier, CarrierElement)

Triggers the FSM event "Loaded".

OPSTRANSPORT.Ncargo

Total number of cargo groups.

OPSTRANSPORT.NcargoDead

Totalnumber of dead cargo groups.

OPSTRANSPORT.Ncarrier

Total number of assigned carriers.

OPSTRANSPORT.NcarrierDead

Total number of dead carrier groups

OPSTRANSPORT.Ndelivered

Total number of cargo groups delivered.

OPSTRANSPORT:New(CargoGroups, PickupZone, DeployZone)

Create a new OPSTRANSPORT class object.

OPSTRANSPORT:OnAfterCancel(From, Event, To)

On after "Cancel" event.

OPSTRANSPORT:OnAfterDelivered(From, Event, To)

On after "Delivered" event.

OPSTRANSPORT:OnAfterExecuting(From, Event, To)

On after "Executing" event.

OPSTRANSPORT:OnAfterLoaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier, CarrierElement)

On after "Loaded" event.

OPSTRANSPORT:OnAfterPlanned(From, Event, To)

On after "Planned" event.

OPSTRANSPORT:OnAfterQueued(From, Event, To)

On after "Queued" event.

OPSTRANSPORT:OnAfterRequested(From, Event, To)

On after "Requested" event.

OPSTRANSPORT:OnAfterScheduled(From, Event, To)

On after "Scheduled" event.

OPSTRANSPORT:OnAfterUnloaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier)

On after "Unloaded" event.

OPSTRANSPORT:Planned()

Triggers the FSM event "Planned".

OPSTRANSPORT:Queued()

Triggers the FSM event "Queued".

OPSTRANSPORT:RemoveLegion(Legion)

Remove LEGION from transport.

OPSTRANSPORT:Requested()

Triggers the FSM event "Requested".

OPSTRANSPORT:Scheduled()

Triggers the FSM event "Scheduled".

OPSTRANSPORT:SetCarrierTransportStatus(CarrierGroup, Status)

Add a carrier assigned for this transport.

OPSTRANSPORT:SetDeployZone(DeployZone, TransportZoneCombo)

Set deploy zone.

OPSTRANSPORT:SetDisembarkActivation(Active, TransportZoneCombo)

Set activation status of group when disembarked from transport carrier.

OPSTRANSPORT:SetDisembarkCarriers(Carriers, TransportZoneCombo)

Set transfer carrier(s).

OPSTRANSPORT:SetDisembarkInUtero(InUtero, TransportZoneCombo)

Set if group remains in utero after disembarkment from carrier.

OPSTRANSPORT:SetDisembarkZone(DisembarkZone, TransportZoneCombo)

Set disembark zone.

OPSTRANSPORT:SetEmbarkZone(EmbarkZone, TransportZoneCombo)

Set embark zone.

OPSTRANSPORT:SetFormationPickup(Formation, TransportZoneCombo)

Set pickup formation.

OPSTRANSPORT:SetFormationTransport(Formation, TransportZoneCombo)

Set transport formation.

OPSTRANSPORT:SetLegionStatus(Legion, Status)

Set LEGION transport status.

OPSTRANSPORT:SetPickupZone(PickupZone, TransportZoneCombo)

Set pickup zone.

OPSTRANSPORT:SetPriority(Prio, Importance, Urgent)

Set mission priority and (optional) urgency.

OPSTRANSPORT:SetRequiredCargos(Cargos, TransportZoneCombo)

Set required cargo.

OPSTRANSPORT:SetRequiredCarriers(NcarriersMin, NcarriersMax)

Set number of required carrier groups for an OPSTRANSPORT assignment.

OPSTRANSPORT:SetTime(ClockStart, ClockStop)

Set transport start and stop time.

OPSTRANSPORT:SetVerbosity(Verbosity)

Set verbosity.

OPSTRANSPORT.Status

OPSTRANSPORT:StatusUpdate()

Triggers the FSM event "StatusUpdate".

OPSTRANSPORT.Tover

OPSTRANSPORT.Tstart

Start time in abs. seconds.

OPSTRANSPORT.Tstop

Stop time in abs. seconds. Default #nil (never stops).

OPSTRANSPORT:Unloaded(OpsGroupCargo, OpsGroupCarrier)

Triggers the FSM event "Unloaded".

OPSTRANSPORT:_AddCarrier(CarrierGroup)

Add a carrier assigned for this transport.

OPSTRANSPORT:_CheckDelivered()

Check if all cargo of this transport assignment was delivered.

OPSTRANSPORT:_CheckRequiredCargos(TransportZoneCombo)

Check if all required cargos are loaded.

OPSTRANSPORT:_CountCargosInZone(Zone, Delivered, Carrier, TransportZoneCombo)

Count how many cargo groups are inside a zone.

OPSTRANSPORT:_CreateCargoGroupData(group, TransportZoneCombo, DisembarkActivation)

Create a cargo group data structure.

OPSTRANSPORT:_DelCarrier(CarrierGroup, Delay)

Remove group from the current carrier list/table.

OPSTRANSPORT:_GetCarrierNames()

Get a list of alive carriers.

OPSTRANSPORT:_GetFormationPickup(TransportZoneCombo)

Get pickup formation.

OPSTRANSPORT:_GetFormationTransport(TransportZoneCombo)

Get transport formation.

OPSTRANSPORT:_GetOpsGroupFromObject(Object)

Get an OPSGROUP from a given OPSGROUP or GROUP object.

OPSTRANSPORT:_GetPathTransport(Category, TransportZoneCombo)

Get a path for transportation.

OPSTRANSPORT:_GetTransportZoneCombo(Carrier)

Get a transport zone combination (TZC) for a carrier group.

OPSTRANSPORT:__Cancel(delay)

Triggers the FSM event "Cancel" after a delay.

OPSTRANSPORT:__Delivered(delay)

Triggers the FSM event "Delivered" after a delay.

OPSTRANSPORT:__Executing(delay)

Triggers the FSM event "Executing" after a delay.

OPSTRANSPORT:__Loaded(delay, OpsGroupCargo, OpsGroupCarrier, CarrierElement)

Triggers the FSM event "Loaded" after a delay.

OPSTRANSPORT:__Planned(delay)

Triggers the FSM event "Planned" after a delay.

OPSTRANSPORT:__Queued(delay)

Triggers the FSM event "Queued" after a delay.

OPSTRANSPORT:__Requested(delay)

Triggers the FSM event "Requested" after a delay.

OPSTRANSPORT:__Scheduled(delay)

Triggers the FSM event "Scheduled" after a delay.

OPSTRANSPORT:__StatusUpdate(delay)

Triggers the FSM event "Status" after a delay.

OPSTRANSPORT:__Unloaded(delay, OpsGroupCargo, OpsGroupCarrier)

Triggers the FSM event "Unloaded" after a delay.

OPSTRANSPORT.assets

Warehouse assets assigned for this transport.

OPSTRANSPORT.assetsCargo

OPSTRANSPORT.carrierTransportStatus

Status of each carrier.

OPSTRANSPORT.carriers

Carriers assigned for this transport.

OPSTRANSPORT.chief

Chief of the transport.

OPSTRANSPORT.commander

Commander of the transport.

OPSTRANSPORT.conditionStart

Start conditions.

OPSTRANSPORT.duration

Duration (Tstop-Tstart) of the transport in seconds.

OPSTRANSPORT.importance

Importance of this transport. Smaller=higher.

OPSTRANSPORT.legions

Assigned legions.

OPSTRANSPORT.lid

Log ID.

OPSTRANSPORT.mission

The mission attached to this transport.

OPSTRANSPORT.nCarriersMax

OPSTRANSPORT.nCarriersMin

OPSTRANSPORT:onafterCancel(From, Event, To)

On after "Cancel" event.

OPSTRANSPORT:onafterDeadCarrierAll(From, Event, To)

On after "DeadCarrierAll" event.

OPSTRANSPORT:onafterDeadCarrierGroup(From, Event, To, OpsGroup)

On after "DeadCarrierGroup" event.

OPSTRANSPORT:onafterDelivered(From, Event, To)

On after "Delivered" event.

OPSTRANSPORT:onafterExecuting(From, Event, To)

On after "Executing" event.

OPSTRANSPORT:onafterLoaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier, CarrierElement)

On after "Loaded" event.

OPSTRANSPORT:onafterPlanned(From, Event, To)

On after "Planned" event.

OPSTRANSPORT:onafterScheduled(From, Event, To)

On after "Scheduled" event.

OPSTRANSPORT:onafterStatusUpdate(From, Event, To)

On after "StatusUpdate" event.

OPSTRANSPORT:onafterUnloaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier)

On after "Unloaded" event.

OPSTRANSPORT:onbeforeDelivered(From, Event, To)

On before "Delivered" event.

OPSTRANSPORT.opszone

OPS zone.

OPSTRANSPORT.prio

Priority of this transport. Should be a number between 0 (high prio) and 100 (low prio).

OPSTRANSPORT.requestID

The ID of the queued warehouse request. Necessary to cancel the request if the transport was cancelled before the request is processed.

OPSTRANSPORT.statusCommander

Staus of the COMMANDER.

OPSTRANSPORT.statusLegion

Transport status of all assigned LEGIONs.

OPSTRANSPORT.tzCombos

Table of transport zone combos. Each element of the table is of type #OPSTRANSPORT.TransportZoneCombo.

OPSTRANSPORT.tzcCounter

Running number of added transport zone combos.

OPSTRANSPORT.tzcDefault

Default transport zone combo.

OPSTRANSPORT.uid

Unique ID of the transport.

OPSTRANSPORT.urgent

If true, transport is urgent.

OPSTRANSPORT.verbose

Verbosity level.

OPSTRANSPORT.version

Army Group version.

Fields and Methods inherited from FSM Description

OPSTRANSPORT:AddEndState(State)

Adds an End state.

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

Set the default Process template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

OPSTRANSPORT:AddScore(State, ScoreText, Score)

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.

OPSTRANSPORT:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

OPSTRANSPORT.CallScheduler

Call scheduler.

OPSTRANSPORT.ClassName

Name of the class.

OPSTRANSPORT.Events

OPSTRANSPORT:GetCurrentState()

Get current state.

OPSTRANSPORT:GetEndStates()

Returns the End states.

OPSTRANSPORT:GetProcess(From, Event)

OPSTRANSPORT:GetProcesses()

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

OPSTRANSPORT:GetScores()

Returns a table with the scores defined.

OPSTRANSPORT:GetStartState()

Returns the start state of the FSM.

OPSTRANSPORT:GetState()

Get current state.

OPSTRANSPORT:GetSubs()

Returns a table with the Subs defined.

OPSTRANSPORT:GetTransitions()

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

OPSTRANSPORT:Is(State)

Check if FSM is in state.

OPSTRANSPORT:LoadCallBacks(CallBackTable)

Load call backs.

OPSTRANSPORT:New()

Creates a new FSM object.

OPSTRANSPORT.Scores

Scores.

OPSTRANSPORT:SetProcess(From, Event, Fsm)

OPSTRANSPORT:SetStartState(State)

Sets the start state of the FSM.

OPSTRANSPORT._EndStates

OPSTRANSPORT._EventSchedules

OPSTRANSPORT._Processes

OPSTRANSPORT._Scores

OPSTRANSPORT._StartState

OPSTRANSPORT._Transitions

OPSTRANSPORT:_add_to_map(Map, Event)

Add to map.

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

Call handler.

OPSTRANSPORT:_create_transition(EventName)

Create transition.

OPSTRANSPORT:_delayed_transition(EventName)

Delayed transition.

OPSTRANSPORT:_eventmap(Events, EventStructure)

Event map.

OPSTRANSPORT:_gosub(ParentFrom, ParentEvent)

Go sub.

OPSTRANSPORT:_handler(EventName, ...)

Handler.

OPSTRANSPORT:_isendstate(Current)

Is end state.

OPSTRANSPORT:_submap(subs, sub, name)

Sub maps.

OPSTRANSPORT:can(e)

Check if can do an event.

OPSTRANSPORT:cannot(e)

Check if cannot do an event.

OPSTRANSPORT.current

Current state name.

OPSTRANSPORT.endstates

OPSTRANSPORT:is(State, state)

Check if FSM is in state.

OPSTRANSPORT.options

Options.

OPSTRANSPORT.subs

Subs.

Fields and Methods inherited from BASE Description

OPSTRANSPORT.ClassID

The ID number of the class.

OPSTRANSPORT.ClassName

The name of the class.

OPSTRANSPORT.ClassNameAndID

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

OPSTRANSPORT:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

OPSTRANSPORT:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

OPSTRANSPORT:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

OPSTRANSPORT:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

OPSTRANSPORT:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

OPSTRANSPORT:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

OPSTRANSPORT:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

OPSTRANSPORT:E(Arguments)

Log an exception which will be traced always.

OPSTRANSPORT:EventDispatcher()

Returns the event dispatcher

OPSTRANSPORT:EventRemoveAll()

Remove all subscribed events

OPSTRANSPORT:F(Arguments)

Trace a function call.

OPSTRANSPORT:F2(Arguments)

Trace a function call level 2.

OPSTRANSPORT:F3(Arguments)

Trace a function call level 3.

OPSTRANSPORT:GetClassID()

Get the ClassID of the class instance.

OPSTRANSPORT:GetClassName()

Get the ClassName of the class instance.

OPSTRANSPORT:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

OPSTRANSPORT:GetEventPriority()

Get the Class Event processing Priority.

OPSTRANSPORT:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

OPSTRANSPORT:GetState(Object, Key)

Get a Value given a Key from the Object.

OPSTRANSPORT:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

OPSTRANSPORT:I(Arguments)

Log an information which will be traced always.

OPSTRANSPORT:Inherit(Child, Parent)

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

OPSTRANSPORT:IsInstanceOf(ClassName)

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

OPSTRANSPORT:IsTrace()

Enquires if tracing is on (for the class).

OPSTRANSPORT:New()

BASE constructor.

OPSTRANSPORT:OnEvent(EventData)

Occurs when an Event for an object is triggered.

OPSTRANSPORT:OnEventBDA(EventData)

BDA.

OPSTRANSPORT:OnEventBaseCaptured(EventData)

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

OPSTRANSPORT:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

OPSTRANSPORT:OnEventCrash(EventData)

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

OPSTRANSPORT:OnEventDead(EventData)

Occurs when an object is dead.

OPSTRANSPORT:OnEventDetailedFailure(EventData)

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

OPSTRANSPORT:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

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

OPSTRANSPORT:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

OPSTRANSPORT:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

OPSTRANSPORT:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

OPSTRANSPORT:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

OPSTRANSPORT:OnEventKill(EventData)

Occurs on the death of a unit.

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

OPSTRANSPORT:OnEventLandingAfterEjection(EventData)

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

OPSTRANSPORT:OnEventLandingQualityMark(EventData)

Landing quality mark.

OPSTRANSPORT:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

OPSTRANSPORT:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

OPSTRANSPORT:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

OPSTRANSPORT:OnEventMissionEnd(EventData)

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

OPSTRANSPORT:OnEventMissionStart(EventData)

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

OPSTRANSPORT:OnEventParatrooperLanding(EventData)

Weapon add.

OPSTRANSPORT:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

OPSTRANSPORT:OnEventPlayerEnterAircraft(EventData)

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

OPSTRANSPORT:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

OPSTRANSPORT:OnEventPlayerLeaveUnit(EventData)

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

OPSTRANSPORT:OnEventRefueling(EventData)

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

OPSTRANSPORT:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

OPSTRANSPORT:OnEventScore(EventData)

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

OPSTRANSPORT:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

OPSTRANSPORT:OnEventShootingStart(EventData)

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

OPSTRANSPORT:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

OPSTRANSPORT:OnEventTakeoff(EventData)

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

OPSTRANSPORT:OnEventTriggerZone(EventData)

Trigger zone.

OPSTRANSPORT:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

OPSTRANSPORT:ScheduleStop(SchedulerID)

Stops the Schedule.

OPSTRANSPORT.Scheduler

OPSTRANSPORT:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

OPSTRANSPORT:SetState(Object, Key, Value)

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

OPSTRANSPORT:T(Arguments)

Trace a function logic level 1.

OPSTRANSPORT:T2(Arguments)

Trace a function logic level 2.

OPSTRANSPORT:T3(Arguments)

Trace a function logic level 3.

OPSTRANSPORT:TraceAll(TraceAll)

Trace all methods in MOOSE

OPSTRANSPORT:TraceClass(Class)

Set tracing for a class

OPSTRANSPORT:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

OPSTRANSPORT:TraceLevel(Level)

Set trace level

OPSTRANSPORT:TraceOff()

Set trace off.

OPSTRANSPORT:TraceOn()

Set trace on.

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

OPSTRANSPORT:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

OPSTRANSPORT._

OPSTRANSPORT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

OPSTRANSPORT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

OPSTRANSPORT.__

OPSTRANSPORT:onEvent(event)

The main event handling function...

Fields and Methods inherited from OPSTRANSPORT.Condition Description

OPSTRANSPORT.Condition.arg

Optional arguments passed to the condition callback function.

OPSTRANSPORT.Condition.func

Callback function to check for a condition. Should return a #boolean.

Fields and Methods inherited from OPSTRANSPORT.Path Description

OPSTRANSPORT.Path.category

Category for which carriers this path is used.

OPSTRANSPORT.Path.radius

Radomization radius for waypoints in meters. Default 0 m.

OPSTRANSPORT.Path.reverse

If true, path is used in reversed order.

OPSTRANSPORT.Path.waypoints

Table of waypoints.

Fields and Methods inherited from OPSTRANSPORT.Status Description

OPSTRANSPORT.Status.CANCELLED

Transport was cancelled.

OPSTRANSPORT.Status.DELIVERED

Transport was delivered.

OPSTRANSPORT.Status.EXECUTING

Transport is being executed.

OPSTRANSPORT.Status.FAILED

Transport failed.

OPSTRANSPORT.Status.PLANNED

Planning state.

OPSTRANSPORT.Status.QUEUED

Queued state.

OPSTRANSPORT.Status.REQUESTED

Requested state.

OPSTRANSPORT.Status.SCHEDULED

Transport is scheduled in the cargo queue.

OPSTRANSPORT.Status.SUCCESS

Transport was a success.

Fields and Methods inherited from OPSTRANSPORT.TransportZoneCombo Description

OPSTRANSPORT.TransportZoneCombo.Cargos

Cargo groups of the TZ combo. Each element is of type Ops.OpsGroup#OPSGROUP.CargoGroup.

OPSTRANSPORT.TransportZoneCombo.DeployAirbase

Airbase for deploy.

OPSTRANSPORT.TransportZoneCombo.DeployZone

Deploy zone.

OPSTRANSPORT.TransportZoneCombo.DisembarkCarriers

Carriers where the cargo is directly disembarked to.

OPSTRANSPORT.TransportZoneCombo.DisembarkZone

Zone where the troops are disembared to.

OPSTRANSPORT.TransportZoneCombo.EmbarkZone

Embark zone if different from pickup zone.

OPSTRANSPORT.TransportZoneCombo.Ncargo

Number of cargos assigned. This is a running number and not decreased if cargo is delivered or dead.

OPSTRANSPORT.TransportZoneCombo.Ncarriers

Number of carrier groups using this transport zone.

OPSTRANSPORT.TransportZoneCombo.PickupAirbase

Airbase for pickup.

OPSTRANSPORT.TransportZoneCombo.PickupFormation

Formation used to pickup.

OPSTRANSPORT.TransportZoneCombo.PickupPaths

Paths for pickup.

OPSTRANSPORT.TransportZoneCombo.PickupZone

Pickup zone.

OPSTRANSPORT.TransportZoneCombo.RequiredCargos

Required cargos.

OPSTRANSPORT.TransportZoneCombo.TransportFormation

Formation used to transport.

OPSTRANSPORT.TransportZoneCombo.TransportPaths

Path for Transport. Each elment of the table is of type #OPSTRANSPORT.Path.

OPSTRANSPORT.TransportZoneCombo.assets

Cargo assets.

OPSTRANSPORT.TransportZoneCombo.assetsCargo

OPSTRANSPORT.TransportZoneCombo.disembarkActivation

If true, troops are spawned in late activated state when disembarked from carrier.

OPSTRANSPORT.TransportZoneCombo.disembarkInUtero

If true, troops are disembarked "in utero".

OPSTRANSPORT.TransportZoneCombo.uid

Unique ID of the TZ combo.

OPSTRANSPORT class.

Field(s)

#string OPSTRANSPORT.ClassName

Name of the class.

#number OPSTRANSPORT.Ncargo

Total number of cargo groups.

#number OPSTRANSPORT.NcargoDead

Totalnumber of dead cargo groups.

#number OPSTRANSPORT.Ncarrier

Total number of assigned carriers.

#number OPSTRANSPORT.NcarrierDead

Total number of dead carrier groups

#number OPSTRANSPORT.Ndelivered

Total number of cargo groups delivered.

OPSTRANSPORT.Tover

Time stamp.

#number OPSTRANSPORT.Tstart

Start time in abs. seconds.

#number OPSTRANSPORT.Tstop

Stop time in abs. seconds. Default #nil (never stops).

#table OPSTRANSPORT.assets

Warehouse assets assigned for this transport.

#table OPSTRANSPORT.carrierTransportStatus

Status of each carrier.

#table OPSTRANSPORT.carriers

Carriers assigned for this transport.

Ops.Chief#CHIEF OPSTRANSPORT.chief

Chief of the transport.

Ops.Commander#COMMANDER OPSTRANSPORT.commander

Commander of the transport.

#table OPSTRANSPORT.conditionStart

Start conditions.

#number OPSTRANSPORT.duration

Duration (Tstop-Tstart) of the transport in seconds.

#number OPSTRANSPORT.importance

Importance of this transport. Smaller=higher.

#table OPSTRANSPORT.legions

Assigned legions.

#string OPSTRANSPORT.lid

Log ID.

Ops.Auftrag#AUFTRAG OPSTRANSPORT.mission

The mission attached to this transport.

#number OPSTRANSPORT.prio

Priority of this transport. Should be a number between 0 (high prio) and 100 (low prio).

#table OPSTRANSPORT.requestID

The ID of the queued warehouse request. Necessary to cancel the request if the transport was cancelled before the request is processed.

#string OPSTRANSPORT.statusCommander

Staus of the COMMANDER.

#table OPSTRANSPORT.statusLegion

Transport status of all assigned LEGIONs.

#table OPSTRANSPORT.tzCombos

Table of transport zone combos. Each element of the table is of type #OPSTRANSPORT.TransportZoneCombo.

#number OPSTRANSPORT.tzcCounter

Running number of added transport zone combos.

#number OPSTRANSPORT.uid

Unique ID of the transport.

#boolean OPSTRANSPORT.urgent

If true, transport is urgent.

#number OPSTRANSPORT.verbose

Verbosity level.

#string OPSTRANSPORT.version

Army Group version.

Function(s)

Add carrier asset to transport.

Defined in:

OPSTRANSPORT

Parameters:

The asset to be added.

Transport zone combo.

Return value:

Add cargo asset.

Defined in:

OPSTRANSPORT

Parameters:

The asset to be added.

Transport zone combo.

Return value:

Add cargo groups to be transported.

Defined in:

OPSTRANSPORT

Parameters:

Set of groups to be transported. Can also be passed as a single GROUP or OPSGROUP object.

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

Return value:

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:

Add LEGION to the transport.

Defined in:

OPSTRANSPORT

Parameter:

The legion.

Return value:

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:

A (late activated) GROUP defining a transport path by their waypoints.

#number Radius

Randomization radius in meters. Default 0 m.

Transport Zone combo.

Reversed

Return value:

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.

Triggers the FSM event "Cancel".

Defined in:

OPSTRANSPORT

Delete carrier asset from transport.

Defined in:

OPSTRANSPORT

Parameter:

The asset to be removed.

Return value:

Triggers the FSM event "Delivered".

Defined in:

OPSTRANSPORT

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.

Triggers the FSM event "Executing".

Defined in:

OPSTRANSPORT

Find transfer carrier element for cargo group.

Defined in:

OPSTRANSPORT

Parameters:

The cargo group that needs to be loaded into a carrier unit/element of the carrier group.

(Optional) Zone where the carrier must be in.

Transport zone combo.

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.

(Optional) Only count cargo groups that fit into the given carrier group. Current cargo is not a factor.

Transport zone combo.

Return value:

#table:

Cargo Ops groups. Can be and empty table {}.

Get cargos.

Defined in:

OPSTRANSPORT

Parameter:

Transport zone combo.

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:

Transport zone combo.

Return value:

Zone where the troops are deployed.

Get disembark activation.

Defined in:

OPSTRANSPORT

Parameter:

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:

Transport zone combo.

Return value:

#table:

Table of carrier OPS groups.

Get disembark in utero.

Defined in:

OPSTRANSPORT

Parameter:

Transport zone combo.

Return value:

#boolean:

If true, groups stay in utero after disembarkment.

Get disembark zone.

Defined in:

OPSTRANSPORT

Parameter:

Transport zone combo.

Return value:

Zone where the troops are disembarked to.

Get embark zone.

Defined in:

OPSTRANSPORT

Parameter:

Transport zone combo.

Return value:

Zone where the troops are embarked from.

Get LEGION transport status.

Defined in:

OPSTRANSPORT

Parameter:

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:

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:

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:

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

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

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:

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.

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.

Triggers the FSM event "Planned".

Defined in:

OPSTRANSPORT

Triggers the FSM event "Queued".

Defined in:

OPSTRANSPORT

Remove LEGION from transport.

Defined in:

OPSTRANSPORT

Parameter:

The legion.

Return value:

Triggers the FSM event "Requested".

Defined in:

OPSTRANSPORT

Triggers the FSM event "Scheduled".

Defined in:

OPSTRANSPORT

Add a carrier assigned for this transport.

Defined in:

OPSTRANSPORT

Parameters:

Ops.OpsGroup#OPSGROUP CarrierGroup

Carrier OPSGROUP.

#string Status

Carrier Status.

Return value:

Set deploy zone.

Defined in:

OPSTRANSPORT

Parameters:

Core.Zone#ZONE DeployZone

Zone where the troops are deployed.

Transport zone combo.

Return value:

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.

Transport zone combo.

Return value:

Set transfer carrier(s).

These are carrier groups, where the cargo is directly loaded into when disembarked.

Defined in:

OPSTRANSPORT

Parameters:

Carrier set. Can also be passed as a #GROUP, #OPSGROUP or #SET_OPSGROUP object.

Transport zone combo.

Return value:

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.

Transport zone combo.

Return value:

Set disembark zone.

Defined in:

OPSTRANSPORT

Parameters:

Core.Zone#ZONE DisembarkZone

Zone where the troops are disembarked.

Transport zone combo.

Return value:

Set embark zone.

Defined in:

OPSTRANSPORT

Parameters:

Core.Zone#ZONE EmbarkZone

Zone where the troops are embarked.

Transport zone combo.

Return value:

Set pickup formation.

Defined in:

OPSTRANSPORT

Parameters:

#number Formation

Pickup formation.

Transport zone combo.

Return value:

Set transport formation.

Defined in:

OPSTRANSPORT

Parameters:

#number Formation

Pickup formation.

Transport zone combo.

Return value:

Set LEGION transport status.

Defined in:

OPSTRANSPORT

Parameters:

The legion.

#string Status

New status.

Return value:

Set pickup zone.

Defined in:

OPSTRANSPORT

Parameters:

Core.Zone#ZONE PickupZone

Zone where the troops are picked up.

Transport zone combo.

Return value:

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:

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:

Required cargo set. Can also be passed as a #GROUP, #OPSGROUP or #SET_OPSGROUP object.

Transport zone combo.

Return value:

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:

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:

Set verbosity.

Defined in:

OPSTRANSPORT

Parameter:

#number Verbosity

Be more verbose. Default 0

Return value:

Triggers the FSM event "StatusUpdate".

Defined in:

OPSTRANSPORT

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:

Check if all cargo of this transport assignment was delivered.

Defined in:

OPSTRANSPORT

Check if all required cargos are loaded.

Defined in:

OPSTRANSPORT

Parameter:

Transport zone combo.

Return value:

#boolean:

If true, all required cargos are loaded or there is no required cargo.

Count how many cargo groups are inside a zone.

Defined in:

OPSTRANSPORT

Parameters:

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.

(Optional) Only count cargo groups that fit into the given carrier group. Current cargo is not a factor.

Transport zone combo.

Return value:

#number:

Number of cargo groups.

Create a cargo group data structure.

Defined in:

OPSTRANSPORT

Parameters:

The GROUP or OPSGROUP object.

Transport zone combo.

#boolean DisembarkActivation

If true, cargo group is activated when disembarked.

Return value:

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:

Get a list of alive carriers.

Defined in:

OPSTRANSPORT

Return value:

#table:

Names of all carriers

Get pickup formation.

Defined in:

OPSTRANSPORT

Parameter:

Transport zone combo.

Return value:

#number:

Formation.

Get transport formation.

Defined in:

OPSTRANSPORT

Parameter:

Transport zone combo.

Return value:

#number:

Formation.

Get an OPSGROUP from a given OPSGROUP or GROUP object.

If the object is a GROUUP, an OPSGROUP is created automatically.

Defined in:

OPSTRANSPORT

Parameter:

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.

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:

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.

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.

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.

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)

#string OPSTRANSPORT.ClassName

Name of the class.

#number OPSTRANSPORT.Ncargo

Total number of cargo groups.

#number OPSTRANSPORT.NcargoDead

Totalnumber of dead cargo groups.

#number OPSTRANSPORT.Ncarrier

Total number of assigned carriers.

#number OPSTRANSPORT.NcarrierDead

Total number of dead carrier groups

#number OPSTRANSPORT.Ndelivered

Total number of cargo groups delivered.

OPSTRANSPORT.Tover

Time stamp.

#number OPSTRANSPORT.Tstart

Start time in abs. seconds.

#number OPSTRANSPORT.Tstop

Stop time in abs. seconds. Default #nil (never stops).

#table OPSTRANSPORT.assets

Warehouse assets assigned for this transport.

#table OPSTRANSPORT.carrierTransportStatus

Status of each carrier.

#table OPSTRANSPORT.carriers

Carriers assigned for this transport.

Ops.Chief#CHIEF OPSTRANSPORT.chief

Chief of the transport.

Ops.Commander#COMMANDER OPSTRANSPORT.commander

Commander of the transport.

#table OPSTRANSPORT.conditionStart

Start conditions.

#number OPSTRANSPORT.duration

Duration (Tstop-Tstart) of the transport in seconds.

#number OPSTRANSPORT.importance

Importance of this transport. Smaller=higher.

#table OPSTRANSPORT.legions

Assigned legions.

#string OPSTRANSPORT.lid

Log ID.

Ops.Auftrag#AUFTRAG OPSTRANSPORT.mission

The mission attached to this transport.

#number OPSTRANSPORT.prio

Priority of this transport. Should be a number between 0 (high prio) and 100 (low prio).

#table OPSTRANSPORT.requestID

The ID of the queued warehouse request. Necessary to cancel the request if the transport was cancelled before the request is processed.

#string OPSTRANSPORT.statusCommander

Staus of the COMMANDER.

#table OPSTRANSPORT.statusLegion

Transport status of all assigned LEGIONs.

#table OPSTRANSPORT.tzCombos

Table of transport zone combos. Each element of the table is of type #OPSTRANSPORT.TransportZoneCombo.

#number OPSTRANSPORT.tzcCounter

Running number of added transport zone combos.

#number OPSTRANSPORT.uid

Unique ID of the transport.

#boolean OPSTRANSPORT.urgent

If true, transport is urgent.

#number OPSTRANSPORT.verbose

Verbosity level.

#string OPSTRANSPORT.version

Army Group version.

Function(s)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

Set the default Process template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

#string To

The To state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns the End states.

Defined in:

Return value:

#table:

End states.

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Sub processes.

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

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

Defined in:

Return value:

#table:

Transitions.

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

Call handler.

Defined in:

Parameters:

#string step

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

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#string OPSTRANSPORT.ClassName

Name of the class.

#number OPSTRANSPORT.Ncargo

Total number of cargo groups.

#number OPSTRANSPORT.NcargoDead

Totalnumber of dead cargo groups.

#number OPSTRANSPORT.Ncarrier

Total number of assigned carriers.

#number OPSTRANSPORT.NcarrierDead

Total number of dead carrier groups

#number OPSTRANSPORT.Ndelivered

Total number of cargo groups delivered.

OPSTRANSPORT.Tover

Time stamp.

#number OPSTRANSPORT.Tstart

Start time in abs. seconds.

#number OPSTRANSPORT.Tstop

Stop time in abs. seconds. Default #nil (never stops).

#table OPSTRANSPORT.assets

Warehouse assets assigned for this transport.

#table OPSTRANSPORT.carrierTransportStatus

Status of each carrier.

#table OPSTRANSPORT.carriers

Carriers assigned for this transport.

Ops.Chief#CHIEF OPSTRANSPORT.chief

Chief of the transport.

Ops.Commander#COMMANDER OPSTRANSPORT.commander

Commander of the transport.

#table OPSTRANSPORT.conditionStart

Start conditions.

#number OPSTRANSPORT.duration

Duration (Tstop-Tstart) of the transport in seconds.

#number OPSTRANSPORT.importance

Importance of this transport. Smaller=higher.

#table OPSTRANSPORT.legions

Assigned legions.

#string OPSTRANSPORT.lid

Log ID.

Ops.Auftrag#AUFTRAG OPSTRANSPORT.mission

The mission attached to this transport.

#number OPSTRANSPORT.prio

Priority of this transport. Should be a number between 0 (high prio) and 100 (low prio).

#table OPSTRANSPORT.requestID

The ID of the queued warehouse request. Necessary to cancel the request if the transport was cancelled before the request is processed.

#string OPSTRANSPORT.statusCommander

Staus of the COMMANDER.

#table OPSTRANSPORT.statusLegion

Transport status of all assigned LEGIONs.

#table OPSTRANSPORT.tzCombos

Table of transport zone combos. Each element of the table is of type #OPSTRANSPORT.TransportZoneCombo.

#number OPSTRANSPORT.tzcCounter

Running number of added transport zone combos.

#number OPSTRANSPORT.uid

Unique ID of the transport.

#boolean OPSTRANSPORT.urgent

If true, transport is urgent.

#number OPSTRANSPORT.verbose

Verbosity level.

#string OPSTRANSPORT.version

Army Group version.

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

Get a Value given a Key from the Object.

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

Return value:

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

Subscribe to a DCS Event.

Defined in:

Parameters:

Event ID.

#function EventFunction

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

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

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

Examples:

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

ClassName

is the name of the class or the class itself to run the check against

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

function EVENT:New()
  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
  return self
end
  

Defined in:

Return value:

Occurs when an Event for an object is triggered.

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

Defined in:

Parameter:

The EventData structure.

BDA.

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

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

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

Defined in:

Parameter:

The EventData structure.

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

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

Discard chair after ejection.

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

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

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

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

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

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

  • initiator: The unit that killed the target
  • target: Target Object
  • weapon: Weapon Object

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

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

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
  • subplace: is always 0 for unknown reasons.

Defined in:

Parameter:

The EventData structure.

Landing quality mark.

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

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

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

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

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

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

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

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

Weapon add.

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

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

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

Defined in:

Parameter:

The EventData structure.

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

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

The EventData structure.

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

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.EVENT#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.EVENT#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Trigger zone.

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

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

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

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#number Repeat

Specifies the interval in seconds when the scheduler will call the event function.

#number RandomizeFactor

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

#number Stop

Specifies the amount of seconds when the scheduler will be stopped.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

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

Set the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that will hold the Value set by the Key.

Key

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

-- Switch the tracing On
BASE:TraceOnOff( true )

-- Switch the tracing Off
BASE:TraceOnOff( false )

UnSubscribe to a DCS event.

Defined in:

Parameter:

Event ID.

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event

Generic transport condition.

Field(s)

#table OPSTRANSPORT.Condition.arg

Optional arguments passed to the condition callback function.

#function OPSTRANSPORT.Condition.func

Callback function to check for a condition. Should return a #boolean.

Function(s)

Path used for pickup or transport.

Field(s)

#number OPSTRANSPORT.Path.category

Category for which carriers this path is used.

#number OPSTRANSPORT.Path.radius

Radomization radius for waypoints in meters. Default 0 m.

#boolean OPSTRANSPORT.Path.reverse

If true, path is used in reversed order.

#table OPSTRANSPORT.Path.waypoints

Table of waypoints.

Function(s)

Cargo transport status.

Field(s)

#string OPSTRANSPORT.Status.CANCELLED

Transport was cancelled.

#string OPSTRANSPORT.Status.DELIVERED

Transport was delivered.

#string OPSTRANSPORT.Status.EXECUTING

Transport is being executed.

#string OPSTRANSPORT.Status.FAILED

Transport failed.

#string OPSTRANSPORT.Status.PLANNED

Planning state.

#string OPSTRANSPORT.Status.QUEUED

Queued state.

#string OPSTRANSPORT.Status.REQUESTED

Requested state.

#string OPSTRANSPORT.Status.SCHEDULED

Transport is scheduled in the cargo queue.

#string OPSTRANSPORT.Status.SUCCESS

Transport was a success.

Function(s)

Transport zone combination.

Field(s)

#table OPSTRANSPORT.TransportZoneCombo.Cargos

Cargo groups of the TZ combo. Each element is of type Ops.OpsGroup#OPSGROUP.CargoGroup.

#table OPSTRANSPORT.TransportZoneCombo.DisembarkCarriers

Carriers where the cargo is directly disembarked to.

Core.Zone#ZONE OPSTRANSPORT.TransportZoneCombo.DisembarkZone

Zone where the troops are disembared to.

Core.Zone#ZONE OPSTRANSPORT.TransportZoneCombo.EmbarkZone

Embark zone if different from pickup zone.

#number OPSTRANSPORT.TransportZoneCombo.Ncargo

Number of cargos assigned. This is a running number and not decreased if cargo is delivered or dead.

#number OPSTRANSPORT.TransportZoneCombo.Ncarriers

Number of carrier groups using this transport zone.

#number OPSTRANSPORT.TransportZoneCombo.PickupFormation

Formation used to pickup.

#number OPSTRANSPORT.TransportZoneCombo.TransportFormation

Formation used to transport.

#table OPSTRANSPORT.TransportZoneCombo.TransportPaths

Path for Transport. Each elment of the table is of type #OPSTRANSPORT.Path.

#boolean OPSTRANSPORT.TransportZoneCombo.disembarkActivation

If true, troops are spawned in late activated state when disembarked from carrier.

#boolean OPSTRANSPORT.TransportZoneCombo.disembarkInUtero

If true, troops are disembarked "in utero".

#number OPSTRANSPORT.TransportZoneCombo.uid

Unique ID of the TZ combo.

Function(s)