Banner Image

Module Functional.AICSAR

Functional - AI CSAR system

Main Features:

  • Send out helicopters to downed pilots
  • Rescues players and AI alike
  • Coalition specific
  • Starting from a FARP or Airbase
  • Dedicated MASH zone
  • Some FSM functions to include in your mission scripts
  • Limit number of available helos

Example Missions:

Demo missions can be found on github.

  

Author: applevangelist

Last Update April 2022


Global(s)

Global AICSAR

I once donated a pint of my finest red corpuscles to the great American Red Cross and the doctor opined my blood was very helpful; contained so much alcohol they could use it to sterilize their instruments.
W.C.Fields


AICSAR Concept

For an AI or human pilot landing with a parachute, a rescue mission will be spawned.

#AICSAR AICSAR

I once donated a pint of my finest red corpuscles to the great American Red Cross and the doctor opined my blood was very helpful; contained so much alcohol they could use it to sterilize their instruments.
W.C.Fields


AICSAR Concept

For an AI or human pilot landing with a parachute, a rescue mission will be spawned.

The helicopter will fly to the pilot, pick him or her up, and fly back to a designated MASH (medical) zone, drop the pilot and then return to base. Operational maxdistance can be set as well as the landing radius around the downed pilot. Keep in mind that AI helicopters cannot hover-load at the time of writing, so rescue operations over water or in the mountains might not work. Optionally, if you have a CSAR operation with human pilots in your mission, you can set AICSAR to ignore missions when human helicopter pilots are around.

Setup

Setup is a one-liner:

       -- @param #string Alias Name of this instance.
       -- @param #number Coalition Coalition as in coalition.side.BLUE, can also be passed as "blue", "red" or "neutral"
       -- @param #string Pilottemplate Pilot template name.
       -- @param #string Helotemplate Helicopter template name.
       -- @param Wrapper.Airbase#AIRBASE FARP FARP object or Airbase from where to start.
       -- @param Core.Zone#ZONE MASHZone Zone where to drop pilots after rescue.
       local my_aicsar=AICSAR:New("Luftrettung",coalition.side.BLUE,"Downed Pilot","Rescue Helo",AIRBASE:FindByName("Test FARP"),ZONE:New("MASH"))

Options are

       my_aicsar.maxdistance -- maximum operational distance in meters. Defaults to 50NM or 92.6km
       my_aicsar.rescuezoneradius -- landing zone around downed pilot. Defaults to 200m
       my_aicsar.autoonoff -- stop operations when human helicopter pilots are around. Defaults to true.
       my_aicsar.verbose -- text messages to own coalition about ongoing operations. Defaults to true.
       my_aicsarlimithelos -- limit available number of helos going on mission (defaults to true)
       my_aicsar.helonumber -- number of helos available (default: 3)

Radio options

Radio messages, soundfile names and (for SRS) lengths are defined in three enumerators, so you can customize, localize messages and soundfiles to your liking:

Defaults are:

       AICSAR.Messages = {
         EN = {
         INITIALOK = "Roger, Pilot, we hear you. Stay where you are, a helo is on the way!",
         INITIALNOTOK = "Sorry, Pilot. You're behind maximum operational distance! Good Luck!",
         PILOTDOWN = "Pilot down at ", -- note that this will be appended with the position
         PILOTKIA = "Pilot KIA!",
         HELODOWN = "CSAR Helo Down!",
         PILOTRESCUED = "Pilot rescued!",
         PILOTINHELO = "Pilot picked up!",
         },
       }

Correspondingly, sound file names are defined as these defaults:

       AICSAR.RadioMessages = {
         EN = {
         INITIALOK = "initialok.ogg",
         INITIALNOTOK = "initialnotok.ogg",
         PILOTDOWN = "pilotdown.ogg",
         PILOTKIA = "pilotkia.ogg", 
         HELODOWN = "helodown.ogg", 
         PILOTRESCUED = "pilotrescued.ogg", 
         PILOTINHELO = "pilotinhelo.ogg",
         }, 
       }

and these default transmission lengths in seconds:

       AICSAR.RadioLength = {
         EN = {
         INITIALOK = 4.1,
         INITIALNOTOK = 4.6, 
         PILOTDOWN = 2.6,
         PILOTKIA = 1.1,
         HELODOWN = 2.1,
         PILOTRESCUED = 3.5,
         PILOTINHELO = 2.6,
         },
       }

