Banner Image

Module Ops.PlayerRecce

Ops - Allow a player in a helo like the Gazelle, KA-50 to recon and lase ground targets.

Features:

  • Allow a player in a helicopter to detect, smoke, flare, lase and report ground units to others.
  • Implements visual detection from the helo
  • Implements optical detection via the Gazelle Vivianne system and lasing
  • KA-50 BlackShark basic support
  • Everyone else gets visual detection only
  • Upload target info to a PLAYERTASKCONTROLLER Instance

Demo Missions

Demo missions can be found on github.


Authors:

  • Applevangelist (Design & Programming)

Global(s)

Global PLAYERRECCE

It is our attitude at the beginning of a difficult task which, more than anything else, which will affect its successful outcome. (William James)


PLAYERRECCE

  • Allow a player in a helicopter to detect, smoke, flare, lase and report ground units to others.
#PLAYERRECCE PLAYERRECCE

It is our attitude at the beginning of a difficult task which, more than anything else, which will affect its successful outcome. (William James)


PLAYERRECCE

  • Allow a player in a helicopter to detect, smoke, flare, lase and report ground units to others.
  • Implements visual detection from the helo
  • Implements optical detection via the Gazelle Vivianne system and lasing
  • KA-50 BlackShark basic support
  • Everyone else gets visual detection only
  • Upload target info to a PLAYERTASKCONTROLLER Instance

If you have questions or suggestions, please visit the MOOSE Discord channel.

                     

Type(s)

Fields and Methods inherited from CanLase Description

CanLase.Ka-50

CanLase.SA342L

CanLase.SA342M

CanLase.SA342Minigun

CanLase.SA342Mistral

CanLase.typename

Unit type name

Fields and Methods inherited from PLAYERRECCE Description

PLAYERRECCE.AttackSet

PLAYERRECCE.AutoLase

PLAYERRECCE.BCFrequency

PLAYERRECCE.BCModulation

PLAYERRECCE.CallsignTranslations

PLAYERRECCE.Cameraheight

PLAYERRECCE.CanLase

PLAYERRECCE.ClassName

Name of the class.

PLAYERRECCE.ClientMenus

PLAYERRECCE.Coalition

PLAYERRECCE.CoalitionName

PLAYERRECCE.Controller

PLAYERRECCE.Culture

PLAYERRECCE:DisableSmokeOwnPosition()

[User] Disable smoking of own position

PLAYERRECCE:EnableSmokeOwnPosition()

[User] Enable smoking of own position

PLAYERRECCE.FlareColor

PLAYERRECCE.Frequency

PLAYERRECCE.GazelleViewFactors

PLAYERRECCE.Gender

PLAYERRECCE.Keepnumber

PLAYERRECCE.LaserCodes

PLAYERRECCE.LaserFOV

PLAYERRECCE.LaserRelativePos

PLAYERRECCE.LaserSpots

PLAYERRECCE.LaserTarget

PLAYERRECCE.MaxViewDistance

PLAYERRECCE.MenuName

PLAYERRECCE.Modulation

PLAYERRECCE.Name

PLAYERRECCE:New(Name, Coalition, PlayerSet)

Create and run a new PlayerRecce instance.

PLAYERRECCE.OnStation

PLAYERRECCE.PathToGoogleKey

PLAYERRECCE.PathToSRS

PLAYERRECCE.PlayerSet

PLAYERRECCE.Port

PLAYERRECCE.RPMarker

PLAYERRECCE.RPName

PLAYERRECCE.ReferencePoint

PLAYERRECCE.SRS

PLAYERRECCE.SRSQueue

PLAYERRECCE:SetAttackSet(AttackSet)

[User] Set a set of clients which will receive target reports

PLAYERRECCE:SetCallSignOptions(ShortCallsign, Keepnumber, CallsignTranslations)

[User] Set callsign options for TTS output.

PLAYERRECCE:SetLaserCodes(LaserCodes)

[User] Set a table of possible laser codes.

PLAYERRECCE:SetMenuName(Name)

[User] Set the top menu name to a custom string.

