Module Ops.Intel

self

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact to be added.

INTEL:AddContactToCluster(contact, cluster)

Add a contact to the cluster.

Defined in:

INTEL

Parameters:

#INTEL.Contact contact

The contact.

#INTEL.Cluster cluster

The cluster.

INTEL:AddMissionToCluster(Cluster, Mission)

Add a Mission (Auftrag) to a cluster for tracking.

Defined in:

INTEL

Parameters:

#INTEL.Cluster Cluster

The cluster

Ops.Auftrag#AUFTRAG Mission

The mission connected with this cluster

Return value:

self

INTEL:AddMissionToContact(Contact, Mission)

Add a Mission (Auftrag) to a contact for tracking.

Defined in:

INTEL

Parameters:

#INTEL.Contact Contact

The contact

Ops.Auftrag#AUFTRAG Mission

The mission connected with this contact

Return value:

self

INTEL:AddRejectZone(RejectZone)

Add a reject zone.

Contacts detected in this zone are rejected and not reported by the detection. Note that reject zones overrule accept zones, i.e. if a unit is inside and accept zone and inside a reject zone, it is rejected.

Defined in:

INTEL

Parameter:

Core.Zone#ZONE RejectZone

Add a zone to the reject zone set.

Return value:

self

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

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

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

INTEL:CheckClusterCoordinateChanged(cluster, coordinate)

Get the coordinate of a cluster.

Defined in:

INTEL

Parameters:

#INTEL.Cluster cluster

The cluster.

Core.Point#COORDINATE coordinate

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

Return value:

#boolean:

INTEL:CheckContactInClusters(contact)

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

INTEL:ClusterCountUnits(Cluster)

Count number of units in cluster

Defined in:

INTEL

Parameter:

#INTEL.Cluster Cluster

The cluster

Return value:

#number:

unitcount

INTEL:CreateCluster(coordinate)

Create a new cluster.

Defined in:

INTEL

Parameter:

Core.Point#COORDINATE coordinate

The coordinate of the cluster.

Return value:

#INTEL.Cluster:

cluster The cluster.

INTEL:CreateDetectedItems(DetectedGroups, RecceDetecting)

Create detected items.

Defined in:

INTEL

Parameters:

#table DetectedGroups

Table of detected Groups

#table RecceDetecting

Table of detecting recce names

INTEL:FilterCategoryGroup(GroupCategories)

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

INTEL:GetClusterCoordinate(cluster)

Get the coordinate of a cluster.

Defined in:

INTEL

Parameter:

#INTEL.Cluster cluster

The cluster.

Return value:

Core.Point#COORDINATE:

The coordinate of this cluster.

INTEL:GetClusterOfContact(contact)

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

Defined in:

INTEL

Parameter:

#INTEL.Contact contact

The contact.

Return value:

#INTEL.Cluster:

The cluster this contact belongs to or nil.

INTEL:GetContactByName(groupname)

Get a contact by name.

Defined in:

INTEL

Parameter:

#string groupname

Name of the contact group.

Return value:

#INTEL.Contact:

The contact.

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

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:

Wrapper.Unit#UNIT Unit

The unit detecting.

#table DetectedUnits

Table of detected units to be filled

#table RecceDetecting

Table of recce per unit to be filled

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

INTEL:IsContactConnectedToCluster(contact, cluster)

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.

INTEL:IsContactPartOfAnyClusters(contact)

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

Defined in:

INTEL

Parameter:

#INTEL.Contact contact

The contact.

Return value:

#INTEL.Cluster:

The cluster this contact is part of or nil otherwise.

INTEL:New(DetectionSet, Coalition, Alias)

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

#string Alias

An optional alias how this object is called in the logs etc.

Return value:

self

INTEL:OnAfterLostCluster(From, Event, To, Cluster, Mission)

On After "LostCluster" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Cluster Cluster

Lost cluster

Ops.Auftrag#AUFTRAG Mission

