Close ×

AI.AI_A2A

AI -- (R2.2) - Models the process of air operations for airplanes.
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_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_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.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 new statics in your running missions.
Core.Spot

Core - Management of spotting logistics, that can be activated and deactivated upon command.
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 https://wiki.hoggitworld.com/view/Simulator_Scripting_Engine_Documentation 
for further explanation and examples.
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.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.
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.
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.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 Utils

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

Authors:

Grimes : Design & Programming of the MIST framework.

Contributions:

FlightControl : Rework to OO framework

Global(s)

Global BIGSMOKEPRESET

#BIGSMOKEPRESET BIGSMOKEPRESET

Global FLARECOLOR

#FLARECOLOR FLARECOLOR

Global SMOKECOLOR

#SMOKECOLOR SMOKECOLOR

Global UTILS

#UTILS UTILS

Global lookup_table

#table lookup_table

Type(s)

Type BIGSMOKEPRESET

BIGSMOKEPRESET

Fields and Methods inherited from BIGSMOKEPRESET	Description
BIGSMOKEPRESET.HugeSmoke
BIGSMOKEPRESET.HugeSmokeAndFire
BIGSMOKEPRESET.LargeSmoke
BIGSMOKEPRESET.LargeSmokeAndFire
BIGSMOKEPRESET.MediumSmoke
BIGSMOKEPRESET.MediumSmokeAndFire
BIGSMOKEPRESET.SmallSmoke
BIGSMOKEPRESET.SmallSmokeAndFire

Type FLARECOLOR

FLARECOLOR

Fields and Methods inherited from FLARECOLOR	Description
FLARECOLOR.Green
FLARECOLOR.Red
FLARECOLOR.White
FLARECOLOR.Yellow

Type SMOKECOLOR

SMOKECOLOR

Fields and Methods inherited from SMOKECOLOR	Description
SMOKECOLOR.Blue
SMOKECOLOR.Green
SMOKECOLOR.Orange
SMOKECOLOR.Red
SMOKECOLOR.White

Type UTILS

UTILS

