Banner Image

Module AI.AI_Cargo_Dispatcher_APC

AI -- (2.4) - Models the intelligent transportation of infantry and other cargo using APCs.

Features:

  • Quickly transport cargo to various deploy zones using ground vehicles (APCs, trucks ...).
  • Various Cargo.Cargo#CARGO types can be transported. These are infantry groups and crates.
  • Define a list of deploy zones of various types to transport the cargo to.
  • The vehicles follow the roads to ensure the fastest possible cargo transportation over the ground.
  • Multiple vehicles can transport multiple cargo as one vehicle group.
  • Multiple vehicle groups can be enabled as one collaborating transportation process.
  • Infantry loaded as cargo, will unboard in case enemies are nearby and will help defending the vehicles.
  • Different ranges can be setup for enemy defenses.
  • Different options can be setup to tweak the cargo transporation behaviour.

Test Missions:

Test missions can be located on the main GITHUB site.

[FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/]
(https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)


Author: FlightControl


Global(s)

Global AI_CARGO_DISPATCHER_APC

A dynamic cargo transportation capability for AI groups.

#AI_CARGO_DISPATCHER_APC AI_CARGO_DISPATCHER_APC

A dynamic cargo transportation capability for AI groups.

Armoured Personnel APCs (APC), Trucks, Jeeps and other carrier equipment can be mobilized to intelligently transport infantry and other cargo within the simulation.

The AI_CARGO_DISPATCHER_APC module is derived from the AI_CARGO_DISPATCHER module.

Note! In order to fully understand the mechanisms of the AI_CARGO_DISPATCHER_APC class, it is recommended that you first consult and READ the documentation of the AI.AI_Cargo_Dispatcher module!!!

Especially to learn how to Tailor the different cargo handling events, this will be very useful!

On top, the AI_CARGO_DISPATCHER_APC class uses the Cargo.Cargo capabilities within the MOOSE framework. Also ensure that you fully understand how to declare and setup Cargo objects within the MOOSE framework before using this class. CARGO derived objects must be declared within the mission to make the AI_CARGO_DISPATCHER_HELICOPTER object recognize the cargo.

1) AI_CARGO_DISPATCHER_APC constructor.


2) AI_CARGO_DISPATCHER_APC is a Finite State Machine.

This section must be read as follows. Each of the rows indicate a state transition, triggered through an event, and with an ending state of the event was executed. The first column is the From state, the second column the Event, and the third column the To state.

So, each of the rows have the following structure.

  • From => Event => To

Important to know is that an event can only be executed if the current state is the From state. This, when an Event that is being triggered has a From state that is equal to the Current state of the state machine, the event will be executed, and the resulting state will be the To state.

These are the different possible state transitions of this state machine implementation:

  • Idle => Start => Monitoring

  • Monitoring => Monitor => Monitoring

  • Monitoring => Stop => Idle

  • Monitoring => Pickup => Monitoring

  • Monitoring => Load => Monitoring

  • Monitoring => Loading => Monitoring

  • Monitoring => Loaded => Monitoring

  • Monitoring => PickedUp => Monitoring

  • Monitoring => Deploy => Monitoring

  • Monitoring => Unload => Monitoring

  • Monitoring => Unloaded => Monitoring

  • Monitoring => Deployed => Monitoring

  • Monitoring => Home => Monitoring

2.1) AI_CARGO_DISPATCHER States.

  • Monitoring: The process is dispatching.
  • Idle: The process is idle.

2.2) AI_CARGO_DISPATCHER Events.

  • Start: Start the transport process.

  • Stop: Stop the transport process.

  • Monitor: Monitor and take action.

  • Pickup: Pickup cargo.

  • Load: Load the cargo.

  • Loading: The dispatcher is coordinating the loading of a cargo.

  • Loaded: Flag that the cargo is loaded.

  • PickedUp: The dispatcher has loaded all requested cargo into the CarrierGroup.

  • Deploy: Deploy cargo to a location.

  • Unload: Unload the cargo.

  • Unloaded: Flag that the cargo is unloaded.

  • Deployed: All cargo is unloaded from the carriers in the group.

  • Home: A Carrier is going home.

2.3) Enhance your mission scripts with Tailored Event Handling!

Within your mission, you can capture these events when triggered, and tailor the events with your own code! Check out the AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER class at chapter 3 for details on the different event handlers that are available and how to use them.

There are a lot of templates available that allows you to quickly setup an event handler for a specific event type!


3) Set the pickup parameters.

Several parameters can be set to pickup cargo:

4) Set the deploy parameters.

Several parameters can be set to deploy cargo:

5) Set the home zone when there isn't any more cargo to pickup.

A home zone can be specified to where the APCs will move when there isn't any cargo left for pickup. Use AI_CARGO_DISPATCHER_APC.SetHomeZone() to specify the home zone.

If no home zone is specified, the APCs will wait near the deploy zone for a new pickup command.


Type(s)

Fields and Methods inherited from AI_CARGO_DISPATCHER_APC Description

AI_CARGO_DISPATCHER_APC:AICargo(APC, CargoSet)

AI_CARGO_DISPATCHER_APC.CombatRadius

AI_CARGO_DISPATCHER_APC:New(APCSet, CargoSet, PickupZoneSet, DeployZoneSet, CombatRadius)

Creates a new AI_CARGO_DISPATCHER_APC object.

AI_CARGO_DISPATCHER_APC:SetCombatRadius(CombatRadius)

Enable/Disable unboarding of cargo (infantry) when enemies are nearby (to help defend the carrier).

Fields and Methods inherited from AI_CARGO_DISPATCHER Description

AI_CARGO_DISPATCHER_APC.AI_Cargo

AI_CARGO_DISPATCHER_APC.CargoSet

The set of Cargo.Cargo#CARGO objects, which can be CARGO_GROUP, CARGO_CRATE, CARGO_SLINGLOAD objects.

AI_CARGO_DISPATCHER_APC.CarrierHome

AI_CARGO_DISPATCHER_APC.CarrierSet

The set of Wrapper.Group#GROUP objects of carriers that will transport the cargo.

AI_CARGO_DISPATCHER_APC.DeployInnerRadius

The inner radius in meters around the cargo coordinate to deploy the cargo.

AI_CARGO_DISPATCHER_APC.DeployMaxHeight

The maximum height to fly to the cargo deploy location.

AI_CARGO_DISPATCHER_APC.DeployMaxSpeed

The maximum speed to move to the cargo deploy location.

AI_CARGO_DISPATCHER_APC.DeployMinHeight

The minimum height to fly to the cargo deploy location.

AI_CARGO_DISPATCHER_APC.DeployMinSpeed

The minimum speed to move to the cargo deploy location.

AI_CARGO_DISPATCHER_APC.DeployOuterRadius

The outer radius in meters around the cargo coordinate to deploy the cargo.

AI_CARGO_DISPATCHER_APC.DeployZoneSet

The set of deploy zones, which are used to where the cargo will be deployed by the carriers.

AI_CARGO_DISPATCHER_APC.HomeZone

The home zone where the carriers will return when there is no more cargo to pickup.

AI_CARGO_DISPATCHER_APC.MonitorTimeInterval

The interval in seconds when the cargo dispatcher will search for new cargo to be picked up.

AI_CARGO_DISPATCHER_APC:New(CarrierSet, CargoSet, PickupZoneSet, DeployZoneSet)

Creates a new AI_CARGO_DISPATCHER object.

AI_CARGO_DISPATCHER_APC:OnAfterDeploy(From, Event, To, CarrierGroup, Coordinate, Speed, Height, DeployZone)

Deploy event handler OnAfter for AI_CARGO_DISPATCHER.

AI_CARGO_DISPATCHER_APC:OnAfterDeployed(From, Event, To, CarrierGroup, DeployZone)

Deployed event handler OnAfter for AI_CARGO_DISPATCHER.

AI_CARGO_DISPATCHER_APC:OnAfterHome(From, Event, To, CarrierGroup, Coordinate, Speed, Height, HomeZone)

Home event handler OnAfter for AI_CARGO_DISPATCHER.

AI_CARGO_DISPATCHER_APC:OnAfterLoad(From, Event, To, CarrierGroup, PickupZone)

Load event handler OnAfter for AI_CARGO_DISPATCHER.

AI_CARGO_DISPATCHER_APC:OnAfterLoaded(From, Event, To, CarrierGroup, Cargo, CarrierUnit, PickupZone)

Loaded event handler OnAfter for AI_CARGO_DISPATCHER.

AI_CARGO_DISPATCHER_APC:OnAfterLoading(From, Event, To, CarrierGroup, Cargo, CarrierUnit, PickupZone)

Loading event handler OnAfter for AI_CARGO_DISPATCHER.

AI_CARGO_DISPATCHER_APC:OnAfterPickedUp(From, Event, To, CarrierGroup, PickupZone)

PickedUp event handler OnAfter for AI_CARGO_DISPATCHER.

AI_CARGO_DISPATCHER_APC:OnAfterPickup(From, Event, To, CarrierGroup, Coordinate, Speed, Height, PickupZone)

Pickup event handler OnAfter for AI_CARGO_DISPATCHER.

AI_CARGO_DISPATCHER_APC:OnAfterUnload(From, Event, To, CarrierGroup, DeployZone)

Unload event handler OnAfter for AI_CARGO_DISPATCHER.

AI_CARGO_DISPATCHER_APC:OnAfterUnloaded(From, Event, To, CarrierGroup, Cargo, CarrierUnit, DeployZone)

Unloaded event handler OnAfter for AI_CARGO_DISPATCHER.

AI_CARGO_DISPATCHER_APC:OnAfterUnloading(From, Event, To, CarrierGroup, Cargo, CarrierUnit, DeployZone)

UnLoading event handler OnAfter for AI_CARGO_DISPATCHER.

AI_CARGO_DISPATCHER_APC.PickupCargo

AI_CARGO_DISPATCHER_APC.PickupInnerRadius

The inner radius in meters around the cargo coordinate to pickup the cargo.

AI_CARGO_DISPATCHER_APC.PickupMaxHeight

The maximum height to fly to the cargo pickup location.

AI_CARGO_DISPATCHER_APC.PickupMaxSpeed

The maximum speed to move to the cargo pickup location.

AI_CARGO_DISPATCHER_APC.PickupMinHeight

The minimum height to fly to the cargo pickup location.

AI_CARGO_DISPATCHER_APC.PickupMinSpeed

The minimum speed to move to the cargo pickup location.

