Close ×

AI.AI_A2A_Cap

AI -- (R2.2) - Models the process of Combat Air Patrol (CAP) for airplanes.
AI.AI_A2A_Dispatcher

AI - (R2.2) - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.
AI.AI_A2A_GCI

AI -- (R2.2) - Models the process of Ground Controlled Interception (GCI) for airplanes.
AI.AI_A2A_Patrol

AI -- (R2.2) - Models the process of air patrol of airplanes.
AI.AI_A2G_BAI

AI -- Models the process of air to ground BAI engagement for airplanes and helicopters.
AI.AI_A2G_CAS

AI -- Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_A2G_Dispatcher

AI - Create an automated A2G defense system based on a detection network of reconnaissance vehicles and air units, coordinating SEAD, BAI and CAP operations.
AI.AI_A2G_SEAD

AI -- Models the process of air to ground SEAD engagement for airplanes and helicopters.
AI.AI_AIR_Dispatcher

AI - Create an automated AIR defense system based on a detection network of reconnaissance vehicles and air units, coordinating SEAD, BAI and CAP operations.
AI.AI_Air

AI - Models the process of AI air operations.
AI.AI_Air_Engage

AI -- Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_Air_Patrol

AI -- Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.
AI.AI_Air_Squadron

AI - Models squadrons for airplanes and helicopters.
AI.AI_Bai

AI -- Peform Battlefield Area Interdiction (BAI) within an engagement zone.
AI.AI_Balancer

AI -- Balance player slots with AI to create an engaging simulation environment, independent of the amount of players.
AI.AI_Cap

AI -- Perform Combat Air Patrolling (CAP) for airplanes.
AI.AI_Cargo

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_APC

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Airplane

AI -- (R2.4) - Models the intelligent transportation of infantry (cargo).
AI.AI_Cargo_Dispatcher

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Dispatcher_APC

AI -- (2.4) - Models the intelligent transportation of infantry and other cargo using APCs.
AI.AI_Cargo_Dispatcher_Airplane

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo using Planes.
AI.AI_Cargo_Dispatcher_Helicopter

AI -- (2.4) - Models the intelligent transportation of infantry and other cargo using Helicopters.
AI.AI_Cargo_Helicopter

AI -- (R2.4) - Models the intelligent transportation of infantry (cargo).
AI.AI_Cas

AI -- Perform Close Air Support (CAS) near friendlies.
AI.AI_ESCORT_DISPATCHER_REQUEST

AI - Models the assignment of AI escorts to player flights upon request using the radio menu.
AI.AI_Escort

Functional -- Taking the lead of AI escorting your flight or of other AI, upon request using the menu.
AI.AI_Escort_Dispatcher

AI - Models the automatic assignment of AI escorts to player flights.
AI.AI_Formation

AI -- Build large airborne formations of aircraft.
AI.AI_Patrol

AI -- Perform Air Patrolling for airplanes.
Actions.Account

Actions - ACT_ACCOUNT_ classes account for (detect, count & report) various DCS events occuring on Wrapper.Units.
Actions.Assign

(SP) (MP) (FSM) Accept or reject process for player (task) assignments.
Actions.Assist

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Actions.Route

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Cargo.Cargo

Core -- Management of CARGO logistics, that can be transported from and to transportation carriers.
Cargo.CargoCrate

Cargo -- Management of single cargo crates, which are based on a Static object.
Cargo.CargoGroup

Cargo -- Management of grouped cargo logistics, which are based on a Wrapper.Group object.
Cargo.CargoSlingload

Cargo -- Management of single cargo crates, which are based on a Static object.
Cargo.CargoUnit

Cargo -- Management of single cargo logistics, which are based on a Wrapper.Unit object.
Core.Astar

Core - A* Pathfinding.
Core.Base

Core - The base class within the framework.
Core.Database

Core - Manages several databases containing templates, mission objects, and mission information.
Core.Event

Core - Models DCS event dispatching using a publish-subscribe model.
Core.Fsm

Core - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.
Core.Goal

Core - Models the process to achieve goal(s).
Core.Menu

Core - Manage hierarchical menu structures and commands for players within a mission.
Core.Message

Core - Informs the players using messages during a simulation.
Core.Point

Core - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.
Core.Radio

