Banner Image

Module AI.AI_Cargo_Helicopter

AI - Models the intelligent transportation of cargo using helicopters.


Author: FlightControl


Global(s)

Global AI_CARGO_HELICOPTER

Brings a dynamic cargo handling capability for an AI helicopter group.

#AI_CARGO_HELICOPTER AI_CARGO_HELICOPTER

Brings a dynamic cargo handling capability for an AI helicopter group.

Helicopter carriers can be mobilized to intelligently transport infantry and other cargo within the simulation.

The AI_CARGO_HELICOPTER class uses the Cargo.Cargo capabilities within the MOOSE framework. Cargo.Cargo must be declared within the mission to make the AI_CARGO_HELICOPTER object recognize the cargo. Please consult the Cargo.Cargo module for more information.

Cargo pickup.

Using the AI_CARGO_HELICOPTER.Pickup() method, you are able to direct the helicopters towards a point on the battlefield to board/load the cargo at the specific coordinate. Ensure that the landing zone is horizontally flat, and that trees cannot be found in the landing vicinity, or the helicopters won't land or will even crash!

Cargo deployment.

Using the AI_CARGO_HELICOPTER.Deploy() method, you are able to direct the helicopters towards a point on the battlefield to unboard/unload the cargo at the specific coordinate. Ensure that the landing zone is horizontally flat, and that trees cannot be found in the landing vicinity, or the helicopters won't land or will even crash!

Infantry health.

When infantry is unboarded from the helicopters, the infantry is actually respawned into the battlefield. As a result, the unboarding infantry is very healthy every time it unboards. This is due to the limitation of the DCS simulator, which is not able to specify the health of new spawned units as a parameter. However, infantry that was destroyed when unboarded, won't be respawned again. Destroyed is destroyed. As a result, there is some additional strength that is gained when an unboarding action happens, but in terms of simulation balance this has marginal impact on the overall battlefield simulation. Fortunately, the firing strength of infantry is limited, and thus, respacing healthy infantry every time is not so much of an issue ...


Global AI_CARGO_QUEUE

Type(s)

Fields and Methods inherited from AI_CARGO_HELICOPTER Description

AI_CARGO_HELICOPTER.Coalition

AI_CARGO_HELICOPTER:Deploy(Coordinate, Speed)

Deploy Trigger for AI_CARGO_HELICOPTER

AI_CARGO_HELICOPTER.DeployZone

AI_CARGO_HELICOPTER.Helicopter

AI_CARGO_HELICOPTER:Home(Coordinate, Speed, Height)

Home Trigger for AI_CARGO_HELICOPTER

AI_CARGO_HELICOPTER:New(Helicopter, CargoSet)

Creates a new AI_CARGO_HELICOPTER object.

AI_CARGO_HELICOPTER:OnAfterDeploy(From, Event, To, Coordinate, Speed)

Deploy Handler OnAfter for AI_CARGO_HELICOPTER

AI_CARGO_HELICOPTER:OnAfterDeployed(From, Event, To)

Deployed Handler OnAfter for AI_CARGO_HELICOPTER

AI_CARGO_HELICOPTER:OnAfterPickedUp(Helicopter, From, Event, To, Unit)

PickedUp Handler OnAfter for AI_CARGO_HELICOPTER - Cargo set has been picked up, ready to deploy

AI_CARGO_HELICOPTER:OnAfterPickup(From, Event, To, Coordinate, Speed)

Pickup Handler OnAfter for AI_CARGO_HELICOPTER

AI_CARGO_HELICOPTER:OnAfterUnloaded(From, Event, To, Cargo, Unit)

Unloaded Handler OnAfter for AI_CARGO_HELICOPTER - Cargo unloaded, carrier is empty

AI_CARGO_HELICOPTER:OnBeforeDeploy(From, Event, To, Coordinate, Speed)

Deploy Handler OnBefore for AI_CARGO_HELICOPTER