PLAYERRECCE:SetPlayerTaskController(Controller)

[User] Set PlayerTaskController.

PLAYERRECCE:SetReferencePoint(Coordinate, Name)

[User] Set a reference point coordinate for A2G Operations.

PLAYERRECCE:SetSRS(Frequency, Modulation, PathToSRS, Gender, Culture, Port, Voice, Volume, PathToGoogleKey)

[User] Set SRS TTS details - see Sound.SRS for details

PLAYERRECCE:SetTransmitOnlyWithPlayers(Switch)

[User] For SRS - Switch to only transmit if there are players on the server.

PLAYERRECCE.ShortCallsign

PLAYERRECCE.SmokeColor

PLAYERRECCE.SmokeOwn

PLAYERRECCE.TForget

PLAYERRECCE.TargetCache

PLAYERRECCE.TransmitOnlyWithPlayers

PLAYERRECCE.UnitLaserCodes

PLAYERRECCE.UseController

PLAYERRECCE.UseSRS

PLAYERRECCE.ViewZone

PLAYERRECCE.ViewZoneLaser

PLAYERRECCE.ViewZoneVisual

PLAYERRECCE.Voice

PLAYERRECCE.Volume

PLAYERRECCE:_BuildMenus(self)

[Internal]

PLAYERRECCE:_CameraOn(client, playername)

[Internal] Check Gazelle camera in on

PLAYERRECCE:_CheckNewTargets(targetset, client, playername)

[Internal]

PLAYERRECCE:_CleanupTargetCache()

[Internal]

PLAYERRECCE:_EventHandler(EventData)

[Internal] Event handling

PLAYERRECCE:_FlareTargets(client, group, playername)

[Internal]

PLAYERRECCE:_GetActualMaxLOSight(unit, vheading, vnod, vivoff)

[Internal] Get the max line of sight based on unit head and camera nod via trigonometrie.

PLAYERRECCE:_GetClockDirection(unit, target)

(Internal) Function to determine clockwise direction to target.

PLAYERRECCE:_GetGazelleVivianneSight(Gazelle)

[Internal] Get the view parameters from a Gazelle camera

PLAYERRECCE:_GetHVTTarget(targetset)

[Internal]

PLAYERRECCE:_GetKnownTargets(client)

[Internal]

PLAYERRECCE:_GetTargetSet(unit, camera, laser)

[Internal]

PLAYERRECCE:_GetTextForSpeech(text)

[Internal] Get text for text-to-speech.

PLAYERRECCE:_GetViewZone(unit, vheading, minview, maxview, angle, camon, laser)

[Internal] Build a ZONE_POLYGON from a given viewport of a unit

PLAYERRECCE:_IlluTargets(client, group, playername)

[Internal]

PLAYERRECCE:_LaseTarget(client, targetset)

[Internal]

PLAYERRECCE:_ReportLaserTargets(client, group, playername)

[Internal]

PLAYERRECCE:_ReportVisualTargets(client, group, playername)

[Internal]

PLAYERRECCE:_SetClientLaserCode(client, group, playername, code)

[Internal]

PLAYERRECCE:_SmokeTargets(client, group, playername)

[Internal]

PLAYERRECCE:_SwitchLasing(client, group, playername)

[Internal]

PLAYERRECCE:_SwitchLasingDist(client, group, playername, mindist, maxdist)

[Internal]

PLAYERRECCE:_SwitchOnStation(client, group, playername)

[Internal]

PLAYERRECCE:_SwitchSmoke(client, group, playername)

[Internal]

PLAYERRECCE:_UploadTargets(client, group, playername)

[Internal]

PLAYERRECCE:_WIP(client, group, playername)

[Internal]

PLAYERRECCE.debug

PLAYERRECCE.lasingtime

PLAYERRECCE.lid

Class id string for output to DCS log file.

PLAYERRECCE.minthreatlevel

PLAYERRECCE:onafterIllumination(From, Event, To, Client, Playername, TargetSet)

[Internal] Targets Illuminated

PLAYERRECCE:onafterRecceOffStation(From, Event, To, Client, Playername)

[Internal] Recce off station

