Banner Image

Module Tasking.DetectionManager

Tasking - This module contains the DETECTION_MANAGER class and derived classes.


The #DETECTION_MANAGER class defines the core functions to report detected objects to groups. Reportings can be done in several manners, and it is up to the derived classes if DETECTION_MANAGER to model the reporting behaviour.

1.1) DETECTION_MANAGER constructor:

* DETECTION_MANAGER.New(): Create a new DETECTION_MANAGER instance.

1.2) DETECTION_MANAGER reporting:

Derived DETECTION_MANAGER classes will reports detected units using the method DETECTION_MANAGER.ReportDetected(). This method implements polymorphic behaviour.

The time interval in seconds of the reporting can be changed using the methods DETECTION_MANAGER.SetRefreshTimeInterval(). To control how long a reporting message is displayed, use DETECTION_MANAGER.SetReportDisplayTime(). Derived classes need to implement the method DETECTION_MANAGER.GetReportDisplayTime() to use the correct display time for displayed messages during a report.

Reporting can be started and stopped using the methods DETECTION_MANAGER.StartReporting() and DETECTION_MANAGER.StopReporting() respectively. If an ad-hoc report is requested, use the method DETECTION_MANAGER#ReportNow().

The default reporting interval is every 60 seconds. The reporting messages are displayed 15 seconds.


2) #DETECTION_REPORTING class, extends #DETECTION_MANAGER

The #DETECTION_REPORTING class implements detected units reporting. Reporting can be controlled using the reporting methods available in the Tasking.DetectionManager#DETECTION_MANAGER class.

2.1) DETECTION_REPORTING constructor:

The DETECTION_REPORTING.New() method creates a new DETECTION_REPORTING instance.


Contributions: Mechanist, Prof_Hilactic, FlightControl - Concept & Testing

Author: FlightControl - Framework Design & Programming

Global(s)

Global DETECTION_MANAGER

DETECTION_MANAGER class.

#DETECTION_MANAGER DETECTION_MANAGER

DETECTION_MANAGER class.

Global DETECTION_REPORTING

Type(s)

Fields and Methods inherited from DETECTION_MANAGER Description

DETECTION_MANAGER.CC

The command center that is used to communicate with the players.

DETECTION_MANAGER.Detection

The DETECTION_BASE object that is used to report the detected objects.

DETECTION_MANAGER:GetCommandCenter()

Get the command center to communicate actions to the players.

DETECTION_MANAGER:GetReportDisplayTime()

Get the reporting message display time.

DETECTION_MANAGER:MessageToPlayers(Squadron, Message, SoundFile, SoundDuration, SoundPath, DefenderGroup)

Send an information message to the players reporting to the command center.

DETECTION_MANAGER:New(SetGroup, Detection)

FAC constructor.

DETECTION_MANAGER:OnAfterAborted(From, Event, To, Task)

Aborted Handler OnAfter for DETECTION_MANAGER

DETECTION_MANAGER:OnAfterCancelled(From, Event, To, Task)

Cancelled Handler OnAfter for DETECTION_MANAGER

DETECTION_MANAGER:OnAfterFailed(From, Event, To, Task)

Failed Handler OnAfter for DETECTION_MANAGER

DETECTION_MANAGER:OnAfterStart(From, Event, To)

Start Handler OnAfter for DETECTION_MANAGER

DETECTION_MANAGER:OnAfterStop(From, Event, To)

Stop Handler OnAfter for DETECTION_MANAGER

DETECTION_MANAGER:OnAfterSuccess(From, Event, To, Task)

Success Handler OnAfter for DETECTION_MANAGER

DETECTION_MANAGER:OnBeforeStart(From, Event, To)

Start Handler OnBefore for DETECTION_MANAGER

DETECTION_MANAGER:OnBeforeStop(From, Event, To)

Stop Handler OnBefore for DETECTION_MANAGER

DETECTION_MANAGER:ProcessDetected(Detection)

Reports the detected items to the Core.Set#SET_GROUP.

DETECTION_MANAGER:SetCommandCenter(CommandCenter)

Set a command center to communicate actions to the players reporting to the command center.

DETECTION_MANAGER.SetGroup

The groups to which the FAC will report to.

DETECTION_MANAGER:SetRefreshTimeInterval(RefreshTimeInterval)

Set the reporting time interval.

DETECTION_MANAGER:SetReportDisplayTime(ReportDisplayTime)

Set the reporting message display time.

DETECTION_MANAGER:SetTacticalMenu(DispatcherMainMenuText, DispatcherMenuText)

Set a command center to communicate actions to the players reporting to the command center.

DETECTION_MANAGER:Start()

Start Trigger for DETECTION_MANAGER

DETECTION_MANAGER:Stop()