AI_CARGO_HELICOPTER:OnBeforePickup(From, Event, To, Coordinate)

Pickup Handler OnBefore for AI_CARGO_HELICOPTER

AI_CARGO_HELICOPTER:Pickup(Coordinate, Speed)

Pickup Trigger for AI_CARGO_HELICOPTER

AI_CARGO_HELICOPTER.PickupZone

AI_CARGO_HELICOPTER.RouteDeploy

AI_CARGO_HELICOPTER.RouteHome

AI_CARGO_HELICOPTER.RoutePickup

AI_CARGO_HELICOPTER:SetCarrier(Helicopter)

Set the Carrier.

AI_CARGO_HELICOPTER:SetLandingSpeedAndHeight(speed, height)

Set landingspeed and -height for helicopter landings.

AI_CARGO_HELICOPTER.Zone

AI_CARGO_HELICOPTER:_Deploy(AICargoHelicopter, Coordinate, DeployZone)

Depoloy function and queue.

AI_CARGO_HELICOPTER.__Deploy(Delay, self, Coordinate, Speed)

Deploy Asynchronous Trigger for AI_CARGO_HELICOPTER

AI_CARGO_HELICOPTER.__Home(Delay, self, Coordinate, Speed, Height)

Home Asynchronous Trigger for AI_CARGO_HELICOPTER

AI_CARGO_HELICOPTER:__Pickup(Delay, Coordinate, Speed)

Pickup Asynchronous Trigger for AI_CARGO_HELICOPTER

AI_CARGO_HELICOPTER.landingheight

AI_CARGO_HELICOPTER.landingspeed

AI_CARGO_HELICOPTER:onafterDeploy(Helicopter, From, Event, To, Coordinate, Speed, Height, DeployZone)

On after Deploy event.

AI_CARGO_HELICOPTER:onafterDeployed(Helicopter, From, Event, To, Cargo, Deployed, DeployZone)

On after Deployed event.

AI_CARGO_HELICOPTER:onafterHome(Helicopter, From, Event, To, Coordinate, Speed, Height, HomeZone)

On after Home event.

AI_CARGO_HELICOPTER:onafterLanded(Helicopter, From, Event, To)

AI_CARGO_HELICOPTER:onafterOrbit(Helicopter, From, Event, To, Coordinate, Speed)

AI_CARGO_HELICOPTER:onafterPickup(Helicopter, From, Event, To, Coordinate, Speed, Height, PickupZone)

On after Pickup event.

AI_CARGO_HELICOPTER:onafterQueue(Helicopter, From, Event, To, Coordinate, Speed, DeployZone)

Fields and Methods inherited from FSM_CONTROLLABLE Description

AI_CARGO_HELICOPTER.Controllable

AI_CARGO_HELICOPTER:GetControllable()

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_CARGO_HELICOPTER:New(FSMT, Controllable)

Creates a new FSM_CONTROLLABLE object.

AI_CARGO_HELICOPTER:OnAfterStop(Controllable, From, Event, To)

OnAfter Transition Handler for Event Stop.

AI_CARGO_HELICOPTER:OnBeforeStop(Controllable, From, Event, To)

OnBefore Transition Handler for Event Stop.

AI_CARGO_HELICOPTER:OnEnterStopped(Controllable, From, Event, To)

OnEnter Transition Handler for State Stopped.

AI_CARGO_HELICOPTER:OnLeaveStopped(Controllable, From, Event, To)

OnLeave Transition Handler for State Stopped.

AI_CARGO_HELICOPTER:SetControllable(FSMControllable)

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_CARGO_HELICOPTER:Stop()

Synchronous Event Trigger for Event Stop.

AI_CARGO_HELICOPTER:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

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

Fields and Methods inherited from FSM Description

AI_CARGO_HELICOPTER:AddEndState(State)

Adds an End state.