Core - Is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions.
Core.RadioQueue

Core - Queues Radio Transmissions.
Core.RadioSpeech

Core - Makes the radio talk.
Core.Report

Core - Provides a handy means to create messages and reports.
Core.ScheduleDispatcher

Core -- SCHEDULEDISPATCHER dispatches the different schedules.
Core.Scheduler

Core - Prepares and handles the execution of functions over scheduled time (intervals).
Core.Set

Core - Define collections of objects to perform bulk actions and logically group objects.
Core.Settings

Core - Manages various settings for running missions, consumed by moose classes and provides a menu system for players to tweak settings in running missions.
Core.Spawn

Core - Spawn dynamically new groups of units in running missions.
Core.SpawnStatic

Core - Spawn statics.
Core.Spot

Core - Management of spotting logistics, that can be activated and deactivated upon command.
Core.Timer

Core - Timer scheduler.
Core.UserFlag

Core - Manage user flags to interact with the mission editor trigger system and server side scripts.
Core.UserSound

Core - Manage user sound.
Core.Velocity

Core - Models a velocity or speed, which can be expressed in various formats according the settings.
Core.Zone

Core - Define zones within your mission of various forms, with various capabilities.
DCS

DCS API Prototypes
See the Simulator Scripting Engine Documentation on Hoggit for further explanation and examples.
ENUMS

Utilities Enumerators.
Functional.ATC_Ground

Functional -- Monitor airbase traffic and regulate speed while taxiing.
Functional.Arty

Functional - Control artillery units.
Functional.CleanUp

Functional -- Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.
Functional.Designate

Functional -- Management of target Designation.
Functional.Detection

Functional -- Models the detection of enemy units by FACs or RECCEs and group them according various methods.
Functional.Escort

Functional -- Taking the lead of AI escorting your flight.
Functional.FOX

Functional - (R2.5) - Yet Another Missile Trainer.
Functional.MissileTrainer

Functional -- Train missile defence and deflection.
Functional.Movement

Functional -- Limit the movement of simulaneous moving ground vehicles.
Functional.PseudoATC

Functional - Rudimentary ATC.
Functional.Range

Functional - Range Practice.
Functional.Rat

Functional - Create random airtraffic in your missions.
Functional.Scoring

Functional - Administer the scoring of player achievements, and create a CSV file logging the scoring events for use at team or squadron websites.
Functional.Sead

Functional -- Make SAM sites execute evasive and defensive behaviour when being fired upon.
Functional.Suppression

Functional - Suppress fire of ground units when they get hit.
Functional.Warehouse

Functional - Simulation of logistic operations.
Functional.ZoneCaptureCoalition

Functional -- Models the process to zone guarding and capturing.
Functional.ZoneGoal

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone.
Functional.ZoneGoalCargo

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone and Cargo.
Functional.ZoneGoalCoalition

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone for a Coalition.
Ops.Airboss

Ops - Manages aircraft CASE X recoveries for carrier operations (X=I, II, III).
Ops.Airwing

Ops - Airwing Warehouse.
Ops.ArmyGroup

Ops - Enhanced Ground Group.
Ops.Atis

Ops - Automatic Terminal Information Service (ATIS).
Ops.Auftrag

Ops - Auftrag (mission) for Ops.
Ops.FlightGroup

Ops - Enhanced Airborne Group.
Ops.Intel

Ops - Office of Military Intelligence.
Ops.NavyGroup

Ops - Enhanced Naval Group.
Ops.OpsGroup

Ops - Generic group enhancement functions.
Ops.RecoveryTanker

Ops - Recovery tanker for carrier operations.
Ops.RescueHelo

Ops - Rescue helicopter for carrier operations.
Ops.Squadron

Ops - Airwing Squadron.
Ops.Target

Ops - Target.
Tasking.CommandCenter

Tasking -- A command center governs multiple missions, and takes care of the reporting and communications.
Tasking.DetectionManager

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

Tasking -- A mission models a goal to be achieved through the execution and completion of tasks by human players.
Tasking.Task

Tasking -- A task object governs the main engine to administer human taskings.
Tasking.TaskInfo

Tasking -- Controls the information of a Task.
Tasking.TaskZoneCapture

Tasking - The TASK_Protect models tasks for players to protect or capture specific zones.
Tasking.Task_A2A

