Close ×

AI.AI_A2A_Cap

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

AI - 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 - Models the process of Ground Controlled Interception (GCI) for airplanes.
AI.AI_A2A_Patrol

AI - 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 with reconnaissance units, coordinating SEAD, BAI and CAS operations.
AI.AI_A2G_SEAD

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

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

AI - Create an automated AIR defense system with reconnaissance units, coordinating SEAD, BAI and CAP 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_CAS

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

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_APC

AI - Models the intelligent transportation of cargo using ground vehicles.
AI.AI_Cargo_Airplane

AI - Models the intelligent transportation of cargo using airplanes.
AI.AI_Cargo_Dispatcher

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Dispatcher_APC

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

AI - Models the intelligent transportation of infantry and other cargo using Planes.
AI.AI_Cargo_Dispatcher_Helicopter

AI - Models the intelligent transportation of infantry and other cargo using Helicopters.
AI.AI_Cargo_Dispatcher_Ship

AI - Models the intelligent transportation of infantry and other cargo using Ships.
AI.AI_Cargo_Helicopter

AI - Models the intelligent transportation of cargo using helicopters.
AI.AI_Cargo_Ship

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Escort

AI - Taking the lead of AI escorting your flight or of other AI.
AI.AI_Escort_Dispatcher

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

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

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

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

AI - Perform Air Patrolling for airplanes.
Actions.Act_Account

Actions - ACT_ACCOUNT_ classes account for (detect, count & report) various DCS events occurring on UNITs.
Actions.Act_Assign

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

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

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

Cargo - 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 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 UNIT object.
Core.Astar

Core - A* Pathfinding.
Core.Base

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

Core - TACAN and other beacons.
Core.Condition

Core - Define any or all conditions to be evaluated.
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.MarkerOps_Base

Core - Tap into markers added to the F10 map by users.
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.Pathline

Core - Path from A to B.
Core.Point

Core - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.
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 missions, providing a menu 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.TextAndSound

Core - A Moose GetText system.
Core.Timer

Core - Timer scheduler.
Core.UserFlag

Core - Manage user flags to interact with the mission editor trigger system and server side scripts.
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.
Core.Zone_Detection

Core - The ZONE_DETECTION class, defined by a zone name, a detection object and a radius.
DCS

DCS API Prototypes.
Functional.ATC_Ground

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

Functional - Control artillery units.
Functional.CleanUp

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

Functional - Manage and track client slots easily to add your own client-based menus and modules to.
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.DetectionZones

Functional - Captures the class DETECTION_ZONES.
Functional.Escort

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

Functional - Yet Another Missile Trainer.
Functional.Mantis

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

Functional - Train missile defence and deflection.
Functional.Movement

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

Functional - Basic ATC.
Functional.RAT

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

Functional - Range Practice.
Functional.Scoring

Functional - Administer the scoring of player achievements, file and log the scoring events for use at websites.
Functional.Sead

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

Functional - Short Range Air Defense System.
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 - Base class that models processes to achieve goals involving a Zone.
Functional.ZoneGoalCargo

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

Functional - Base class that models processes to achieve goals involving a Zone for a Coalition.
Ops.ATIS


Ops.Airboss

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

Ops - Combat Search and Rescue.
Ops.CTLD

Ops - Combat Troops & Logistics Department.
Ops.RecoveryTanker

Ops - Recovery tanker for carrier operations.
Ops.RescueHelo

Ops - Rescue helicopter for carrier operations.
Shapes.CUBE


Author: nielsvaes/coconutcockpit
Shapes.LINE


Author: nielsvaes/coconutcockpit
Shapes.OVAL


Author: nielsvaes/coconutcockpit
Shapes.POLYGON


Author: nielsvaes/coconutcockpit
Shapes.SHAPE_BASE

Shapes - Class that serves as the base shapes drawn in the Mission Editor
Author: nielsvaes/coconutcockpit
Shapes.TRIANGLE

TRIANGLE class with properties and methods for handling triangles.
Sound.Radio

Sound - Radio transmissions.
Sound.RadioQueue

Sound - Queues Radio Transmissions.
Sound.RadioSpeech

Core - Makes the radio talk.
Sound.SRS