AI_CARGO_HELICOPTER: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_HELICOPTER:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

AI_CARGO_HELICOPTER:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

AI_CARGO_HELICOPTER.CallScheduler

Call scheduler.

AI_CARGO_HELICOPTER.ClassName

Name of the class.

AI_CARGO_HELICOPTER.Events

AI_CARGO_HELICOPTER:GetCurrentState()

Get current state.

AI_CARGO_HELICOPTER:GetEndStates()

Returns the End states.

AI_CARGO_HELICOPTER:GetProcess(From, Event)

AI_CARGO_HELICOPTER:GetProcesses()

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

AI_CARGO_HELICOPTER:GetScores()

Returns a table with the scores defined.

AI_CARGO_HELICOPTER:GetStartState()

Returns the start state of the FSM.

AI_CARGO_HELICOPTER:GetState()

Get current state.

AI_CARGO_HELICOPTER:GetSubs()

Returns a table with the Subs defined.

AI_CARGO_HELICOPTER:GetTransitions()

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

AI_CARGO_HELICOPTER:Is(State)

Check if FSM is in state.

AI_CARGO_HELICOPTER:LoadCallBacks(CallBackTable)

Load call backs.

AI_CARGO_HELICOPTER:New()

Creates a new FSM object.

AI_CARGO_HELICOPTER.Scores

Scores.

AI_CARGO_HELICOPTER:SetProcess(From, Event, Fsm)

AI_CARGO_HELICOPTER:SetStartState(State)

Sets the start state of the FSM.

AI_CARGO_HELICOPTER._EndStates

AI_CARGO_HELICOPTER._EventSchedules

AI_CARGO_HELICOPTER._Processes

AI_CARGO_HELICOPTER._Scores

AI_CARGO_HELICOPTER._StartState

AI_CARGO_HELICOPTER._Transitions

AI_CARGO_HELICOPTER:_add_to_map(Map, Event)

Add to map.

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

Call handler.

AI_CARGO_HELICOPTER:_create_transition(EventName)

Create transition.

AI_CARGO_HELICOPTER:_delayed_transition(EventName)

Delayed transition.

AI_CARGO_HELICOPTER:_eventmap(Events, EventStructure)

Event map.

AI_CARGO_HELICOPTER:_gosub(ParentFrom, ParentEvent)

Go sub.

AI_CARGO_HELICOPTER:_handler(EventName, ...)

Handler.

AI_CARGO_HELICOPTER:_isendstate(Current)

Is end state.

AI_CARGO_HELICOPTER:_submap(subs, sub, name)

Sub maps.

AI_CARGO_HELICOPTER:can(e)

Check if can do an event.

AI_CARGO_HELICOPTER:cannot(e)

Check if cannot do an event.

AI_CARGO_HELICOPTER.current

Current state name.

AI_CARGO_HELICOPTER.endstates

AI_CARGO_HELICOPTER:is(State, state)

Check if FSM is in state.

AI_CARGO_HELICOPTER.options

Options.

AI_CARGO_HELICOPTER.subs

Subs.

Fields and Methods inherited from BASE Description

AI_CARGO_HELICOPTER.ClassID

The ID number of the class.

AI_CARGO_HELICOPTER.ClassName

The name of the class.

AI_CARGO_HELICOPTER.ClassNameAndID

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

AI_CARGO_HELICOPTER:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

AI_CARGO_HELICOPTER:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

AI_CARGO_HELICOPTER:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

AI_CARGO_HELICOPTER:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

AI_CARGO_HELICOPTER:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

AI_CARGO_HELICOPTER:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

AI_CARGO_HELICOPTER:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

AI_CARGO_HELICOPTER:E(Arguments)

Log an exception which will be traced always.

AI_CARGO_HELICOPTER:EventDispatcher()

Returns the event dispatcher

AI_CARGO_HELICOPTER:EventRemoveAll()

Remove all subscribed events