PLAYERRECCE:onafterRecceOnStation(From, Event, To, Client, Playername)

[Internal] Recce on station

PLAYERRECCE:onafterShack(From, Event, To, Client, Target, Targettype)

[Internal] Lased target destroyed

PLAYERRECCE:onafterStatus(From, Event, To)

[Internal] Status Loop

PLAYERRECCE:onafterStop(From, Event, To)

[Internal] Stop

PLAYERRECCE:onafterTargetDetected(From, Event, To, Targetsbyclock, Client, Playername)

[Internal] Target Detected

PLAYERRECCE:onafterTargetLOSLost(From, Event, To, Client, Target)

[Internal] Laser lost LOS

PLAYERRECCE:onafterTargetLasing(From, Event, To, Client, Target, Lasercode, Lasingtime)

[Internal] Target lasing

PLAYERRECCE:onafterTargetReport(From, Event, To, Client, TargetSet, Target, Text)

[Internal] Target report

PLAYERRECCE:onafterTargetReportSent(From, Event, To, Client, TargetSet, Target, Text)

[Internal] Target data upload

PLAYERRECCE:onafterTargetsFlared(From, Event, To, Client, Playername, TargetSet)

[Internal] Targets Flared

PLAYERRECCE:onafterTargetsSmoked(From, Event, To, Client, Playername, TargetSet)

[Internal] Targets Smoked

PLAYERRECCE.smokeownposition

PLAYERRECCE.timestamp

PLAYERRECCE.verbose

Switch verbosity.

PLAYERRECCE.version

Fields and Methods inherited from FSM Description

PLAYERRECCE:AddEndState(State)

Adds an End state.

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

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

PLAYERRECCE:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

PLAYERRECCE:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

PLAYERRECCE.CallScheduler

Call scheduler.

PLAYERRECCE.ClassName

Name of the class.

PLAYERRECCE.Events

PLAYERRECCE:GetCurrentState()

Get current state.

PLAYERRECCE:GetEndStates()

Returns the End states.

PLAYERRECCE:GetProcess(From, Event)

PLAYERRECCE:GetProcesses()

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

PLAYERRECCE:GetScores()

Returns a table with the scores defined.

PLAYERRECCE:GetStartState()

Returns the start state of the FSM.

PLAYERRECCE:GetState()

Get current state.

PLAYERRECCE:GetSubs()

Returns a table with the Subs defined.

PLAYERRECCE:GetTransitions()

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

PLAYERRECCE:Is(State)

Check if FSM is in state.

PLAYERRECCE:LoadCallBacks(CallBackTable)

Load call backs.

PLAYERRECCE:New()

Creates a new FSM object.

PLAYERRECCE.Scores

Scores.

PLAYERRECCE:SetProcess(From, Event, Fsm)

PLAYERRECCE:SetStartState(State)

Sets the start state of the FSM.

PLAYERRECCE._EndStates

PLAYERRECCE._EventSchedules

PLAYERRECCE._Processes

PLAYERRECCE._Scores

PLAYERRECCE._StartState

PLAYERRECCE._Transitions

PLAYERRECCE:_add_to_map(Map, Event)

Add to map.

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

Call handler.

PLAYERRECCE:_create_transition(EventName)

Create transition.

PLAYERRECCE:_delayed_transition(EventName)

Delayed transition.

PLAYERRECCE:_eventmap(Events, EventStructure)

Event map.

PLAYERRECCE:_gosub(ParentFrom, ParentEvent)

Go sub.

PLAYERRECCE:_handler(EventName, ...)

Handler.

PLAYERRECCE:_isendstate(Current)

Is end state.

PLAYERRECCE:_submap(subs, sub, name)

Sub maps.

PLAYERRECCE:can(e)

Check if can do an event.

PLAYERRECCE:cannot(e)

Check if cannot do an event.

PLAYERRECCE.current

Current state name.

PLAYERRECCE.endstates

PLAYERRECCE:is(State, state)

Check if FSM is in state.

PLAYERRECCE.options

Options.

PLAYERRECCE.subs

Subs.

Fields and Methods inherited from BASE Description

