Banner Image

Module Ops.Intel

Ops - Office of Military Intelligence.

Main Features:

  • Detect and track contacts consistently
  • Detect and track clusters of contacts consistently
  • Use FSM events to link functionality into your scripts
  • Easy setup

Author: funkyfranky

Global(s)

Global INTEL

Top Secret!


The INTEL Concept

  • Lightweight replacement for Functional.Detection#DETECTION
  • Detect and track contacts consistently
  • Detect and track clusters of contacts consistently
  • Once detected and still alive, planes will be tracked 10 minutes, helicopters 20 minutes, ships and trains 1 hour, ground units 2 hours
  • Use FSM events to link functionality into your scripts

Basic Usage

Set up a detection SET_GROUP

Red_DetectionSetGroup = SET_GROUP:New()
Red_DetectionSetGroup:FilterPrefixes( { "Red EWR" } )
Red_DetectionSetGroup:FilterOnce()

New Intel type detection for the red side, logname "KGB"

RedIntel = INTEL:New(Red_DetectionSetGroup, "red", "KGB")
RedIntel:SetClusterAnalysis(true, true)
RedIntel:SetVerbosity(2)
RedIntel:__Start(2)

Hook into new contacts found

function RedIntel:OnAfterNewContact(From, Event, To, Contact)
  local text = string.format("NEW contact %s detected by %s", Contact.groupname, Contact.recce or "unknown")
  MESSAGE:New(text, 15, "KGB"):ToAll()
end

## And/or new clusters found

function RedIntel:OnAfterNewCluster(From, Event, To, Cluster)
  local text = string.format("NEW cluster #%d of size %d", Cluster.index, Cluster.size)
  MESSAGE:New(text,15,"KGB"):ToAll()
end
#INTEL INTEL

Top Secret!


The INTEL Concept

  • Lightweight replacement for Functional.Detection#DETECTION
  • Detect and track contacts consistently
  • Detect and track clusters of contacts consistently
  • Once detected and still alive, planes will be tracked 10 minutes, helicopters 20 minutes, ships and trains 1 hour, ground units 2 hours
  • Use FSM events to link functionality into your scripts

Basic Usage

Set up a detection SET_GROUP

Red_DetectionSetGroup = SET_GROUP:New()
Red_DetectionSetGroup:FilterPrefixes( { "Red EWR" } )
Red_DetectionSetGroup:FilterOnce()

New Intel type detection for the red side, logname "KGB"

RedIntel = INTEL:New(Red_DetectionSetGroup, "red", "KGB")
RedIntel:SetClusterAnalysis(true, true)
RedIntel:SetVerbosity(2)
RedIntel:__Start(2)

Hook into new contacts found

function RedIntel:OnAfterNewContact(From, Event, To, Contact)
  local text = string.format("NEW contact %s detected by %s", Contact.groupname, Contact.recce or "unknown")
  MESSAGE:New(text, 15, "KGB"):ToAll()
end

## And/or new clusters found

function RedIntel:OnAfterNewCluster(From, Event, To, Cluster)
  local text = string.format("NEW cluster #%d of size %d", Cluster.index, Cluster.size)
  MESSAGE:New(text,15,"KGB"):ToAll()
end

Global INTEL_DLINK

INTEL_DLINK data aggregator

Type(s)

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

INTEL:AddAcceptZone(AcceptZone)

Add an accept zone.

INTEL:AddAgent(AgentGroup)

Add a group to the detection set.

INTEL:AddConflictZone(ConflictZone)

Add a conflict zone.

INTEL:AddContact(Contact)

Add a contact to our list.

INTEL:AddContactToCluster(contact, cluster)

Add a contact to the cluster.

INTEL:AddMissionToCluster(Cluster, Mission)

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

INTEL:AddMissionToContact(Contact, Mission)

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

INTEL:AddRejectZone(RejectZone)

Add a reject zone.

INTEL:CalcClusterDirection(cluster)

Calculate cluster heading.

INTEL:CalcClusterFuturePosition(cluster, seconds)

Calculate cluster future position after given seconds.

INTEL:CalcClusterSpeed(cluster)

Calculate cluster speed.

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:CalcClusterVelocityVec3(cluster)

Calculate cluster velocity vector.

INTEL:CheckContactInClusters(contact)

Check if contact is in any known cluster.

INTEL.ClassName

Name of the class.

INTEL:ClusterCountUnits(Cluster)

Count number of alive units in cluster.

INTEL.Clusters

Clusters of detected groups.

INTEL:ContactCountUnits(Contact)

Count number of alive units in contact.

INTEL.Contacts

Table of detected items.

INTEL.ContactsLost

Table of lost detected items.

INTEL.ContactsUnknown

Table of new detected items.

INTEL:CreateDetectedItems(DetectedGroups, DetectedStatics, RecceDetecting)

Create detected items.

INTEL.Ctype