AI_CARGO_HELICOPTER:F(Arguments)

Trace a function call.

AI_CARGO_HELICOPTER:F2(Arguments)

Trace a function call level 2.

AI_CARGO_HELICOPTER:F3(Arguments)

Trace a function call level 3.

AI_CARGO_HELICOPTER:GetClassID()

Get the ClassID of the class instance.

AI_CARGO_HELICOPTER:GetClassName()

Get the ClassName of the class instance.

AI_CARGO_HELICOPTER:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

AI_CARGO_HELICOPTER:GetEventPriority()

Get the Class Event processing Priority.

AI_CARGO_HELICOPTER:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

AI_CARGO_HELICOPTER:GetState(Object, Key)

Get a Value given a Key from the Object.

AI_CARGO_HELICOPTER:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

AI_CARGO_HELICOPTER:I(Arguments)

Log an information which will be traced always.

AI_CARGO_HELICOPTER:Inherit(Child, Parent)

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

AI_CARGO_HELICOPTER:IsInstanceOf(ClassName)

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

AI_CARGO_HELICOPTER:IsTrace()

Enquires if tracing is on (for the class).

AI_CARGO_HELICOPTER:New()

BASE constructor.

AI_CARGO_HELICOPTER:OnEvent(EventData)

Occurs when an Event for an object is triggered.

AI_CARGO_HELICOPTER:OnEventBDA(EventData)

BDA.

AI_CARGO_HELICOPTER:OnEventBaseCaptured(EventData)

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

AI_CARGO_HELICOPTER:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

AI_CARGO_HELICOPTER:OnEventCrash(EventData)

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

AI_CARGO_HELICOPTER:OnEventDead(EventData)

Occurs when an object is dead.

AI_CARGO_HELICOPTER:OnEventDetailedFailure(EventData)

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

AI_CARGO_HELICOPTER:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

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

AI_CARGO_HELICOPTER:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

AI_CARGO_HELICOPTER:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

AI_CARGO_HELICOPTER:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

AI_CARGO_HELICOPTER:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

AI_CARGO_HELICOPTER:OnEventKill(EventData)

Occurs on the death of a unit.

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

AI_CARGO_HELICOPTER:OnEventLandingAfterEjection(EventData)

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

AI_CARGO_HELICOPTER:OnEventLandingQualityMark(EventData)

Landing quality mark.

AI_CARGO_HELICOPTER:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

AI_CARGO_HELICOPTER:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

AI_CARGO_HELICOPTER:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

AI_CARGO_HELICOPTER:OnEventMissionEnd(EventData)

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

AI_CARGO_HELICOPTER:OnEventMissionStart(EventData)

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

AI_CARGO_HELICOPTER:OnEventParatrooperLanding(EventData)

Weapon add.

AI_CARGO_HELICOPTER:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

AI_CARGO_HELICOPTER:OnEventPlayerEnterAircraft(EventData)

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

AI_CARGO_HELICOPTER:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

AI_CARGO_HELICOPTER:OnEventPlayerLeaveUnit(EventData)

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

AI_CARGO_HELICOPTER:OnEventRefueling(EventData)

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

AI_CARGO_HELICOPTER:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

AI_CARGO_HELICOPTER:OnEventScore(EventData)

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

AI_CARGO_HELICOPTER:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

AI_CARGO_HELICOPTER:OnEventShootingStart(EventData)

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

AI_CARGO_HELICOPTER:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

AI_CARGO_HELICOPTER:OnEventTakeoff(EventData)

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

AI_CARGO_HELICOPTER:OnEventTriggerZone(EventData)

Trigger zone.

AI_CARGO_HELICOPTER:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

AI_CARGO_HELICOPTER:ScheduleStop(SchedulerID)

Stops the Schedule.

AI_CARGO_HELICOPTER.Scheduler

AI_CARGO_HELICOPTER:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