AI_CARGO_DISPATCHER_APC.PickupOuterRadius

The outer radius in meters around the cargo coordinate to pickup the cargo.

AI_CARGO_DISPATCHER_APC.PickupZoneSet

The set of pickup zones, which are used to where the cargo can be picked up by the carriers. If nil, then cargo can be picked up everywhere.

AI_CARGO_DISPATCHER_APC.SetCargo

AI_CARGO_DISPATCHER_APC.SetCarrier

AI_CARGO_DISPATCHER_APC:SetDeployHeight(MaxHeight, MinHeight)

Set the height or randomizes the height in meters to fly and deploy the cargo.

AI_CARGO_DISPATCHER_APC:SetDeployRadius(OuterRadius, InnerRadius)

Sets or randomizes the deploy location for the carrier around the cargo coordinate in a radius defined an outer and an optional inner radius.

AI_CARGO_DISPATCHER_APC:SetDeploySpeed(MaxSpeed, MinSpeed)

Sets or randomizes the speed in km/h to deploy the cargo.

AI_CARGO_DISPATCHER_APC:SetHomeZone(HomeZone)

Set the home zone.

AI_CARGO_DISPATCHER_APC:SetMonitorTimeInterval(MonitorTimeInterval)

Set the monitor time interval.

AI_CARGO_DISPATCHER_APC:SetPickupHeight(MaxHeight, MinHeight)

Set the height or randomizes the height in meters to fly and pickup the cargo.

AI_CARGO_DISPATCHER_APC:SetPickupRadius(OuterRadius, InnerRadius)

Sets or randomizes the pickup location for the carrier around the cargo coordinate in a radius defined an outer and optional inner radius.

AI_CARGO_DISPATCHER_APC:SetPickupSpeed(MaxSpeed, MinSpeed)

Set the speed or randomizes the speed in km/h to pickup the cargo.

AI_CARGO_DISPATCHER_APC:Start()

Start Trigger for AI_CARGO_DISPATCHER

AI_CARGO_DISPATCHER_APC:Stop()

Stop Trigger for AI_CARGO_DISPATCHER

AI_CARGO_DISPATCHER_APC:__Start(Delay)

Start Asynchronous Trigger for AI_CARGO_DISPATCHER

AI_CARGO_DISPATCHER_APC:__Stop(Delay)

Stop Asynchronous Trigger for AI_CARGO_DISPATCHER

AI_CARGO_DISPATCHER_APC:onafterMonitor()

The Start trigger event, which actually takes action at the specified time interval.

AI_CARGO_DISPATCHER_APC:onafterStart(From, Event, To)

AI_CARGO_DISPATCHER_APC:onafterTransport(From, Event, To, Carrier, Cargo)

Make a Carrier run for a cargo deploy action after the cargo has been loaded, by default.

Fields and Methods inherited from FSM Description

AI_CARGO_DISPATCHER_APC:AddEndState(State)

Adds an End state.

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

AI_CARGO_DISPATCHER_APC:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

AI_CARGO_DISPATCHER_APC:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

AI_CARGO_DISPATCHER_APC.CallScheduler

AI_CARGO_DISPATCHER_APC.Events

AI_CARGO_DISPATCHER_APC:GetCurrentState()

AI_CARGO_DISPATCHER_APC:GetEndStates()

Returns the End states.

AI_CARGO_DISPATCHER_APC:GetProcess(From, Event)

AI_CARGO_DISPATCHER_APC:GetProcesses()

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

AI_CARGO_DISPATCHER_APC:GetScores()

Returns a table with the scores defined.

AI_CARGO_DISPATCHER_APC:GetStartState()

Returns the start state of the FSM.

AI_CARGO_DISPATCHER_APC:GetState()

AI_CARGO_DISPATCHER_APC:GetSubs()

Returns a table with the Subs defined.

AI_CARGO_DISPATCHER_APC:GetTransitions()

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

AI_CARGO_DISPATCHER_APC:Is(State)

AI_CARGO_DISPATCHER_APC:LoadCallBacks(CallBackTable)

AI_CARGO_DISPATCHER_APC:New()

Creates a new FSM object.

AI_CARGO_DISPATCHER_APC.Scores

AI_CARGO_DISPATCHER_APC:SetProcess(From, Event, Fsm)

AI_CARGO_DISPATCHER_APC:SetStartState(State)

Sets the start state of the FSM.

AI_CARGO_DISPATCHER_APC._EndStates

AI_CARGO_DISPATCHER_APC._EventSchedules

AI_CARGO_DISPATCHER_APC._Processes

AI_CARGO_DISPATCHER_APC._Scores

AI_CARGO_DISPATCHER_APC._StartState

AI_CARGO_DISPATCHER_APC._Transitions

AI_CARGO_DISPATCHER_APC:_add_to_map(Map, Event)

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

AI_CARGO_DISPATCHER_APC:_create_transition(EventName)

AI_CARGO_DISPATCHER_APC:_delayed_transition(EventName)

AI_CARGO_DISPATCHER_APC:_eventmap(Events, EventStructure)

AI_CARGO_DISPATCHER_APC:_gosub(ParentFrom, ParentEvent)

AI_CARGO_DISPATCHER_APC:_handler(EventName, ...)

AI_CARGO_DISPATCHER_APC:_isendstate(Current)

AI_CARGO_DISPATCHER_APC:_submap(subs, sub, name)