Sound - Simple Radio Standalone (SRS) Integration and Text-to-Speech.
Sound.SoundOutput

Sound - Sound output classes.
Sound.UserSound

Sound - Manage user sound.
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.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_Capture_Dispatcher

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.
Tasking.Task_Capture_Zone

Tasking - The TASK_Protect models tasks for players to protect or capture specific zones.
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

Tasking - This module contains the TASK_MANAGER class and derived classes.
Utilities.Enums

Utilities Enumerators.
Utilities.FiFo

 UTILS - Classic FiFo Stack.
Utilities.Profiler

Utils - Lua Profiler.
Utilities.STTS

Utilities  - DCS Simple Text-To-Speech (STTS).
Utilities.Socket

Utilities - Socket.
Utilities.Templates

Utilities - Templates.
Utilities.Utils

Utilities - Derived utilities taken from the MIST framework, added helpers from the MOOSE community.
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.DynamicCargo

Wrapper - Dynamic Cargo create from the F8 menu.
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.Net

Wrapper - DCS net functions.
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.Storage

Wrapper - Warehouse storage of DCS airbases.
Wrapper.Unit

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

Wrapper - Weapon functions.

Module Sound.SoundOutput

Sound - Sound output classes.

Features:

Create a SOUNDFILE object (mp3 or ogg) to be played via DCS or SRS transmissions
Create a SOUNDTEXT object for text-to-speech output vis SRS Simple-Text-To-Speech (STTS)

Author: funkyfranky

There are two classes, SOUNDFILE and SOUNDTEXT, defined in this section that deal with playing sound files or arbitrary text (via SRS Simple-Text-To-Speech), respectively.

The SOUNDFILE and SOUNDTEXT objects can be defined and used in other MOOSE classes.

Global(s)

Global SOUNDBASE

Basic sound output inherited by other classes suche as SOUNDFILE and SOUNDTEXT.

#SOUNDBASE SOUNDBASE

Basic sound output inherited by other classes suche as SOUNDFILE and SOUNDTEXT.

This class is not meant to be used by "ordinary" users.

Global SOUNDFILE

Sound files used by other classes.

#SOUNDFILE SOUNDFILE

Sound files used by other classes.

The SOUNDFILE Concept

A SOUNDFILE object hold the important properties that are necessary to play the sound file, e.g. its file name, path, duration.

It can be created with the SOUNDFILE.New(FileName, Path, Duration) function:

local soundfile=SOUNDFILE:New("My Soundfile.ogg", "Sound File/", 3.5)

SRS

If sound files are supposed to be played via SRS, you need to use the SOUNDFILE.SetPlayWithSRS() function.

Location/Path

DCS

DCS can only play sound files that are located inside the mission (.miz) file. In particular, DCS cannot make use of files that are stored on your hard drive.

The default location where sound files are stored in DCS is the directory "l10n/DEFAULT/". This is where sound files are placed, if they are added via the mission editor (TRIGGERS-->ACTIONS-->SOUND TO ALL). Note however, that sound files which are not added with a trigger command, will be deleted each time the mission is saved! Therefore, this directory is not ideal to be used especially if many sound files are to be included since for each file a trigger action needs to be created. Which is cumbersome, to say the least.

The recommended way is to create a new folder inside the mission (.miz) file (a miz file is essentially zip file and can be opened, e.g., with 7-Zip) and to place the sound files in there. Sound files in these folders are not wiped out by DCS on the next save.

SRS

SRS sound files need to be located on your local drive (not inside the miz). Therefore, you need to specify the full path.

Global SOUNDTEXT

Text-to-speech objects for other classes.

#SOUNDTEXT SOUNDTEXT

Text-to-speech objects for other classes.

The SOUNDTEXT Concept

A SOUNDTEXT object holds all necessary information to play a general text via SRS Simple-Text-To-Speech.

It can be created with the SOUNDTEXT.New(Text, Duration) function.

SOUNDTEXT.New(Text, Duration): Creates a new SOUNDTEXT object.

Options

Gender

You can choose a gender ("male" or "femal") with the SOUNDTEXT.SetGender(Gender) function. Note that the gender voice needs to be installed on your windows machine for the used culture (see below).