The easiest way to add a soundfile to your mission is to use the "Sound to..." trigger in the mission editor. This will effectively save your sound file inside of the .miz mission file.

To customize or localize your texts and sounds, you can take e.g. the following approach to add a German language version:

      -- parameters are: locale, ID, text, soundfilename, duration
      my_aicsar.gettext:AddEntry("de","INITIALOK","Copy, Pilot, wir hören Sie. Bleiben Sie, wo Sie sind, ein Hubschrauber sammelt Sie auf!","okneu.ogg",5.0)
      my_aicsar.locale = "de" -- plays and shows the defined German language texts and sound. Fallback is "en", if something is undefined.

Switch on radio transmissions via either SRS or "normal" DCS radio e.g. like so:

     my_aicsar:SetSRSRadio(true,"C:\\Program Files\\DCS-SimpleRadio-Standalone",270,radio.modulation.AM,5002)

or

     my_aicsar:SetDCSRadio(true,300,radio.modulation.AM,GROUP:FindByName("FARP-Radio"))

See the function documentation for parameter details.


-

Type(s)

AICSAR , extends Core.Fsm#FSM , extends Core.Base#BASE
Fields and Methods inherited from AICSAR Description

AICSAR.ClassName

Name of this class.

AICSAR.DCSFrequency

AICSAR.DCSModulation

AICSAR.DCSRadio

AICSAR:DCSRadioBroadcast(Soundfile, Duration, Subtitle)

[Internal] Sound output via non-SRS Radio.

AICSAR.DCSRadioGroup

AICSAR.DCSRadioQueue

AICSAR:InitLocalization()

[Internal] Create the Moose TextAndSoundEntries

AICSAR.MGRS_Accuracy

AICSAR.Messages

AICSAR:New(Alias, Coalition, Pilottemplate, Helotemplate, FARP, MASHZone)

Function to create a new AICSAR object

AICSAR:OnAfterHeloDown(From, Event, To, Helo, Index)

On after "HeloDown" event.

AICSAR:OnAfterPilotDown(From, Event, To, Coordinate, InReach)

On after "PilotDown" event.

AICSAR:OnAfterPilotKIA(From, Event, To)

On after "PilotKIA" event.

AICSAR:OnAfterPilotPickedUp(From, Event, To, Helo, CargoTable, Index)

On after "PilotPickedUp" event.

AICSAR:OnAfterPilotRescued(From, Event, To)

On after "PilotRescued" event.

AICSAR:OnEventLandingAfterEjection(EventData)

[Internal] Catch the landing after ejection and spawn a pilot in situ.

AICSAR.RadioLength

AICSAR.RadioMessages

AICSAR.SRS

AICSAR.SRSFrequency

AICSAR.SRSModulation

AICSAR.SRSPath

AICSAR.SRSPort

AICSAR.SRSRadio

AICSAR.SRSSoundPath

AICSAR:SetDCSRadio(OnOff, Frequency, Modulation, Group)

[User] Switch sound output on and use normale (DCS) radio

AICSAR:SetSRSRadio(OnOff, Path, Frequency, Modulation, SoundPath, Port)

[User] Switch sound output on and use SRS

AICSAR:Status()

Triggers the FSM event "Status".

AICSAR:Stop()

Triggers the FSM event "Stop".

AICSAR:_CheckHelos()

[Internal] Check helo queue

AICSAR:_CheckInMashZone(Pilot)

[Internal] Check if pilot arrived in rescue zone (MASH)

AICSAR:_CheckQueue()

[Internal] Check pilot queue for next mission

AICSAR:_CountHelos()

[Internal] Count helos queue

AICSAR:_GetFlight()

[Internal] Get FlightGroup

AICSAR:_InitMission(Pilot, Index)

[Internal] Create a new rescue mission

AICSAR:__Status(delay)

Triggers the FSM event "Status" after a delay.

AICSAR:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

AICSAR.alias

Alias Name.

AICSAR.autoonoff

Only send a helo when no human heli pilots are available.

AICSAR.coalition

Colition side.

AICSAR.farp

FARP object from where to start.

AICSAR.farpzone

MASH zone to drop rescued pilots.

AICSAR.gettext

AICSAR.helonumber

number of helos available (default: 3)

AICSAR.helos

Table of Ops.FlightGroup#FLIGHTGROUP objects

AICSAR.helotemplate

Template for CSAR helo.

AICSAR.lid