INTEL.DetectDLINK

INTEL.DetectIRST

INTEL.DetectOptical

INTEL.DetectRWR

INTEL.DetectRadar

INTEL.DetectVisual

INTEL:FilterCategoryGroup(GroupCategories)

Filter group categories.

INTEL:GetClusterAltitude(Cluster, Update)

Get the altitude of a cluster.

INTEL:GetClusterCoordinate(Cluster, Update)

Get the coordinate of a cluster.

INTEL:GetClusterOfContact(contact)

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

INTEL:GetClusterTable()

Get table of #INTEL.Cluster objects

INTEL:GetContactByName(groupname)

Get a contact by name.

INTEL:GetContactCategoryName(Contact)

Get category name of a contact.

INTEL:GetContactCoordinate(Contact)

Get coordinate of a contact.

INTEL:GetContactGroup(Contact)

Get group of a contact.

INTEL:GetContactName(Contact)

Get name of a contact.

INTEL:GetContactTable()

Get table of #INTEL.Contact objects

INTEL:GetContactThreatlevel(Contact)

Get threatlevel of a contact.

INTEL:GetContactTypeName(Contact)

Get type name of a contact.

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

(Internal) Return the detected target groups of the controllable as a Core.Set#SET_GROUP.

INTEL:GetHighestThreatContact(Cluster)

Get the contact with the highest threat level from the cluster.

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:KnowObject(Positionable, RecceName, Tdetected)

Make the INTEL aware of a object that was not detected (yet).

INTEL:LostCluster(delay, Cluster, Mission)

Triggers the FSM event "LostCluster" after a delay.

INTEL:LostContact(delay, Contact)

Triggers the FSM event "LostContact" after a delay.

INTEL:New(DetectionSet, Coalition, Alias)

Create a new INTEL object and start the FSM.

INTEL:NewCluster(delay, Cluster)

Triggers the FSM event "NewCluster" after a delay.

INTEL:NewContact(delay, Contact)

Triggers the FSM event "NewContact" after a delay.

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

On After "LostCluster" event.

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

On After "LostContact" event.

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

On After "NewCluster" event.

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

On After "NewContact" event.

INTEL:PaintPicture()

[Internal] Paint picture of the battle field.

INTEL.RadarAcceptRange

INTEL.RadarAcceptRangeKilometers

INTEL.RadarBlur

INTEL.RadarBlurClosing

INTEL.RadarBlurClosingSquare

INTEL.RadarBlurMinHeight

INTEL.RadarBlurThresBlur

INTEL.RadarBlurThresHeight

INTEL:RemoveAcceptZone(AcceptZone)

Remove an accept zone from the accept zone set.

INTEL:RemoveConflictZone(ConflictZone)

Remove a conflict zone from the conflict zone set.

INTEL:RemoveContact(Contact)

Remove a contact from our list.

INTEL:RemoveContactFromCluster(contact, cluster)

Remove a contact from a cluster.

INTEL:RemoveRejectZone(RejectZone)

Remove a reject zone from the reject zone set.

INTEL:SetAcceptRange(Range)

Set the accept range in kilometers from each of the recce.

INTEL:SetAcceptZones(AcceptZoneSet)

Set accept zones.

INTEL:SetClusterAnalysis(Switch, Markers, Arrows)

Enable or disable cluster analysis of detected targets.

INTEL:SetClusterRadius(radius)

Change radius of the Clusters.

INTEL:SetConflictZones(ConflictZoneSet)

Set conflict zones.

INTEL:SetDetectStatics(Switch)

Set whether STATIC objects are detected.

INTEL:SetDetectionTypes(DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)

Set detection types for this #INTEL - all default to true.

INTEL:SetFilterCategory(Categories)

Filter unit categories.

INTEL:SetForgetTime(TimeInterval)

OBSOLETE, will be removed in next version! Set forget contacts time interval.

INTEL:SetRadarBlur(minheight, thresheight, thresblur, closing)

Method to make the radar detection less accurate, e.g.

INTEL:SetRejectZones(RejectZoneSet)

Set reject zones.

INTEL:SetVerbosity(Verbosity)

Set verbosity level for debugging.

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:_AddCluster(Cluster)

Add cluster to table.

INTEL:_CheckClusterCoordinateChanged(Cluster, Threshold, Coordinate)

Check if the coorindate of the cluster changed.

INTEL:_CheckContactLost(Contact)

Check if a contact was lost.

INTEL:_CreateCluster()

Create a new cluster.

INTEL:_CreateClusterFromContact(Contact)

Create a new cluster from a first contact.

INTEL:_CreateContact(Positionable, RecceName)

Create an #INTEL.Contact item from a given GROUP or STATIC object.

INTEL:_GetClosestClusterOfContact(Contact)

Get closest cluster of contact.

INTEL:_GetDistContactToCluster(Contact, Cluster)