AI_CARGO_DISPATCHER_APC:can(e)

AI_CARGO_DISPATCHER_APC:cannot(e)

AI_CARGO_DISPATCHER_APC.current

AI_CARGO_DISPATCHER_APC.endstates

AI_CARGO_DISPATCHER_APC:is(state)

AI_CARGO_DISPATCHER_APC.options

AI_CARGO_DISPATCHER_APC.subs

Fields and Methods inherited from BASE Description

AI_CARGO_DISPATCHER_APC.ClassID

The ID number of the class.

AI_CARGO_DISPATCHER_APC.ClassName

The name of the class.

AI_CARGO_DISPATCHER_APC.ClassNameAndID

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

AI_CARGO_DISPATCHER_APC:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

AI_CARGO_DISPATCHER_APC:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

AI_CARGO_DISPATCHER_APC:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

AI_CARGO_DISPATCHER_APC:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

AI_CARGO_DISPATCHER_APC:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

AI_CARGO_DISPATCHER_APC:E(Arguments)

Log an exception which will be traced always.

AI_CARGO_DISPATCHER_APC:EventDispatcher()

Returns the event dispatcher

AI_CARGO_DISPATCHER_APC:EventRemoveAll()

Remove all subscribed events

AI_CARGO_DISPATCHER_APC:F(Arguments)

Trace a function call.

AI_CARGO_DISPATCHER_APC:F2(Arguments)

Trace a function call level 2.

AI_CARGO_DISPATCHER_APC:F3(Arguments)

Trace a function call level 3.

AI_CARGO_DISPATCHER_APC:GetClassID()

Get the ClassID of the class instance.

AI_CARGO_DISPATCHER_APC:GetClassName()

Get the ClassName of the class instance.

AI_CARGO_DISPATCHER_APC:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

AI_CARGO_DISPATCHER_APC:GetEventPriority()

Get the Class Event processing Priority.

AI_CARGO_DISPATCHER_APC:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

AI_CARGO_DISPATCHER_APC:GetState(Object, Key)

Get a Value given a Key from the Object.

AI_CARGO_DISPATCHER_APC:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

AI_CARGO_DISPATCHER_APC:I(Arguments)

Log an information which will be traced always.

AI_CARGO_DISPATCHER_APC:Inherit(Child, Parent)

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

AI_CARGO_DISPATCHER_APC:IsInstanceOf(ClassName)

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

AI_CARGO_DISPATCHER_APC:IsTrace()

Enquires if tracing is on (for the class).

AI_CARGO_DISPATCHER_APC:New()

BASE constructor.

AI_CARGO_DISPATCHER_APC:OnEvent(EventData)

Occurs when an object is completely destroyed.

AI_CARGO_DISPATCHER_APC:OnEventBaseCaptured(EventData)

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

AI_CARGO_DISPATCHER_APC:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

AI_CARGO_DISPATCHER_APC:OnEventCrash(EventData)

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

AI_CARGO_DISPATCHER_APC:OnEventDead(EventData)

Occurs when an object is dead.

AI_CARGO_DISPATCHER_APC:OnEventDetailedFailure(EventData)

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

AI_CARGO_DISPATCHER_APC:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected

AI_CARGO_DISPATCHER_APC:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

AI_CARGO_DISPATCHER_APC:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

AI_CARGO_DISPATCHER_APC:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

AI_CARGO_DISPATCHER_APC:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

AI_CARGO_DISPATCHER_APC:OnEventKill(EventData)

Occurs on the death of a unit.

AI_CARGO_DISPATCHER_APC:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

AI_CARGO_DISPATCHER_APC:OnEventLandingAfterEjection(EventData)

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

AI_CARGO_DISPATCHER_APC:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

AI_CARGO_DISPATCHER_APC:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

AI_CARGO_DISPATCHER_APC:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

AI_CARGO_DISPATCHER_APC:OnEventMissionEnd(EventData)

Occurs when a mission ends

AI_CARGO_DISPATCHER_APC:OnEventMissionStart(EventData)

Occurs when a mission starts

AI_CARGO_DISPATCHER_APC:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

AI_CARGO_DISPATCHER_APC:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

AI_CARGO_DISPATCHER_APC:OnEventPlayerLeaveUnit(EventData)

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

AI_CARGO_DISPATCHER_APC:OnEventRefueling(EventData)

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

AI_CARGO_DISPATCHER_APC:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

AI_CARGO_DISPATCHER_APC:OnEventScore(EventData)

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

AI_CARGO_DISPATCHER_APC:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

AI_CARGO_DISPATCHER_APC:OnEventShootingStart(EventData)

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

AI_CARGO_DISPATCHER_APC:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

AI_CARGO_DISPATCHER_APC:OnEventTakeoff(EventData)

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

AI_CARGO_DISPATCHER_APC:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

AI_CARGO_DISPATCHER_APC:ScheduleStop(SchedulerFunction)

Stops the Schedule.

AI_CARGO_DISPATCHER_APC.Scheduler

AI_CARGO_DISPATCHER_APC:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

AI_CARGO_DISPATCHER_APC:SetState(Object, Key, Value)

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

AI_CARGO_DISPATCHER_APC:T(Arguments)

Trace a function logic level 1.

AI_CARGO_DISPATCHER_APC:T2(Arguments)

Trace a function logic level 2.