LID for log entries.

AICSAR.limithelos

limit available number of helos going on mission (defaults to true)

AICSAR.locale

AICSAR.maxdistance

Max distance to go for a rescue.

AICSAR:onafterHeloDown(From, Event, To, Helo, Index)

[Internal] onafterHeloDown

AICSAR:onafterPilotDown(From, Event, To, Coordinate, InReach)

[Internal] onafterPilotDown

AICSAR:onafterPilotKIA(From, Event, To)

[Internal] onafterPilotKIA

AICSAR:onafterPilotPickedUp(From, Event, To, Helo, CargoTable, Index)

[Internal] onafterPilotPickedUp

AICSAR:onafterPilotRescued(From, Event, To)

[Internal] onafterPilotRescued

AICSAR:onafterStart(From, Event, To)

[Internal] onafterStart

AICSAR:onafterStatus(From, Event, To)

[Internal] onafterStatus

AICSAR:onafterStop(From, Event, To)

[Internal] onafterStop

AICSAR.pilotindex

Table index to bind pilot to helo.

AICSAR.pilotqueue

Queue of pilots to rescue.

AICSAR.playerset

Track if alive heli pilots are available.

AICSAR.rescued

Track number of rescued pilot.

AICSAR.rescuezoneradius

Radius around downed pilot for the helo to land in.

AICSAR.template

Template for pilot.

AICSAR.verbose

Switch more output.

AICSAR.version

Versioning.

Fields and Methods inherited from FSM Description

AICSAR:AddEndState(State)

Adds an End state.

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

AICSAR:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

AICSAR:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

AICSAR.CallScheduler

Call scheduler.

AICSAR.ClassName

Name of the class.

AICSAR.Events

AICSAR:GetCurrentState()

Get current state.

AICSAR:GetEndStates()

Returns the End states.

AICSAR:GetProcess(From, Event)

AICSAR:GetProcesses()

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

AICSAR:GetScores()

Returns a table with the scores defined.

AICSAR:GetStartState()

Returns the start state of the FSM.

AICSAR:GetState()

Get current state.

AICSAR:GetSubs()

Returns a table with the Subs defined.

AICSAR:GetTransitions()

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

AICSAR:Is(State)

Check if FSM is in state.

AICSAR:LoadCallBacks(CallBackTable)

Load call backs.

AICSAR:New()

Creates a new FSM object.

AICSAR.Scores

Scores.

AICSAR:SetProcess(From, Event, Fsm)

AICSAR:SetStartState(State)

Sets the start state of the FSM.

AICSAR._EndStates

AICSAR._EventSchedules

AICSAR._Processes

AICSAR._Scores

AICSAR._StartState

AICSAR._Transitions

AICSAR:_add_to_map(Map, Event)

Add to map.

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

Call handler.

AICSAR:_create_transition(EventName)

Create transition.

AICSAR:_delayed_transition(EventName)

Delayed transition.

AICSAR:_eventmap(Events, EventStructure)

Event map.

AICSAR:_gosub(ParentFrom, ParentEvent)

Go sub.

AICSAR:_handler(EventName, ...)

Handler.

AICSAR:_isendstate(Current)

Is end state.

AICSAR:_submap(subs, sub, name)

Sub maps.

AICSAR:can(e)

Check if can do an event.

AICSAR:cannot(e)

Check if cannot do an event.

AICSAR.current

Current state name.

AICSAR.endstates

AICSAR:is(State, state)

Check if FSM is in state.

AICSAR.options

Options.

AICSAR.subs

Subs.

Fields and Methods inherited from BASE Description

AICSAR.ClassID

The ID number of the class.

AICSAR.ClassName

The name of the class.

AICSAR.ClassNameAndID

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

AICSAR:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

AICSAR:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

AICSAR:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

AICSAR:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

AICSAR:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

AICSAR:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

AICSAR:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

AICSAR:E(Arguments)

Log an exception which will be traced always.

AICSAR:EventDispatcher()

Returns the event dispatcher

AICSAR:EventRemoveAll()

Remove all subscribed events

AICSAR:F(Arguments)

Trace a function call.

AICSAR:F2(Arguments)

Trace a function call level 2.

AICSAR:F3(Arguments)

Trace a function call level 3.

AICSAR:GetClassID()

Get the ClassID of the class instance.

AICSAR:GetClassName()

Get the ClassName of the class instance.

AICSAR:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

AICSAR:GetEventPriority()