Tasking - The TASK_A2A models tasks for players in Air to Air engagements.
Tasking.Task_A2A_Dispatcher

Tasking - Dynamically allocates A2A tasks to human players, based on detected airborne targets through an EWR network.
Tasking.Task_A2G

Tasking - The TASK_A2G models tasks for players in Air to Ground engagements.
Tasking.Task_A2G_Dispatcher

Tasking -- Dynamically allocates A2G tasks to human players, based on detected ground targets through reconnaissance.
Tasking.Task_Cargo

Tasking -- Base class to model tasks for players to transport cargo.
Tasking.Task_Cargo_CSAR

Tasking -- Orchestrates the task for players to execute CSAR for downed pilots.
Tasking.Task_Cargo_Dispatcher

Tasking - Creates and manages player TASK_CARGO tasks.
Tasking.Task_Cargo_Transport

Tasking -- Models tasks for players to transport cargo.
Tasking.Task_Manager

This module contains the TASK_MANAGER class and derived classes.
Tasking.Task_Zone_Capture_Dispatcher

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.
Utilities.PROFILER

Utils - Lua Profiler.
Utils

This module contains derived utilities taken from the MIST framework, which are excellent tools to be reused in an OO environment.
Wrapper.Airbase

Wrapper -- AIRBASE is a wrapper class to handle the DCS Airbase objects.
Wrapper.Client

Wrapper -- CLIENT wraps DCS Unit objects acting as a Client or Player within a mission.
Wrapper.Controllable

Wrapper -- CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".
Wrapper.Group

Wrapper -- GROUP wraps the DCS Class Group objects.
Wrapper.Identifiable

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.
Wrapper.Marker

Wrapper - Markers On the F10 map.
Wrapper.Object

Wrapper -- OBJECT wraps the DCS Object derived objects.
Wrapper.Positionable

Wrapper -- POSITIONABLE wraps DCS classes that are "positionable".
Wrapper.Scenery

Wrapper -- SCENERY models scenery within the DCS simulator.
Wrapper.Static

Wrapper -- STATIC wraps the DCS StaticObject class.
Wrapper.Unit

Wrapper - UNIT is a wrapper class for the DCS Class Unit.
routines

Various routines

Module Ops.Intel

Ops - Office of Military Intelligence.

Main Features:

Stuff

Author: funkyfranky

Global(s)

Global INTEL

Top Secret!

Banner Image

The INTEL Concept

#INTEL INTEL

Top Secret!

Banner Image

The INTEL Concept

Type(s)

Type INTEL

INTEL , extends Core.Fsm#FSM , extends Core.Base#BASE