The Auftrag connected with this cluster or nil

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

On After "LostContact" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Contact Contact

Lost contact.

INTEL:OnAfterNewCluster(From, Event, To, Contact, Cluster)

On After "NewCluster" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Contact Contact

Detected contact.

#INTEL.Cluster Cluster

Detected cluster

INTEL:OnAfterNewContact(From, Event, To, 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.

INTEL:PaintPicture()

Paint picture of the battle field.

Defined in:

INTEL

INTEL:RemoveAcceptZone(AcceptZone)

Remove an accept zone from the accept zone set.

Defined in:

INTEL

Parameter:

Core.Zone#ZONE AcceptZone

Remove a zone from the accept zone set.

Return value:

self

INTEL:RemoveContact(Contact)

Remove a contact from our list.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact to be removed.

INTEL:RemoveContactFromCluster(contact, cluster)

Remove a contact from a cluster.

Defined in:

INTEL

Parameters:

#INTEL.Contact contact

The contact.

#INTEL.Cluster cluster

The cluster.

INTEL:RemoveRejectZone(RejectZone)

Remove a reject zone from the reject zone set.

Defined in:

INTEL

Parameter:

Core.Zone#ZONE RejectZone

Remove a zone from the reject zone set.

Return value:

self

INTEL:SetAcceptZones(AcceptZoneSet)

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

INTEL:SetClusterAnalysis(Switch, Markers)

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

INTEL:SetClusterRadius(radius)

Change radius of the Clusters

Defined in:

INTEL

Parameter:

#number radius

The radius of the clusters

Return value:

self

INTEL:SetFilterCategory(Categories)

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

INTEL:SetForgetTime(TimeInterval)

Set forget contacts time interval.

For unknown contacts only. 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

INTEL:SetRejectZones(RejectZoneSet)

Set reject zones.

Contacts detected in this/these zone(s) are rejected and not reported by the detection. Note that reject zones overrule accept zones, i.e. if a unit is inside and accept zone and inside a reject zone, it is rejected.

Defined in:

INTEL

Parameter:

Core.Set#SET_ZONE RejectZoneSet

Set of reject zone(s).

Return value:

self

INTEL:SetVerbosity(Verbosity)

Set verbosity level for debugging.

Defined in:

INTEL

Parameter:

#number Verbosity

The higher, the noisier, e.g. 0=off, 2=debug

Return value:

self

INTEL:Start()

Triggers the FSM event "Start".

Starts the INTEL. Initializes parameters and starts event handlers.

Defined in:

INTEL

INTEL:Status()

Triggers the FSM event "Status".

Defined in:

INTEL

INTEL:UpdateClusterMarker(cluster)

Update cluster F10 marker.

Defined in:

INTEL

Parameter:

#INTEL.Cluster cluster

The cluster.

Return value:

self

INTEL:UpdateIntel()

Update detected items.

Defined in:

INTEL

INTEL:_CheckContactLost(Contact)

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.

INTEL:_UpdateClusterPositions()

Update coordinates of the known clusters.

Defined in:

INTEL

INTEL:__Start(delay)

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.

INTEL:__Status(delay)

Triggers the FSM event "Status" after a delay.

Defined in:

INTEL

Parameter:

#number delay

Delay in seconds.

INTEL:__Stop(delay)

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.

INTEL:onafterLostCluster(From, Event, To, Cluster, Mission)

On after "LostCluster" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Cluster Cluster

Lost cluster

Ops.Auftrag#AUFTRAG Mission

The Auftrag connected with this cluster or nil

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

On after "LostContact" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Contact Contact

Detected contact.

INTEL:onafterNewCluster(From, Event, To, Contact, Cluster)

On after "NewCluster" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Contact Contact

Detected contact.

#INTEL.Cluster Cluster

Detected cluster

INTEL:onafterNewContact(From, Event, To, 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.

INTEL:onafterStart(From, Event, To)

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.

INTEL:onafterStatus(From, Event, To)

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.

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

Radius im kilometers in which groups/units are considered to belong to a cluster

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

INTEL:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM 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.

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.

Core.Fsm#FSM_PROCESS Process

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:

Core.Fsm#FSM_PROCESS:

The SubFSM.

INTEL:AddScore(State, ScoreText, Score)

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

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

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

INTEL:AddTransition(From, Event, To)

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.

INTEL:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

INTEL:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

INTEL:GetProcess(From, Event)

Defined in:

Parameters:

From

Event

INTEL:GetProcesses()

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

Defined in:

Return value:

#table:

Sub processes.

INTEL:GetScores(Scores)

Returns a table with the scores defined.

Defined in:

Parameter:

#table Scores

INTEL:GetStartState()

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

INTEL:GetState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

INTEL:GetSubs()

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

INTEL:GetTransitions()

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

Defined in:

Return value:

#table:

Transitions.

INTEL:Is(State)

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

INTEL:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

INTEL:New()

Creates a new FSM object.

Defined in:

Return value:

#FSM:

INTEL:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Event

Fsm

INTEL:SetStartState(State)

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

INTEL:_add_to_map(Map, Event)

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

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

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.

INTEL:_create_transition(EventName)

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

INTEL:_delayed_transition(EventName)

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

INTEL:_eventmap(Events, EventStructure)

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

INTEL:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

INTEL:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

INTEL:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

INTEL:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

INTEL:can(e)

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.

INTEL:cannot(e)

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

INTEL:is(State, state)

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

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

Radius im kilometers in which groups/units are considered to belong to a cluster

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

INTEL:ClearState(Object, StateName)

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.

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

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

INTEL:CreateEventCrash(EventTime, Initiator)

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.

INTEL:CreateEventDead(EventTime, Initiator)

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.

INTEL:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

INTEL:CreateEventRemoveUnit(EventTime, Initiator)

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.

INTEL:CreateEventTakeoff(EventTime, Initiator)

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.

INTEL:CreateEventUnitLost(EventTime, Initiator)

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.

INTEL:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

INTEL:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

INTEL:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

INTEL:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

INTEL:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

INTEL:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

INTEL:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

INTEL:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

INTEL:GetClassNameAndID()

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.

INTEL:GetEventPriority()

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.

INTEL:GetParent(Child, FromClass)

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:

INTEL:GetState(Object, Key)

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.

INTEL:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS EventID

Event ID.

#function EventFunction

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

Return value:

INTEL:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

INTEL:Inherit(Child, Parent)

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

INTEL:IsInstanceOf(ClassName)

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:

INTEL:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

INTEL:New()

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:

INTEL:OnEvent(EventData)

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventBaseCaptured(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventCrash(EventData)

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

initiator : The unit that has crashed

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventDead(EventData)

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventDetailedFailure(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventEjection(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventHit(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventKill(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

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.

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventLandingAfterEjection(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventMissionEnd(EventData)

Occurs when a mission ends

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventMissionStart(EventData)

Occurs when a mission starts

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventPilotDead(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventPlayerEnterAircraft(EventData)

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

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:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventPlayerLeaveUnit(EventData)

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

initiator : The unit that the player left.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventRefueling(EventData)

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventScore(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventShootingEnd(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventShootingStart(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventShot(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventTakeoff(EventData)

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:

Core.Event#EVENTDATA EventData

The EventData structure.

INTEL:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

initiator: The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

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.

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

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.

INTEL:ScheduleStop(SchedulerFunction)

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.

INTEL:SetEventPriority(EventPriority)

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

INTEL:SetState(Object, Key, Value)

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.

INTEL:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

INTEL:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

INTEL:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

INTEL:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

INTEL:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

INTEL:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

INTEL:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

INTEL:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

INTEL:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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.

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 )

INTEL:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

INTEL:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

INTEL:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in: