Banner Image

Module Ops.Intel

Ops - Office of Military Intelligence.

Main Features:

  • Stuff

Author: funkyfranky

Global(s)

Global INTEL

Top Secret!


Banner Image

The INTEL Concept

#INTEL INTEL

Top Secret!


Banner Image

The INTEL Concept

Type(s)

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

INTEL:AddAcceptZone(AcceptZone)

Set accept zones.

INTEL:AddContact(Contact)

Add a contact to our list.

INTEL:AddContactToCluster(contact, cluster)

Add a contact to the cluster.

INTEL:CalcClusterThreatlevelAverage(cluster)

Calculate cluster threat level average.

INTEL:CalcClusterThreatlevelMax(cluster)

Calculate max cluster threat level.

INTEL:CalcClusterThreatlevelSum(cluster)

Calculate cluster threat level sum.

INTEL:CheckClusterCoordinateChanged(cluster, coordinate)

Get the coordinate of a cluster.

INTEL:CheckContactInClusters(contact)

Check if contact is in any known cluster.

INTEL.ClassName

Name of the class.

INTEL.Clusters

Clusters of detected groups.

INTEL.Contacts

Table of detected items.

INTEL.ContactsLost

Table of lost detected items.

INTEL.ContactsUnknown

Table of new detected items.

INTEL:CreateCluster(coordinate)

Create a new cluster.

INTEL:CreateDetectedItems(DetectedGroups)

Create detected items.

INTEL.Debug

Debug mode. Messages to all about status.

INTEL:FilterCategoryGroup(GroupCategories)

Filter group categories.

INTEL:GetClusterCoordinate(cluster)

Get the coordinate of a cluster.

INTEL:GetClusterOfContact(contact)

Get the cluster this contact belongs to (if any).

INTEL:GetContactByName(groupname)

Get a contact by name.

INTEL:GetDetectedUnits(Unit, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK, DetectedUnits)

Return the detected target groups of the controllable as a SET_GROUP.

INTEL:IsContactConnectedToCluster(contact, cluster)

Check if contact is close to any other contact this cluster.

INTEL:IsContactPartOfAnyClusters(contact)

Check if contact is close to any contact of known clusters.

INTEL:New(DetectionSet, Coalition)

Create a new INTEL object and start the FSM.

INTEL:PaintPicture()

Paint picture of the battle field.

INTEL:RemoveContact(Contact)

Remove a contact from our list.

INTEL:RemoveContactFromCluster(contact, cluster)

Remove a contact from a cluster.

INTEL:SetAcceptZones(AcceptZoneSet)

Set accept zones.

INTEL:SetClusterAnalysis(Switch, Markers)

Enable or disable cluster analysis of detected targets.

INTEL:SetFilterCategory(Categories)

Filter unit categories.

INTEL:SetForgetTime(TimeInterval)

Set forget contacts time interval.

INTEL:Start()

Triggers the FSM event "Start".

INTEL:Status()

Triggers the FSM event "Status".

INTEL:UpdateClusterMarker(cluster)

Update cluster F10 marker.

INTEL:UpdateIntel()

Update detected items.

INTEL:_CheckContactLost(Contact)

Check if a contact was lost.

INTEL:__Start(delay)

Triggers the FSM event "Start" after a delay.

INTEL:__Status(delay)

Triggers the FSM event "Status" after a delay.

INTEL:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

INTEL.acceptzoneset

Set of accept zones. If defined, only contacts in these zones are considered.

INTEL.alias

Name of the agency.

INTEL.clusteranalysis

If true, create clusters of detected targets.

INTEL.clustercounter

Running number of clusters.

INTEL.clustermarkers

If true, create cluster markers on F10 map.

INTEL.coalition

Coalition side number, e.g. coalition.side.RED.

INTEL.dTforget

Time interval in seconds before a known contact which is not detected any more is forgotten.

INTEL.detectionset

Set of detection groups, aka agents.

INTEL.filterCategory

Filter for unit categories.

INTEL.filterCategoryGroup

Filter for group categories.

INTEL.lid

Class id string for output to DCS log file.

INTEL:onafterLostContact(From, Event, To, Contact)

On after "LostContact" event.

INTEL:onafterNewContact(From, Event, To, Contact)

On after "NewContact" event.

INTEL:onafterStart(From, Event, To)

On after Start event.

INTEL:onafterStatus(From, Event, To)

On after "Status" event.

INTEL.rejectzoneset

Set of reject zones. Contacts in these zones are not considered, even if they are in accept zones.

INTEL.verbose

Verbosity level.

INTEL.version

INTEL class version.

Fields and Methods inherited from FSM Description

INTEL:AddEndState(State)

Adds an End state.

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

INTEL:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

INTEL:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

INTEL.CallScheduler

Call scheduler.

INTEL.ClassName

Name of the class.

INTEL.Events

INTEL:GetCurrentState()

Get current state.

INTEL:GetEndStates()

Returns the End states.

INTEL:GetProcess(From, Event)

INTEL:GetProcesses()

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

INTEL:GetScores(Scores)

Returns a table with the scores defined.

INTEL:GetStartState()

Returns the start state of the FSM.

INTEL:GetState()

Get current state.

INTEL:GetSubs()

Returns a table with the Subs defined.

INTEL:GetTransitions()

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

INTEL:Is(State, If)

Check if FSM is in state.

INTEL:LoadCallBacks(CallBackTable)

Load call backs.

INTEL:New()

Creates a new FSM object.

INTEL.Scores

Scores.

INTEL:SetProcess(From, Event, Fsm)

INTEL:SetStartState(State)

Sets the start state of the FSM.

INTEL._EndStates

INTEL._EventSchedules

INTEL._Processes

INTEL._Scores

INTEL._StartState

INTEL._Transitions

INTEL:_add_to_map(Map, Event)

Add to map.

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

Call handler.

INTEL:_create_transition(EventName)

Create transition.

INTEL:_delayed_transition(EventName)

Delayed transition.

INTEL:_eventmap(Events, EventStructure)

Event map.

INTEL:_gosub(ParentFrom, ParentEvent)

Go sub.

INTEL:_handler(EventName, ...)

Handler.

INTEL:_isendstate(Current)

Is end state.

INTEL:_submap(subs, sub, name)

Sub maps.

INTEL:can(e)

Check if can do an event.

INTEL:cannot(e)

Check if cannot do an event.

INTEL.current

Current state name.

INTEL.endstates

INTEL:is(State, If, state)

Check if FSM is in state.

INTEL.options

Options.

INTEL.subs

Subs.

Fields and Methods inherited from BASE Description

INTEL.ClassID

The ID number of the class.

INTEL.ClassName

The name of the class.

INTEL.ClassNameAndID

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

INTEL:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

INTEL:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

INTEL:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

INTEL:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

INTEL:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

INTEL:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

INTEL:E(Arguments)

Log an exception which will be traced always.

INTEL:EventDispatcher()

Returns the event dispatcher

INTEL:EventRemoveAll()

Remove all subscribed events

INTEL:F(Arguments)

Trace a function call.

INTEL:F2(Arguments)

Trace a function call level 2.

INTEL:F3(Arguments)

Trace a function call level 3.

INTEL:GetClassID()

Get the ClassID of the class instance.

INTEL:GetClassName()

Get the ClassName of the class instance.

INTEL:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

INTEL:GetEventPriority()

Get the Class Event processing Priority.

INTEL:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

INTEL:GetState(Object, Key)

Get a Value given a Key from the Object.

INTEL:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

INTEL:I(Arguments)

Log an information which will be traced always.

INTEL:Inherit(Child, Parent)

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

INTEL:IsInstanceOf(ClassName)

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

INTEL:IsTrace()

Enquires if tracing is on (for the class).

INTEL:New()

BASE constructor.

INTEL:OnEvent(EventData)

Occurs when an object is completely destroyed.

INTEL:OnEventBaseCaptured(EventData)

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

INTEL:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

INTEL:OnEventCrash(EventData)

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

INTEL:OnEventDead(EventData)

Occurs when an object is dead.

INTEL:OnEventDetailedFailure(EventData)

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

INTEL:OnEventEjection(EventData)

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

INTEL:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

INTEL:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

INTEL:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

INTEL:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

INTEL:OnEventKill(EventData)

Occurs on the death of a unit.

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

INTEL:OnEventLandingAfterEjection(EventData)

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

INTEL:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

INTEL:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

INTEL:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

INTEL:OnEventMissionEnd(EventData)

Occurs when a mission ends

INTEL:OnEventMissionStart(EventData)

Occurs when a mission starts

INTEL:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

INTEL:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

INTEL:OnEventPlayerLeaveUnit(EventData)

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

INTEL:OnEventRefueling(EventData)

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

INTEL:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

INTEL:OnEventScore(EventData)

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

INTEL:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

INTEL:OnEventShootingStart(EventData)

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

INTEL:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

INTEL:OnEventTakeoff(EventData)

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

INTEL:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

INTEL:ScheduleStop(SchedulerFunction)

Stops the Schedule.

INTEL.Scheduler

INTEL:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

INTEL:SetState(Object, Key, Value)

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

INTEL:T(Arguments)

Trace a function logic level 1.

INTEL:T2(Arguments)

Trace a function logic level 2.

INTEL:T3(Arguments)

Trace a function logic level 3.

INTEL:TraceAll(TraceAll)

Trace all methods in MOOSE

INTEL:TraceClass(Class)

Set tracing for a class

INTEL:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

INTEL:TraceLevel(Level)

Set trace level

INTEL:TraceOff()

Set trace off.

INTEL:TraceOn()

Set trace on.

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

INTEL:UnHandleEvent(Event)

UnSubscribe to a DCS event.

INTEL._

INTEL:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

INTEL:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

INTEL.__

INTEL:onEvent(event)

Fields and Methods inherited from INTEL.Cluster Description

INTEL.Cluster.Contacts

Table of contacts in the cluster.

INTEL.Cluster.coordinate

Coordinate of the cluster.

INTEL.Cluster.index

Cluster index.

INTEL.Cluster.marker

F10 marker.

INTEL.Cluster.size

Number of groups in the cluster.

INTEL.Cluster.threatlevelAve

Average of threat levels.

INTEL.Cluster.threatlevelMax

Max threat level of cluster.

INTEL.Cluster.threatlevelSum

Sum of threat levels.

Fields and Methods inherited from INTEL.Contact Description

INTEL.Contact.Tdetected

Time stamp in abs. mission time seconds when this item was last detected.

INTEL.Contact.attribute

Generalized attribute.

INTEL.Contact.category

Category number.

INTEL.Contact.categoryname

Category name.

INTEL.Contact.group

The contact group.

INTEL.Contact.groupname

Name of the group.

INTEL.Contact.isgrund

INTEL.Contact.ishelo

INTEL.Contact.isship

INTEL.Contact.position

Last known position of the item.

INTEL.Contact.speed

Last known speed in m/s.

INTEL.Contact.threatlevel

Threat level of this item.

INTEL.Contact.typename

Type name of detected item.

INTEL.Contact.velocity

3D velocity vector. Components x,y and z in m/s.

INTEL class.

Field(s)

#string INTEL.ClassName

Name of the class.

#table INTEL.Clusters

Clusters of detected groups.

#table INTEL.Contacts

Table of detected items.

#table INTEL.ContactsLost

Table of lost detected items.

#table INTEL.ContactsUnknown

Table of new detected items.

#boolean INTEL.Debug

Debug mode. Messages to all about status.

Core.Set#SET_ZONE INTEL.acceptzoneset

Set of accept zones. If defined, only contacts in these zones are considered.

#string INTEL.alias

Name of the agency.

#boolean INTEL.clusteranalysis

If true, create clusters of detected targets.

#number INTEL.clustercounter

Running number of clusters.

#boolean INTEL.clustermarkers

