Banner Image

Module AI.AI_Cargo

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo.


Author: FlightControl


Global(s)

Global AI_CARGO

Base class for the dynamic cargo handling capability for AI groups.

#AI_CARGO AI_CARGO

Base class for the dynamic cargo handling capability for AI groups.

Carriers can be mobilized to intelligently transport infantry and other cargo within the simulation. The AI_CARGO module uses the Cargo.Cargo capabilities within the MOOSE framework. CARGO derived objects must be declared within the mission to make the AI_CARGO object recognize the cargo. Please consult the Cargo.Cargo module for more information.

The derived classes from this module are:

Type(s)

Fields and Methods inherited from AI_CARGO Description

AI_CARGO.CargoCarrier

AI_CARGO.CargoSet

AI_CARGO.Carrier_Cargo

AI_CARGO:Deploy(Coordinate, Speed)

Deploy Trigger for AI_CARGO

AI_CARGO:IsRelocating()

AI_CARGO:IsTransporting()

AI_CARGO:New(Carrier, CargoSet, CombatRadius)

Creates a new AI_CARGO object.

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

Deploy Handler OnAfter for AI_CARGO

AI_CARGO:OnAfterDeployed(Carrier, From, Event, To, DeployZone, Defend)

On after Deployed event.

AI_CARGO:OnAfterLoaded(Carrier, From, Event, To)

Loaded Handler OnAfter for AI_CARGO

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

Pickup Handler OnAfter for AI_CARGO

AI_CARGO:OnAfterUnloaded(Carrier, From, Event, To)

Unloaded Handler OnAfter for AI_CARGO

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

Deploy Handler OnBefore for AI_CARGO

AI_CARGO:OnBeforePickup(From, Event, To, Coordinate, Speed)

Pickup Handler OnBefore for AI_CARGO

AI_CARGO:Pickup(Coordinate, Speed)

Pickup Trigger for AI_CARGO

AI_CARGO.Relocating

AI_CARGO.Transporting

AI_CARGO:__Deploy(Delay, Coordinate, Speed)

Deploy Asynchronous Trigger for AI_CARGO

AI_CARGO:__Pickup(Delay, Coordinate, Speed)

Pickup Asynchronous Trigger for AI_CARGO

AI_CARGO:onafterBoard(Carrier, From, Event, To, Cargo, CarrierUnit, PickupZone)

On after Board event.

AI_CARGO:onafterDeploy(APC, From, Event, To, Coordinate, Speed, Height, DeployZone)

On after Deploy event.

AI_CARGO:onafterDeployed(Carrier, From, Event, To, DeployZone, Defend)

On after Deployed event.

AI_CARGO:onafterLoaded(Carrier, From, Event, To, PickupZone, Cargo)

On after Loaded event.

AI_CARGO:onafterPickedUp(Carrier, From, Event, To, PickupZone)

On after PickedUp event.

AI_CARGO:onafterPickup(APC, From, Event, To, Coordinate, Speed, Height, PickupZone)

On after Pickup event.

AI_CARGO:onafterUnboard(Carrier, From, Event, To, Cargo, DeployZone, CarrierUnit, Defend)

On after Unboard event.

AI_CARGO:onafterUnload(Carrier, From, Event, To, DeployZone, Defend)

On after Unload event.

AI_CARGO:onafterUnloaded(Carrier, From, Event, To, Cargo, Deployed, DeployZone, CarrierUnit, Defend)

On after Unloaded event.

AI_CARGO:onbeforeLoad(Carrier, From, Event, To, PickupZone)

On before Load event.

AI_CARGO:onbeforeReload(Carrier, From, Event, To, PickupZone)

On before Reload event.

Fields and Methods inherited from FSM_CONTROLLABLE Description

AI_CARGO.Controllable

AI_CARGO:GetControllable()

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_CARGO:New(FSMT, Controllable)

Creates a new FSM_CONTROLLABLE object.

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

OnAfter Transition Handler for Event Stop.

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

OnBefore Transition Handler for Event Stop.

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

OnEnter Transition Handler for State Stopped.

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

OnLeave Transition Handler for State Stopped.

AI_CARGO:SetControllable(FSMControllable)

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_CARGO:Stop()

Synchronous Event Trigger for Event Stop.

AI_CARGO:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

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

Fields and Methods inherited from FSM Description

AI_CARGO:AddEndState(State)

Adds an End state.

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

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

AI_CARGO:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

AI_CARGO.CallScheduler

AI_CARGO.Events

AI_CARGO:GetCurrentState()

AI_CARGO:GetEndStates()

Returns the End states.

AI_CARGO:GetProcess(From, Event)

AI_CARGO:GetProcesses()

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

AI_CARGO:GetScores()

Returns a table with the scores defined.

AI_CARGO:GetStartState()

Returns the start state of the FSM.

AI_CARGO:GetState()

AI_CARGO:GetSubs()