AI_CARGO_HELICOPTER:SetState(Object, Key, Value)

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

AI_CARGO_HELICOPTER:T(Arguments)

Trace a function logic level 1.

AI_CARGO_HELICOPTER:T2(Arguments)

Trace a function logic level 2.

AI_CARGO_HELICOPTER:T3(Arguments)

Trace a function logic level 3.

AI_CARGO_HELICOPTER:TraceAll(TraceAll)

Trace all methods in MOOSE

AI_CARGO_HELICOPTER:TraceClass(Class)

Set tracing for a class

AI_CARGO_HELICOPTER:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

AI_CARGO_HELICOPTER:TraceLevel(Level)

Set trace level

AI_CARGO_HELICOPTER:TraceOff()

Set trace off.

AI_CARGO_HELICOPTER:TraceOn()

Set trace on.

AI_CARGO_HELICOPTER: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_HELICOPTER:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

AI_CARGO_HELICOPTER._

AI_CARGO_HELICOPTER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

AI_CARGO_HELICOPTER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

AI_CARGO_HELICOPTER.__

AI_CARGO_HELICOPTER:onEvent(event)

The main event handling function...

Field(s)

AI_CARGO_HELICOPTER.DeployZone

Keep the DeployZone, because when the helo has landed, we want to provide the DeployZone to the mission designer as part of the Unloaded event.

Function(s)

Deploy Trigger for AI_CARGO_HELICOPTER

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Place at which the cargo is deployed.

#number Speed

Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.

Home Trigger for AI_CARGO_HELICOPTER

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Place to which the helicopter will go.

#number Speed

(optional) Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.

#number Height

(optional) Height the Helicopter should be flying at.

Creates a new AI_CARGO_HELICOPTER object.

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Wrapper.Group#GROUP Helicopter

Return value:

Deploy Handler OnAfter for AI_CARGO_HELICOPTER

Defined in:

AI_CARGO_HELICOPTER

Parameters:

#string From

#string Event

#string To

#number Speed

Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.

Deployed Handler OnAfter for AI_CARGO_HELICOPTER

Defined in:

AI_CARGO_HELICOPTER

Parameters:

#string From

#string Event

#string To

PickedUp Handler OnAfter for AI_CARGO_HELICOPTER - Cargo set has been picked up, ready to deploy

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Wrapper.Group#GROUP Helicopter

The helicopter #GROUP object

#string From

#string Event

#string To

The helicopter #UNIT object

Pickup Handler OnAfter for AI_CARGO_HELICOPTER

Defined in:

AI_CARGO_HELICOPTER

Parameters:

#string From

#string Event

#string To

#number Speed

Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.

Unloaded Handler OnAfter for AI_CARGO_HELICOPTER - Cargo unloaded, carrier is empty

Defined in:

AI_CARGO_HELICOPTER

Parameters:

#string From

#string Event

#string To

The #CARGO_GROUP object.

The helicopter #UNIT object

Deploy Handler OnBefore for AI_CARGO_HELICOPTER

Defined in:

AI_CARGO_HELICOPTER

Parameters:

#string From

#string Event

#string To

Place at which cargo is deployed.

#number Speed

Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.

Return value:

#boolean:

Pickup Handler OnBefore for AI_CARGO_HELICOPTER

Defined in:

AI_CARGO_HELICOPTER

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

Pickup Trigger for AI_CARGO_HELICOPTER

Defined in:

AI_CARGO_HELICOPTER

Parameters:

#number Speed

Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.

Set the Carrier.

Defined in:

AI_CARGO_HELICOPTER

Parameter:

Wrapper.Group#GROUP Helicopter

Return value:

Set landingspeed and -height for helicopter landings.

Adjust after tracing if your helis get stuck after landing.

Defined in:

AI_CARGO_HELICOPTER

Parameters:

#number speed

Landing speed in kph(!), e.g. 15

#number height

Landing height in meters(!), e.g. 5.5