Fields and Methods inherited from INTEL	Description
INTEL:AddAcceptZone(AcceptZone)	Set accept zones.
INTEL:AddContact(Contact)	Add a contact to our list.
INTEL:AddContactToCluster(contact, cluster)	Add a contact to the cluster.
INTEL:CalcClusterThreatlevelAverage(cluster)	Calculate cluster threat level average.
INTEL:CalcClusterThreatlevelMax(cluster)	Calculate max cluster threat level.
INTEL:CalcClusterThreatlevelSum(cluster)	Calculate cluster threat level sum.
INTEL:CheckClusterCoordinateChanged(cluster, coordinate)	Get the coordinate of a cluster.
INTEL:CheckContactInClusters(contact)	Check if contact is in any known cluster.
INTEL.ClassName	Name of the class.
INTEL.Clusters	Clusters of detected groups.
INTEL.Contacts	Table of detected items.
INTEL.ContactsLost	Table of lost detected items.
INTEL.ContactsUnknown	Table of new detected items.
INTEL:CreateCluster(coordinate)	Create a new cluster.
INTEL:CreateDetectedItems(DetectedGroups)	Create detected items.
INTEL.Debug	Debug mode. Messages to all about status.
INTEL:FilterCategoryGroup(GroupCategories)	Filter group categories.
INTEL:GetClusterCoordinate(cluster)	Get the coordinate of a cluster.
INTEL:GetClusterOfContact(contact)	Get the cluster this contact belongs to (if any).
INTEL:GetContactByName(groupname)	Get a contact by name.
INTEL:GetDetectedUnits(Unit, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK, DetectedUnits)	Return the detected target groups of the controllable as a SET_GROUP.
INTEL:IsContactConnectedToCluster(contact, cluster)	Check if contact is close to any other contact this cluster.
INTEL:IsContactPartOfAnyClusters(contact)	Check if contact is close to any contact of known clusters.
INTEL:New(DetectionSet, Coalition)	Create a new INTEL object and start the FSM.
INTEL:PaintPicture()	Paint picture of the battle field.
INTEL:RemoveContact(Contact)	Remove a contact from our list.
INTEL:RemoveContactFromCluster(contact, cluster)	Remove a contact from a cluster.
INTEL:SetAcceptZones(AcceptZoneSet)	Set accept zones.
INTEL:SetClusterAnalysis(Switch, Markers)	Enable or disable cluster analysis of detected targets.
INTEL:SetFilterCategory(Categories)	Filter unit categories.
INTEL:SetForgetTime(TimeInterval)	Set forget contacts time interval.
INTEL:Start()	Triggers the FSM event "Start".
INTEL:Status()	Triggers the FSM event "Status".
INTEL:UpdateClusterMarker(cluster)	Update cluster F10 marker.
INTEL:UpdateIntel()	Update detected items.
INTEL:_CheckContactLost(Contact)	Check if a contact was lost.
INTEL:__Start(delay)	Triggers the FSM event "Start" after a delay.
INTEL:__Status(delay)	Triggers the FSM event "Status" after a delay.
INTEL:__Stop(delay)	Triggers the FSM event "Stop" after a delay.
INTEL.acceptzoneset	Set of accept zones. If defined, only contacts in these zones are considered.
INTEL.alias	Name of the agency.
INTEL.clusteranalysis	If true, create clusters of detected targets.
INTEL.clustercounter	Running number of clusters.
INTEL.clustermarkers	If true, create cluster markers on F10 map.
INTEL.coalition	Coalition side number, e.g. `coalition.side.RED`.
INTEL.dTforget	Time interval in seconds before a known contact which is not detected any more is forgotten.
INTEL.detectionset	Set of detection groups, aka agents.
INTEL.filterCategory	Filter for unit categories.
INTEL.filterCategoryGroup	Filter for group categories.
INTEL.lid	Class id string for output to DCS log file.
INTEL:onafterLostContact(From, Event, To, Contact)	On after "LostContact" event.
INTEL:onafterNewContact(From, Event, To, Contact)	On after "NewContact" event.
INTEL:onafterStart(From, Event, To)	On after Start event.
INTEL:onafterStatus(From, Event, To)	On after "Status" event.
INTEL.rejectzoneset	Set of reject zones. Contacts in these zones are not considered, even if they are in accept zones.
INTEL.verbose	Verbosity level.
INTEL.version	INTEL class version.

Fields and Methods inherited from FSM	Description
INTEL:AddEndState(State)	Adds an End state.
INTEL:AddProcess(From, Event, Process, ReturnEvents)	Set the default Process template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.
INTEL:AddScore(State, ScoreText, Score)	Adds a score for the FSM to be achieved.
INTEL:AddScoreProcess(From, Event, State, ScoreText, Score)	Adds a score for the FSM_PROCESS to be achieved.
INTEL:AddTransition(From, Event, To)	Add a new transition rule to the FSM.
INTEL.CallScheduler	Call scheduler.
INTEL.ClassName	Name of the class.
INTEL.Events
INTEL:GetCurrentState()	Get current state.
INTEL:GetEndStates()	Returns the End states.
INTEL:GetProcess(From, Event)
INTEL:GetProcesses()	Returns a table of the SubFSM rules defined within the FSM.
INTEL:GetScores(Scores)	Returns a table with the scores defined.
INTEL:GetStartState()	Returns the start state of the FSM.
INTEL:GetState()	Get current state.
INTEL:GetSubs()	Returns a table with the Subs defined.
INTEL:GetTransitions()	Returns a table of the transition rules defined within the FSM.
INTEL:Is(State, If)	Check if FSM is in state.
INTEL:LoadCallBacks(CallBackTable)	Load call backs.
INTEL:New()	Creates a new FSM object.
INTEL.Scores	Scores.
INTEL:SetProcess(From, Event, Fsm)
INTEL:SetStartState(State)	Sets the start state of the FSM.
INTEL._EndStates
INTEL._EventSchedules
INTEL._Processes
INTEL._Scores
INTEL._StartState
INTEL._Transitions
INTEL:_add_to_map(Map, Event)	Add to map.
INTEL:_call_handler(step, trigger, params, EventName)	Call handler.
INTEL:_create_transition(EventName)	Create transition.
INTEL:_delayed_transition(EventName)	Delayed transition.
INTEL:_eventmap(Events, EventStructure)	Event map.
INTEL:_gosub(ParentFrom, ParentEvent)	Go sub.
INTEL:_handler(EventName, ...)	Handler.
INTEL:_isendstate(Current)	Is end state.
INTEL:_submap(subs, sub, name)	Sub maps.
INTEL:can(e)	Check if can do an event.
INTEL:cannot(e)	Check if cannot do an event.
INTEL.current	Current state name.
INTEL.endstates
INTEL:is(State, If, state)	Check if FSM is in state.
INTEL.options	Options.
INTEL.subs	Subs.