Returns a table with the Subs defined.

AI_CARGO:GetTransitions()

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

AI_CARGO:Is(State)

AI_CARGO:LoadCallBacks(CallBackTable)

AI_CARGO:New()

Creates a new FSM object.

AI_CARGO.Scores

AI_CARGO:SetProcess(From, Event, Fsm)

AI_CARGO:SetStartState(State)

Sets the start state of the FSM.

AI_CARGO._EndStates

AI_CARGO._EventSchedules

AI_CARGO._Processes

AI_CARGO._Scores

AI_CARGO._StartState

AI_CARGO._Transitions

AI_CARGO:_add_to_map(Map, Event)

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

AI_CARGO:_create_transition(EventName)

AI_CARGO:_delayed_transition(EventName)

AI_CARGO:_eventmap(Events, EventStructure)

AI_CARGO:_gosub(ParentFrom, ParentEvent)

AI_CARGO:_handler(EventName, ...)

AI_CARGO:_isendstate(Current)

AI_CARGO:_submap(subs, sub, name)

AI_CARGO:can(e)

AI_CARGO:cannot(e)

AI_CARGO.current

AI_CARGO.endstates

AI_CARGO:is(state)

AI_CARGO.options

AI_CARGO.subs

Fields and Methods inherited from BASE Description

AI_CARGO.ClassID

The ID number of the class.

AI_CARGO.ClassName

The name of the class.

AI_CARGO.ClassNameAndID

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

AI_CARGO:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

AI_CARGO:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

AI_CARGO:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

AI_CARGO:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

AI_CARGO:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

AI_CARGO:E(Arguments)

Log an exception which will be traced always.

AI_CARGO:EventDispatcher()

Returns the event dispatcher

AI_CARGO:EventRemoveAll()

Remove all subscribed events

AI_CARGO:F(Arguments)

Trace a function call.

AI_CARGO:F2(Arguments)

Trace a function call level 2.

AI_CARGO:F3(Arguments)

Trace a function call level 3.

AI_CARGO:GetClassID()

Get the ClassID of the class instance.

AI_CARGO:GetClassName()

Get the ClassName of the class instance.

AI_CARGO:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

AI_CARGO:GetEventPriority()

Get the Class Event processing Priority.

AI_CARGO:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

AI_CARGO:GetState(Object, Key)

Get a Value given a Key from the Object.

AI_CARGO:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

AI_CARGO:I(Arguments)

Log an information which will be traced always.

AI_CARGO:Inherit(Child, Parent)

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

AI_CARGO:IsInstanceOf(ClassName)

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

AI_CARGO:IsTrace()

Enquires if tracing is on (for the class).

AI_CARGO:New()

BASE constructor.

AI_CARGO:OnEvent(EventData)

Occurs when an object is completely destroyed.

AI_CARGO:OnEventBaseCaptured(EventData)

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

AI_CARGO:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

AI_CARGO:OnEventCrash(EventData)

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

AI_CARGO:OnEventDead(EventData)

Occurs when an object is dead.

AI_CARGO:OnEventDetailedFailure(EventData)

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

AI_CARGO:OnEventEjection(EventData)

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

AI_CARGO:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

AI_CARGO:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

AI_CARGO:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

AI_CARGO:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

AI_CARGO:OnEventKill(EventData)

Occurs on the death of a unit.

AI_CARGO: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:OnEventLandingAfterEjection(EventData)

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

AI_CARGO:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

AI_CARGO:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

AI_CARGO:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

AI_CARGO:OnEventMissionEnd(EventData)

Occurs when a mission ends

AI_CARGO:OnEventMissionStart(EventData)

Occurs when a mission starts

AI_CARGO:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

AI_CARGO:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

AI_CARGO:OnEventPlayerLeaveUnit(EventData)

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

AI_CARGO:OnEventRefueling(EventData)

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

AI_CARGO:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

AI_CARGO:OnEventScore(EventData)

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

AI_CARGO:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

AI_CARGO:OnEventShootingStart(EventData)

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

AI_CARGO:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

AI_CARGO:OnEventTakeoff(EventData)

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

AI_CARGO:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

AI_CARGO:ScheduleStop(SchedulerFunction)

Stops the Schedule.

AI_CARGO.Scheduler

AI_CARGO:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

AI_CARGO:SetState(Object, Key, Value)

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

AI_CARGO:T(Arguments)

Trace a function logic level 1.

AI_CARGO:T2(Arguments)

Trace a function logic level 2.

AI_CARGO:T3(Arguments)

Trace a function logic level 3.

AI_CARGO:TraceAll(TraceAll)

Trace all methods in MOOSE

AI_CARGO:TraceClass(Class)

Set tracing for a class

AI_CARGO:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

AI_CARGO:TraceLevel(Level)

Set trace level

AI_CARGO:TraceOff()

Set trace off.

AI_CARGO:TraceOn()

Set trace on.

AI_CARGO: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:UnHandleEvent(Event)

UnSubscribe to a DCS event.

AI_CARGO._

AI_CARGO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

AI_CARGO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

AI_CARGO.__

AI_CARGO:onEvent(event)

Field(s)

Function(s)

Deploy Trigger for AI_CARGO

Defined in:

AI_CARGO

Parameters:

#number Speed

Speed in km/h. Default is 50% of max possible speed the group can do.

Defined in:

AI_CARGO

Defined in:

AI_CARGO

Creates a new AI_CARGO object.

Defined in:

AI_CARGO

Parameters:

#number CombatRadius

Return value:

Deploy Handler OnAfter for AI_CARGO

Defined in:

AI_CARGO

Parameters:

#string From

#string Event

#string To

#number Speed

Speed in km/h. Default is 50% of max possible speed the group can do.

On after Deployed event.

Defined in:

AI_CARGO

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Zone#ZONE DeployZone

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

#boolean Defend

Defend for APCs.

Loaded Handler OnAfter for AI_CARGO

Defined in:

AI_CARGO

Parameters:

#string From

#string Event

#string To

Pickup Handler OnAfter for AI_CARGO

Defined in:

AI_CARGO

Parameters:

#string From

#string Event

#string To

#number Speed

Speed in km/h. Default is 50% of max possible speed the group can do.

Unloaded Handler OnAfter for AI_CARGO

Defined in:

AI_CARGO

Parameters:

#string From

#string Event

#string To

Deploy Handler OnBefore for AI_CARGO

Defined in:

AI_CARGO

Parameters:

#string From

#string Event

#string To

#number Speed

Speed in km/h. Default is 50% of max possible speed the group can do.

Return value:

#boolean:

Pickup Handler OnBefore for AI_CARGO

Defined in:

AI_CARGO

Parameters:

#string From

#string Event

#string To

#number Speed

Speed in km/h. Default is 50% of max possible speed the group can do.

Return value:

#boolean:

Pickup Trigger for AI_CARGO

Defined in:

AI_CARGO

Parameters:

#number Speed

Speed in km/h. Default is 50% of max possible speed the group can do.

Deploy Asynchronous Trigger for AI_CARGO

Defined in:

AI_CARGO

Parameters:

#number Delay

#number Speed

Speed in km/h. Default is 50% of max possible speed the group can do.

Pickup Asynchronous Trigger for AI_CARGO

Defined in:

AI_CARGO

Parameters:

#number Delay

Pickup place. If not given, loading starts at the current location.

#number Speed

Speed in km/h. Default is 50% of max possible speed the group can do.

On after Board event.

Defined in:

AI_CARGO

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Cargo object.

Wrapper.Unit#UNIT CarrierUnit

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.

On after Deploy event.

Defined in:

AI_CARGO

Parameters:

From

Event

To

Deploy place.

#number Speed

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

#number Height

Height in meters to move to the deploy coordinate.

Core.Zone#ZONE DeployZone

The zone where the cargo will be deployed.

On after Deployed event.

Defined in:

AI_CARGO

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Zone#ZONE DeployZone

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

#boolean Defend

Defend for APCs.

On after Loaded event.

Defined in:

AI_CARGO

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

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.

Cargo

Return value:

#boolean:

Cargo loaded.

On after PickedUp event.

Defined in:

AI_CARGO

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

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.

On after Pickup event.

Defined in:

AI_CARGO

Parameters:

From

Event

To

of the pickup point.

#number Speed

Speed in km/h to drive 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 PickupZone

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

On after Unboard event.

Defined in:

AI_CARGO

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#string Cargo

Cargo#CARGO Cargo Cargo object.

Core.Zone#ZONE DeployZone

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

CarrierUnit

Defend

On after Unload event.

Defined in:

AI_CARGO

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Zone#ZONE DeployZone

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

Defend

On after Unloaded event.

Defined in:

AI_CARGO

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#string Cargo

Cargo#CARGO Cargo Cargo object.

#boolean Deployed

Cargo is deployed.

Core.Zone#ZONE DeployZone

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

CarrierUnit

Defend

On before Load event.

Defined in:

AI_CARGO

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

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.

On before Reload event.

Defined in:

AI_CARGO

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

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.

Field(s)

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.

Defined in:

Parameters:

step

trigger

params

EventName

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:

Defined in:

Parameters:

From

Event

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

Defined in:

Parameter:

CallBackTable

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.

Defined in:

Parameters:

Map

Event

Defined in:

Parameters:

step

trigger

params

EventName

Defined in:

Parameter:

EventName

Defined in:

Parameter:

EventName

Defined in:

Parameters:

Events

EventStructure

Defined in:

Parameters:

ParentFrom

ParentEvent

Defined in:

Parameters:

EventName

...

Defined in:

Parameter:

Current

Defined in:

Parameters:

subs

sub

name

Defined in:

Parameter:

e

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