AI_CARGO_DISPATCHER_APC:T3(Arguments)

Trace a function logic level 3.

AI_CARGO_DISPATCHER_APC:TraceAll(TraceAll)

Trace all methods in MOOSE

AI_CARGO_DISPATCHER_APC:TraceClass(Class)

Set tracing for a class

AI_CARGO_DISPATCHER_APC:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

AI_CARGO_DISPATCHER_APC:TraceLevel(Level)

Set trace level

AI_CARGO_DISPATCHER_APC:TraceOff()

Set trace off.

AI_CARGO_DISPATCHER_APC:TraceOn()

Set trace on.

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

AI_CARGO_DISPATCHER_APC:UnHandleEvent(Event)

UnSubscribe to a DCS event.

AI_CARGO_DISPATCHER_APC._

AI_CARGO_DISPATCHER_APC:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

AI_CARGO_DISPATCHER_APC:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

AI_CARGO_DISPATCHER_APC.__

AI_CARGO_DISPATCHER_APC:onEvent(event)

Field(s)

Function(s)

Defined in:

AI_CARGO_DISPATCHER_APC

Parameters:

APC

CargoSet

Creates a new AI_CARGO_DISPATCHER_APC object.

Defined in:

AI_CARGO_DISPATCHER_APC

Parameters:

The set of Wrapper.Group#GROUP objects of vehicles, trucks, APCs that will transport the cargo.

The set of Cargo.Cargo#CARGO objects, which can be CARGO_GROUP, CARGO_CRATE, CARGO_SLINGLOAD objects.

Core.Set#SET_ZONE PickupZoneSet

(optional) The set of pickup zones, which are used to where the cargo can be picked up by the APCs. If nil, then cargo can be picked up everywhere.

Core.Set#SET_ZONE DeployZoneSet

The set of deploy zones, which are used to where the cargo will be deployed by the APCs.

DCS#Distance CombatRadius

The cargo will be unloaded from the APC and engage the enemy if the enemy is within CombatRadius range. The radius is in meters, the default value is 500 meters.

Return value:

Usage:


     -- An AI dispatcher object for a vehicle squadron, moving infantry from pickup zones to deploy zones.

     local SetCargoInfantry = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
     local SetAPC = SET_GROUP:New():FilterPrefixes( "APC" ):FilterStart()
     local SetDeployZones = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
     
     AICargoDispatcherAPC = AI_CARGO_DISPATCHER_APC:New( SetAPC, SetCargoInfantry, nil, SetDeployZones ) 
     AICargoDispatcherAPC:Start()

Enable/Disable unboarding of cargo (infantry) when enemies are nearby (to help defend the carrier).

This is only valid for APCs and trucks etc, thus ground vehicles.

Defined in:

AI_CARGO_DISPATCHER_APC

Parameter:

#number CombatRadius

Provide the combat radius to defend the carrier by unboarding the cargo when enemies are nearby. When the combat radius is 0, no defense will happen of the carrier. When the combat radius is not provided, no defense will happen!

Return value:

Usage:


-- Disembark the infantry when the carrier is under attack.
AICargoDispatcher:SetCombatRadius( true )

-- Keep the cargo in the carrier when the carrier is under attack.
AICargoDispatcher:SetCombatRadius( false )

Field(s)

Function(s)

Creates a new AI_CARGO_DISPATCHER object.

Defined in:

Parameters:

Core.Set#SET_GROUP CarrierSet

The set of Wrapper.Group#GROUP objects of carriers that will transport the cargo.

The set of Cargo.Cargo#CARGO objects, which can be CARGO_GROUP, CARGO_CRATE, CARGO_SLINGLOAD objects.

Core.Set#SET_ZONE PickupZoneSet

(optional) The set of pickup zones, which are used to where the cargo can be picked up by the carriers. If nil, then cargo can be picked up everywhere.

Core.Set#SET_ZONE DeployZoneSet

The set of deploy zones, which are used to where the cargo will be deployed by the carriers.

Return value:

Usages:

  • 
         -- An AI dispatcher object for a helicopter squadron, moving infantry from pickup zones to deploy zones.
    
         local SetCargoInfantry = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
         local SetHelicopter = SET_GROUP:New():FilterPrefixes( "Helicopter" ):FilterStart()
         local SetPickupZones = SET_ZONE:New():FilterPrefixes( "Pickup" ):FilterStart()
         local SetDeployZones = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
         
         AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones ) 
         AICargoDispatcherHelicopter:Start()
    
  • 
         -- An AI dispatcher object for a vehicle squadron, moving infantry from pickup zones to deploy zones.
    
         local SetCargoInfantry = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
         local SetAPC = SET_GROUP:New():FilterPrefixes( "APC" ):FilterStart()
         local SetDeployZones = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
         
         AICargoDispatcherAPC = AI_CARGO_DISPATCHER_APC:New( SetAPC, SetCargoInfantry, nil, SetDeployZones ) 
         AICargoDispatcherAPC:Start()
    
  • 
         -- An AI dispatcher object for an airplane squadron, moving infantry and vehicles from pickup airbases to deploy airbases.
      
         local CargoInfantrySet = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
         local AirplanesSet = SET_GROUP:New():FilterPrefixes( "Airplane" ):FilterStart()
         local PickupZoneSet = SET_ZONE:New()
         local DeployZoneSet = SET_ZONE:New()
         
         PickupZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Gudauta ) )
         DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Sochi_Adler ) )
         DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Maykop_Khanskaya ) )
         DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Mineralnye_Vody ) )
         DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Vaziani ) )
         
         AICargoDispatcherAirplanes = AI_CARGO_DISPATCHER_AIRPLANE:New( AirplanesSet, CargoInfantrySet, PickupZoneSet, DeployZoneSet ) 
         AICargoDispatcherAirplanes:Start()
    