Fields and Methods inherited from BASE	Description
INTEL.ClassID	The ID number of the class.
INTEL.ClassName	The name of the class.
INTEL.ClassNameAndID	The name of the class concatenated with the ID number of the class.
INTEL:ClearState(Object, StateName)	Clear the state of an object.
INTEL:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)	Creation of a Birth Event.
INTEL:CreateEventCrash(EventTime, Initiator)	Creation of a Crash Event.
INTEL:CreateEventDead(EventTime, Initiator)	Creation of a Dead Event.
INTEL:CreateEventRemoveUnit(EventTime, Initiator)	Creation of a Remove Unit Event.
INTEL:CreateEventTakeoff(EventTime, Initiator)	Creation of a Takeoff Event.
INTEL:CreateEventUnitLost(EventTime, Initiator)	Creation of a Crash Event.
INTEL:E(Arguments)	Log an exception which will be traced always.
INTEL:EventDispatcher()	Returns the event dispatcher
INTEL:EventRemoveAll()	Remove all subscribed events
INTEL:F(Arguments)	Trace a function call.
INTEL:F2(Arguments)	Trace a function call level 2.
INTEL:F3(Arguments)	Trace a function call level 3.
INTEL:GetClassID()	Get the ClassID of the class instance.
INTEL:GetClassName()	Get the ClassName of the class instance.
INTEL:GetClassNameAndID()	Get the ClassName + ClassID of the class instance.
INTEL:GetEventPriority()	Get the Class Event processing Priority.
INTEL:GetParent(Child, FromClass)	This is the worker method to retrieve the Parent class.
INTEL:GetState(Object, Key)	Get a Value given a Key from the Object.
INTEL:HandleEvent(Event, EventFunction)	Subscribe to a DCS Event.
INTEL:I(Arguments)	Log an information which will be traced always.
INTEL:Inherit(Child, Parent)	This is the worker method to inherit from a parent class.
INTEL:IsInstanceOf(ClassName)	This is the worker method to check if an object is an (sub)instance of a class.
INTEL:IsTrace()	Enquires if tracing is on (for the class).
INTEL:New()	BASE constructor.
INTEL:OnEvent(EventData)	Occurs when an object is completely destroyed.
INTEL:OnEventBaseCaptured(EventData)	Occurs when a ground unit captures either an airbase or a farp.
INTEL:OnEventBirth(EventData)	Occurs when any object is spawned into the mission.
INTEL:OnEventCrash(EventData)	Occurs when any aircraft crashes into the ground and is completely destroyed.
INTEL:OnEventDead(EventData)	Occurs when an object is dead.
INTEL:OnEventDetailedFailure(EventData)	Unknown precisely what creates this event, likely tied into newer damage model.
INTEL:OnEventEjection(EventData)	Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected
INTEL:OnEventEngineShutdown(EventData)	Occurs when any aircraft shuts down its engines.
INTEL:OnEventEngineStartup(EventData)	Occurs when any aircraft starts its engines.
INTEL:OnEventHit(EventData)	Occurs whenever an object is hit by a weapon.
INTEL:OnEventHumanFailure(EventData)	Occurs when any system fails on a human controlled aircraft.
INTEL:OnEventKill(EventData)	Occurs on the death of a unit.
INTEL:OnEventLand(EventData)	Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.
INTEL:OnEventLandingAfterEjection(EventData)	Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
INTEL:OnEventMarkAdded(EventData)	Occurs when a new mark was added.
INTEL:OnEventMarkChange(EventData)	Occurs when a mark text was changed.
INTEL:OnEventMarkRemoved(EventData)	Occurs when a mark was removed.
INTEL:OnEventMissionEnd(EventData)	Occurs when a mission ends
INTEL:OnEventMissionStart(EventData)	Occurs when a mission starts
INTEL:OnEventPilotDead(EventData)	Occurs when the pilot of an aircraft is killed.
INTEL:OnEventPlayerEnterUnit(EventData)	Occurs when any player assumes direct control of a unit.
INTEL:OnEventPlayerLeaveUnit(EventData)	Occurs when any player relieves control of a unit to the AI.
INTEL:OnEventRefueling(EventData)	Occurs when an aircraft connects with a tanker and begins taking on fuel.
INTEL:OnEventRefuelingStop(EventData)	Occurs when an aircraft is finished taking fuel.
INTEL:OnEventScore(EventData)	Occurs when any modification to the "Score" as seen on the debrief menu would occur.
INTEL:OnEventShootingEnd(EventData)	Occurs when any unit stops firing its weapon.
INTEL:OnEventShootingStart(EventData)	Occurs when any unit begins firing a weapon that has a high rate of fire.
INTEL:OnEventShot(EventData)	Occurs whenever any unit in a mission fires a weapon.
INTEL:OnEventTakeoff(EventData)	Occurs when an aircraft takes off from an airbase, farp, or ship.
INTEL:OnEventUnitLost(EventData)	Occurs when the game thinks an object is destroyed.
INTEL:ScheduleOnce(Start, SchedulerFunction, ...)	Schedule a new time event.
INTEL:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)	Schedule a new time event.
INTEL:ScheduleStop(SchedulerFunction)	Stops the Schedule.
INTEL.Scheduler
INTEL:SetEventPriority(EventPriority)	Set the Class Event processing Priority.
INTEL:SetState(Object, Key, Value)	Set a state or property of the Object given a Key and a Value.
INTEL:T(Arguments)	Trace a function logic level 1.
INTEL:T2(Arguments)	Trace a function logic level 2.
INTEL:T3(Arguments)	Trace a function logic level 3.
INTEL:TraceAll(TraceAll)	Trace all methods in MOOSE
INTEL:TraceClass(Class)	Set tracing for a class
INTEL:TraceClassMethod(Class, Method)	Set tracing for a specific method of class
INTEL:TraceLevel(Level)	Set trace level
INTEL:TraceOff()	Set trace off.
INTEL:TraceOn()	Set trace on.
INTEL:TraceOnOff(TraceOnOff)	Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.
INTEL:UnHandleEvent(Event)	UnSubscribe to a DCS event.
INTEL._
INTEL:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)	Trace a function call.
INTEL:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)	Trace a function logic.
INTEL.__
INTEL:onEvent(event)