If true, create cluster markers on F10 map.

#number INTEL.coalition

Coalition side number, e.g. coalition.side.RED.

#number INTEL.dTforget

Time interval in seconds before a known contact which is not detected any more is forgotten.

Core.Set#SET_GROUP INTEL.detectionset

Set of detection groups, aka agents.

#table INTEL.filterCategory

Filter for unit categories.

#table INTEL.filterCategoryGroup

Filter for group categories.

#string INTEL.lid

Class id string for output to DCS log file.

Core.Set#SET_ZONE INTEL.rejectzoneset

Set of reject zones. Contacts in these zones are not considered, even if they are in accept zones.

#number INTEL.verbose

Verbosity level.

#string INTEL.version

INTEL class version.

Function(s)

Set accept zones.

Only contacts detected in this zone are considered.

Defined in:

INTEL

Parameter:

Core.Zone#ZONE AcceptZone

Add a zone to the accept zone set.

Return value:

self

Add a contact to our list.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact to be added.

Add a contact to the cluster.

Defined in:

INTEL

Parameters:

#INTEL.Contact contact

The contact.

#INTEL.Cluster cluster

The cluster.

Calculate cluster threat level average.

Defined in:

INTEL

Parameter:

#INTEL.Cluster cluster

The cluster of contacts.

Return value:

#number:

Average of all threat levels of all groups in the cluster.

Calculate max cluster threat level.

Defined in:

INTEL

Parameter:

#INTEL.Cluster cluster

The cluster of contacts.

Return value:

#number:

Max threat levels of all groups in the cluster.

Calculate cluster threat level sum.

Defined in:

INTEL

Parameter:

#INTEL.Cluster cluster

The cluster of contacts.

Return value:

#number:

Sum of all threat levels of all groups in the cluster.

Get the coordinate of a cluster.

Defined in:

INTEL

Parameters:

#INTEL.Cluster cluster

The cluster.

(Optional) Coordinate of the new cluster. Default is to calculate the current coordinate.

Check if contact is in any known cluster.

Defined in:

INTEL

Parameter:

#INTEL.Contact contact

The contact.

Return value:

#boolean:

If true, contact is in clusters

Create a new cluster.

Defined in:

INTEL

Parameter:

The coordinate of the cluster.

Return value:

cluster The cluster.

Create detected items.

Defined in:

INTEL

Parameter:

#table DetectedGroups

Table of detected Groups

Filter group categories.

Valid categories are:

  • Group.Category.AIRPLANE
  • Group.Category.HELICOPTER
  • Group.Category.GROUND
  • Group.Category.SHIP
  • Group.Category.TRAIN

Defined in:

INTEL

Parameter:

#table GroupCategories

Filter categories, e.g. {Group.Category.AIRPLANE, Group.Category.HELICOPTER}.

Return value:

self

Get the coordinate of a cluster.

Defined in:

INTEL

Parameter:

#INTEL.Cluster cluster

The cluster.

Return value:

The coordinate of this cluster.

Get the cluster this contact belongs to (if any).

Defined in:

INTEL

Parameter:

#INTEL.Contact contact

The contact.

Return value:

The cluster this contact belongs to or nil.

Get a contact by name.

Defined in:

INTEL

Parameter:

#string groupname

Name of the contact group.

Return value:

The contact.

Return the detected target groups of the controllable as a SET_GROUP.

The optional parametes specify the detection methods that can be applied. If no detection method is given, the detection will use all the available methods by default.

Defined in:

INTEL

Parameters:

The unit detecting.

#boolean DetectVisual

(Optional) If false, do not include visually detected targets.

#boolean DetectOptical

(Optional) If false, do not include optically detected targets.

#boolean DetectRadar

(Optional) If false, do not include targets detected by radar.

#boolean DetectIRST

(Optional) If false, do not include targets detected by IRST.

#boolean DetectRWR

(Optional) If false, do not include targets detected by RWR.

#boolean DetectDLINK

(Optional) If false, do not include targets detected by data link.

DetectedUnits

Check if contact is close to any other contact this cluster.

Defined in:

INTEL

Parameters:

#INTEL.Contact contact

The contact.

#INTEL.Cluster cluster

The cluster the check.

Return value:

#boolean:

If true, contact is connected to this cluster.

Check if contact is close to any contact of known clusters.

Defined in:

INTEL

Parameter:

#INTEL.Contact contact

The contact.

Return value:

The cluster this contact is part of or nil otherwise.

Create a new INTEL object and start the FSM.

Defined in:

INTEL

Parameters:

Core.Set#SET_GROUP DetectionSet

Set of detection groups.

#number Coalition

Coalition side. Can also be passed as a string "red", "blue" or "neutral".

Return value:

self

Paint picture of the battle field.

Defined in:

INTEL

Remove a contact from our list.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact to be removed.

Remove a contact from a cluster.

Defined in:

INTEL

Parameters:

#INTEL.Contact contact

The contact.

#INTEL.Cluster cluster

The cluster.

Set accept zones.

Only contacts detected in this/these zone(s) are considered.

Defined in:

INTEL

Parameter:

Core.Set#SET_ZONE AcceptZoneSet

Set of accept zones

Return value:

self

Enable or disable cluster analysis of detected targets.

Targets will be grouped in coupled clusters.

Defined in:

INTEL

Parameters:

#boolean Switch

If true, enable cluster analysis.

#boolean Markers

If true, place markers on F10 map.

Return value:

self

Filter unit categories.

Valid categories are:

  • Unit.Category.AIRPLANE
  • Unit.Category.HELICOPTER
  • Unit.Category.GROUND_UNIT
  • Unit.Category.SHIP
  • Unit.Category.STRUCTURE

Defined in:

INTEL

Parameter:

#table Categories

Filter categories, e.g. {Unit.Category.AIRPLANE, Unit.Category.HELICOPTER}.

Return value:

self

Set forget contacts time interval.

Previously known contacts that are not detected any more, are "lost" after this time. This avoids fast oscillations between a contact being detected and undetected.

Defined in:

INTEL

Parameter:

#number TimeInterval

Time interval in seconds. Default is 120 sec.

Return value:

self

Triggers the FSM event "Start".

Starts the INTEL. Initializes parameters and starts event handlers.

Defined in:

INTEL

Triggers the FSM event "Status".

Defined in:

INTEL

Update cluster F10 marker.

Defined in:

INTEL

Parameter:

#INTEL.Cluster cluster

The cluster.

Return value:

self

Update detected items.

Defined in:

INTEL

Check if a contact was lost.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact to be removed.

Return value:

#boolean:

If true, contact was not detected for at least dTforget seconds.

Triggers the FSM event "Start" after a delay.

Starts the INTEL. Initializes parameters and starts event handlers.

Defined in:

INTEL

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Status" after a delay.

Defined in:

INTEL

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Stop" after a delay.

Stops the INTEL and all its event handlers.

Defined in:

INTEL

Parameter:

#number delay

Delay in seconds.

On after "LostContact" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Contact Contact

Detected contact.

On after "NewContact" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Contact Contact

Detected contact.

On after Start event.

Starts the FLIGHTGROUP FSM and event handlers.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Status" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Field(s)

#string INTEL.ClassName

Name of the class.

#table INTEL.Clusters

Clusters of detected groups.

#table INTEL.Contacts

Table of detected items.

#table INTEL.ContactsLost

Table of lost detected items.

#table INTEL.ContactsUnknown

Table of new detected items.

#boolean INTEL.Debug

Debug mode. Messages to all about status.

Core.Set#SET_ZONE INTEL.acceptzoneset

Set of accept zones. If defined, only contacts in these zones are considered.

#string INTEL.alias

Name of the agency.

#boolean INTEL.clusteranalysis

If true, create clusters of detected targets.

#number INTEL.clustercounter

Running number of clusters.

#boolean INTEL.clustermarkers

If true, create cluster markers on F10 map.

#number INTEL.coalition