Deploy event handler OnAfter for AI_CARGO_DISPATCHER.

Use this event handler to tailor the event when a CarrierGroup is routed to a deploy coordinate, to Unload all cargo objects in each CarrierUnit. You can use this event handler to post messages to players, or provide status updates etc.

Defined in:

Parameters:

#string From

A string that contains the "from state name" when the event was triggered.

#string Event

A string that contains the "event name" when the event was triggered.

#string To

A string that contains the "to state name" when the event was triggered.

Wrapper.Group#GROUP CarrierGroup

The group object that contains the CarrierUnits.

The deploy coordinate.

#number Speed

The velocity in meters per second on which the CarrierGroup is routed towards the deploy Coordinate.

#number Height

Height in meters to move to the deploy coordinate.

Core.Zone#ZONE DeployZone

The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.

Deployed event handler OnAfter for AI_CARGO_DISPATCHER.

Use this event handler to tailor the event when a carrier has deployed all cargo objects from the CarrierGroup. You can use this event handler to post messages to players, or provide status updates etc.

Defined in:

Parameters:

#string From

A string that contains the "from state name" when the event was triggered.

#string Event

A string that contains the "event name" when the event was triggered.

#string To

A string that contains the "to state name" when the event was triggered.

Wrapper.Group#GROUP CarrierGroup

The group object that contains the CarrierUnits.

Core.Zone#ZONE DeployZone

The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.

Home event handler OnAfter for AI_CARGO_DISPATCHER.

Use this event handler to tailor the event when a CarrierGroup is returning to the HomeZone, after it has deployed all cargo objects from the CarrierGroup. You can use this event handler to post messages to players, or provide status updates etc. If there is no HomeZone is specified, the CarrierGroup will stay at the current location after having deployed all cargo.

Defined in:

Parameters:

#string From

A string that contains the "from state name" when the event was triggered.

#string Event

A string that contains the "event name" when the event was triggered.

#string To

A string that contains the "to state name" when the event was triggered.

Wrapper.Group#GROUP CarrierGroup

The group object that contains the CarrierUnits.

The home coordinate the Carrier will arrive and stop it's activities.

#number Speed

The velocity in meters per second on which the CarrierGroup is routed towards the home Coordinate.

#number Height

Height in meters to move to the home coordinate.

Core.Zone#ZONE HomeZone

The zone wherein the carrier will return when all cargo has been transported. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.

Load event handler OnAfter for AI_CARGO_DISPATCHER.

Use this event handler to tailor the event when a CarrierGroup has initiated the loading or boarding of cargo within reporting or near range. You can use this event handler to post messages to players, or provide status updates etc.

Defined in:

Parameters:

#string From

A string that contains the "from state name" when the event was triggered.

#string Event

A string that contains the "event name" when the event was triggered.

#string To

A string that contains the "to state name" when the event was triggered.

Wrapper.Group#GROUP CarrierGroup

The group object that contains the CarrierUnits.

(optional) The zone from where the cargo is picked up. Note that the zone is optional and may not be provided, but for AI_CARGO_DISPATCHER_AIRBASE there will always be a PickupZone, as the pickup location is an airbase zone.

Loaded event handler OnAfter for AI_CARGO_DISPATCHER.

Use this event handler to tailor the event when a CarrierUnit of a CarrierGroup has loaded a cargo object. You can use this event handler to post messages to players, or provide status updates etc. Note that if more cargo objects were loading or boarding into the CarrierUnit, then this event can be triggered multiple times for each different Cargo/CarrierUnit. A CarrierUnit can be part of the larger CarrierGroup.

Defined in:

Parameters:

#string From

A string that contains the "from state name" when the event was triggered.

#string Event

A string that contains the "event name" when the event was triggered.

#string To

A string that contains the "to state name" when the event was triggered.

Wrapper.Group#GROUP CarrierGroup

The group object that contains the CarrierUnits.

The cargo object.

Wrapper.Unit#UNIT CarrierUnit

The carrier unit that is executing the cargo loading operation.

(optional) The zone from where the cargo is picked up. Note that the zone is optional and may not be provided, but for AI_CARGO_DISPATCHER_AIRBASE there will always be a PickupZone, as the pickup location is an airbase zone.

Loading event handler OnAfter for AI_CARGO_DISPATCHER.

Use this event handler to tailor the event when a CarrierUnit of a CarrierGroup is in the process of loading or boarding of a cargo object. You can use this event handler to post messages to players, or provide status updates etc. Note that this event is triggered repeatedly until all cargo (units) have been boarded into the carrier.

Defined in:

Parameters:

#string From

A string that contains the "from state name" when the event was triggered.

#string Event

A string that contains the "event name" when the event was triggered.

#string To

A string that contains the "to state name" when the event was triggered.

Wrapper.Group#GROUP CarrierGroup