Type INTEL.Cluster

INTEL.Cluster

Fields and Methods inherited from INTEL.Cluster	Description
INTEL.Cluster.Contacts	Table of contacts in the cluster.
INTEL.Cluster.coordinate	Coordinate of the cluster.
INTEL.Cluster.index	Cluster index.
INTEL.Cluster.marker	F10 marker.
INTEL.Cluster.size	Number of groups in the cluster.
INTEL.Cluster.threatlevelAve	Average of threat levels.
INTEL.Cluster.threatlevelMax	Max threat level of cluster.
INTEL.Cluster.threatlevelSum	Sum of threat levels.

Type INTEL.Contact

INTEL.Contact

Fields and Methods inherited from INTEL.Contact	Description
INTEL.Contact.Tdetected	Time stamp in abs. mission time seconds when this item was last detected.
INTEL.Contact.attribute	Generalized attribute.
INTEL.Contact.category	Category number.
INTEL.Contact.categoryname	Category name.
INTEL.Contact.group	The contact group.
INTEL.Contact.groupname	Name of the group.
INTEL.Contact.isgrund
INTEL.Contact.ishelo
INTEL.Contact.isship
INTEL.Contact.position	Last known position of the item.
INTEL.Contact.speed	Last known speed in m/s.
INTEL.Contact.threatlevel	Threat level of this item.
INTEL.Contact.typename	Type name of detected item.
INTEL.Contact.velocity	3D velocity vector. Components x,y and z in m/s.