Stop Trigger for DETECTION_MANAGER

DETECTION_MANAGER._RefreshTimeInterval

DETECTION_MANAGER._ReportDisplayTime

DETECTION_MANAGER:__Start(Delay)

Start Asynchronous Trigger for DETECTION_MANAGER

DETECTION_MANAGER:__Stop(Delay)

Stop Asynchronous Trigger for DETECTION_MANAGER

DETECTION_MANAGER:onafterReport(From, Event, To)

DETECTION_MANAGER:onafterStart(From, Event, To)

Fields and Methods inherited from FSM Description

DETECTION_MANAGER:AddEndState(State)

Adds an End state.

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

DETECTION_MANAGER:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

DETECTION_MANAGER:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

DETECTION_MANAGER.CallScheduler

DETECTION_MANAGER.Events

DETECTION_MANAGER:GetCurrentState()

DETECTION_MANAGER:GetEndStates()

Returns the End states.

DETECTION_MANAGER:GetProcess(From, Event)

DETECTION_MANAGER:GetProcesses()

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

DETECTION_MANAGER:GetScores()

Returns a table with the scores defined.

DETECTION_MANAGER:GetStartState()

Returns the start state of the FSM.

DETECTION_MANAGER:GetState()

DETECTION_MANAGER:GetSubs()

Returns a table with the Subs defined.

DETECTION_MANAGER:GetTransitions()

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

DETECTION_MANAGER:Is(State)

DETECTION_MANAGER:LoadCallBacks(CallBackTable)

DETECTION_MANAGER:New()

Creates a new FSM object.

DETECTION_MANAGER.Scores

DETECTION_MANAGER:SetProcess(From, Event, Fsm)

DETECTION_MANAGER:SetStartState(State)

Sets the start state of the FSM.

DETECTION_MANAGER._EndStates

DETECTION_MANAGER._EventSchedules

DETECTION_MANAGER._Processes

DETECTION_MANAGER._Scores

DETECTION_MANAGER._StartState

DETECTION_MANAGER._Transitions

DETECTION_MANAGER:_add_to_map(Map, Event)

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

DETECTION_MANAGER:_create_transition(EventName)

DETECTION_MANAGER:_delayed_transition(EventName)

DETECTION_MANAGER:_eventmap(Events, EventStructure)

DETECTION_MANAGER:_gosub(ParentFrom, ParentEvent)

DETECTION_MANAGER:_handler(EventName, ...)

DETECTION_MANAGER:_isendstate(Current)

DETECTION_MANAGER:_submap(subs, sub, name)

DETECTION_MANAGER:can(e)

DETECTION_MANAGER:cannot(e)

DETECTION_MANAGER.current

DETECTION_MANAGER.endstates

DETECTION_MANAGER:is(state)

DETECTION_MANAGER.options

DETECTION_MANAGER.subs

Fields and Methods inherited from BASE Description

DETECTION_MANAGER.ClassID

The ID number of the class.

DETECTION_MANAGER.ClassName

The name of the class.

DETECTION_MANAGER.ClassNameAndID

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

DETECTION_MANAGER:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

DETECTION_MANAGER:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

DETECTION_MANAGER:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

DETECTION_MANAGER:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

DETECTION_MANAGER:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

DETECTION_MANAGER:E(Arguments)

Log an exception which will be traced always.

DETECTION_MANAGER:EventDispatcher()

Returns the event dispatcher

DETECTION_MANAGER:EventRemoveAll()

Remove all subscribed events

DETECTION_MANAGER:F(Arguments)

Trace a function call.

DETECTION_MANAGER:F2(Arguments)

Trace a function call level 2.

DETECTION_MANAGER:F3(Arguments)

Trace a function call level 3.

DETECTION_MANAGER:GetClassID()

Get the ClassID of the class instance.

DETECTION_MANAGER:GetClassName()

Get the ClassName of the class instance.

DETECTION_MANAGER:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

DETECTION_MANAGER:GetEventPriority()

Get the Class Event processing Priority.

DETECTION_MANAGER:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

DETECTION_MANAGER:GetState(Object, Key)

Get a Value given a Key from the Object.

DETECTION_MANAGER:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

DETECTION_MANAGER:I(Arguments)

Log an information which will be traced always.

DETECTION_MANAGER:Inherit(Child, Parent)

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

DETECTION_MANAGER:IsInstanceOf(ClassName)

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

DETECTION_MANAGER:IsTrace()

Enquires if tracing is on (for the class).

DETECTION_MANAGER:New()

BASE constructor.

DETECTION_MANAGER:OnEvent(EventData)

Occurs when an object is completely destroyed.

DETECTION_MANAGER:OnEventBaseCaptured(EventData)

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

DETECTION_MANAGER:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