Return value:

Usage:

If your choppers get stuck, add tracing to your script to determine if they hit the right parameters like so:
   
       BASE:TraceOn()
       BASE:TraceClass("AI_CARGO_HELICOPTER")
       
Watch the DCS.log for entries stating `Helicopter:<name>, Height = Helicopter:<number>, Velocity = Helicopter:<number>`
Adjust if necessary.

Depoloy function and queue.

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Wrapper.Group#GROUP AICargoHelicopter

Coordinate

DeployZone

Deploy Asynchronous Trigger for AI_CARGO_HELICOPTER

Defined in:

AI_CARGO_HELICOPTER

Parameters:

#number Delay

Delay in seconds.

Place at which the cargo is deployed.

#number Speed

Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.

Home Asynchronous Trigger for AI_CARGO_HELICOPTER

Defined in:

AI_CARGO_HELICOPTER

Parameters:

#number Delay

Delay in seconds.

Place to which the helicopter will go.

#number Speed

(optional) Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.

#number Height

(optional) Height the Helicopter should be flying at.

Pickup Asynchronous Trigger for AI_CARGO_HELICOPTER

Defined in:

AI_CARGO_HELICOPTER

Parameters:

#number Delay

Delay in seconds.

#number Speed

Speed in km/h to go to the pickup coordinate. Default is 50% of max possible speed the unit can go.

On after Deploy event.

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Wrapper.Group#GROUP Helicopter

Transport helicopter.

From

Event

To

Place at which the cargo is deployed.

#number Speed

Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.

#number Height

Height in meters to move to the deploy coordinate.

DeployZone

On after Deployed event.

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Wrapper.Group#GROUP Helicopter

#string From

From state.

#string Event

Event.

#string To

To state.

Cargo object.

#boolean Deployed

Cargo is deployed.

DeployZone

Return value:

#boolean:

True if all cargo has been unloaded.

On after Home event.

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Wrapper.Group#GROUP Helicopter

From

Event

To

Home place.

#number Speed

Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.

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

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Wrapper.Group#GROUP Helicopter

From

Event

To

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Wrapper.Group#GROUP Helicopter

From

Event

To

#number Speed

On after Pickup event.

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Wrapper.Group#GROUP Helicopter

From

Event

To

Pickup place.

#number Speed

Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.

#number Height

Height in meters to move to the pickup coordinate. This parameter is ignored for APCs.

Core.Zone#ZONE PickupZone

(optional) The zone where the cargo will be picked up. The PickupZone can be nil, if there wasn't any PickupZoneSet provided.

Defined in:

AI_CARGO_HELICOPTER

Parameters:

Wrapper.Group#GROUP Helicopter

From

Event

To

#number Speed

DeployZone

Field(s)

AI_CARGO_HELICOPTER.DeployZone

Keep the DeployZone, because when the helo has landed, we want to provide the DeployZone to the mission designer as part of the Unloaded event.

Function(s)

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Creates a new FSM_CONTROLLABLE object.

Defined in:

Parameters:

#table FSMT

Finite State Machine Table

(optional) The CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Return value:

OnAfter Transition Handler for Event Stop.

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnBefore Transition Handler for Event Stop.

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

OnEnter Transition Handler for State Stopped.

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnLeave Transition Handler for State Stopped.

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Defined in:

Parameter:

Return value:

Synchronous Event Trigger for Event Stop.

Asynchronous Event Trigger for Event Stop.

Defined in:

Parameter:

#number Delay

The delay in seconds.

Field(s)

AI_CARGO_HELICOPTER.DeployZone

Keep the DeployZone, because when the helo has landed, we want to provide the DeployZone to the mission designer as part of the Unloaded event.

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)

AI_CARGO_HELICOPTER.DeployZone

Keep the DeployZone, because when the helo has landed, we want to provide the DeployZone to the mission designer as part of the Unloaded event.

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