Get the Class Event processing Priority.

AICSAR:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

AICSAR:GetState(Object, Key)

Get a Value given a Key from the Object.

AICSAR:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

AICSAR:I(Arguments)

Log an information which will be traced always.

AICSAR:Inherit(Child, Parent)

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

AICSAR:IsInstanceOf(ClassName)

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

AICSAR:IsTrace()

Enquires if tracing is on (for the class).

AICSAR:New()

BASE constructor.

AICSAR:OnEvent(EventData)

Occurs when an Event for an object is triggered.

AICSAR:OnEventBDA(EventData)

BDA.

AICSAR:OnEventBaseCaptured(EventData)

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

AICSAR:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

AICSAR:OnEventCrash(EventData)

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

AICSAR:OnEventDead(EventData)

Occurs when an object is dead.

AICSAR:OnEventDetailedFailure(EventData)

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

AICSAR:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

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

AICSAR:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

AICSAR:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

AICSAR:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

AICSAR:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

AICSAR:OnEventKill(EventData)

Occurs on the death of a unit.

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

AICSAR:OnEventLandingAfterEjection(EventData)

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

AICSAR:OnEventLandingQualityMark(EventData)

Landing quality mark.

AICSAR:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

AICSAR:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

AICSAR:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

AICSAR:OnEventMissionEnd(EventData)

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

AICSAR:OnEventMissionStart(EventData)

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

AICSAR:OnEventParatrooperLanding(EventData)

Weapon add.

AICSAR:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

AICSAR:OnEventPlayerEnterAircraft(EventData)

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

AICSAR:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

AICSAR:OnEventPlayerLeaveUnit(EventData)

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

AICSAR:OnEventRefueling(EventData)

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

AICSAR:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

AICSAR:OnEventScore(EventData)

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

AICSAR:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

AICSAR:OnEventShootingStart(EventData)

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

AICSAR:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

AICSAR:OnEventTakeoff(EventData)

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

AICSAR:OnEventTriggerZone(EventData)

Trigger zone.

AICSAR:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

AICSAR:ScheduleStop(SchedulerID)

Stops the Schedule.

AICSAR.Scheduler

AICSAR:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

AICSAR:SetState(Object, Key, Value)

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

AICSAR:T(Arguments)

Trace a function logic level 1.

AICSAR:T2(Arguments)

Trace a function logic level 2.

AICSAR:T3(Arguments)

Trace a function logic level 3.

AICSAR:TraceAll(TraceAll)

Trace all methods in MOOSE

AICSAR:TraceClass(Class)

Set tracing for a class

AICSAR:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

AICSAR:TraceLevel(Level)

Set trace level

AICSAR:TraceOff()

Set trace off.

AICSAR:TraceOn()

Set trace on.

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

AICSAR:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

AICSAR._

AICSAR:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

AICSAR:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

AICSAR.__

AICSAR:onEvent(event)

The main event handling function...

AI CSAR class.

Field(s)

#string AICSAR.ClassName

Name of this class.

#table AICSAR.Messages

TODO Messages - Messages enum @field Messages

#table AICSAR.RadioLength

TODO Radio Messages - Radio Messages enum for ogg files length in secs @field RadioLength

#table AICSAR.RadioMessages

TODO Radio Messages - Radio Messages enum for ogg files @field RadioMessages

#string AICSAR.alias

Alias Name.

#boolean AICSAR.autoonoff

Only send a helo when no human heli pilots are available.

#number AICSAR.coalition

Colition side.

Wrapper.Airbase#AIRBASE AICSAR.farp

FARP object from where to start.

Core.Zone#ZONE AICSAR.farpzone

MASH zone to drop rescued pilots.

AICSAR.gettext

English standard localization

#number AICSAR.helonumber

number of helos available (default: 3)

#table AICSAR.helos

Table of Ops.FlightGroup#FLIGHTGROUP objects

#string AICSAR.helotemplate

Template for CSAR helo.

#string AICSAR.lid

LID for log entries.

#boolean AICSAR.limithelos

limit available number of helos going on mission (defaults to true)

#string AICSAR.locale
#number AICSAR.maxdistance

Max distance to go for a rescue.

#number AICSAR.pilotindex

Table index to bind pilot to helo.

#table AICSAR.pilotqueue

Queue of pilots to rescue.

Core.Set#SET_CLIENT AICSAR.playerset

Track if alive heli pilots are available.

#table AICSAR.rescued

Track number of rescued pilot.

#number AICSAR.rescuezoneradius

Radius around downed pilot for the helo to land in.

#string AICSAR.template

Template for pilot.

#boolean AICSAR.verbose

Switch more output.

#string AICSAR.version

Versioning.

Function(s)

[Internal] Sound output via non-SRS Radio.

Add message files (.ogg) via "Sound to..." in the ME.

Defined in:

AICSAR

Parameters:

#string Soundfile

Name of the soundfile

#number Duration

Duration of the sound

#string Subtitle

Text to display

Return value:

self

[Internal] Create the Moose TextAndSoundEntries

Defined in:

AICSAR

Return value:

self

Function to create a new AICSAR object

Defined in:

AICSAR

Parameters:

#string Alias

Name of this instance.

#number Coalition

Coalition as in coalition.side.BLUE, can also be passed as "blue", "red" or "neutral"

#string Pilottemplate

Pilot template name.

#string Helotemplate

Helicopter template name.

FARP object or Airbase from where to start.

Core.Zone#ZONE MASHZone

Zone where to drop pilots after rescue.

Return value:

self

On after "HeloDown" event.

Defined in:

AICSAR

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number Index

On after "PilotDown" event.

Defined in:

AICSAR

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Location of the pilot.

#boolean InReach

True if in maxdistance else false.

On after "PilotKIA" event.

Defined in:

AICSAR

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "PilotPickedUp" event.

Defined in:

AICSAR

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#table CargoTable

of Ops.OpsGroup#OPSGROUP Cargo objects

#number Index

On after "PilotRescued" event.

Defined in:

AICSAR

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

[Internal] Catch the landing after ejection and spawn a pilot in situ.

Defined in:

AICSAR

Parameter:

Return value:

self

[User] Switch sound output on and use normale (DCS) radio

Defined in:

AICSAR

Parameters:

#boolean OnOff

Switch on (true) or off (false).

#number Frequency

Defaults to 243 (guard).

#number Modulation

Radio modulation. Defaults to radio.modulation.AM.

The group to use as sending station.

Return value:

self

[User] Switch sound output on and use SRS

Defined in:

AICSAR

Parameters:

#boolean OnOff

Switch on (true) or off (false).

#string Path

Path to your SRS Server Component, e.g. "E:\\Program Files\\DCS-SimpleRadio-Standalone"

#number Frequency

Defaults to 243 (guard)

#number Modulation

Radio modulation. Defaults to radio.modulation.AM

#string SoundPath

Where to find the audio files. Defaults to nil, i.e. add messages via "Sound to..." in the Mission Editor.

#number Port

Port of the SRS, defaults to 5002.

Return value:

self

Triggers the FSM event "Status".

Defined in:

AICSAR

Triggers the FSM event "Stop".

Defined in:

AICSAR

[Internal] Check helo queue

Defined in:

AICSAR

Return value:

self

[Internal] Check if pilot arrived in rescue zone (MASH)

Defined in:

AICSAR

Parameter:

The pilot to be rescued.

Return value:

#boolean:

outcome

[Internal] Check pilot queue for next mission

Defined in:

AICSAR

Return value:

self

[Internal] Count helos queue

Defined in:

AICSAR

Return value:

#number:

Number of helos on mission

[Internal] Get FlightGroup

Defined in:

AICSAR

Return value:

The FlightGroup

[Internal] Create a new rescue mission

Defined in:

AICSAR

Parameters:

The pilot to be rescued.

#number Index

Index number of this pilot

Return value:

self

Triggers the FSM event "Status" after a delay.

Defined in:

AICSAR

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Stop" after a delay.

Defined in:

AICSAR

Parameter:

#number delay

Delay in seconds.

[Internal] onafterHeloDown

Defined in:

AICSAR

Parameters:

#string From

#string Event

#string To

#number Index

Return value:

self

[Internal] onafterPilotDown

Defined in:

AICSAR

Parameters:

#string From

#string Event

#string To

Location of the pilot.

#boolean InReach

True if in maxdistance else false.

Return value:

self

[Internal] onafterPilotKIA

Defined in:

AICSAR

Parameters:

#string From

#string Event

#string To

Return value:

self

[Internal] onafterPilotPickedUp

Defined in:

AICSAR

Parameters:

#string From

#string Event

#string To

#table CargoTable

of Ops.OpsGroup#OPSGROUP Cargo objects