Type Ops.Intel

Type INTEL

INTEL class.

Field(s)

#string INTEL.ClassName

Name of the class.

#table INTEL.Clusters

Clusters of detected groups.

#table INTEL.Contacts

Table of detected items.

#table INTEL.ContactsLost

Table of lost detected items.

#table INTEL.ContactsUnknown

Table of new detected items.

#boolean INTEL.Debug

Debug mode. Messages to all about status.

Core.Set#SET_ZONE INTEL.acceptzoneset

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

#string INTEL.alias

Name of the agency.

#boolean INTEL.clusteranalysis

If true, create clusters of detected targets.

#number INTEL.clustercounter

Running number of clusters.

#boolean INTEL.clustermarkers

If true, create cluster markers on F10 map.

#number INTEL.coalition

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

#number INTEL.dTforget

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

Core.Set#SET_GROUP INTEL.detectionset

Set of detection groups, aka agents.

#table INTEL.filterCategory

Filter for unit categories.

#table INTEL.filterCategoryGroup

Filter for group categories.

#string INTEL.lid

Class id string for output to DCS log file.

Core.Set#SET_ZONE INTEL.rejectzoneset

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

#number INTEL.verbose

Verbosity level.

#string INTEL.version

INTEL class version.

Function(s)

INTEL:AddAcceptZone(AcceptZone)

Set accept zones.

Only contacts detected in this zone are considered.

Defined in:

INTEL

Parameter:

Core.Zone#ZONE AcceptZone

Add a zone to the accept zone set.

Return value:

#INTEL:

self

INTEL:AddContact(Contact)

Add a contact to our list.

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

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

Create detected items.

Defined in:

INTEL

Parameter:

#table DetectedGroups

Table of detected Groups

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:

#INTEL:

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, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK, DetectedUnits)

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.

#boolean DetectVisual

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

#boolean DetectOptical

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

#boolean DetectRadar

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

#boolean DetectIRST

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

#boolean DetectRWR

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

#boolean DetectDLINK

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

DetectedUnits

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)

Create a new INTEL object and start the FSM.

Defined in:

INTEL

Parameters:

Core.Set#SET_GROUP DetectionSet

Set of detection groups.

#number Coalition

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

Return value:

#INTEL:

self

INTEL:PaintPicture()

Paint picture of the battle field.

Defined in:

INTEL

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

#INTEL:

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:

#INTEL:

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:

#INTEL:

self

INTEL:SetForgetTime(TimeInterval)

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:

#INTEL:

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:

#INTEL:

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

#boolean INTEL.Debug

Debug mode. Messages to all about status.

Core.Set#SET_ZONE INTEL.acceptzoneset

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

#string INTEL.alias

Name of the agency.

#boolean INTEL.clusteranalysis

If true, create clusters of detected targets.

#number INTEL.clustercounter

Running number of clusters.

#boolean INTEL.clustermarkers

If true, create cluster markers on F10 map.

#number INTEL.coalition

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

#number INTEL.dTforget

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

Core.Set#SET_GROUP INTEL.detectionset

Set of detection groups, aka agents.

#table INTEL.filterCategory

Filter for unit categories.

#table INTEL.filterCategoryGroup

Filter for group categories.

#string INTEL.lid

Class id string for output to DCS log file.

Core.Set#SET_ZONE INTEL.rejectzoneset

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

#number INTEL.verbose

Verbosity level.

#string INTEL.version

INTEL class version.

Function(s)

INTEL:AddEndState(State)

Adds an End state.

Defined in:

Core.Fsm#FSM

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:

Core.Fsm#FSM

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:

Core.Fsm#FSM

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:

Core.Fsm#FSM

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:

Core.Fsm#FSM

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:

Core.Fsm#FSM

Return value:

#string:

Current FSM state.

INTEL:GetEndStates()

Returns the End states.

Defined in:

Core.Fsm#FSM