Coalition side number, e.g. coalition.side.RED.

#number INTEL.dTforget

Time interval in seconds before a known contact which is not detected any more is forgotten.

Core.Set#SET_GROUP INTEL.detectionset

Set of detection groups, aka agents.

#table INTEL.filterCategory

Filter for unit categories.

#table INTEL.filterCategoryGroup

Filter for group categories.

#string INTEL.lid

Class id string for output to DCS log file.

Core.Set#SET_ZONE INTEL.rejectzoneset

Set of reject zones. Contacts in these zones are not considered, even if they are in accept zones.

#number INTEL.verbose

Verbosity level.

#string INTEL.version

INTEL class version.

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:

Parameter:

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

Parameters:

#string State

State name.

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

#boolean If

true, FSM is in this state.

state

Field(s)

#string INTEL.ClassName

Name of the class.

#table INTEL.Clusters

Clusters of detected groups.

#table INTEL.Contacts

Table of detected items.

#table INTEL.ContactsLost

Table of lost detected items.

#table INTEL.ContactsUnknown

Table of new detected items.

#boolean INTEL.Debug

Debug mode. Messages to all about status.

Core.Set#SET_ZONE INTEL.acceptzoneset

Set of accept zones. If defined, only contacts in these zones are considered.

#string INTEL.alias

Name of the agency.

#boolean INTEL.clusteranalysis

If true, create clusters of detected targets.

#number INTEL.clustercounter

Running number of clusters.

#boolean INTEL.clustermarkers

If true, create cluster markers on F10 map.

#number INTEL.coalition

Coalition side number, e.g. coalition.side.RED.

#number INTEL.dTforget

Time interval in seconds before a known contact which is not detected any more is forgotten.

Core.Set#SET_GROUP INTEL.detectionset

Set of detection groups, aka agents.

#table INTEL.filterCategory

Filter for unit categories.

#table INTEL.filterCategoryGroup

Filter for group categories.

#string INTEL.lid

Class id string for output to DCS log file.

Core.Set#SET_ZONE INTEL.rejectzoneset

Set of reject zones. Contacts in these zones are not considered, even if they are in accept zones.

#number INTEL.verbose

Verbosity level.

#string INTEL.version

INTEL class version.

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.

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

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

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

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

#BASE FromClass

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

Return value:

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

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

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

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

Examples:

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

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

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

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

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

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

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

Defined in:

Return value:

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

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

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.

  • initiator: The unit that killed the target
  • target: Target Object
  • weapon: Weapon Object

Defined in:

Parameter:

The EventData structure.

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

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

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

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.

  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
  • subplace: is always 0 for unknown reasons.

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

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

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

Set the Class Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

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

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

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

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

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

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

Defined in:

Parameter:

event

Cluster info.

Field(s)

#table INTEL.Cluster.Contacts

Table of contacts in the cluster.

Core.Point#COORDINATE INTEL.Cluster.coordinate

Coordinate of the cluster.

#number INTEL.Cluster.index

Cluster index.

#number INTEL.Cluster.size

Number of groups in the cluster.

#number INTEL.Cluster.threatlevelAve

Average of threat levels.

#number INTEL.Cluster.threatlevelMax

Max threat level of cluster.

#number INTEL.Cluster.threatlevelSum

Sum of threat levels.

Function(s)

Detected item info.

Field(s)

#number INTEL.Contact.Tdetected

Time stamp in abs. mission time seconds when this item was last detected.

#string INTEL.Contact.attribute

Generalized attribute.

#number INTEL.Contact.category

Category number.

#string INTEL.Contact.categoryname

Category name.

#string INTEL.Contact.groupname

Name of the group.

Core.Point#COORDINATE INTEL.Contact.position

Last known position of the item.

#number INTEL.Contact.speed

Last known speed in m/s.

#number INTEL.Contact.threatlevel

Threat level of this item.

#string INTEL.Contact.typename

Type name of detected item.

DCS#Vec3 INTEL.Contact.velocity

3D velocity vector. Components x,y and z in m/s.

Function(s)