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 CAS 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 - 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 -- (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_Dispatcher_Ship

AI -- (2.5.1) - Models the intelligent transportation of infantry and other cargo using Ships
Features:Transport cargo to various deploy zones using naval vehicles.
AI.AI_Cargo_Helicopter

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

AI -- (R2.5.1) - Models the intelligent transportation of infantry and other 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

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

Core - TACAN and other beacons.
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.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.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.Shorad

Functional -- Short Range Air Defense System
SHORAD - Short Range Air Defense System
Controls a network of short range air/missile defense groups.
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.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.
Sound.MSRS

Sound - Simple Radio Standalone (SRS) Integration.
Sound.Radio

Sound - Radio transmissions.
Sound.RadioQueue

Sound - Queues Radio Transmissions.
Sound.RadioSpeech

Core - Makes the radio talk.
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.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.
Utilities.Templates

Utils Templates
DCS unit templates
Utils

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.
Utils.FiFo

 UTILS - ClassicFiFo Stack.
Utils.STTS

Utilities  DCS Simple Text-To-Speech (STTS).
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 Sound.MSRS

Sound - Simple Radio Standalone (SRS) Integration.

Main Features:

Play sound files via SRS
Play text-to-speach via SRS

Youtube Videos: None yet

Missions: None yet

Sound files: MOOSE Sound Files

The goal of the SRS project is to bring VoIP communication into DCS and to make communication as frictionless as possible.

Author: funkyfranky

Global(s)

Global MSRS

It is a very sad thing that nowadays there is so little useless information. - Oscar Wilde

Banner Image

The MSRS Concept

This class allows to broadcast sound files or text via Simple Radio Standalone (SRS).

#MSRS MSRS

It is a very sad thing that nowadays there is so little useless information. - Oscar Wilde

Banner Image

The MSRS Concept

This class allows to broadcast sound files or text via Simple Radio Standalone (SRS).

Prerequisites

This script needs SRS version >= 1.9.6.

Play Sound Files

local soundfile=SOUNDFILE:New("My Soundfile.ogg", "D:\\Sounds For DCS")
local msrs=MSRS:New("C:\\Path To SRS", 251, radio.modulation.AM)
msrs:PlaySoundFile(soundfile)

Play Text-To-Speech

Basic example:

-- Create a SOUNDTEXT object.
local text=SOUNDTEXT:New("All Enemies destroyed")

-- MOOSE SRS 
local msrs=MSRS:New("D:\\DCS\\_SRS\\", 305, radio.modulation.AM)

-- Text-to speech with default voice after 2 seconds.
msrs:PlaySoundText(text, 2)

Set Gender

Use a specific gender with the MSRS.SetGender function, e.g. SetGender("male") or :SetGender("female").

Set Culture

Use a specific "culture" with the MSRS.SetCulture function, e.g. :SetCulture("en-US") or :SetCulture("de-DE").

Set Google

Use Google's text-to-speech engine with the MSRS.SetGoogle function, e.g. ':SetGoogle()'. By enabling this it also allows you to utilize SSML in your text for added flexibilty. For more information on setting up a cloud account, visit: https://cloud.google.com/text-to-speech Google's supported SSML reference: https://cloud.google.com/text-to-speech/docs/ssml

Set Voice

Use a specifc voice with the MSRS.SetVoice function, e.g, :SetVoice("Microsoft Hedda Desktop"). Note that this must be installed on your windows system. If enabling SetGoogle(), you can use voices provided by Google Google's supported voices: https://cloud.google.com/text-to-speech/docs/voices

Set Coordinate

Use MSRS.SetCoordinate to define the origin from where the transmission is broadcasted.

Set SRS Port

Use MSRS.SetPort to define the SRS port. Defaults to 5002.

Type(s)

Type MSRS

MSRS , extends Core.Base#BASE

Fields and Methods inherited from MSRS	Description
MSRS.ClassName	Name of the class.
MSRS:GetCoalition()	Get coalition.
MSRS:GetFrequencies(Frequencies)	Get frequencies.
MSRS:GetLabel()	Get label.
MSRS:GetModulations(Modulations)	Get modulations.
MSRS:GetPath()	Get path to SRS directory.
MSRS:GetPort()	Get port.
MSRS:Help()	Print SRS STTS help to DCS log file.
MSRS.Label	Label showing up on the SRS radio overlay. Default is "ROBOT". No spaces allowed.
MSRS:New(PathToSRS, Frequency, Modulation)	Create a new MSRS object.
MSRS:PlaySoundFile(Soundfile, Delay)	Play sound file (ogg or mp3) via SRS.
MSRS:PlaySoundText(SoundText, Delay)	Play a SOUNDTEXT text-to-speech object.
MSRS:PlayText(Text, Delay)	Play text message via STTS.
MSRS:PlayTextFile(TextFile, Delay)	Play text file via STTS.
MSRS:SetCoalition(Coalition)	Set coalition.
MSRS:SetCoordinate(Coordinate)	Set the coordinate from which the transmissions will be broadcasted.
MSRS:SetCulture(Culture)	Set culture.
MSRS:SetFrequencies(Frequencies)	Set frequencies.
MSRS:SetGender(Gender)	Set gender.
MSRS:SetGoogle(PathToCredentials)	Use google text-to-speech.
MSRS:SetLabel(Label)	Set label.
MSRS:SetModulations(Modulations)	Set modulations.
MSRS:SetPath(Path)	Set path to SRS install directory.
MSRS:SetPort(Port)	Set port.
MSRS:SetVoice(Voice)	Set to use a specific voice.
MSRS:_ExecCommand(command)	Execute SRS command to play sound using the `DCS-SR-ExternalAudio.exe`.
MSRS:_GetCommand(freqs, modus, coal, gender, voice, culture, volume, speed, port, label)	Get SRS command to play sound using the `DCS-SR-ExternalAudio.exe`.
MSRS:_GetLatLongAlt(Coordinate)	Get lat, long and alt from coordinate.
MSRS.coalition	Coalition of the transmission.
MSRS.coordinate	Coordinate from where the transmission is send.
MSRS.culture	Culture. Default "en-GB".
MSRS.frequencies	Frequencies used in the transmissions.
MSRS.gender	Gender. Default "female".
MSRS.google	Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".
MSRS.lid	Class id string for output to DCS log file.
MSRS.modulations	Modulations used in the transmissions.
MSRS.name	Name. Default "DCS-STTS".
MSRS.path	Path to the SRS exe. This includes the final slash "/".
MSRS.port	Port. Default 5002.
MSRS.version	MSRS class version.
MSRS.voice	Specifc voce.
MSRS.volume	Volume between 0 (min) and 1 (max). Default 1.

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

Type Sound.MSRS

Type MSRS

MSRS class.

Field(s)

#string MSRS.ClassName

Name of the class.

#string MSRS.Label

Label showing up on the SRS radio overlay. Default is "ROBOT". No spaces allowed.

#number MSRS.coalition

Coalition of the transmission.

Core.Point#COORDINATE MSRS.coordinate

Coordinate from where the transmission is send.

#string MSRS.culture

Culture. Default "en-GB".

#table MSRS.frequencies

Frequencies used in the transmissions.

#string MSRS.gender

Gender. Default "female".

#string MSRS.google

Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".

#string MSRS.lid

Class id string for output to DCS log file.

#table MSRS.modulations

Modulations used in the transmissions.

#string MSRS.name

Name. Default "DCS-STTS".

#string MSRS.path

Path to the SRS exe. This includes the final slash "/".

#number MSRS.port

Port. Default 5002.

#string MSRS.version

MSRS class version.

#string MSRS.voice

Specifc voce.

#number MSRS.volume

Volume between 0 (min) and 1 (max). Default 1.

Function(s)

MSRS:GetCoalition()

Get coalition.

Defined in:

MSRS

Return value:

#number:

Coalition.

MSRS:GetFrequencies(Frequencies)

Get frequencies.

Defined in:

MSRS

Parameter:

#table Frequencies

in MHz.

MSRS:GetLabel()

Get label.

Defined in:

MSRS

Return value:

#number:

Label.

MSRS:GetModulations(Modulations)

Get modulations.

Defined in:

MSRS

Parameter:

#table Modulations

MSRS:GetPath()

Get path to SRS directory.

Defined in:

MSRS

Return value:

#string:

Path to the directory. This includes the final slash "/".

MSRS:GetPort()

Get port.

Defined in:

MSRS

Return value:

#number:

Port.

MSRS:Help()

Print SRS STTS help to DCS log file.

Defined in:

MSRS

Return value:

#MSRS:

self

MSRS:New(PathToSRS, Frequency, Modulation)

Create a new MSRS object.

Defined in:

MSRS

Parameters:

#string PathToSRS

Path to the directory, where SRS is located.

#number Frequency

Radio frequency in MHz. Default 143.00 MHz. Can also be given as a #table of multiple frequencies.

#number Modulation

Radio modulation: 0=AM (default), 1=FM. See radio.modulation.AM and radio.modulation.FM enumerators. Can also be given as a #table of multiple modulations.

Return value:

#MSRS:

self

MSRS:PlaySoundFile(Soundfile, Delay)

Play sound file (ogg or mp3) via SRS.

Defined in:

MSRS

Parameters:

Sound.SoundFile#SOUNDFILE Soundfile

Sound file to play.

#number Delay

Delay in seconds, before the sound file is played.

Return value:

#MSRS:

self

MSRS:PlaySoundText(SoundText, Delay)

Play a SOUNDTEXT text-to-speech object.

Defined in:

MSRS

Parameters:

Sound.SoundFile#SOUNDTEXT SoundText

Sound text.

#number Delay

Delay in seconds, before the sound file is played.

Return value:

#MSRS:

self

MSRS:PlayText(Text, Delay)

Play text message via STTS.

Defined in:

MSRS

Parameters:

#string Text

Text message.

#number Delay

Delay in seconds, before the message is played.

Return value:

#MSRS:

self

MSRS:PlayTextFile(TextFile, Delay)

Play text file via STTS.

Defined in:

MSRS

Parameters:

#string TextFile

Full path to the file.

#number Delay

Delay in seconds, before the message is played.

Return value:

#MSRS:

self

MSRS:SetCoalition(Coalition)

Set coalition.

Defined in:

MSRS

Parameter:

#number Coalition

Coalition. Default 0.

Return value:

#MSRS:

self

MSRS:SetCoordinate(Coordinate)

Set the coordinate from which the transmissions will be broadcasted.

Defined in:

MSRS

Parameter:

Core.Point#COORDINATE Coordinate

Origin of the transmission.

Return value:

#MSRS:

self

MSRS:SetCulture(Culture)

Set culture.

Defined in:

MSRS

Parameter:

#string Culture

Culture, e.g. "en-GB" (default).

Return value:

#MSRS:

self

MSRS:SetFrequencies(Frequencies)

Set frequencies.

Defined in:

MSRS

Parameter:

#table Frequencies

Frequencies in MHz. Can also be given as a #number if only one frequency should be used.

Return value:

#MSRS:

self

MSRS:SetGender(Gender)

Set gender.

Defined in:

MSRS

Parameter:

#string Gender

Gender: "male" or "female" (default).

Return value:

#MSRS:

self

MSRS:SetGoogle(PathToCredentials)

Use google text-to-speech.

Defined in:

MSRS

Parameter:

PathToCredentials

Full path to the google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".

Return value:

#MSRS:

self

MSRS:SetLabel(Label)

Set label.

Defined in:

MSRS

Parameter:

#number Label

Default "ROBOT"

Return value:

#MSRS:

self

MSRS:SetModulations(Modulations)

Set modulations.

Defined in:

MSRS

Parameter:

#table Modulations

Modulations. Can also be given as a #number if only one modulation should be used.

Return value:

#MSRS:

self

MSRS:SetPath(Path)

Set path to SRS install directory.

More precisely, path to where the DCS-

Defined in:

MSRS

Parameter:

#string Path

Path to the directory, where the sound file is located. This does not contain a final backslash or slash.

Return value:

#MSRS:

self

MSRS:SetPort(Port)

Set port.

Defined in:

MSRS

Parameter:

#number Port

Port. Default 5002.

Return value:

#MSRS:

self

MSRS:SetVoice(Voice)

Set to use a specific voice.

Will override gender and culture settings.

Defined in:

MSRS

Parameter:

#string Voice

Voice.

Return value:

#MSRS:

self

MSRS:_ExecCommand(command)

Execute SRS command to play sound using the DCS-SR-ExternalAudio.exe.

Defined in:

MSRS

Parameter:

#string command

Command to executer

Return value:

#number:

Return value of os.execute() command.

MSRS:_GetCommand(freqs, modus, coal, gender, voice, culture, volume, speed, port, label)

Get SRS command to play sound using the DCS-SR-ExternalAudio.exe.

Defined in:

MSRS

Parameters:

#table freqs

Frequencies in MHz.

#table modus

Modulations.

#number coal

Coalition.

#string gender

Gender.

#string voice

Voice.

#string culture

Culture.

#number volume

Volume.

#number speed

Speed.

#number port

Port.

#string label

Label, defaults to "ROBOT" (displayed sender name in the radio overlay of SRS) - No spaces allowed!

Return value:

#string:

Command.

MSRS:_GetLatLongAlt(Coordinate)

Get lat, long and alt from coordinate.

Defined in:

MSRS

Parameter:

Core.Point#Coordinate Coordinate

Coordinate. Can also be a DCS#Vec3.

Return values:

#number:

Latitude.

#number:

Longitude.

#number:

Altitude.

Field(s)

#string MSRS.ClassName

Name of the class.

#string MSRS.Label

Label showing up on the SRS radio overlay. Default is "ROBOT". No spaces allowed.

#number MSRS.coalition

Coalition of the transmission.

Core.Point#COORDINATE MSRS.coordinate

Coordinate from where the transmission is send.

#string MSRS.culture

Culture. Default "en-GB".

#table MSRS.frequencies

Frequencies used in the transmissions.

#string MSRS.gender

Gender. Default "female".

#string MSRS.google

Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".

#string MSRS.lid

Class id string for output to DCS log file.

#table MSRS.modulations

Modulations used in the transmissions.

#string MSRS.name

Name. Default "DCS-STTS".

#string MSRS.path

Path to the SRS exe. This includes the final slash "/".

#number MSRS.port

Port. Default 5002.

#string MSRS.version

MSRS class version.

#string MSRS.voice

Specifc voce.

#number MSRS.volume

Volume between 0 (min) and 1 (max). Default 1.

Function(s)

MSRS:ClearState(Object, StateName)

Clear the state of an object.