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

Functional -- Modular, Automatic and Network capable Targeting and Interception System for Air Defenses
MANTIS - Moose derived  Modular, Automatic and Network capable Targeting and Interception System
Controls a network of SAM sites.
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.Atis

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

Ops - Recovery tanker for carrier operations.
Ops.RescueHelo

Ops - Rescue helicopter for carrier operations.
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 Functional.Mantis

Functional -- Modular, Automatic and Network capable Targeting and Interception System for Air Defenses

MANTIS - Moose derived Modular, Automatic and Network capable Targeting and Interception System Controls a network of SAM sites.

Use detection to switch on the AA site closest to the enemy Leverage evasiveness from SEAD Leverage attack range setup added by DCS in 11/20

Missions:

MANTIS - Modular, Automatic and Network capable Targeting and Interception System

Author : applevangelist

Global(s)

Global MANTIS

The worst thing that can happen to a good cause is, not to be skillfully attacked, but to be ineptly defended. - Frédéric Bastiat

Simple Class for a more intelligent Air Defense System

MANTIS

Moose derived Modular, Automatic and Network capable Targeting and Interception System.

#MANTIS MANTIS

The worst thing that can happen to a good cause is, not to be skillfully attacked, but to be ineptly defended. - Frédéric Bastiat

Simple Class for a more intelligent Air Defense System

MANTIS

Moose derived Modular, Automatic and Network capable Targeting and Interception System.

Controls a network of SAM sites. Use detection to switch on the AA site closest to the enemy. Leverage evasiveness from Functional.Sead#SEAD. Leverage attack range setup added by DCS in 11/20.

Set up your SAM sites in the mission editor. Name the groups with common prefix like "Red SAM". Set up your EWR system in the mission editor. Name the groups with common prefix like "Red EWR". Can be e.g. AWACS or a combination of AWACS and Search Radars like e.g. EWR 1L13 etc. [optional] Set up your HQ. Can be any group, e.g. a command vehicle.

1. Start up your MANTIS

myredmantis = MANTIS:New("myredmantis","Red SAM","Red EWR",nil,"red",false)

[optional] Use

MANTIS:SetEWRGrouping(radius)
MANTIS:SetEWRRange(radius)
MANTIS:SetSAMRadius(radius)
MANTIS:SetDetectInterval(interval)
MANTIS:SetAutoRelocate(hq, ewr)

to fine-tune your setup.

myredmantis:Start()

2. Default settings

By default, the following settings are active:

SAM_Templates_Prefix = "Red SAM" - SAM site group names in the mission editor begin with "Red SAM"
EWR_Templates_Prefix = "Red EWR" - EWR group names in the mission editor begin with "Red EWR" - can also be AWACS
checkradius = 25000 (meters) - SAMs will engage enemy flights, if they are within a 25km around each SAM site - MANTIS:SetSAMRadius(radius)
grouping = 5000 (meters) - Detection (EWR) will group enemy flights to areas of 5km for tracking - MANTIS:SetEWRGrouping(radius)
acceptrange = 80000 (meters) - Detection (EWR) will on consider flights inside a 80km radius - MANTIS:SetEWRRange(radius)
detectinterval = 30 (seconds) - MANTIS will decide every 30 seconds which SAM to activate - MANTIS:SetDetectInterval(interval)
engagerange = 75 (percent) - SAMs will only fire if flights are inside of a 75% radius of their max firerange - MANTIS:SetSAMRange(range)
dynamic = false - Group filtering is set to once, i.e. newly added groups will not be part of the setup by default - MANTIS:New(name,samprefix,ewrprefix,hq,coaltion,dynamic)
autorelocate = false - HQ and (mobile) EWR system will not relocate in random intervals between 30mins and 1 hour - MANTIS:SetAutoRelocate(hq, ewr)
debug = false - Debugging reports on screen are set to off - MANTIS:Debug(onoff)

Global _MANTISdetection

_MANTISdetection

[internal] Grouping detected objects to 5000m zones

Type(s)

Type MANTIS

MANTIS