Return value:

#table:

End states.

INTEL:GetProcess(From, Event)

Defined in:

Core.Fsm#FSM

Parameters:

From

Event

INTEL:GetProcesses()

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

Defined in:

Core.Fsm#FSM

Return value:

#table:

Sub processes.

INTEL:GetScores(Scores)

Returns a table with the scores defined.

Defined in:

Core.Fsm#FSM

Parameter:

#table Scores

INTEL:GetStartState()

Returns the start state of the FSM.

Defined in:

Core.Fsm#FSM

Return value:

#string:

A string containing the start state.

INTEL:GetState()

Get current state.

Defined in:

Core.Fsm#FSM

Return value:

#string:

Current FSM state.

INTEL:GetSubs()

Returns a table with the Subs defined.

Defined in:

Core.Fsm#FSM

Return value:

#table:

Sub processes.

INTEL:GetTransitions()

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

Defined in:

Core.Fsm#FSM

Return value:

#table:

Transitions.

INTEL:Is(State, If)

Check if FSM is in state.

Defined in:

Core.Fsm#FSM

Parameters:

#string State

State name.

#boolean If

true, FSM is in this state.

INTEL:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Core.Fsm#FSM

Parameter:

#table CallBackTable

Table of call backs.

INTEL:New()

Creates a new FSM object.

Defined in:

Core.Fsm#FSM

Return value:

#FSM:

INTEL:SetProcess(From, Event, Fsm)

Defined in:

Core.Fsm#FSM

Parameters:

From

Event

Fsm

INTEL:SetStartState(State)

Sets the start state of the FSM.

Defined in:

Core.Fsm#FSM

Parameter:

#string State

A string defining the start state.

INTEL:_add_to_map(Map, Event)

Add to map.

Defined in:

Core.Fsm#FSM

Parameters:

#table Map

Map.

#table Event

Event table.

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

Call handler.

Defined in:

Core.Fsm#FSM

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:

Core.Fsm#FSM

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

INTEL:_delayed_transition(EventName)

Delayed transition.

Defined in:

Core.Fsm#FSM

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

INTEL:_eventmap(Events, EventStructure)

Event map.

Defined in:

Core.Fsm#FSM

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

INTEL:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Core.Fsm#FSM

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

INTEL:_handler(EventName, ...)

Handler.

Defined in:

Core.Fsm#FSM

Parameters:

#string EventName

Event name.

...

Arguments.

INTEL:_isendstate(Current)

Is end state.

Defined in:

Core.Fsm#FSM

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

INTEL:_submap(subs, sub, name)

Sub maps.

Defined in:

Core.Fsm#FSM

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

INTEL:can(e)

Check if can do an event.

Defined in:

Core.Fsm#FSM

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:

Core.Fsm#FSM

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

INTEL:is(State, If, state)

Check if FSM is in state.

Defined in:

Core.Fsm#FSM

Parameters:

#string State

State name.

#boolean If

true, FSM is in this state.

state

Field(s)

#string INTEL.ClassName

Name of the class.

#table INTEL.Clusters

Clusters of detected groups.

#table INTEL.Contacts

Table of detected items.

#table INTEL.ContactsLost

Table of lost detected items.

#table INTEL.ContactsUnknown

Table of new detected items.

#boolean INTEL.Debug

Debug mode. Messages to all about status.

Core.Set#SET_ZONE INTEL.acceptzoneset

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

#string INTEL.alias

Name of the agency.

#boolean INTEL.clusteranalysis

If true, create clusters of detected targets.

#number INTEL.clustercounter

Running number of clusters.

#boolean INTEL.clustermarkers

If true, create cluster markers on F10 map.

#number INTEL.coalition

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

#number INTEL.dTforget

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

Core.Set#SET_GROUP INTEL.detectionset

Set of detection groups, aka agents.

#table INTEL.filterCategory

Filter for unit categories.

#table INTEL.filterCategoryGroup

Filter for group categories.

#string INTEL.lid

Class id string for output to DCS log file.

Core.Set#SET_ZONE INTEL.rejectzoneset

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

#number INTEL.verbose

Verbosity level.

#string INTEL.version

INTEL class version.

Function(s)

INTEL:ClearState(Object, StateName)

Clear the state of an object.