#number Index

Return value:

self

[Internal] onafterPilotRescued

Defined in:

AICSAR

Parameters:

#string From

#string Event

#string To

Return value:

self

[Internal] onafterStart

Defined in:

AICSAR

Parameters:

#string From

#string Event

#string To

Return value:

self

[Internal] onafterStatus

Defined in:

AICSAR

Parameters:

#string From

#string Event

#string To

Return value:

self

[Internal] onafterStop

Defined in:

AICSAR

Parameters:

#string From

#string Event

#string To

Return value:

self

Field(s)

#string AICSAR.ClassName

Name of this class.

#table AICSAR.Messages

TODO Messages - Messages enum @field Messages

#table AICSAR.RadioLength

TODO Radio Messages - Radio Messages enum for ogg files length in secs @field RadioLength

#table AICSAR.RadioMessages

TODO Radio Messages - Radio Messages enum for ogg files @field RadioMessages

#string AICSAR.alias

Alias Name.

#boolean AICSAR.autoonoff

Only send a helo when no human heli pilots are available.

#number AICSAR.coalition

Colition side.

Wrapper.Airbase#AIRBASE AICSAR.farp

FARP object from where to start.

Core.Zone#ZONE AICSAR.farpzone

MASH zone to drop rescued pilots.

AICSAR.gettext

English standard localization

#number AICSAR.helonumber

number of helos available (default: 3)

#table AICSAR.helos

Table of Ops.FlightGroup#FLIGHTGROUP objects

#string AICSAR.helotemplate

Template for CSAR helo.

#string AICSAR.lid

LID for log entries.

#boolean AICSAR.limithelos

limit available number of helos going on mission (defaults to true)

#string AICSAR.locale
#number AICSAR.maxdistance

Max distance to go for a rescue.

#number AICSAR.pilotindex

Table index to bind pilot to helo.

#table AICSAR.pilotqueue

Queue of pilots to rescue.

Core.Set#SET_CLIENT AICSAR.playerset

Track if alive heli pilots are available.

#table AICSAR.rescued

Track number of rescued pilot.

#number AICSAR.rescuezoneradius

Radius around downed pilot for the helo to land in.

#string AICSAR.template

Template for pilot.

#boolean AICSAR.verbose

Switch more output.

#string AICSAR.version

Versioning.

Function(s)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

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

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

#string To

The To state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns the End states.

Defined in:

Return value:

#table:

End states.

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Sub processes.

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

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

Defined in:

Return value:

#table:

Transitions.

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

Call handler.

Defined in:

Parameters:

#string step

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

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#string AICSAR.ClassName

Name of this class.

#table AICSAR.Messages

TODO Messages - Messages enum @field Messages

#table AICSAR.RadioLength

TODO Radio Messages - Radio Messages enum for ogg files length in secs @field RadioLength

#table AICSAR.RadioMessages

TODO Radio Messages - Radio Messages enum for ogg files @field RadioMessages

#string AICSAR.alias

Alias Name.

#boolean AICSAR.autoonoff

Only send a helo when no human heli pilots are available.

#number AICSAR.coalition

Colition side.

Wrapper.Airbase#AIRBASE AICSAR.farp

FARP object from where to start.

Core.Zone#ZONE AICSAR.farpzone

MASH zone to drop rescued pilots.

AICSAR.gettext

English standard localization

#number AICSAR.helonumber

number of helos available (default: 3)

#table AICSAR.helos

Table of Ops.FlightGroup#FLIGHTGROUP objects

#string AICSAR.helotemplate

Template for CSAR helo.

#string AICSAR.lid

LID for log entries.

#boolean AICSAR.limithelos

limit available number of helos going on mission (defaults to true)

#string AICSAR.locale
#number AICSAR.maxdistance

Max distance to go for a rescue.

#number AICSAR.pilotindex

Table index to bind pilot to helo.

#table AICSAR.pilotqueue

Queue of pilots to rescue.

Core.Set#SET_CLIENT AICSAR.playerset

Track if alive heli pilots are available.

#table AICSAR.rescued

Track number of rescued pilot.

#number AICSAR.rescuezoneradius

Radius around downed pilot for the helo to land in.

#string AICSAR.template

Template for pilot.

#boolean AICSAR.verbose

Switch more output.

#string AICSAR.version

Versioning.

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.

IniObjectCategory

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, set to nil, 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, set to nil, 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