Fields and Methods inherited from MANTIS	Description
MANTIS.@	Functional.Detection#DETECTION_AREAS} Detection The #DETECTION_AREAS object
MANTIS.Adv_EWR_Group
MANTIS:CheckObjectInZone(dectset, samcoordinate)	Function to check if any object is in the given SAM zone
MANTIS.Classname
MANTIS.Coalition
MANTIS:Debug(onoff)	Function to set switch-on/off the debug state
MANTIS.Detection
MANTIS.EWR_Group
MANTIS.EWR_Templates_Prefix	Prefix to build the #GROUP_SET for EWR group
MANTIS:GetCommandCenter()	Function to get the HQ object for further use
MANTIS.MantisAdvTimer
MANTIS.MantisReloTimer
MANTIS.MantisTimer
MANTIS:New(name, samprefix, ewrprefix, hq, coaltion, dynamic)	Function instantiate new class
MANTIS.SAM_Group
MANTIS.SAM_Table	Table of SAM sites
MANTIS.SAM_Templates_Prefix	Prefix to build the #GROUP_SET for SAM sites
MANTIS.SEAD_CC
MANTIS.SEAD_Template_CC	The ME name of the HQ object
MANTIS:SetAdvancedMode(onoff, ratio)	Function to set Advanded Mode
MANTIS:SetAutoRelocate(hq, ewr)	Function to set autorelocation for HQ and EWR objects.
MANTIS:SetCommandCenter(The, group)	Function to set the HQ object for further use
MANTIS:SetDetectInterval(interval)	Function to set the detection interval
MANTIS:SetEWRGrouping(radius)	Function to set the grouping radius of the detection in meters
MANTIS:SetEWRRange(radius)	Function to set the detection radius of the EWR in meters
MANTIS:SetSAMRadius(radius)	Function to set switch-on/off zone for the SAM sites in meters
MANTIS:SetSAMRange(range)	Function to set SAM firing engage range, 0-100 percent, e.g.
MANTIS:SetSAMStartState()	Function to set the SAM start state
MANTIS:Start()	Function to set the SAM start state
MANTIS:StartDetection()	Function to start the detection via EWR groups
MANTIS:Stop()	Function to stop MANTIS
MANTIS:_CheckAdvState()	[Internal] Function to determine state of the advanced mode
MANTIS:_CheckEWRState()	[Internal] Function to check if EWR is (at least partially) alive
MANTIS:_CheckHQState()	[Internal] Function to check if HQ is alive
MANTIS:_GetSAMTable()	[internal] Function to get the self.SAM_Table
MANTIS:_RelocateGroups()	[Internal] Function to execute the relocation
MANTIS:_SetSAMTable(table)	[internal] Function to set the self.SAM_Table
MANTIS.acceptrange	Radius of the EWR detection
MANTIS.adv_ratio	Percentage to use for advanced mode, defaults to 100%
MANTIS.adv_state	Advanced mode state tracker
MANTIS.advanced	Use advanced mode, will decrease reactivity of MANTIS, if HQ and/or EWR network dies. Set SAMs to RED state if both are dead. Requires usage of an HQ object
MANTIS.autorelocate	Relocate HQ and EWR groups in random intervals. Note: You need to select units for this which are actually mobile
MANTIS.autorelocateunits
MANTIS.checkradius	Radius of the SAM sites
MANTIS.debug	Switch on extra messages
MANTIS.detectinterval	Interval in seconds for the target detection
MANTIS.dynamic
MANTIS.engagerange	Firing engage range of the SAMs, see [https://wiki.hoggitworld.com/view/DCS_option_engagementRange]
MANTIS.grouping	Radius to group detected objects
MANTIS.lid	Prefix for logging
MANTIS.name	Name of this Mantis
MANTIS.verbose	Switch on extra logging
MANTIS.version

Type Functional.Mantis

Type MANTIS

MANTIS class, extends Core.Base#BASE

Field(s)

#string MANTIS.Classname

MANTIS.Detection

MANTIS.EWR_Group

Set EWR SET_GROUP

#string MANTIS.EWR_Templates_Prefix

Prefix to build the #GROUP_SET for EWR group

MANTIS.MantisAdvTimer

timer for advanced state check

MANTIS.MantisReloTimer

MANTIS.MantisTimer

MANTIS.SAM_Group

Set SAM SET_GROUP

#table MANTIS.SAM_Table

Table of SAM sites

#string MANTIS.SAM_Templates_Prefix

Prefix to build the #GROUP_SET for SAM sites

MANTIS.SEAD_CC

#string MANTIS.SEAD_Template_CC

The ME name of the HQ object

#number MANTIS.acceptrange

Radius of the EWR detection

#number MANTIS.adv_ratio

Percentage to use for advanced mode, defaults to 100%

#number MANTIS.adv_state

Advanced mode state tracker

#boolean MANTIS.advanced

Use advanced mode, will decrease reactivity of MANTIS, if HQ and/or EWR network dies. Set SAMs to RED state if both are dead. Requires usage of an HQ object

#boolean MANTIS.autorelocate

Relocate HQ and EWR groups in random intervals. Note: You need to select units for this which are actually mobile

#table MANTIS.autorelocateunits

#number MANTIS.checkradius

Radius of the SAM sites

#boolean MANTIS.debug

Switch on extra messages

#number MANTIS.detectinterval

Interval in seconds for the target detection

#number MANTIS.engagerange

Firing engage range of the SAMs, see [https://wiki.hoggitworld.com/view/DCS_option_engagementRange]

#number MANTIS.grouping

Radius to group detected objects

#string MANTIS.lid

Prefix for logging

#string MANTIS.name

Name of this Mantis

#boolean MANTIS.verbose

Switch on extra logging

#string MANTIS.version

@field #string version

Function(s)

MANTIS:CheckObjectInZone(dectset, samcoordinate)

Function to check if any object is in the given SAM zone

Defined in:

MANTIS

Parameters:

#table dectset

Table of coordinates of detected items

samcoordinate

Core.Point#COORDINATE Coordinate object.

Return value:

#boolean:

True if in any zone, else false

MANTIS:Debug(onoff)

Function to set switch-on/off the debug state

Defined in:

MANTIS

Parameter:

#boolean onoff

Set true to switch on

MANTIS:GetCommandCenter()

Function to get the HQ object for further use

Defined in:

MANTIS

Return value:

Wrapper.GROUP#GROUP:

The HQ #GROUP object or nil if it doesn't exist

MANTIS:New(name, samprefix, ewrprefix, hq, coaltion, dynamic)

Function instantiate new class

Defined in:

MANTIS

Parameters:

#string name

Name of this MANTIS for reporting

#string samprefix

Prefixes for the SAM groups from the ME, e.g. all groups starting with "Red Sam..."

#string ewrprefix

Prefixes for the EWR and AWACS groups from the ME, e.g. all groups starting with "Red EWR..."

#string hq

Group name of your HQ (optional)

#string coaltion

Coalition side of your setup, e.g. "blue", "red" or "neutral"

#boolean dynamic

Use constant (true) filtering or just filter once (false, default)

Return value:

#MANTIS:

self

MANTIS:SetAdvancedMode(onoff, ratio)

Function to set Advanded Mode

Defined in:

MANTIS

Parameters:

#boolean onoff

If true, will activate Advanced Mode

#number ratio

[optional] Percentage to use for advanced mode, defaults to 100%

Usage:

Advanced mode will *decrease* reactivity of MANTIS, if HQ and/or EWR network dies.  Set SAMs to RED state if both are dead.  Requires usage of an **HQ** object
E.g. `mymantis:SetAdvancedMode(true, 90)`

MANTIS:SetAutoRelocate(hq, ewr)

Function to set autorelocation for HQ and EWR objects.

Note: Units must be actually mobile in DCS!

Defined in:

MANTIS

Parameters:

#boolean hq

If true, will relocate HQ object

#boolean ewr

If true, will relocate EWR objects

MANTIS:SetCommandCenter(The, group)

Function to set the HQ object for further use

Defined in:

MANTIS

Parameters:

Return values:

#number:

Newly calculated interval

#number:

Previous state for tracking 0, 1, or 2

MANTIS:_CheckEWRState()

[Internal] Function to check if EWR is (at least partially) alive

Defined in:

MANTIS

Return value:

#boolean:

True if EWR is alive, else false

MANTIS:_CheckHQState()

[Internal] Function to check if HQ is alive

Defined in:

MANTIS

Return value:

#boolean:

True if HQ is alive, else false

MANTIS:_GetSAMTable()

[internal] Function to get the self.SAM_Table

Defined in:

MANTIS

Return value:

#table:

table

MANTIS:_RelocateGroups()

[Internal] Function to execute the relocation

Defined in:

MANTIS

MANTIS:_SetSAMTable(table)

[internal] Function to set the self.SAM_Table

Defined in:

MANTIS

Parameter:

table

Return value:

#MANTIS:

self

Module Functional.Mantis

Missions:

Author : *applevangelist *

Global(s)

Global MANTIS

MANTIS

MANTIS

1. Start up your MANTIS

2. Default settings

Global _MANTISdetection

Type(s)

Field(s)

Function(s)

Defined in:

Parameters:

Return value:

Defined in:

Parameter:

Defined in:

Return value:

Defined in:

Author : applevangelist