DETECTION_MANAGER:OnEventCrash(EventData)

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

DETECTION_MANAGER:OnEventDead(EventData)

Occurs when an object is dead.

DETECTION_MANAGER:OnEventEjection(EventData)

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

DETECTION_MANAGER:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

DETECTION_MANAGER:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

DETECTION_MANAGER:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

DETECTION_MANAGER:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

DETECTION_MANAGER:OnEventLand(EventData)

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

DETECTION_MANAGER:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

DETECTION_MANAGER:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

DETECTION_MANAGER:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

DETECTION_MANAGER:OnEventMissionEnd(EventData)

Occurs when a mission ends

DETECTION_MANAGER:OnEventMissionStart(EventData)

Occurs when a mission starts

DETECTION_MANAGER:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

DETECTION_MANAGER:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

DETECTION_MANAGER:OnEventPlayerLeaveUnit(EventData)

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

DETECTION_MANAGER:OnEventRefueling(EventData)

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

DETECTION_MANAGER:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

DETECTION_MANAGER:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

DETECTION_MANAGER:OnEventShootingStart(EventData)

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

DETECTION_MANAGER:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

DETECTION_MANAGER:OnEventTakeoff(EventData)

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

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

Schedule a new time event.

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

Schedule a new time event.

DETECTION_MANAGER:ScheduleStop(SchedulerFunction)

Stops the Schedule.

DETECTION_MANAGER.Scheduler

DETECTION_MANAGER:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

DETECTION_MANAGER:SetState(Object, Key, Value)

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

DETECTION_MANAGER:T(Arguments)

Trace a function logic level 1.

DETECTION_MANAGER:T2(Arguments)

Trace a function logic level 2.

DETECTION_MANAGER:T3(Arguments)

Trace a function logic level 3.

DETECTION_MANAGER:TraceAll(TraceAll)

Trace all methods in MOOSE

DETECTION_MANAGER:TraceClass(Class)

Set tracing for a class

DETECTION_MANAGER:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

DETECTION_MANAGER:TraceLevel(Level)

Set trace level

DETECTION_MANAGER:TraceOff()

Set trace off.

DETECTION_MANAGER:TraceOn()

Set trace on.

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

DETECTION_MANAGER:UnHandleEvent(Event)

UnSubscribe to a DCS event.

DETECTION_MANAGER._

DETECTION_MANAGER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

DETECTION_MANAGER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

DETECTION_MANAGER.__

DETECTION_MANAGER:onEvent(event)

Fields and Methods inherited from DETECTION_REPORTING Description

DETECTION_REPORTING.ClassName

DETECTION_REPORTING.Detection

The DETECTION_BASE object that is used to report the detected objects.

DETECTION_REPORTING:GetDetectedItemsText(DetectedSet)

Creates a string of the detected items in a Detection.

DETECTION_REPORTING:New(SetGroup, Detection)

DETECTION_REPORTING constructor.

DETECTION_REPORTING:ProcessDetected(Group, Detection)

Reports the detected items to the Core.Set#SET_GROUP.

DETECTION_REPORTING.SetGroup

The groups to which the FAC will report to.

Field(s)

Tasking.CommandCenter#COMMANDCENTER DETECTION_MANAGER.CC

The command center that is used to communicate with the players.

Functional.Detection#DETECTION_BASE DETECTION_MANAGER.Detection

The DETECTION_BASE object that is used to report the detected objects.

Core.Set#SET_GROUP DETECTION_MANAGER.SetGroup

The groups to which the FAC will report to.

Function(s)

Get the command center to communicate actions to the players.

Defined in:

DETECTION_MANAGER

Return value:

Get the reporting message display time.

Defined in:

DETECTION_MANAGER

Return value:

#number:

ReportDisplayTime The display time in seconds when a report needs to be done.

Send an information message to the players reporting to the command center.

Defined in:

DETECTION_MANAGER

Parameters:

#table Squadron

The squadron table.

#string Message

The message to be sent.

#string SoundFile

The name of the sound file .wav or .ogg.

#number SoundDuration

The duration of the sound.

#string SoundPath

The path pointing to the folder in the mission file.

Wrapper.Group#GROUP DefenderGroup

The defender group sending the message.

Return value:

FAC constructor.

Defined in:

DETECTION_MANAGER

Parameters:

Return value:

Aborted Handler OnAfter for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Parameters:

#string From

#string Event

#string To

Cancelled Handler OnAfter for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Parameters:

#string From

#string Event

#string To

Failed Handler OnAfter for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Parameters:

#string From

#string Event

#string To

Start Handler OnAfter for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Parameters:

#string From

#string Event

#string To

Stop Handler OnAfter for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Parameters:

#string From

#string Event

#string To

Success Handler OnAfter for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Parameters:

#string From

#string Event