The group object that contains the CarrierUnits.

The cargo object.

Wrapper.Unit#UNIT CarrierUnit

The carrier unit that is executing the cargo loading operation.

(optional) The zone from where the cargo is picked up. Note that the zone is optional and may not be provided, but for AI_CARGO_DISPATCHER_AIRBASE there will always be a PickupZone, as the pickup location is an airbase zone.

PickedUp event handler OnAfter for AI_CARGO_DISPATCHER.

Use this event handler to tailor the event when a carrier has picked up all cargo objects into the CarrierGroup. You can use this event handler to post messages to players, or provide status updates etc.

Defined in:

Parameters:

#string From

A string that contains the "from state name" when the event was triggered.

#string Event

A string that contains the "event name" when the event was triggered.

#string To

A string that contains the "to state name" when the event was triggered.

Wrapper.Group#GROUP CarrierGroup

The group object that contains the CarrierUnits.

(optional) The zone from where the cargo is picked up. Note that the zone is optional and may not be provided, but for AI_CARGO_DISPATCHER_AIRBASE there will always be a PickupZone, as the pickup location is an airbase zone.

Pickup event handler OnAfter for AI_CARGO_DISPATCHER.

Use this event handler to tailor the event when a CarrierGroup is routed towards a new pickup Coordinate and a specified Speed. You can use this event handler to post messages to players, or provide status updates etc.

Defined in:

Parameters:

#string From

A string that contains the "from state name" when the event was triggered.

#string Event

A string that contains the "event name" when the event was triggered.

#string To

A string that contains the "to state name" when the event was triggered.

Wrapper.Group#GROUP CarrierGroup

The group object that contains the CarrierUnits.

The coordinate of the pickup location.

#number Speed

The velocity in meters per second on which the CarrierGroup is routed towards the pickup Coordinate.

#number Height

Height in meters to move to the pickup coordinate.

(optional) The zone from where the cargo is picked up. Note that the zone is optional and may not be provided, but for AI_CARGO_DISPATCHER_AIRBASE there will always be a PickupZone, as the pickup location is an airbase zone.

Unload event handler OnAfter for AI_CARGO_DISPATCHER.

Use this event handler to tailor the event when a CarrierGroup has initiated the unloading or unboarding of cargo. You can use this event handler to post messages to players, or provide status updates etc.

Defined in:

Parameters:

#string From

A string that contains the "from state name" when the event was triggered.

#string Event

A string that contains the "event name" when the event was triggered.

#string To

A string that contains the "to state name" when the event was triggered.

Wrapper.Group#GROUP CarrierGroup

The group object that contains the CarrierUnits.

Core.Zone#ZONE DeployZone

The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.

Unloaded event handler OnAfter for AI_CARGO_DISPATCHER.

Use this event handler to tailor the event when a CarrierUnit of a CarrierGroup has unloaded a cargo object. You can use this event handler to post messages to players, or provide status updates etc. Note that if more cargo objects were unloading or unboarding from the CarrierUnit, then this event can be triggered multiple times for each different Cargo/CarrierUnit. A CarrierUnit can be part of the larger CarrierGroup.

Defined in:

Parameters:

#string From

A string that contains the "from state name" when the event was triggered.

#string Event

A string that contains the "event name" when the event was triggered.

#string To

A string that contains the "to state name" when the event was triggered.

Wrapper.Group#GROUP CarrierGroup

The group object that contains the CarrierUnits.

The cargo object.

Wrapper.Unit#UNIT CarrierUnit

The carrier unit that is executing the cargo unloading operation.

Core.Zone#ZONE DeployZone

The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.

UnLoading event handler OnAfter for AI_CARGO_DISPATCHER.

Use this event handler to tailor the event when a CarrierUnit of a CarrierGroup is in the process of unloading or unboarding of a cargo object. You can use this event handler to post messages to players, or provide status updates etc. Note that this event is triggered repeatedly until all cargo (units) have been unboarded from the CarrierUnit.

Defined in:

Parameters:

#string From

A string that contains the "from state name" when the event was triggered.

#string Event

A string that contains the "event name" when the event was triggered.

#string To

A string that contains the "to state name" when the event was triggered.

Wrapper.Group#GROUP CarrierGroup

The group object that contains the CarrierUnits.

The cargo object.

Wrapper.Unit#UNIT CarrierUnit

The carrier unit that is executing the cargo unloading operation.

Core.Zone#ZONE DeployZone

The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.

Set the height or randomizes the height in meters to fly and deploy the cargo.

The default height is 200 meters.

Defined in:

Parameters:

#number MaxHeight

(optional) The maximum height to fly to the cargo deploy location.

#number MinHeight

(optional) The minimum height to fly to the cargo deploy location.

Return value:

Usage:


-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones ) 

-- Set the minimum deploy fly height to be 50 meters and the maximum height to be 200 meters.
AICargoDispatcherHelicopter:SetDeployHeight( 200, 50 )

Sets or randomizes the deploy location for the carrier around the cargo coordinate in a radius defined an outer and an optional inner radius.

This radius is influencing the location where the carrier will land to deploy the cargo. There is an aspect that is very important to remember and take into account:

  • Take care of the potential cargo position and possible reasons to crash the carrier. This is especially important for locations which are crowded with other objects, like in the middle of villages or cities. So, for the best operation of cargo operations, always ensure that the cargo is located at open spaces.