Get distance to cluster.

INTEL:_IsContactKnown(Contact)

Check if a Contact is already known.

INTEL:_UpdateClusterPositions()

Update coordinates of the known clusters.

INTEL:_UpdateContact(Contact)

Update an #INTEL.Contact item.

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

INTEL.clustercounter

Running number of clusters.

INTEL.clustermarkers

If true, create cluster markers on F10 map.

INTEL.clusterradius

Radius in meters in which groups/units are considered to belong to a cluster.

INTEL.coalition

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

INTEL.conflictzoneset

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

INTEL.dTforget

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

INTEL.detectStatics

If true, detect STATIC objects. Default false.

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:onafterLostCluster(From, Event, To, Cluster, Mission)

On after "LostCluster" event.

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

On after "LostContact" event.

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

On after "NewCluster" 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.prediction

Seconds default to be used with CalcClusterFuturePosition.

INTEL.rejectzoneset

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

INTEL.statusupdate

Time interval in seconds after which the status is refreshed. Default 60 sec. Should be negative.

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

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)

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, 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, IniObjectCategory)

Creation of a Crash Event.

INTEL:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

INTEL:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT 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 Core.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(EventID, 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 Event for an object is triggered.

INTEL:OnEventBDA(EventData)

BDA.

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:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

INTEL:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

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 Have a look at the class Core.Event#EVENT as these are just the prototypes.

INTEL:OnEventLandingAfterEjection(EventData)

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

INTEL:OnEventLandingQualityMark(EventData)

Landing quality mark.

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 Have a look at the class Core.Event#EVENT as these are just the prototypes.

INTEL:OnEventMissionStart(EventData)

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

INTEL:OnEventParatrooperLanding(EventData)

Weapon add.

INTEL:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

INTEL:OnEventPlayerEnterAircraft(EventData)

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

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:OnEventTriggerZone(EventData)

Trigger zone.

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(SchedulerID)

Stops the Schedule.

INTEL.Scheduler

INTEL:SetEventPriority(EventPriority)

Set the Class Core.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(EventID)

UnSubscribe to a DCS event.

INTEL._

INTEL:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

INTEL:_Serialize(Arguments)

(Internal) Serialize arguments

INTEL:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

INTEL.__

INTEL:onEvent(event)

The main event handling function...

Fields and Methods inherited from INTEL.Cluster Description

INTEL.Cluster.Contacts

Table of contacts in the cluster.

INTEL.Cluster.altitude

[AIR] Average flight altitude of the cluster in meters.

INTEL.Cluster.coordinate

Coordinate of the cluster.

INTEL.Cluster.ctype

Cluster type of #INTEL.Ctype.

INTEL.Cluster.index

Cluster index.

INTEL.Cluster.marker

F10 marker.

INTEL.Cluster.markerID

Marker ID.

INTEL.Cluster.mission

The current Auftrag attached to this cluster.

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

[AIR] Flight altitude of the contact in meters.

INTEL.Contact.attribute

Generalized attribute.

INTEL.Contact.category

Category number.

INTEL.Contact.categoryname

Category name.

INTEL.Contact.ctype

Contact type of #INTEL.Ctype.

INTEL.Contact.group

The contact group.

INTEL.Contact.groupname

Name of the group.

INTEL.Contact.heading

[AIR] Heading of the contact, if available.

INTEL.Contact.isStatic

If true, contact is a STATIC object.

INTEL.Contact.isground

If true, contact is a ground group.

INTEL.Contact.ishelo

If true, contact is a helo group.

INTEL.Contact.isship

If true, contact is a naval group.

INTEL.Contact.maneuvering

[AIR] Contact has changed direction by >10 deg.

INTEL.Contact.mission

The current Auftrag attached to this contact.

INTEL.Contact.platform

[AIR] Contact platform name, e.g. Foxbat, Flanker_E, defaults to Bogey if unknown

INTEL.Contact.position

Last known position of the item.

INTEL.Contact.recce

The name of the recce unit that detected this contact.

INTEL.Contact.speed

Last known speed in m/s.

INTEL.Contact.target

The Target attached to this contact.

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.

Fields and Methods inherited from INTEL.Ctype Description

INTEL.Ctype.AIRCRAFT

Airpane or helicopter.

INTEL.Ctype.GROUND

Ground.

INTEL.Ctype.NAVAL

Ship.

INTEL.Ctype.STRUCTURE

Static structure.

Fields and Methods inherited from INTEL_DLINK Description

INTEL_DLINK:AddIntel(Intel)

Function to add an #INTEL object to the aggregator

INTEL_DLINK.ClassName

Name of the class.

INTEL_DLINK:Collect()

Triggers the FSM event "Collect".

INTEL_DLINK:GetClusterTable()

Function to query the detected clusters

INTEL_DLINK:GetContactTable()

Function to query the detected contacts

INTEL_DLINK:GetDetectedItemCoordinates()

Function to query the detected contact coordinates

INTEL_DLINK:New(Intels, Alias, Interval, Cachetime)

Function to instantiate a new object

INTEL_DLINK:OnAfterCollected(From, Event, To, Contacts, Clusters)

On After "Collected" event.

INTEL_DLINK:Start()

Pseudo Functions

- Triggers the FSM event "Start".

INTEL_DLINK:__Start(delay)

Triggers the FSM event "Start" after a delay.

INTEL_DLINK:__Status(delay)

Triggers the FSM event "Collect" after a delay.

INTEL_DLINK:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

INTEL_DLINK.alias

Alias name for logging.

INTEL_DLINK.cachetime

Number of seconds to keep an object.

INTEL_DLINK.clusters

Table of Ops.Intel#INTEL.Cluster clusters.

INTEL_DLINK.contactcoords

Table of contacts' Core.Point#COORDINATE objects.

INTEL_DLINK.contacts

Table of Ops.Intel#INTEL.Contact contacts.

INTEL_DLINK.intels

INTEL_DLINK.interval

Number of seconds between collection runs.

INTEL_DLINK.lid

Class id string for output to DCS log file.

INTEL_DLINK:onafterStart(From, Event, To)

Function to start the work.

INTEL_DLINK:onafterStop(From, Event, To)

Function to stop

INTEL_DLINK:onbeforeCollect(From, Event, To)

Function to collect data from the various #INTEL

INTEL_DLINK:onbeforeCollected(From, Event, To, Contacts, Clusters)

Function called after collection is done

INTEL_DLINK.verbose

Make the logging verbose.

INTEL_DLINK.version

Version string

Fields and Methods inherited from FSM Description

INTEL_DLINK:AddEndState(State)

Adds an End state.

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

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

INTEL_DLINK:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

INTEL_DLINK:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

INTEL_DLINK.CallScheduler

Call scheduler.

INTEL_DLINK.ClassName

Name of the class.

INTEL_DLINK.Events

INTEL_DLINK:GetCurrentState()

Get current state.

INTEL_DLINK:GetEndStates()

Returns the End states.

INTEL_DLINK:GetProcess(From, Event)

INTEL_DLINK:GetProcesses()

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

INTEL_DLINK:GetScores()

Returns a table with the scores defined.

INTEL_DLINK:GetStartState()

Returns the start state of the FSM.

INTEL_DLINK:GetState()

Get current state.

INTEL_DLINK:GetSubs()

Returns a table with the Subs defined.

INTEL_DLINK:GetTransitions()

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

INTEL_DLINK:Is(State)

Check if FSM is in state.

INTEL_DLINK:LoadCallBacks(CallBackTable)

Load call backs.

INTEL_DLINK:New()

Creates a new FSM object.

INTEL_DLINK.Scores

Scores.

INTEL_DLINK:SetProcess(From, Event, Fsm)

INTEL_DLINK:SetStartState(State)

Sets the start state of the FSM.

INTEL_DLINK._EndStates

INTEL_DLINK._EventSchedules

INTEL_DLINK._Processes

INTEL_DLINK._Scores

INTEL_DLINK._StartState

INTEL_DLINK._Transitions

INTEL_DLINK:_add_to_map(Map, Event)

Add to map.

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

Call handler.

INTEL_DLINK:_create_transition(EventName)

Create transition.

INTEL_DLINK:_delayed_transition(EventName)

Delayed transition.

INTEL_DLINK:_eventmap(Events, EventStructure)

Event map.

INTEL_DLINK:_gosub(ParentFrom, ParentEvent)

Go sub.

INTEL_DLINK:_handler(EventName, ...)

Handler.

INTEL_DLINK:_isendstate(Current)

Is end state.

INTEL_DLINK:_submap(subs, sub, name)

Sub maps.

INTEL_DLINK:can(e)

Check if can do an event.

INTEL_DLINK:cannot(e)

Check if cannot do an event.

INTEL_DLINK.current

Current state name.

INTEL_DLINK.endstates

INTEL_DLINK:is(State, state)

Check if FSM is in state.

INTEL_DLINK.options

Options.

INTEL_DLINK.subs

Subs.

Fields and Methods inherited from BASE Description

INTEL_DLINK.ClassID

The ID number of the class.

INTEL_DLINK.ClassName

The name of the class.

INTEL_DLINK.ClassNameAndID

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

INTEL_DLINK:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

INTEL_DLINK:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

INTEL_DLINK:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

INTEL_DLINK:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

INTEL_DLINK:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

INTEL_DLINK:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

INTEL_DLINK:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

INTEL_DLINK:E(Arguments)

Log an exception which will be traced always.

INTEL_DLINK:EventDispatcher()

Returns the event dispatcher

INTEL_DLINK:EventRemoveAll()

Remove all subscribed events

INTEL_DLINK:F(Arguments)

Trace a function call.

INTEL_DLINK:F2(Arguments)

Trace a function call level 2.

INTEL_DLINK:F3(Arguments)

Trace a function call level 3.

INTEL_DLINK:GetClassID()

Get the ClassID of the class instance.

INTEL_DLINK:GetClassName()

Get the ClassName of the class instance.

INTEL_DLINK:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

INTEL_DLINK:GetEventPriority()

Get the Class Core.Event processing Priority.

INTEL_DLINK:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

INTEL_DLINK:GetState(Object, Key)

Get a Value given a Key from the Object.

INTEL_DLINK:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

INTEL_DLINK:I(Arguments)

Log an information which will be traced always.

INTEL_DLINK:Inherit(Child, Parent)

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

INTEL_DLINK:IsInstanceOf(ClassName)

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

INTEL_DLINK:IsTrace()

Enquires if tracing is on (for the class).

INTEL_DLINK:New()

BASE constructor.

INTEL_DLINK:OnEvent(EventData)

Occurs when an Event for an object is triggered.

INTEL_DLINK:OnEventBDA(EventData)

BDA.

INTEL_DLINK:OnEventBaseCaptured(EventData)

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

INTEL_DLINK:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

INTEL_DLINK:OnEventCrash(EventData)

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

INTEL_DLINK:OnEventDead(EventData)

Occurs when an object is dead.

INTEL_DLINK:OnEventDetailedFailure(EventData)

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

INTEL_DLINK:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

INTEL_DLINK:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

INTEL_DLINK:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

INTEL_DLINK:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

INTEL_DLINK:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

INTEL_DLINK:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

INTEL_DLINK:OnEventKill(EventData)

Occurs on the death of a unit.

INTEL_DLINK:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.

INTEL_DLINK:OnEventLandingAfterEjection(EventData)

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

INTEL_DLINK:OnEventLandingQualityMark(EventData)

Landing quality mark.

INTEL_DLINK:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

INTEL_DLINK:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

INTEL_DLINK:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

INTEL_DLINK:OnEventMissionEnd(EventData)

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

INTEL_DLINK:OnEventMissionStart(EventData)

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

INTEL_DLINK:OnEventParatrooperLanding(EventData)

Weapon add.

INTEL_DLINK:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

INTEL_DLINK:OnEventPlayerEnterAircraft(EventData)

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

INTEL_DLINK:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

INTEL_DLINK:OnEventPlayerLeaveUnit(EventData)

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

INTEL_DLINK:OnEventRefueling(EventData)

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

INTEL_DLINK:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

INTEL_DLINK:OnEventScore(EventData)

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

INTEL_DLINK:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

INTEL_DLINK:OnEventShootingStart(EventData)

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

INTEL_DLINK:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

INTEL_DLINK:OnEventTakeoff(EventData)

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

INTEL_DLINK:OnEventTriggerZone(EventData)

Trigger zone.

INTEL_DLINK:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

INTEL_DLINK:ScheduleStop(SchedulerID)

Stops the Schedule.

INTEL_DLINK.Scheduler

INTEL_DLINK:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

INTEL_DLINK:SetState(Object, Key, Value)

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

INTEL_DLINK:T(Arguments)

Trace a function logic level 1.

INTEL_DLINK:T2(Arguments)

Trace a function logic level 2.

INTEL_DLINK:T3(Arguments)

Trace a function logic level 3.

INTEL_DLINK:TraceAll(TraceAll)

Trace all methods in MOOSE

INTEL_DLINK:TraceClass(Class)

Set tracing for a class

INTEL_DLINK:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

INTEL_DLINK:TraceLevel(Level)

Set trace level

INTEL_DLINK:TraceOff()

Set trace off.

INTEL_DLINK:TraceOn()

Set trace on.

INTEL_DLINK: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_DLINK:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

INTEL_DLINK._

INTEL_DLINK:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

INTEL_DLINK:_Serialize(Arguments)

(Internal) Serialize arguments

INTEL_DLINK:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

INTEL_DLINK.__

INTEL_DLINK:onEvent(event)

The main event handling function...

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.RadarBlur
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 in meters in which groups/units are considered to belong to a cluster.

#number INTEL.coalition

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

Core.Set#SET_ZONE INTEL.conflictzoneset

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

#number INTEL.dTforget

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

#boolean INTEL.detectStatics

If true, detect STATIC objects. Default false.

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.

#number INTEL.prediction

Seconds default to be used with CalcClusterFuturePosition.

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

Time interval in seconds after which the status is refreshed. Default 60 sec. Should be negative.

#number INTEL.verbose

Verbosity level.

#string INTEL.version

INTEL class version.

Function(s)

Add an accept zone.

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 group to the detection set.

Defined in:

INTEL

Parameter:

Wrapper.Group#GROUP AgentGroup

Group of agents. Can also be an Ops.OpsGroup#OPSGROUP object.

Return value:

self

Add a conflict zone.

Contacts detected in this zone are conflicted and not reported by the detection. Note that conflict zones overrule all other zones, i.e. if a unit is outside of an accept zone and inside a reject zone, it is still reported if inside a conflict zone.

Defined in:

INTEL

Parameter:

Core.Zone#ZONE ConflictZone

Add a zone to the conflict zone set.

Return value:

self

Add a contact to our list.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact to be added.

Return value:

self

Add a contact to the cluster.

Defined in:

INTEL

Parameters:

#INTEL.Contact contact

The contact.

#INTEL.Cluster cluster

The cluster.

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

Defined in:

INTEL

Parameters:

#INTEL.Cluster Cluster

The cluster

The mission connected with this cluster

Return value:

self

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

Defined in:

INTEL

Parameters:

#INTEL.Contact Contact

The contact

The mission connected with this contact

Return value:

self

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

Calculate cluster heading.

Defined in:

INTEL

Parameter:

#INTEL.Cluster cluster

The cluster of contacts.

Return value:

#number:

Heading average of all groups in the cluster.

Calculate cluster future position after given seconds.

Defined in:

INTEL

Parameters:

#INTEL.Cluster cluster

The cluster of contacts.

#number seconds

Time interval in seconds. Default is self.prediction.

Return value:

Calculated future position of the cluster.

Calculate cluster speed.

Defined in:

INTEL

Parameter:

#INTEL.Cluster cluster

The cluster of contacts.

Return value:

#number:

Speed average of all groups in the cluster in MPS.

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.

Calculate cluster velocity vector.

Defined in:

INTEL

Parameter:

#INTEL.Cluster cluster

The cluster of contacts.

Return value:

Velocity vector in m/s.

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

Count number of alive units in cluster.

Defined in:

INTEL

Parameter:

#INTEL.Cluster Cluster

The cluster

Return value:

#number:

unitcount

Count number of alive units in contact.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact.

Return value:

#number:

unitcount

Create detected items.

Defined in:

INTEL

Parameters:

#table DetectedGroups

Table of detected Groups.

#table DetectedStatics

Table of detected Statics.

#table RecceDetecting

Table of detecting recce names.

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 altitude of a cluster.

Defined in:

INTEL

Parameters:

#INTEL.Cluster Cluster

The cluster.

#boolean Update

If true, update the altitude. Default is to just return the last stored altitude.

Return value:

#number:

The average altitude (ASL) of this cluster in meters.

Get the coordinate of a cluster.

Defined in:

INTEL

Parameters:

#INTEL.Cluster Cluster

The cluster.

#boolean Update

If true, update the coordinate. Default is to just return the last stored position.

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 table of #INTEL.Cluster objects

Defined in:

INTEL

Return value:

#table:

Clusters or nil if not running

Get a contact by name.

Defined in:

INTEL

Parameter:

#string groupname

Name of the contact group.

Return value:

The contact.

Get category name of a contact.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact.

Return value:

#string:

Category name.

Get coordinate of a contact.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact.

Return value:

Coordinates.

Get group of a contact.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact.

Return value:

Group object.

Get name of a contact.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact.

Return value:

#string:

Name of the contact.

Get table of #INTEL.Contact objects

Defined in:

INTEL

Return value:

#table:

Contacts or nil if not running

Get threatlevel of a contact.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact.

Return value:

#number:

Threat level.

Get type name of a contact.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact.

Return value:

#string:

Type name.

(Internal) Return the detected target groups of the controllable as a Core.Set#SET_GROUP.

The optional parameters 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.

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

Get the contact with the highest threat level from the cluster.

Defined in:

INTEL

Parameter:

#INTEL.Cluster Cluster

The cluster.

Return value:

the contact or nil if none

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

#boolean:

If true, contact is connected to this cluster.

#number:

Distance to cluster in meters.

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.

Make the INTEL aware of a object that was not detected (yet).

This will add the object to the contacts table and trigger a NewContact event.

Defined in:

INTEL

Parameters:

Group or static object.

#string RecceName

Name of the recce group that detected this object.

#number Tdetected

Abs. mission time in seconds, when the object is detected. Default now.

Return value:

self

Triggers the FSM event "LostCluster" after a delay.

Defined in:

INTEL

Parameters:

#number delay

Delay in seconds.

#INTEL.Cluster Cluster

Lost cluster.

The Auftrag connected with this cluster or nil.

Triggers the FSM event "LostContact" after a delay.

Defined in:

INTEL

Parameters:

#number delay

Delay in seconds.

#INTEL.Contact Contact

Lost contact.

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

Triggers the FSM event "NewCluster" after a delay.

Defined in:

INTEL

Parameters:

#number delay

Delay in seconds.

#INTEL.Cluster Cluster

Detected cluster.

Triggers the FSM event "NewContact" after a delay.

Defined in:

INTEL

Parameters:

#number delay

Delay in seconds.

#INTEL.Contact Contact

Detected contact.

On After "LostCluster" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Cluster Cluster

Lost cluster.

The Auftrag connected with this cluster or nil.

On After "LostContact" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Contact Contact

Lost contact.

On After "NewCluster" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Cluster Cluster

Detected cluster.

On After "NewContact" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Contact Contact

Detected contact.

[Internal] Paint picture of the battle field.

Does Cluster analysis and updates clusters. Sets markers if markers are enabled.

Defined in:

INTEL

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

Remove a conflict zone from the conflict zone set.

Note that conflict zones overrule all other zones, i.e. if a unit is outside of an accept zone and inside a reject zone, it is still reported if inside a conflict zone.

Defined in:

INTEL

Parameter:

Core.Zone#ZONE ConflictZone

Remove a zone from the conflict zone set.

Return value:

self

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.

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

Set the accept range in kilometers from each of the recce.

Only object closer than this range will be detected.

Defined in:

INTEL

Parameter:

#number Range

Range in kilometers

Return value:

self

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.

#boolean Arrows

If true, draws arrows on F10 map.

Return value:

self

Change radius of the Clusters.

Defined in:

INTEL

Parameter:

#number radius

The radius of the clusters in kilometers. Default 15 km.

Return value:

self

Set conflict zones.

Contacts detected in this/these zone(s) are reported by the detection. Note that conflict zones overrule all other zones, i.e. if a unit is outside of an accept zone and inside a reject zone, it is still reported if inside a conflict zone.

Defined in:

INTEL

Parameter:

Core.Set#SET_ZONE ConflictZoneSet

Set of conflict zone(s).

Return value:

self

Set whether STATIC objects are detected.

Defined in:

INTEL

Parameter:

#boolean Switch

If true, statics are detected.

Return value:

self

Set detection types for this #INTEL - all default to true.

Defined in:

INTEL

Parameters:

#boolean DetectVisual

Visual detection

#boolean DetectOptical

Optical detection

#boolean DetectRadar

Radar detection

#boolean DetectIRST

IRST detection

#boolean DetectRWR

RWR detection

#boolean DetectDLINK

Data link detection

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

OBSOLETE, will be removed in next version! 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

Method to make the radar detection less accurate, e.g.

for WWII scenarios.

Defined in:

INTEL

Parameters:

#number minheight

Minimum flight height to be detected, in meters AGL (above ground)

#number thresheight

Threshold to escape the radar if flying below minheight, defaults to 90 (90% escape chance)

#number thresblur

Threshold to be detected by the radar overall, defaults to 85 (85% chance to be found)

#number closing

Closing-in in km - the limit of km from which on it becomes increasingly difficult to escape radar detection if flying towards the radar position. Should be about 1/3 of the radar detection radius in kilometers, defaults to 20.

Return value:

self

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

Set verbosity level for debugging.

Defined in:

INTEL

Parameter:

#number Verbosity

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

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

Add cluster to table.

Defined in:

INTEL

Parameter:

#INTEL.Cluster Cluster

The cluster to add.

Check if the coorindate of the cluster changed.

Defined in:

INTEL

Parameters:

#INTEL.Cluster Cluster

The cluster.

#number Threshold

in meters. Default 100 m.

Reference coordinate. Default is the last known coordinate of the cluster.

Return value:

#boolean:

If true, the coordinate changed by more than the given threshold.

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.

Create a new cluster.

Defined in:

INTEL

Return value:

cluster The cluster.

Create a new cluster from a first contact.

The contact is automatically added to the cluster.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The first contact.

Return value:

cluster The cluster.

Create an #INTEL.Contact item from a given GROUP or STATIC object.

Defined in:

INTEL

Parameters:

The GROUP or STATIC object.

#string RecceName

The name of the recce group that has detected this contact.

Return value:

The contact.

Get closest cluster of contact.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact.

Return values:

The cluster this contact is part of or #nil otherwise.

#number:

Distance to cluster in meters.

Get distance to cluster.

Defined in:

INTEL

Parameters:

#INTEL.Contact Contact

The contact.

#INTEL.Cluster Cluster

The cluster to which the distance is calculated.

Return value:

#number:

Distance in meters.

Check if a Contact is already known.

It is checked, whether the contact is in the contacts table.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

The contact to be added.

Return value:

#boolean:

If true, contact is already known.

Update coordinates of the known clusters.

Defined in:

INTEL

Update an #INTEL.Contact item.

Defined in:

INTEL

Parameter:

#INTEL.Contact Contact

Contact.

Return value:

The contact.

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

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Cluster Cluster

Lost cluster.

The Auftrag connected with this cluster or nil.

On after "LostContact" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Contact Contact

Lost contact.

On after "NewCluster" event.

Defined in:

INTEL

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#INTEL.Cluster Cluster

Detected cluster.

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.RadarBlur
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 in meters in which groups/units are considered to belong to a cluster.

#number INTEL.coalition

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

Core.Set#SET_ZONE INTEL.conflictzoneset

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

#number INTEL.dTforget

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

#boolean INTEL.detectStatics

If true, detect STATIC objects. Default false.

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.

#number INTEL.prediction

Seconds default to be used with CalcClusterFuturePosition.

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

Time interval in seconds after which the status is refreshed. Default 60 sec. Should be negative.

#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 #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

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

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

#string To

The To state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns the End states.

Defined in:

Return value:

#table:

End states.

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Sub processes.

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

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

Defined in:

Return value:

#table:

Transitions.

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

Call handler.

Defined in:

Parameters:

#string step

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

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#string 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.RadarBlur
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 in meters in which groups/units are considered to belong to a cluster.

#number INTEL.coalition

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

Core.Set#SET_ZONE INTEL.conflictzoneset

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

#number INTEL.dTforget

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

#boolean INTEL.detectStatics

If true, detect STATIC objects. Default false.

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.

#number INTEL.prediction

Seconds default to be used with CalcClusterFuturePosition.

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

Time interval in seconds after which the status is refreshed. Default 60 sec. Should be negative.

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

IniObjectCategory

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Core.Event processing Priority.

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

Defined in:

Return value:

#number:

The Core.Event processing Priority.

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()

Defined in:

Parameters:

#BASE Child

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

#BASE FromClass

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

Return value:

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

Subscribe to a DCS Event.

Defined in:

Parameters:

Event ID.

#function EventFunction

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

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

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

Examples:

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

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

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

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

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

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

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

Defined in:

Return value:

Occurs when an Event for an object is triggered.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.

Defined in:

Parameter:

The EventData structure.

BDA.

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

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

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

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

Discard chair after ejection.

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

Defined in:

Parameter:

The EventData structure.

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

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

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

Defined in:

Parameter:

The EventData structure.

Landing quality mark.

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

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

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

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

The EventData structure.

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

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Trigger zone.

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

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

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

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#string:

The Schedule ID of the planned schedule.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#string:

The Schedule ID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

Set the Class Core.Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Core.Event processing Priority.

Return value:

self

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

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

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:


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

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

UnSubscribe to a DCS event.

Defined in:

Parameter:

Event ID.

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

(Internal) Serialize arguments

Defined in:

Parameter:

#table Arguments

Return value:

#string:

Text

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event

Cluster info.

Field(s)

#table INTEL.Cluster.Contacts

Table of contacts in the cluster.

#number INTEL.Cluster.altitude

[AIR] Average flight altitude of the cluster in meters.

Core.Point#COORDINATE INTEL.Cluster.coordinate

Coordinate of the cluster.

#string INTEL.Cluster.ctype

Cluster type of #INTEL.Ctype.

#number INTEL.Cluster.index

Cluster index.

#number INTEL.Cluster.markerID

Marker ID.

Ops.Auftrag#AUFTRAG INTEL.Cluster.mission

The current Auftrag attached to this cluster.

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

#number INTEL.Contact.altitude

[AIR] Flight altitude of the contact in meters.

#string INTEL.Contact.attribute

Generalized attribute.

#number INTEL.Contact.category

Category number.

#string INTEL.Contact.categoryname

Category name.

#string INTEL.Contact.ctype

Contact type of #INTEL.Ctype.

#string INTEL.Contact.groupname

Name of the group.

#number INTEL.Contact.heading

[AIR] Heading of the contact, if available.

#boolean INTEL.Contact.isStatic

If true, contact is a STATIC object.

#boolean INTEL.Contact.isground

If true, contact is a ground group.

#boolean INTEL.Contact.ishelo

If true, contact is a helo group.

#boolean INTEL.Contact.isship

If true, contact is a naval group.

#boolean INTEL.Contact.maneuvering

[AIR] Contact has changed direction by >10 deg.

Ops.Auftrag#AUFTRAG INTEL.Contact.mission

The current Auftrag attached to this contact.

#string INTEL.Contact.platform

[AIR] Contact platform name, e.g. Foxbat, Flanker_E, defaults to Bogey if unknown

Core.Point#COORDINATE INTEL.Contact.position

Last known position of the item.

#string INTEL.Contact.recce

The name of the recce unit that detected this contact.

#number INTEL.Contact.speed

Last known speed in m/s.

Ops.Target#TARGET INTEL.Contact.target

The Target attached to this contact.

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

Contact or cluster type.

Field(s)

#string INTEL.Ctype.AIRCRAFT

Airpane or helicopter.

#string INTEL.Ctype.GROUND

Ground.

#string INTEL.Ctype.NAVAL

Ship.

#string INTEL.Ctype.STRUCTURE

Static structure.

Function(s)