#string To

Start Handler OnBefore for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

Stop Handler OnBefore for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

Reports the detected items to the Core.Set#SET_GROUP.

Defined in:

DETECTION_MANAGER

Parameter:

Return value:

Set a command center to communicate actions to the players reporting to the command center.

Defined in:

DETECTION_MANAGER

Parameter:

The command center.

Return value:

Set the reporting time interval.

Defined in:

DETECTION_MANAGER

Parameter:

#number RefreshTimeInterval

The interval in seconds when a report needs to be done.

Return value:

Set the reporting message display time.

Defined in:

DETECTION_MANAGER

Parameter:

#number ReportDisplayTime

The display time in seconds when a report needs to be done.

Return value:

Set a command center to communicate actions to the players reporting to the command center.

Defined in:

DETECTION_MANAGER

Parameters:

DispatcherMainMenuText

DispatcherMenuText

Return value:

Start Trigger for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Stop Trigger for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Start Asynchronous Trigger for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Parameter:

#number Delay

Stop Asynchronous Trigger for DETECTION_MANAGER

Defined in:

DETECTION_MANAGER

Parameter:

#number Delay

Defined in:

DETECTION_MANAGER

Parameters:

From

Event

To

Defined in:

DETECTION_MANAGER

Parameters:

From

Event

To

Field(s)

Tasking.CommandCenter#COMMANDCENTER DETECTION_MANAGER.CC

The command center that is used to communicate with the players.

Functional.Detection#DETECTION_BASE DETECTION_MANAGER.Detection

The DETECTION_BASE object that is used to report the detected objects.

Core.Set#SET_GROUP DETECTION_MANAGER.SetGroup

The groups to which the FAC will report to.

Function(s)

Adds an End state.

Defined in:

Parameter:

State

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

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

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

#string To

The To state.

Returns the End states.

Defined in:

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Returns a table with the scores defined.

Defined in:

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Returns a table with the Subs defined.

Defined in:

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

Defined in:

Return value:

#table:

Defined in:

Parameter:

State

Defined in:

Parameter:

CallBackTable

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Defined in:

Parameters:

Map

Event

Defined in:

Parameters:

step

trigger

params

EventName

Defined in:

Parameters:

Events

EventStructure

Defined in:

Parameters:

ParentFrom

ParentEvent

Defined in:

Parameters:

EventName

...

Defined in:

Parameter:

Current

Defined in:

Parameters:

subs

sub

name

Defined in:

Parameter:

e

Defined in:

Parameter:

e

Defined in:

Parameter:

state

Field(s)

Tasking.CommandCenter#COMMANDCENTER DETECTION_MANAGER.CC

The command center that is used to communicate with the players.

Functional.Detection#DETECTION_BASE DETECTION_MANAGER.Detection

The DETECTION_BASE object that is used to report the detected objects.

Core.Set#SET_GROUP DETECTION_MANAGER.SetGroup

The groups to which the FAC will report to.

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

Get a Value given a Key from the Object.

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

Return value:

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

(optional) The function to be called when the event occurs for the unit.

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

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

Examples:

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

ClassName

is the name of the class or the class itself to run the check against

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

function EVENT:New()
  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
  return self
end
  

Defined in:

Return value:

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

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

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

The EventData structure.

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

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#function SchedulerFunction

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

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#number Repeat

Specifies the interval in seconds when the scheduler will call the event function.

#number RandomizeFactor

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

#number Stop

Specifies the amount of seconds when the scheduler will be stopped.

#function SchedulerFunction

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

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

Set the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that will hold the Value set by the Key.

Key

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

-- Switch the tracing On
BASE:TraceOnOff( true )

-- Switch the tracing Off
BASE:TraceOnOff( false )

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

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

Defined in:

Parameter:

event

DETECTION_REPORTING class.

Field(s)

Functional.Detection#DETECTION_BASE DETECTION_REPORTING.Detection

The DETECTION_BASE object that is used to report the detected objects.

Core.Set#SET_GROUP DETECTION_REPORTING.SetGroup

The groups to which the FAC will report to.

Function(s)

Creates a string of the detected items in a Detection.

Defined in:

DETECTION_REPORTING

Parameter:

Core.Set#SET_UNIT DetectedSet

The detected Set created by the Functional.Detection#DETECTION_BASE object.

Return value:

DETECTION_REPORTING constructor.

Defined in:

DETECTION_REPORTING

Parameters:

Return value:

Reports the detected items to the Core.Set#SET_GROUP.

Defined in:

DETECTION_REPORTING

Parameters:

The Wrapper.Group object to where the report needs to go.

The detection created by the Functional.Detection#DETECTION_BASE object.

Return value:

#boolean:

Return true if you want the reporting to continue... false will cancel the reporting loop.