PLAYERRECCE.ClassID

The ID number of the class.

PLAYERRECCE.ClassName

The name of the class.

PLAYERRECCE.ClassNameAndID

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

PLAYERRECCE:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

PLAYERRECCE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

PLAYERRECCE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

PLAYERRECCE:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

PLAYERRECCE:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

PLAYERRECCE:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

PLAYERRECCE:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

PLAYERRECCE:E(Arguments)

Log an exception which will be traced always.

PLAYERRECCE:EventDispatcher()

Returns the event dispatcher

PLAYERRECCE:EventRemoveAll()

Remove all subscribed events

PLAYERRECCE:F(Arguments)

Trace a function call.

PLAYERRECCE:F2(Arguments)

Trace a function call level 2.

PLAYERRECCE:F3(Arguments)

Trace a function call level 3.

PLAYERRECCE:GetClassID()

Get the ClassID of the class instance.

PLAYERRECCE:GetClassName()

Get the ClassName of the class instance.

PLAYERRECCE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

PLAYERRECCE:GetEventPriority()

Get the Class Core.Event processing Priority.

PLAYERRECCE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

PLAYERRECCE:GetState(Object, Key)

Get a Value given a Key from the Object.

PLAYERRECCE:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

PLAYERRECCE:I(Arguments)

Log an information which will be traced always.

PLAYERRECCE:Inherit(Child, Parent)

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

PLAYERRECCE:IsInstanceOf(ClassName)

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

PLAYERRECCE:IsTrace()

Enquires if tracing is on (for the class).

PLAYERRECCE:New()

BASE constructor.

PLAYERRECCE:OnEvent(EventData)

Occurs when an Event for an object is triggered.

PLAYERRECCE:OnEventBDA(EventData)

BDA.

PLAYERRECCE:OnEventBaseCaptured(EventData)

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

PLAYERRECCE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

PLAYERRECCE:OnEventCrash(EventData)

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

PLAYERRECCE:OnEventDead(EventData)

Occurs when an object is dead.

PLAYERRECCE:OnEventDetailedFailure(EventData)

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

PLAYERRECCE:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

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

PLAYERRECCE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

PLAYERRECCE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

PLAYERRECCE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

PLAYERRECCE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

PLAYERRECCE:OnEventKill(EventData)

Occurs on the death of a unit.

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

PLAYERRECCE:OnEventLandingAfterEjection(EventData)

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

PLAYERRECCE:OnEventLandingQualityMark(EventData)

Landing quality mark.

PLAYERRECCE:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

PLAYERRECCE:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

PLAYERRECCE:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

PLAYERRECCE:OnEventMissionEnd(EventData)

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

PLAYERRECCE:OnEventMissionStart(EventData)

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

PLAYERRECCE:OnEventParatrooperLanding(EventData)

Weapon add.

PLAYERRECCE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

PLAYERRECCE:OnEventPlayerEnterAircraft(EventData)

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

PLAYERRECCE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

PLAYERRECCE:OnEventPlayerLeaveUnit(EventData)

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

PLAYERRECCE:OnEventRefueling(EventData)

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

PLAYERRECCE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

PLAYERRECCE:OnEventScore(EventData)

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

PLAYERRECCE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

PLAYERRECCE:OnEventShootingStart(EventData)

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

PLAYERRECCE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

PLAYERRECCE:OnEventTakeoff(EventData)

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

PLAYERRECCE:OnEventTriggerZone(EventData)

Trigger zone.

PLAYERRECCE:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

PLAYERRECCE:ScheduleStop(SchedulerID)

Stops the Schedule.

PLAYERRECCE.Scheduler

PLAYERRECCE:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

PLAYERRECCE:SetState(Object, Key, Value)

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

PLAYERRECCE:T(Arguments)

Trace a function logic level 1.

PLAYERRECCE:T2(Arguments)

Trace a function logic level 2.

PLAYERRECCE:T3(Arguments)

Trace a function logic level 3.

PLAYERRECCE:TraceAll(TraceAll)

Trace all methods in MOOSE

PLAYERRECCE:TraceClass(Class)

Set tracing for a class

PLAYERRECCE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

PLAYERRECCE:TraceLevel(Level)

Set trace level

PLAYERRECCE:TraceOff()

Set trace off.

PLAYERRECCE:TraceOn()

Set trace on.

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

PLAYERRECCE:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

PLAYERRECCE._

PLAYERRECCE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

PLAYERRECCE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

PLAYERRECCE.__

PLAYERRECCE:onEvent(event)

The main event handling function...

Field(s)

#string Cameraheight.typename

Unit type name

Function(s)

Field(s)

#boolean CanLase.Ka-50
#boolean CanLase.SA342L
#boolean CanLase.SA342M
#string CanLase.typename

Unit type name

Function(s)

PLAYERRECCE class.

Field(s)

#string PLAYERRECCE.ClassName

Name of the class.

#string PLAYERRECCE.lid

Class id string for output to DCS log file.

#boolean PLAYERRECCE.verbose

Switch verbosity.

Function(s)

[User] Disable smoking of own position

Defined in:

PLAYERRECCE

Return value:

[User] Enable smoking of own position

Defined in:

PLAYERRECCE

Return value:

self

Create and run a new PlayerRecce instance.

Defined in:

PLAYERRECCE

Parameters:

#string Name

The name of this instance

#number Coalition

e.g. coalition.side.BLUE

The set of pilots working as recce

Return value:

self

[User] Set a set of clients which will receive target reports

Defined in:

PLAYERRECCE

Parameter:

Return value:

[User] Set callsign options for TTS output.

See Wrapper.Group#GROUP.GetCustomCallSign() on how to set customized callsigns.

Defined in:

PLAYERRECCE

Parameters:

#boolean ShortCallsign

If true, only call out the major flight number

#boolean Keepnumber

If true, keep the customized callsign in the #GROUP name for players as-is, no amendments or numbers.

#table CallsignTranslations

(optional) Table to translate between DCS standard callsigns and bespoke ones. Does not apply if using customized callsigns from playername or group name.

Return value:

self

[User] Set a table of possible laser codes.

Each new RECCE can select a code from this table, default is 1688.

Defined in:

PLAYERRECCE

Parameter:

#list<#number> LaserCodes

Return value:

[User] Set the top menu name to a custom string.

Defined in:

PLAYERRECCE

Parameter:

#string Name

The name to use as the top menu designation.

Return value:

self

[User] Set PlayerTaskController.

Allows to upload target reports to the controller, in turn creating tasks for other players.

Defined in:

PLAYERRECCE

Parameter:

Return value:

[User] Set a reference point coordinate for A2G Operations.

Will be used in coordinate references.

Defined in:

PLAYERRECCE

Parameters:

Coordinate of the RP

#string Name

Name of the RP

Return value:

[User] Set SRS TTS details - see Sound.SRS for details

Defined in:

PLAYERRECCE

Parameters:

#number Frequency

Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 271 or {127,251}. There needs to be exactly the same number of modulations!

#number Modulation

Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!

#string PathToSRS

Defaults to "C:\Program Files\DCS-SimpleRadio-Standalone"

#string Gender

(Optional) Defaults to "male"

#string Culture

(Optional) Defaults to "en-US"

#number Port

(Optional) Defaults to 5002

#string Voice

(Optional) Use a specifc voice with the Sound.SRS.SetVoice function, e.g, :SetVoice("Microsoft Hedda Desktop"). Note that this must be installed on your windows system. Can also be Google voice types, if you are using Google TTS.

#number Volume

(Optional) Volume - between 0.0 (silent) and 1.0 (loudest)

#string PathToGoogleKey

(Optional) Path to your google key if you want to use google TTS

Return value:

self

[User] For SRS - Switch to only transmit if there are players on the server.

Defined in:

PLAYERRECCE

Parameter:

#boolean Switch

If true, only send SRS if there are alive Players.

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameter:

[Internal] Check Gazelle camera in on

Defined in:

PLAYERRECCE

Parameters:

#string playername

Return value:

OnOff

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Core.Set#SET_UNIT targetset

#string playername

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Return value:

self

[Internal] Event handling

Defined in:

PLAYERRECCE

Parameter:

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

Return value:

self

[Internal] Get the max line of sight based on unit head and camera nod via trigonometrie.

Returns 0 if camera is off.

Defined in:

PLAYERRECCE

Parameters:

The unit which LOS we want

#number vheading

Heading where the unit or camera is looking

#number vnod

Nod down in degrees

#boolean vivoff

Camera on or off

Return value:

#number:

maxview Max view distance in meters

(Internal) Function to determine clockwise direction to target.

Defined in:

PLAYERRECCE

Parameters:

The Helicopter

The downed Group

Return value:

#number:

direction

[Internal] Get the view parameters from a Gazelle camera

Defined in:

PLAYERRECCE

Parameter:

Return values:

#number:

cameraheading in degrees.

#number:

cameranodding in degrees.

#number:

maxview in meters.

#boolean:

cameraison If true, camera is on, else off.

[Internal]

Defined in:

PLAYERRECCE

Parameter:

Core.Set#SET_UNIT targetset

Set of targets, can be empty!

Return value:

Target or nil

[Internal]

Defined in:

PLAYERRECCE

Parameter:

Return values:

Set of targets, can be empty!

#number:

count Count of targets

[Internal]

Defined in:

PLAYERRECCE

Parameters:

The FACA unit

#boolean camera

If true, use the unit's camera for targets in sight

#laser laser

Use laser zone

Return values:

Set of targets, can be empty!

#number:

count Count of targets

[Internal] Get text for text-to-speech.

Numbers are spaced out, e.g. "Heading 180" becomes "Heading 1 8 0 ".

Defined in:

PLAYERRECCE

Parameter:

#string text

Original text.

Return value:

#string:

Spoken text.

[Internal] Build a ZONE_POLYGON from a given viewport of a unit

Defined in:

PLAYERRECCE

Parameters:

The unit which is looking

#number vheading

Heading where the unit or camera is looking

#number minview

Min line of sight - for lasing

#number maxview

Max line of sight

#number angle

Angle left/right to be added to heading to form a triangle

#boolean camon

Camera is switched on

#boolean laser

Zone is for lasing

Return value:

ViewZone or nil if camera is off

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

The FACA unit

Core.Set#SET_UNIT targetset

Set of targets, can be empty!

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

code

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

#number mindist

#number maxdist

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

Return value:

self

[Internal]

Defined in:

PLAYERRECCE

Parameters:

#string playername

Return value:

self

[Internal] Targets Illuminated

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

#string Playername

Core.Set#SET_UNIT TargetSet

Return value:

self

[Internal] Recce off station

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

#string Playername

Return value:

self

[Internal] Recce on station

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

#string Playername

Return value:

self

[Internal] Lased target destroyed

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

#string Targettype

Return value:

self

[Internal] Status Loop

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Return value:

self

[Internal] Stop

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Return value:

self

[Internal] Target Detected

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

#table Targetsbyclock

#string Playername

Return value:

self

[Internal] Laser lost LOS

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Return value:

self

[Internal] Target lasing

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

#number Lasercode

#number Lasingtime

Return value:

self

[Internal] Target report

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Core.Set#SET_UNIT TargetSet

#string Text

Return value:

self

[Internal] Target data upload

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Core.Set#SET_UNIT TargetSet

#string Text

Return value:

self

[Internal] Targets Flared

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

#string Playername

Core.Set#SET_UNIT TargetSet

Return value:

self

[Internal] Targets Smoked

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

#string Playername

Core.Set#SET_UNIT TargetSet

Return value:

self

Field(s)

#string PLAYERRECCE.ClassName

Name of the class.

#string PLAYERRECCE.lid

Class id string for output to DCS log file.

#boolean PLAYERRECCE.verbose

Switch verbosity.

Function(s)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

Set the default #FSM_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 PLAYERRECCE.ClassName

Name of the class.

#string PLAYERRECCE.lid

Class id string for output to DCS log file.

#boolean PLAYERRECCE.verbose

Switch verbosity.

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