Culture

You can choose a "culture" (accent) with the SOUNDTEXT.SetCulture(Culture) function, where the default (SRS) culture is "en-GB".

Other examples for culture are: "en-US" (US accent), "de-DE" (German), "it-IT" (Italian), "ru-RU" (Russian), "zh-CN" (Chinese).

Note that the chosen culture needs to be installed on your windows machine.

Specific Voice

You can use a specific voice for the transmission with the SOUNDTEXT.SetVoice(VoiceName) function. Here are some examples

Name: Microsoft Hazel Desktop, Culture: en-GB, Gender: Female, Age: Adult, Desc: Microsoft Hazel Desktop - English (Great Britain)
Name: Microsoft David Desktop, Culture: en-US, Gender: Male, Age: Adult, Desc: Microsoft David Desktop - English (United States)
Name: Microsoft Zira Desktop, Culture: en-US, Gender: Female, Age: Adult, Desc: Microsoft Zira Desktop - English (United States)
Name: Microsoft Hedda Desktop, Culture: de-DE, Gender: Female, Age: Adult, Desc: Microsoft Hedda Desktop - German
Name: Microsoft Helena Desktop, Culture: es-ES, Gender: Female, Age: Adult, Desc: Microsoft Helena Desktop - Spanish (Spain)
Name: Microsoft Hortense Desktop, Culture: fr-FR, Gender: Female, Age: Adult, Desc: Microsoft Hortense Desktop - French
Name: Microsoft Elsa Desktop, Culture: it-IT, Gender: Female, Age: Adult, Desc: Microsoft Elsa Desktop - Italian (Italy)
Name: Microsoft Irina Desktop, Culture: ru-RU, Gender: Female, Age: Adult, Desc: Microsoft Irina Desktop - Russian
Name: Microsoft Huihui Desktop, Culture: zh-CN, Gender: Female, Age: Adult, Desc: Microsoft Huihui Desktop - Chinese (Simplified)

Note that this must be installed on your windos machine. Also note that this overrides any culture and gender settings.

Type(s)

Type SOUNDBASE

SOUNDBASE

Fields and Methods inherited from SOUNDBASE	Description
SOUNDBASE.GetSpeechTime(Text, Speed, isGoogle, self, length, speed)	Function returns estimated speech time in seconds.
SOUNDBASE:New()	Constructor to create a new SOUNDBASE object.

Type SOUNDFILE

SOUNDFILE

Fields and Methods inherited from SOUNDFILE	Description
SOUNDFILE:GetDuration()	Get duration how long the sound file takes to play.
SOUNDFILE:GetFileName()	Get the sound file name.
SOUNDFILE:GetName()	Get the complete sound file name inlcuding its path.
SOUNDFILE:GetPath()	Get path of the directory, where the sound file is located.
SOUNDFILE:New(FileName, Path, Duration, UseSrs)	Constructor to create a new SOUNDFILE object.
SOUNDFILE:SetDuration(Duration)	Set duration how long it takes to play the sound file.
SOUNDFILE:SetFileName(FileName)	Set sound file name.
SOUNDFILE:SetPath(Path)	Set path, where the sound file is located.
SOUNDFILE:SetPlayWithSRS(Switch)	Set whether sound files should be played via SRS.
SOUNDFILE.duration
SOUNDFILE.filename
SOUNDFILE.path
SOUNDFILE.useSRS

Type SOUNDTEXT

SOUNDTEXT

Fields and Methods inherited from SOUNDTEXT	Description
SOUNDTEXT:New(Text, Duration)	Constructor to create a new SOUNDTEXT object.
SOUNDTEXT:SetCulture(Culture)	Set TTS culture - local for the voice.
SOUNDTEXT:SetDuration(Duration)	Set duration, how long it takes to speak the text.
SOUNDTEXT:SetGender(Gender)	Set gender.
SOUNDTEXT:SetText(Text)	Set text.
SOUNDTEXT:SetVoice(VoiceName)	Set to use a specific voice name.
SOUNDTEXT.culture
SOUNDTEXT.duration
SOUNDTEXT.gender
SOUNDTEXT.text
SOUNDTEXT.voice