The default radius is 0, so the center. In case of a polygon zone, a random location will be selected as the center in the zone.

Defined in:

Parameters:

#number OuterRadius

The outer radius in meters around the cargo coordinate.

#number InnerRadius

(optional) The inner radius in meters around the cargo coordinate.

Return value:

Usage:


-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones ) 

-- Set the carrier to land within a band around the cargo coordinate between 500 and 300 meters!
AICargoDispatcherHelicopter:SetDeployRadius( 500, 300 )

Sets or randomizes the speed in km/h to deploy the cargo.

Defined in:

Parameters:

#number MaxSpeed

The maximum speed to move to the cargo deploy location.

#number MinSpeed

(optional) The minimum speed to move to the cargo deploy location.

Return value:

Usage:


-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones ) 

-- Set the minimum deploy speed to be 100 km/h and the maximum speed to be 200 km/h.
AICargoDispatcherHelicopter:SetDeploySpeed( 200, 100 )

Set the home zone.

When there is nothing anymore to pickup, the carriers will go to a random coordinate in this zone. They will await here new orders.

Defined in:

Parameter:

The home zone where the carriers will return when there is no more cargo to pickup.

Return value:

Usage:


-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones ) 

-- Set the home coordinate
local HomeZone = ZONE:New( "Home" )
AICargoDispatcherHelicopter:SetHomeZone( HomeZone )

Set the monitor time interval.

Defined in:

Parameter:

#number MonitorTimeInterval

The interval in seconds when the cargo dispatcher will search for new cargo to be picked up.

Return value:

Set the height or randomizes the height in meters to fly and pickup the cargo.

The default height is 200 meters.

Defined in:

Parameters:

#number MaxHeight

(optional) The maximum height to fly to the cargo pickup location.

#number MinHeight

(optional) The minimum height to fly to the cargo pickup location.

Return value:

Usage:


-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones ) 

-- Set the minimum pickup fly height to be 50 meters and the maximum height to be 200 meters.
AICargoDispatcherHelicopter:SetPickupHeight( 200, 50 )

Sets or randomizes the pickup location for the carrier around the cargo coordinate in a radius defined an outer and optional inner radius.

This radius is influencing the location where the carrier will land to pickup the cargo. There are two aspects that are very important to remember and take into account:

  • Ensure that the outer and inner radius are within reporting radius set by the cargo. For example, if the cargo has a reporting radius of 400 meters, and the outer and inner radius is set to 500 and 450 respectively, then no cargo will be loaded!!!
  • Also take care of the potential cargo position and possible reasons to crash the carrier. This is especially important for locations which are crowded with other objects, like in the middle of villages or cities. So, for the best operation of cargo operations, always ensure that the cargo is located at open spaces.

The default radius is 0, so the center. In case of a polygon zone, a random location will be selected as the center in the zone.

Defined in:

Parameters:

#number OuterRadius

The outer radius in meters around the cargo coordinate.

#number InnerRadius

(optional) The inner radius in meters around the cargo coordinate.

Return value:

Usage:


-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones ) 

-- Set the carrier to land within a band around the cargo coordinate between 500 and 300 meters!
AICargoDispatcherHelicopter:SetPickupRadius( 500, 300 )

Set the speed or randomizes the speed in km/h to pickup the cargo.

Defined in:

Parameters:

#number MaxSpeed

(optional) The maximum speed to move to the cargo pickup location.

#number MinSpeed

The minimum speed to move to the cargo pickup location.

Return value:

Usage:


-- Create a new cargo dispatcher
AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones ) 

-- Set the minimum pickup speed to be 100 km/h and the maximum speed to be 200 km/h.
AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )

Start Trigger for AI_CARGO_DISPATCHER

Stop Trigger for AI_CARGO_DISPATCHER

Start Asynchronous Trigger for AI_CARGO_DISPATCHER

Defined in:

Parameter:

#number Delay

Stop Asynchronous Trigger for AI_CARGO_DISPATCHER

Defined in:

Parameter:

#number Delay

The Start trigger event, which actually takes action at the specified time interval.

Make a Carrier run for a cargo deploy action after the cargo has been loaded, by default.

Defined in:

Parameters:

From

Event

To

Return value:

Field(s)

Function(s)

Adds an End state.

Defined in:

Parameter:

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.

Returns the End states.

Defined in:

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

Defined in:

Return value:

#table:

Returns a table with the scores defined.

Defined in:

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Returns a table with the Subs defined.

Defined in:

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

Defined in:

Return value:

#table:

Defined in:

Parameter:

State

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Defined in:

Parameters:

step

trigger

params

EventName

Defined in:

Parameters:

Events

EventStructure

Defined in:

Parameters:

ParentFrom

ParentEvent

Defined in:

Parameters:

EventName

...

Defined in:

Parameters:

subs

sub

name

Defined in:

Parameter:

e

Defined in:

Parameter:

state

Field(s)

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a 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.

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:

#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 object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

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

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.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

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.

Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

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.

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.

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

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

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

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. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

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.

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.

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

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.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. 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. 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.

Defined in:

Parameter:

The EventData structure.

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

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.

Occurs when the game thinks an object is destroyed.

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

#number:

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

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

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

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

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

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

TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class. @param #BASE self @param DCS#Event event

Defined in:

Parameter:

event