Fields and Methods inherited from UTILS	Description
UTILS.BasicSerialize(s)
UTILS.BeaufortScale(speed)
UTILS.CelciusToFarenheit(Celcius)
UTILS.ClockToSeconds(clock, Seconds)	Convert clock time from hours, minutes and seconds to seconds.
UTILS.DeepCopy(object)
UTILS.DisplayMissionTime(duration)	Display clock and mission time on screen as a message to all.
UTILS.DoString(s)
UTILS.FeetToMeters(feet)
UTILS.GetMarkID()
UTILS.IsInRadius(InVec2, Vec2, Radius)
UTILS.IsInSphere(InVec3, Vec3, Radius)
UTILS.IsInstanceOf(object, className)	Function to infer instance of an object Examples: UTILS.IsInstanceOf( 'some text', 'string' ) will return true UTILS.IsInstanceOf( some_function, 'function' ) will return true UTILS.IsInstanceOf( 10, 'number' ) will return true UTILS.IsInstanceOf( false, 'boolean' ) will return true UTILS.IsInstanceOf( nil, 'nil' ) will return true UTILS.IsInstanceOf( ZONE:New( 'some zone', ZONE ) will return true UTILS.IsInstanceOf( ZONE:New( 'some zone', 'ZONE' ) will return true UTILS.IsInstanceOf( ZONE:New( 'some zone', 'zone' ) will return true UTILS.IsInstanceOf( ZONE:New( 'some zone', 'BASE' ) will return true UTILS.IsInstanceOf( ZONE:New( 'some zone', 'GROUP' ) will return false
UTILS.KmphToMps(kmph)
UTILS.KnotsToKmph(knots)
UTILS.KnotsToMps(knots)
UTILS.MetersToFeet(meters)
UTILS.MetersToNM(meters)
UTILS.MiphToMps(miph)
UTILS.MpsToKmph(mps)
UTILS.MpsToKnots(mps)
UTILS.MpsToMiph(mps)
UTILS.NMToMeters(NM)
UTILS.OneLineSerialize(tbl)
UTILS.RandomGaussian(x0, sigma, xmin, xmax, imax)	Generate a Gaussian pseudo-random number.
UTILS.Randomize(value, fac, lower, upper)	Randomize a value by a certain amount.
UTILS.Round(num, idp)	From http://lua-users.org/wiki/SimpleRound use negative idp for rounding ahead of decimal place, positive for rounding after decimal place
UTILS.SecondsToClock(seconds)	Convert time in seconds to hours, minutes and seconds.
UTILS.Split(str, sep)	Split string at seperators.
UTILS.ToDegree(angle)
UTILS.ToRadian(angle)
UTILS.VecCross(a, b)	Calculate the cross product of two 3D vectors.
UTILS.VecDot(a, b)	Calculate the dot product of two vectors.
UTILS.VecNorm(a)	Calculate the euclidean norm (length) of a 3D vector.
UTILS._MarkID
UTILS.spairs(t, order)
UTILS.tostringLL(lat, lon, acc, DMS)
UTILS.tostringMGRS(MGRS, acc)

Type Utils

Type BIGSMOKEPRESET

Big smoke preset enum.

Field(s)

#number BIGSMOKEPRESET.HugeSmoke

#number BIGSMOKEPRESET.HugeSmokeAndFire

#number BIGSMOKEPRESET.LargeSmoke

#number BIGSMOKEPRESET.LargeSmokeAndFire

#number BIGSMOKEPRESET.MediumSmoke

#number BIGSMOKEPRESET.MediumSmokeAndFire

#number BIGSMOKEPRESET.SmallSmoke

#number BIGSMOKEPRESET.SmallSmokeAndFire

Function(s)

Type FLARECOLOR

Field(s)

Function(s)

Type SMOKECOLOR

Field(s)

Function(s)

Type UTILS

Utilities static class.

Field(s)

#number UTILS._MarkID

Function(s)

UTILS.BasicSerialize(s)

porting in Slmod's "safestring" basic serialize

Defined in:

UTILS

Parameter:

UTILS.BeaufortScale(speed)

Beaufort scale: returns Beaufort number and wind description as a function of wind speed in m/s.

Defined in:

UTILS

Parameter:

speed

UTILS.CelciusToFarenheit(Celcius)

Defined in:

UTILS

Parameter:

Celcius

UTILS.ClockToSeconds(clock, Seconds)

Convert clock time from hours, minutes and seconds to seconds.

Defined in:

UTILS

Parameters:

#string clock

String of clock time. E.g., "06:12:35" or "5:1:30+1". Format is (H)H:(M)M:((S)S)(+D) H=Hours, M=Minutes, S=Seconds, D=Days.

#number Seconds

Corresponds to what you cet from timer.getAbsTime() function.

UTILS.DeepCopy(object)

from http://lua-users.org/wiki/CopyTable

Defined in:

UTILS

Parameter:

object

UTILS.DisplayMissionTime(duration)

Display clock and mission time on screen as a message to all.

Defined in:

UTILS

Parameter:

#number duration

Duration in seconds how long the time is displayed. Default is 5 seconds.

UTILS.DoString(s)

porting in Slmod's dostring

Defined in:

UTILS

Parameter:

UTILS.FeetToMeters(feet)

Defined in:

UTILS

Parameter:

feet

UTILS.GetMarkID()

get a new mark ID for markings

Defined in:

UTILS

UTILS.IsInRadius(InVec2, Vec2, Radius)

Test if a Vec2 is in a radius of another Vec2

Defined in:

UTILS

Parameters:

InVec2

Vec2

Radius

UTILS.IsInSphere(InVec3, Vec3, Radius)

Test if a Vec3 is in the sphere of another Vec3

Defined in:

UTILS

Parameters:

InVec3

Vec3

Radius

UTILS.IsInstanceOf(object, className)

Function to infer instance of an object

Examples:

UTILS.IsInstanceOf( 'some text', 'string' ) will return true
UTILS.IsInstanceOf( some_function, 'function' ) will return true
UTILS.IsInstanceOf( 10, 'number' ) will return true
UTILS.IsInstanceOf( false, 'boolean' ) will return true
UTILS.IsInstanceOf( nil, 'nil' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', ZONE ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'ZONE' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'zone' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'BASE' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'GROUP' ) will return false

Defined in:

UTILS

Parameters:

object

is the object to be evaluated

className

is the name of the class to evaluate (can be either a string or a Moose class)

Return value:

#boolean:

UTILS.KmphToMps(kmph)

Defined in:

UTILS

Parameter:

kmph

UTILS.KnotsToKmph(knots)

Defined in:

UTILS

Parameter:

knots

UTILS.KnotsToMps(knots)

Defined in:

UTILS

Parameter:

knots

UTILS.MetersToFeet(meters)

Defined in:

UTILS

Parameter:

meters

UTILS.MetersToNM(meters)

Defined in:

UTILS

Parameter:

meters

UTILS.MiphToMps(miph)

Defined in:

UTILS

Parameter:

miph

UTILS.MpsToKmph(mps)

Defined in:

UTILS

Parameter:

mps

UTILS.MpsToKnots(mps)

Defined in:

UTILS

Parameter:

mps

UTILS.MpsToMiph(mps)

Defined in:

UTILS

Parameter:

mps

UTILS.NMToMeters(NM)

Defined in:

UTILS

Parameter:

UTILS.OneLineSerialize(tbl)

porting in Slmod's serialize_slmod2

Defined in:

UTILS

Parameter:

tbl

UTILS.RandomGaussian(x0, sigma, xmin, xmax, imax)

Generate a Gaussian pseudo-random number.

Defined in:

UTILS

Parameters:

#number x0

Expectation value of distribution.

#number sigma

(Optional) Standard deviation. Default 10.

#number xmin

(Optional) Lower cut-off value.

#number xmax

(Optional) Upper cut-off value.

#number imax

(Optional) Max number of tries to get a value between xmin and xmax (if specified). Default 100.

Return value:

#number:

Gaussian random number.

UTILS.Randomize(value, fac, lower, upper)

Randomize a value by a certain amount.

Defined in:

UTILS

Parameters:

#number value

The value which should be randomized

#number fac

Randomization factor.

#number lower

(Optional) Lower limit of the returned value.

#number upper

(Optional) Upper limit of the returned value.

Return value:

#number:

Randomized value.

Usages:

UTILS.Randomize(100, 0.1) returns a value between 90 and 110, i.e. a plus/minus ten percent variation.

UTILS.Randomize(100, 0.5, nil, 120) returns a value between 50 and 120, i.e. a plus/minus fivty percent variation with upper bound 120.

UTILS.Round(num, idp)

From http://lua-users.org/wiki/SimpleRound use negative idp for rounding ahead of decimal place, positive for rounding after decimal place

Defined in:

UTILS

Parameters:

num

idp

UTILS.SecondsToClock(seconds)

Convert time in seconds to hours, minutes and seconds.

Defined in:

UTILS

Parameter:

#number seconds

Time in seconds, e.g. from timer.getAbsTime() function.

Return value:

#string:

Time in format Hours:Minutes:Seconds+Days (HH:MM:SS+D).

UTILS.Split(str, sep)

Split string at seperators.

C.f. http://stackoverflow.com/questions/1426954/split-string-in-lua

Defined in:

UTILS

Parameters:

#string str

Sting to split.

#string sep

Speparator for split.

Return value:

#table:

Split text.

UTILS.ToDegree(angle)

Defined in:

UTILS

Parameter:

angle

UTILS.ToRadian(angle)

Defined in:

UTILS

Parameter:

angle

UTILS.VecCross(a, b)

Calculate the cross product of two 3D vectors.

The result is a 3D vector.

Defined in:

UTILS

Parameters:

DCS#Vec3 a

Vector in 3D with x, y, z components.

DCS#Vec3 b

Vector in 3D with x, y, z components.

Return value:

DCS#Vec3:

Vector

UTILS.VecDot(a, b)

Calculate the dot product of two vectors.

The result is a number.

Defined in:

UTILS

Parameters:

DCS#Vec3 a

Vector in 3D with x, y, z components.

DCS#Vec3 b

Vector in 3D with x, y, z components.

Return value:

#number:

Scalar product of the two vectors a*b.

UTILS.VecNorm(a)

Calculate the euclidean norm (length) of a 3D vector.

Defined in:

UTILS

Parameter:

DCS#Vec3 a

Vector in 3D with x, y, z components.

Return value:

#number:

Norm of the vector.

UTILS.spairs(t, order)

Here is a customized version of pairs, which I called spairs because it iterates over the table in a sorted order.

Defined in:

UTILS

Parameters:

order

UTILS.tostringLL(lat, lon, acc, DMS)

acc: in DM: decimal point of minutes. In DMS: decimal point of seconds. position after the decimal of the least significant digit: So: 42.32 - acc of 2.

Defined in:

UTILS

Parameters:

lat

lon

acc

DMS

UTILS.tostringMGRS(MGRS, acc)

acc- the accuracy of each easting/northing. 0, 1, 2, 3, 4, or 5.

Defined in:

UTILS

Parameters:

MGRS

acc