From 51256887ac79ba9398877303f45908c5cc2b65b8 Mon Sep 17 00:00:00 2001 From: MooseBotter Date: Fri, 5 Jan 2024 14:53:46 +0000 Subject: [PATCH] Auto commit by GitHub Actions Workflow --- Documentation/AI.AI_A2A_Cap.html | 11 + Documentation/AI.AI_A2A_Dispatcher.html | 11 + Documentation/AI.AI_A2A_Gci.html | 11 + Documentation/AI.AI_A2A_Patrol.html | 11 + Documentation/AI.AI_A2G_BAI.html | 11 + Documentation/AI.AI_A2G_CAS.html | 11 + Documentation/AI.AI_A2G_Dispatcher.html | 75 +- Documentation/AI.AI_A2G_SEAD.html | 11 + Documentation/AI.AI_Air.html | 143 +- Documentation/AI.AI_Air_Dispatcher.html | 55 +- Documentation/AI.AI_Air_Engage.html | 11 + Documentation/AI.AI_Air_Patrol.html | 11 + Documentation/AI.AI_Air_Squadron.html | 11 + Documentation/AI.AI_BAI.html | 11 + Documentation/AI.AI_Balancer.html | 11 + Documentation/AI.AI_CAP.html | 11 + Documentation/AI.AI_CAS.html | 11 + Documentation/AI.AI_Cargo.html | 11 + Documentation/AI.AI_Cargo_APC.html | 11 + Documentation/AI.AI_Cargo_Airplane.html | 23 +- Documentation/AI.AI_Cargo_Dispatcher.html | 11 + Documentation/AI.AI_Cargo_Dispatcher_APC.html | 11 + .../AI.AI_Cargo_Dispatcher_Airplane.html | 11 + .../AI.AI_Cargo_Dispatcher_Helicopter.html | 11 + .../AI.AI_Cargo_Dispatcher_Ship.html | 11 + Documentation/AI.AI_Cargo_Helicopter.html | 11 + Documentation/AI.AI_Cargo_Ship.html | 11 + Documentation/AI.AI_Escort.html | 11 + Documentation/AI.AI_Escort_Dispatcher.html | 11 + .../AI.AI_Escort_Dispatcher_Request.html | 11 + Documentation/AI.AI_Escort_Request.html | 11 + Documentation/AI.AI_Formation.html | 11 + Documentation/AI.AI_Patrol.html | 23 + Documentation/Actions.Act_Account.html | 11 + Documentation/Actions.Act_Assign.html | 11 + Documentation/Actions.Act_Assist.html | 11 + Documentation/Actions.Act_Route.html | 11 + Documentation/Cargo.Cargo.html | 22 +- Documentation/Cargo.CargoCrate.html | 11 + Documentation/Cargo.CargoGroup.html | 28 +- Documentation/Cargo.CargoSlingload.html | 11 + Documentation/Cargo.CargoUnit.html | 33 +- Documentation/Core.Astar.html | 11 + Documentation/Core.Base.html | 11 + Documentation/Core.Beacon.html | 11 + Documentation/Core.Condition.html | 11 + Documentation/Core.Database.html | 11 + Documentation/Core.Event.html | 11 + Documentation/Core.Fsm.html | 11 + Documentation/Core.Goal.html | 11 + Documentation/Core.MarkerOps_Base.html | 11 + Documentation/Core.Menu.html | 11 + Documentation/Core.Message.html | 11 + Documentation/Core.Pathline.html | 11 + Documentation/Core.Point.html | 11 + Documentation/Core.Report.html | 11 + Documentation/Core.ScheduleDispatcher.html | 11 + Documentation/Core.Scheduler.html | 11 + Documentation/Core.Set.html | 11 + Documentation/Core.Settings.html | 41 +- Documentation/Core.Spawn.html | 337 +- Documentation/Core.SpawnStatic.html | 95 + Documentation/Core.Spot.html | 110 + Documentation/Core.TextAndSound.html | 11 + Documentation/Core.Timer.html | 11 + Documentation/Core.UserFlag.html | 11 + Documentation/Core.Velocity.html | 11 + Documentation/Core.Zone.html | 11 + Documentation/Core.Zone_Detection.html | 11 + Documentation/DCS.html | 11 + Documentation/Functional.ATC_Ground.html | 11 + Documentation/Functional.Artillery.html | 11 + Documentation/Functional.CleanUp.html | 11 + Documentation/Functional.Designate.html | 11 + Documentation/Functional.Detection.html | 50 +- Documentation/Functional.DetectionZones.html | 11 + Documentation/Functional.Escort.html | 11 + Documentation/Functional.Fox.html | 11 + Documentation/Functional.Mantis.html | 121 +- Documentation/Functional.MissileTrainer.html | 11 + Documentation/Functional.Movement.html | 39 +- Documentation/Functional.PseudoATC.html | 11 + Documentation/Functional.RAT.html | 29 + Documentation/Functional.Range.html | 11 + Documentation/Functional.Scoring.html | 25 +- Documentation/Functional.Sead.html | 11 + Documentation/Functional.Shorad.html | 11 + Documentation/Functional.Suppression.html | 11 + Documentation/Functional.Warehouse.html | 11 + .../Functional.ZoneCaptureCoalition.html | 11 + Documentation/Functional.ZoneGoal.html | 11 + Documentation/Functional.ZoneGoalCargo.html | 11 + .../Functional.ZoneGoalCoalition.html | 11 + Documentation/Ops.ATIS.html | 11 + Documentation/Ops.Airboss.html | 88 +- Documentation/Ops.CSAR.html | 209 +- Documentation/Ops.CTLD.html | 185 +- Documentation/Ops.RecoveryTanker.html | 11 + Documentation/Ops.RescueHelo.html | 11 + Documentation/Sound.Radio.html | 11 + Documentation/Sound.RadioQueue.html | 11 + Documentation/Sound.RadioSpeech.html | 11 + Documentation/Sound.SRS.html | 15673 ++++++++++++++++ Documentation/Sound.SoundOutput.html | 11 + Documentation/Sound.UserSound.html | 11 + Documentation/Tasking.CommandCenter.html | 11 + Documentation/Tasking.DetectionManager.html | 11 + Documentation/Tasking.Mission.html | 11 + Documentation/Tasking.Task.html | 33 +- Documentation/Tasking.TaskInfo.html | 11 + Documentation/Tasking.Task_A2A.html | 11 + .../Tasking.Task_A2A_Dispatcher.html | 11 + Documentation/Tasking.Task_A2G.html | 11 + .../Tasking.Task_A2G_Dispatcher.html | 31 +- Documentation/Tasking.Task_CARGO.html | 17 +- .../Tasking.Task_Capture_Dispatcher.html | 11 + Documentation/Tasking.Task_Capture_Zone.html | 11 + Documentation/Tasking.Task_Cargo_CSAR.html | 11 + .../Tasking.Task_Cargo_Dispatcher.html | 55 +- .../Tasking.Task_Cargo_Transport.html | 11 + Documentation/Tasking.Task_Manager.html | 11 + Documentation/Utilities.Enums.html | 11 + Documentation/Utilities.FiFo.html | 11 + Documentation/Utilities.Profiler.html | 11 + Documentation/Utilities.STTS.html | 11 + Documentation/Utilities.Socket.html | 11 + Documentation/Utilities.Templates.html | 11 + Documentation/Utilities.Utils.html | 11 + Documentation/Wrapper.Airbase.html | 11 + Documentation/Wrapper.Client.html | 11 + Documentation/Wrapper.Controllable.html | 11 + Documentation/Wrapper.Group.html | 89 +- Documentation/Wrapper.Identifiable.html | 11 + Documentation/Wrapper.Marker.html | 11 + Documentation/Wrapper.Net.html | 11 + Documentation/Wrapper.Object.html | 11 + Documentation/Wrapper.Positionable.html | 11 + Documentation/Wrapper.Scenery.html | 11 + Documentation/Wrapper.Static.html | 11 + Documentation/Wrapper.Storage.html | 11 + Documentation/Wrapper.Unit.html | 11 + Documentation/Wrapper.Weapon.html | 11 + Documentation/index.html | 23 + 143 files changed, 18174 insertions(+), 754 deletions(-) create mode 100644 Documentation/Sound.SRS.html diff --git a/Documentation/AI.AI_A2A_Cap.html b/Documentation/AI.AI_A2A_Cap.html index 83737a990..e212c9b93 100644 --- a/Documentation/AI.AI_A2A_Cap.html +++ b/Documentation/AI.AI_A2A_Cap.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index 86ffb9715..bf6258b9c 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_A2A_Gci.html b/Documentation/AI.AI_A2A_Gci.html index dc9b67a9c..c878c6654 100644 --- a/Documentation/AI.AI_A2A_Gci.html +++ b/Documentation/AI.AI_A2A_Gci.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_A2A_Patrol.html b/Documentation/AI.AI_A2A_Patrol.html index a25cd2a78..a88ecf9a2 100644 --- a/Documentation/AI.AI_A2A_Patrol.html +++ b/Documentation/AI.AI_A2A_Patrol.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_A2G_BAI.html b/Documentation/AI.AI_A2G_BAI.html index 78176027e..a534d30e8 100644 --- a/Documentation/AI.AI_A2G_BAI.html +++ b/Documentation/AI.AI_A2G_BAI.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_A2G_CAS.html b/Documentation/AI.AI_A2G_CAS.html index 708fe36d8..5d1f1c8a5 100644 --- a/Documentation/AI.AI_A2G_CAS.html +++ b/Documentation/AI.AI_A2G_CAS.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index d7742273a..6d874ba6e 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -4745,17 +4756,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -4878,14 +4878,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + AI_A2G_DISPATCHER.SetSendPlayerMessages - -

flash messages to players

-
@@ -13281,17 +13278,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -13414,14 +13400,11 @@ multiplied by the Overhead and rounded up to the smallest integer.

- #boolean + AI_A2G_DISPATCHER.SetSendPlayerMessages - -

flash messages to players

-
@@ -14623,17 +14606,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -14756,14 +14728,11 @@ multiplied by the Overhead and rounded up to the smallest integer.

- #boolean + AI_A2G_DISPATCHER.SetSendPlayerMessages - -

flash messages to players

-
@@ -16267,17 +16236,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -16400,14 +16358,11 @@ multiplied by the Overhead and rounded up to the smallest integer.

- #boolean + AI_A2G_DISPATCHER.SetSendPlayerMessages - -

flash messages to players

-
diff --git a/Documentation/AI.AI_A2G_SEAD.html b/Documentation/AI.AI_A2G_SEAD.html index 1d9874aec..001547517 100644 --- a/Documentation/AI.AI_A2G_SEAD.html +++ b/Documentation/AI.AI_A2G_SEAD.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index b1bb88d10..5873e0fe8 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -3067,6 +3078,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -3166,28 +3188,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -5895,6 +5895,17 @@ A random value in this bracket is then applied in the waypoint routing generatio + + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -5994,28 +6005,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -6642,6 +6631,17 @@ A random value in this bracket is then applied in the waypoint routing generatio + + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -6741,28 +6741,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -8277,6 +8255,17 @@ A random value in this bracket is then applied in the waypoint routing generatio + + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -8376,28 +8365,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
diff --git a/Documentation/AI.AI_Air_Dispatcher.html b/Documentation/AI.AI_Air_Dispatcher.html index f4621ac6d..21a12e447 100644 --- a/Documentation/AI.AI_Air_Dispatcher.html +++ b/Documentation/AI.AI_Air_Dispatcher.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -4505,17 +4516,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -9813,17 +9813,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -11141,17 +11130,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -12771,17 +12749,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
diff --git a/Documentation/AI.AI_Air_Engage.html b/Documentation/AI.AI_Air_Engage.html index 22b5a8ade..351d910a2 100644 --- a/Documentation/AI.AI_Air_Engage.html +++ b/Documentation/AI.AI_Air_Engage.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Air_Patrol.html b/Documentation/AI.AI_Air_Patrol.html index 4e732255b..df3e9002e 100644 --- a/Documentation/AI.AI_Air_Patrol.html +++ b/Documentation/AI.AI_Air_Patrol.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 21ec386bf..7f173ddbf 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_BAI.html b/Documentation/AI.AI_BAI.html index ae083f96c..7e53b5542 100644 --- a/Documentation/AI.AI_BAI.html +++ b/Documentation/AI.AI_BAI.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Balancer.html b/Documentation/AI.AI_Balancer.html index 7063e1f88..82fbc43b5 100644 --- a/Documentation/AI.AI_Balancer.html +++ b/Documentation/AI.AI_Balancer.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_CAP.html b/Documentation/AI.AI_CAP.html index aaa4ffcc4..ca3f530f5 100644 --- a/Documentation/AI.AI_CAP.html +++ b/Documentation/AI.AI_CAP.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_CAS.html b/Documentation/AI.AI_CAS.html index dce2a3b15..e08526422 100644 --- a/Documentation/AI.AI_CAS.html +++ b/Documentation/AI.AI_CAS.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index afbb51bb2..b29a37a21 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Cargo_APC.html b/Documentation/AI.AI_Cargo_APC.html index 2923bebd4..e45c4dead 100644 --- a/Documentation/AI.AI_Cargo_APC.html +++ b/Documentation/AI.AI_Cargo_APC.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index f2b8a0901..4d6980a95 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -2790,9 +2801,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

- @@ -4566,9 +4574,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

- @@ -5184,9 +5189,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

- @@ -6690,9 +6692,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

- diff --git a/Documentation/AI.AI_Cargo_Dispatcher.html b/Documentation/AI.AI_Cargo_Dispatcher.html index 4c8c13ebb..9fb700d0c 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher.html +++ b/Documentation/AI.AI_Cargo_Dispatcher.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_APC.html b/Documentation/AI.AI_Cargo_Dispatcher_APC.html index 207c9d9fc..b8c07b63d 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_APC.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_APC.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html index e92cd5228..3ee7ecf45 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html index e4c028398..44b1ef863 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html index 94d24eff6..8bc107742 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index 0feb46663..dcf9819bc 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Cargo_Ship.html b/Documentation/AI.AI_Cargo_Ship.html index 4404d4d7f..51be68582 100644 --- a/Documentation/AI.AI_Cargo_Ship.html +++ b/Documentation/AI.AI_Cargo_Ship.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Escort.html b/Documentation/AI.AI_Escort.html index 20c02a393..a037f9ff7 100644 --- a/Documentation/AI.AI_Escort.html +++ b/Documentation/AI.AI_Escort.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Escort_Dispatcher.html b/Documentation/AI.AI_Escort_Dispatcher.html index 5644c5d8b..858cf219b 100644 --- a/Documentation/AI.AI_Escort_Dispatcher.html +++ b/Documentation/AI.AI_Escort_Dispatcher.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Escort_Dispatcher_Request.html b/Documentation/AI.AI_Escort_Dispatcher_Request.html index ca6cf19cc..32ff4863c 100644 --- a/Documentation/AI.AI_Escort_Dispatcher_Request.html +++ b/Documentation/AI.AI_Escort_Dispatcher_Request.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Escort_Request.html b/Documentation/AI.AI_Escort_Request.html index bc24953de..4ba7d23ad 100644 --- a/Documentation/AI.AI_Escort_Request.html +++ b/Documentation/AI.AI_Escort_Request.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Formation.html b/Documentation/AI.AI_Formation.html index a83dd5eb2..8546a1e47 100644 --- a/Documentation/AI.AI_Formation.html +++ b/Documentation/AI.AI_Formation.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index 0ce61737a..3320c8798 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -3251,6 +3262,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

This table contains the targets detected during patrol.

+ @@ -6498,6 +6512,9 @@ Note that this method is required, as triggers the next route when patrolling fo + +

This table contains the targets detected during patrol.

+ @@ -7242,6 +7259,9 @@ Note that this method is required, as triggers the next route when patrolling fo + +

This table contains the targets detected during patrol.

+ @@ -8874,6 +8894,9 @@ Note that this method is required, as triggers the next route when patrolling fo + +

This table contains the targets detected during patrol.

+ diff --git a/Documentation/Actions.Act_Account.html b/Documentation/Actions.Act_Account.html index 9d536c2fb..60a607aef 100644 --- a/Documentation/Actions.Act_Account.html +++ b/Documentation/Actions.Act_Account.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Actions.Act_Assign.html b/Documentation/Actions.Act_Assign.html index 3744909aa..f30e9a2ce 100644 --- a/Documentation/Actions.Act_Assign.html +++ b/Documentation/Actions.Act_Assign.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Actions.Act_Assist.html b/Documentation/Actions.Act_Assist.html index ebab51b23..75343449b 100644 --- a/Documentation/Actions.Act_Assist.html +++ b/Documentation/Actions.Act_Assist.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Actions.Act_Route.html b/Documentation/Actions.Act_Route.html index 5530d9987..45351ca0f 100644 --- a/Documentation/Actions.Act_Route.html +++ b/Documentation/Actions.Act_Route.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Cargo.Cargo.html b/Documentation/Cargo.Cargo.html index 8dc30d230..d9a7e5da6 100644 --- a/Documentation/Cargo.Cargo.html +++ b/Documentation/Cargo.Cargo.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -2802,17 +2813,6 @@ All derived classes from CARGO follow the same state machine, expose the same ca - - - -
-
- - -CARGO.Weight - - -
diff --git a/Documentation/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index 244f7e419..8d527ced2 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 814e963ae..37621542a 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -1918,6 +1929,9 @@ Therefore, this class is considered to be deprecated

+ +

Then we register the new group in the database

+ @@ -1929,20 +1943,6 @@ Therefore, this class is considered to be deprecated

- - - -
-
- - -CARGO_GROUP.CargoObject - - - - -

Now we spawn the new group based on the template created.

-
diff --git a/Documentation/Cargo.CargoSlingload.html b/Documentation/Cargo.CargoSlingload.html index 9b87f78a1..61ee17e0b 100644 --- a/Documentation/Cargo.CargoSlingload.html +++ b/Documentation/Cargo.CargoSlingload.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 6c8253d83..0ea00b2ac 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -1816,17 +1827,6 @@ Therefore, this class is considered to be deprecated

Set cargo object.

- - - -
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2531,17 +2531,6 @@ Therefore, this class is considered to be deprecated

Set cargo object.

- - - -
-
- - #number -CARGO_UNIT.RunCount - - -
diff --git a/Documentation/Core.Astar.html b/Documentation/Core.Astar.html index a7b1dd93d..c7304347e 100644 --- a/Documentation/Core.Astar.html +++ b/Documentation/Core.Astar.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Base.html b/Documentation/Core.Base.html index f0c8ed1f8..a427626aa 100644 --- a/Documentation/Core.Base.html +++ b/Documentation/Core.Base.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Beacon.html b/Documentation/Core.Beacon.html index 92ab34de6..d729643f7 100644 --- a/Documentation/Core.Beacon.html +++ b/Documentation/Core.Beacon.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Condition.html b/Documentation/Core.Condition.html index bdf06e4c1..149e90557 100644 --- a/Documentation/Core.Condition.html +++ b/Documentation/Core.Condition.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Database.html b/Documentation/Core.Database.html index 36291629c..207d22b75 100644 --- a/Documentation/Core.Database.html +++ b/Documentation/Core.Database.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Event.html b/Documentation/Core.Event.html index 2d066da9c..c0e0d1753 100644 --- a/Documentation/Core.Event.html +++ b/Documentation/Core.Event.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index c358181b4..021da0d33 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Goal.html b/Documentation/Core.Goal.html index 42e6d895d..18a0b7336 100644 --- a/Documentation/Core.Goal.html +++ b/Documentation/Core.Goal.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.MarkerOps_Base.html b/Documentation/Core.MarkerOps_Base.html index 0829e2e44..9d4b22feb 100644 --- a/Documentation/Core.MarkerOps_Base.html +++ b/Documentation/Core.MarkerOps_Base.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Menu.html b/Documentation/Core.Menu.html index 9754da710..7fb722a92 100644 --- a/Documentation/Core.Menu.html +++ b/Documentation/Core.Menu.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Message.html b/Documentation/Core.Message.html index 410c6ecdd..ff48f6d79 100644 --- a/Documentation/Core.Message.html +++ b/Documentation/Core.Message.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Pathline.html b/Documentation/Core.Pathline.html index 51e9a8ba6..43c164f37 100644 --- a/Documentation/Core.Pathline.html +++ b/Documentation/Core.Pathline.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 839434712..f880757cb 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Report.html b/Documentation/Core.Report.html index 957f46604..d4cb2f8dc 100644 --- a/Documentation/Core.Report.html +++ b/Documentation/Core.Report.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.ScheduleDispatcher.html b/Documentation/Core.ScheduleDispatcher.html index bdb7ddf3b..15582851a 100644 --- a/Documentation/Core.ScheduleDispatcher.html +++ b/Documentation/Core.ScheduleDispatcher.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Scheduler.html b/Documentation/Core.Scheduler.html index c1b082ba3..51e3523ab 100644 --- a/Documentation/Core.Scheduler.html +++ b/Documentation/Core.Scheduler.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Set.html b/Documentation/Core.Set.html index 73af9b7bf..fc612bd70 100644 --- a/Documentation/Core.Set.html +++ b/Documentation/Core.Set.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index d59fe676e..007137576 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -2853,7 +2864,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + SETTINGS.A2GSystem @@ -2897,11 +2908,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -5010,7 +5032,7 @@ It is advised to use this method at the start of the mission.

- #string + SETTINGS.A2GSystem @@ -5054,11 +5076,22 @@ It is advised to use this method at the start of the mission.

- + #boolean SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index ce0f65647..525f4deb7 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+
+
+
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -2977,6 +2988,24 @@ and any spaces before and after the resulting name are removed.

SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

+ + + +

SPAWN.communication

+ + + + + +

SPAWN.livery_id

+ + + + + +

SPAWN.modulation

+ + @@ -3536,14 +3565,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SPAWN.AIOnOff - -

The AI is on by default when spawning a group.

-
@@ -3613,9 +3639,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

-
@@ -3704,6 +3727,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnGrouping + + +
@@ -3740,6 +3774,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnInitAirbase + + +
@@ -3784,6 +3829,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -3846,26 +3902,64 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -SPAWN.SpawnInitKeepUnitNames +SPAWN.SpawnInitLimit - -

Overwrite unit names by default with group name.

-
- #boolean -SPAWN.SpawnInitLimit + +SPAWN.SpawnInitLivery +
+ +
+
+
+ -

By default, no InitLimit

+SPAWN.SpawnInitModex + + + +
+ +
+
+
+ + +SPAWN.SpawnInitModexPostfix + + + +
+ +
+
+
+ + +SPAWN.SpawnInitModexPrefix + + + +
+ +
+
+
+ + +SPAWN.SpawnInitModu + +
@@ -3878,6 +3972,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -3909,7 +4014,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3923,7 +4028,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -4080,17 +4185,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -4125,7 +4219,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

+

When the first Spawn executes, all the Groups need to be made visible before start.

@@ -4202,6 +4296,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.modulation + + +
@@ -9444,14 +9571,11 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #boolean + SPAWN.AIOnOff - -

The AI is on by default when spawning a group.

-
@@ -9521,9 +9645,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

- @@ -9612,6 +9733,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.SpawnGrouping + + +
@@ -9648,6 +9780,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.SpawnInitAirbase + + +
@@ -9692,6 +9835,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -9754,26 +9908,64 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

#boolean -SPAWN.SpawnInitKeepUnitNames +SPAWN.SpawnInitLimit - -

Overwrite unit names by default with group name.

-
- #boolean -SPAWN.SpawnInitLimit + +SPAWN.SpawnInitLivery +
+ +
+
+
+ -

By default, no InitLimit

+SPAWN.SpawnInitModex + + + +
+ +
+
+
+ + +SPAWN.SpawnInitModexPostfix + + + +
+ +
+
+
+ + +SPAWN.SpawnInitModexPrefix + + + +
+ +
+
+
+ + +SPAWN.SpawnInitModu + +
@@ -9786,6 +9978,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -9817,7 +10020,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #number + SPAWN.SpawnMaxGroups @@ -9831,7 +10034,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #number + SPAWN.SpawnMaxUnitsAlive @@ -9988,17 +10191,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -10033,7 +10225,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

+

When the first Spawn executes, all the Groups need to be made visible before start.

@@ -10110,6 +10302,39 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.modulation + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index ac784a7f5..20e3ac873 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -1985,6 +1996,24 @@ such as position and heading.

SPAWNSTATIC:_SpawnStatic(Template, CountryID)

Spawns a new static using a given template.

+ + + +

SPAWNSTATIC.heliport_callsign_id

+ + + + + +

SPAWNSTATIC.heliport_frequency

+ + + + + +

SPAWNSTATIC.heliport_modulation

+ + @@ -2899,6 +2928,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
@@ -4252,6 +4314,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 9ec109d37..a3e956874 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -2804,6 +2815,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
@@ -4087,6 +4131,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
@@ -5609,6 +5686,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
diff --git a/Documentation/Core.TextAndSound.html b/Documentation/Core.TextAndSound.html index 6001e6b60..49cd69bbf 100644 --- a/Documentation/Core.TextAndSound.html +++ b/Documentation/Core.TextAndSound.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Timer.html b/Documentation/Core.Timer.html index 3c65b33be..cc278637a 100644 --- a/Documentation/Core.Timer.html +++ b/Documentation/Core.Timer.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.UserFlag.html b/Documentation/Core.UserFlag.html index 067e63fd5..9b87f70f0 100644 --- a/Documentation/Core.UserFlag.html +++ b/Documentation/Core.UserFlag.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Velocity.html b/Documentation/Core.Velocity.html index bba32d973..a51715ddf 100644 --- a/Documentation/Core.Velocity.html +++ b/Documentation/Core.Velocity.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Zone.html b/Documentation/Core.Zone.html index 452f7fcdd..064a880b9 100644 --- a/Documentation/Core.Zone.html +++ b/Documentation/Core.Zone.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Core.Zone_Detection.html b/Documentation/Core.Zone_Detection.html index 5e64e4758..ecc9f0429 100644 --- a/Documentation/Core.Zone_Detection.html +++ b/Documentation/Core.Zone_Detection.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/DCS.html b/Documentation/DCS.html index cd2d7c82f..d7b2477e5 100644 --- a/Documentation/DCS.html +++ b/Documentation/DCS.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index ed3db3144..0297d9b81 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.Artillery.html b/Documentation/Functional.Artillery.html index cc6202dc0..f050616a9 100644 --- a/Documentation/Functional.Artillery.html +++ b/Documentation/Functional.Artillery.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.CleanUp.html b/Documentation/Functional.CleanUp.html index d7121828f..37bd87e08 100644 --- a/Documentation/Functional.CleanUp.html +++ b/Documentation/Functional.CleanUp.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 97c4a990f..b607f3771 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 66de48ebf..f66315709 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -19343,17 +19354,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - - - -
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -19514,7 +19514,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
- + #number DETECTION_BASE.RefreshTimeInterval @@ -24112,17 +24112,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -24283,7 +24272,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval @@ -25876,17 +25865,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -26047,7 +26025,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.DetectionZones.html b/Documentation/Functional.DetectionZones.html index 9755f9ced..97c4fb419 100644 --- a/Documentation/Functional.DetectionZones.html +++ b/Documentation/Functional.DetectionZones.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+
+ +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.Escort.html b/Documentation/Functional.Escort.html index 00f2caa9e..84fe48792 100644 --- a/Documentation/Functional.Escort.html +++ b/Documentation/Functional.Escort.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.Fox.html b/Documentation/Functional.Fox.html index b73012aff..0a52a07f5 100644 --- a/Documentation/Functional.Fox.html +++ b/Documentation/Functional.Fox.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index ea4fe1ee2..968b7b984 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -3938,6 +3949,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The #DETECTION_AREAS object for AWACS

+ + + +
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -4538,50 +4560,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Prefix for logging

- - - -
-
- - #number -MANTIS.maxclassic - - - -
- -
-
-
- - #number -MANTIS.maxlongrange - - - -
- -
-
-
- - #number -MANTIS.maxmidrange - - - -
- -
-
-
- - #number -MANTIS.maxshortrange - - -
@@ -8627,6 +8605,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

The #DETECTION_AREAS object for AWACS

+ + + +
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -9227,50 +9216,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

Prefix for logging

- - - -
-
- - #number -MANTIS.maxclassic - - - -
- -
-
-
- - #number -MANTIS.maxlongrange - - - -
- -
-
-
- - #number -MANTIS.maxmidrange - - - -
- -
-
-
- - #number -MANTIS.maxshortrange - - -
diff --git a/Documentation/Functional.MissileTrainer.html b/Documentation/Functional.MissileTrainer.html index 0313063d7..a83611392 100644 --- a/Documentation/Functional.MissileTrainer.html +++ b/Documentation/Functional.MissileTrainer.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index 8d01e33b4..fcc4c7970 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -2257,20 +2268,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - #number -MOVEMENT.AliveUnits - - - - -

Contains the counter how many units are currently alive.

- -
- -
@@ -2501,20 +2498,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - #number -MOVEMENT.AliveUnits - - - - -

Contains the counter how many units are currently alive.

- -
- -
diff --git a/Documentation/Functional.PseudoATC.html b/Documentation/Functional.PseudoATC.html index d49dad80d..bbce1e993 100644 --- a/Documentation/Functional.PseudoATC.html +++ b/Documentation/Functional.PseudoATC.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+
+
+
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.RAT.html b/Documentation/Functional.RAT.html index dfed908dc..ba8e64c89 100644 --- a/Documentation/Functional.RAT.html +++ b/Documentation/Functional.RAT.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -4550,6 +4561,24 @@ and any spaces before and after the resulting name are removed.

RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

+ + + +

RAT.communication

+ + + + + +

RAT.livery_id

+ + + + + +

RAT.modulation

+ + diff --git a/Documentation/Functional.Range.html b/Documentation/Functional.Range.html index c82c93a90..980d67478 100644 --- a/Documentation/Functional.Range.html +++ b/Documentation/Functional.Range.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html index a5afe19ff..05b564896 100644 --- a/Documentation/Functional.Scoring.html +++ b/Documentation/Functional.Scoring.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -2855,14 +2866,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SCORING.AutoSave - -

Create the CSV file.

-
@@ -3045,7 +3053,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SCORING.penaltyoncoalitionchange @@ -5444,14 +5452,11 @@ The scale magnifies the scores given to the players.

- #boolean + SCORING.AutoSave - -

Create the CSV file.

-
@@ -5634,7 +5639,7 @@ The scale magnifies the scores given to the players.

- #boolean + SCORING.penaltyoncoalitionchange diff --git a/Documentation/Functional.Sead.html b/Documentation/Functional.Sead.html index 0949d1563..265a5190d 100644 --- a/Documentation/Functional.Sead.html +++ b/Documentation/Functional.Sead.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+
+
+
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.Shorad.html b/Documentation/Functional.Shorad.html index da28935c6..0fdd79f96 100644 --- a/Documentation/Functional.Shorad.html +++ b/Documentation/Functional.Shorad.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.Suppression.html b/Documentation/Functional.Suppression.html index d0b0c8e9a..49d3e4967 100644 --- a/Documentation/Functional.Suppression.html +++ b/Documentation/Functional.Suppression.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.Warehouse.html b/Documentation/Functional.Warehouse.html index 92a8580de..bf2c15dda 100644 --- a/Documentation/Functional.Warehouse.html +++ b/Documentation/Functional.Warehouse.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.ZoneCaptureCoalition.html b/Documentation/Functional.ZoneCaptureCoalition.html index 33668c5ff..dc997f40b 100644 --- a/Documentation/Functional.ZoneCaptureCoalition.html +++ b/Documentation/Functional.ZoneCaptureCoalition.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.ZoneGoal.html b/Documentation/Functional.ZoneGoal.html index d96a261b7..6b0cf54dd 100644 --- a/Documentation/Functional.ZoneGoal.html +++ b/Documentation/Functional.ZoneGoal.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.ZoneGoalCargo.html b/Documentation/Functional.ZoneGoalCargo.html index 96d008600..dc9bca025 100644 --- a/Documentation/Functional.ZoneGoalCargo.html +++ b/Documentation/Functional.ZoneGoalCargo.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Functional.ZoneGoalCoalition.html b/Documentation/Functional.ZoneGoalCoalition.html index 53b8e3711..0cce93351 100644 --- a/Documentation/Functional.ZoneGoalCoalition.html +++ b/Documentation/Functional.ZoneGoalCoalition.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Ops.ATIS.html b/Documentation/Ops.ATIS.html index c43b353b3..38071a917 100644 --- a/Documentation/Ops.ATIS.html +++ b/Documentation/Ops.ATIS.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 0bc570825..23bc09c97 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -9589,6 +9600,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

+ + + +
+
+ + +AIRBOSS.RQLid + + +
@@ -9600,6 +9622,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of marshal.

+ + + +
+
+ + +AIRBOSS.RQMid + + +
@@ -29788,6 +29821,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

+ + + +
+
+ + +AIRBOSS.RQLid + + +
@@ -29799,6 +29843,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

+ + + +
+
+ + +AIRBOSS.RQMid + + +
@@ -32867,6 +32922,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

+ + + +
+
+ + +AIRBOSS.RQLid + + +
@@ -32878,6 +32944,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

+ + + +
+
+ + +AIRBOSS.RQMid + + +
@@ -40923,17 +41000,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Band modulation.

- - - -
-
- - -AIRBOSS.Radio.voice - - -
diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index f438f7f10..d433d558f 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -2594,12 +2605,6 @@ Dropped troop noMessage and forcedesc parameters aren't saved.

CSAR.inTransitGroups

- - - -

CSAR.index

- - @@ -3994,7 +3999,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.FreeVHFFrequencies @@ -4329,7 +4334,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Core.Point#COORDINATE CSAR.coordinate @@ -4418,11 +4423,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.csarUnits + +

table of CSAR unit names

+
@@ -4443,11 +4451,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -4571,17 +4593,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

contain a table for each SAR with all units he has with the original names

-
- -
-
-
- - -CSAR.index - - -
@@ -4790,6 +4801,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+ + #number +CSAR.rescuedpilots + + + + +

counter for saved pilots

+ +
+
@@ -4815,6 +4840,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+ + #number +CSAR.rescues + + + + +

counter for successful rescue landings at FARP/AFB/MASH

+ +
+
@@ -10006,7 +10045,7 @@ callsigns from playername or group name.

- + #table CSAR.FreeVHFFrequencies @@ -10341,7 +10380,7 @@ callsigns from playername or group name.

- + Core.Point#COORDINATE CSAR.coordinate @@ -10430,11 +10469,14 @@ callsigns from playername or group name.

- + #table CSAR.csarUnits + +

table of CSAR unit names

+
@@ -10455,11 +10497,25 @@ callsigns from playername or group name.

- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -10583,17 +10639,6 @@ callsigns from playername or group name.

contain a table for each SAR with all units he has with the original names

-
- -
-
-
- - -CSAR.index - - -
@@ -10802,6 +10847,20 @@ callsigns from playername or group name.

+
+
+
+ + #number +CSAR.rescuedpilots + + + + +

counter for saved pilots

+ +
+
@@ -10827,6 +10886,20 @@ callsigns from playername or group name.

+
+
+
+ + #number +CSAR.rescues + + + + +

counter for successful rescue landings at FARP/AFB/MASH

+ +
+
@@ -12503,7 +12576,7 @@ callsigns from playername or group name.

- + #table CSAR.FreeVHFFrequencies @@ -12838,7 +12911,7 @@ callsigns from playername or group name.

- + Core.Point#COORDINATE CSAR.coordinate @@ -12927,11 +13000,14 @@ callsigns from playername or group name.

- + #table CSAR.csarUnits + +

table of CSAR unit names

+
@@ -12952,11 +13028,25 @@ callsigns from playername or group name.

- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -13080,17 +13170,6 @@ callsigns from playername or group name.

contain a table for each SAR with all units he has with the original names

-
- -
-
-
- - -CSAR.index - - -
@@ -13299,6 +13378,20 @@ callsigns from playername or group name.

+
+
+
+ + #number +CSAR.rescuedpilots + + + + +

counter for saved pilots

+ +
+
@@ -13324,6 +13417,20 @@ callsigns from playername or group name.

+
+
+
+ + #number +CSAR.rescues + + + + +

counter for successful rescue landings at FARP/AFB/MASH

+ +
+
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index ef93480f6..8f3b4c768 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+
+
+
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -7705,17 +7716,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Name of the class.

-
- -
-
-
- - #number -CTLD.CrateCounter - - -
@@ -7736,7 +7736,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.CtldUnits @@ -7836,7 +7836,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.FreeFMFrequencies @@ -7863,9 +7863,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Beacons

-
@@ -7950,14 +7947,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.PilotGroups - -

tables

-
@@ -8052,17 +8046,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #number -CTLD.TroopCounter - - -
@@ -8598,7 +8581,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + CTLD.troopdropzoneradius @@ -18063,17 +18046,6 @@ However, if you create a new folder inside the miz file, which contains the soun

Name of the class.

-
- -
-
-
- - #number -CTLD.CrateCounter - - -
@@ -18094,7 +18066,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.CtldUnits @@ -18194,7 +18166,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeFMFrequencies @@ -18221,9 +18193,6 @@ However, if you create a new folder inside the miz file, which contains the soun - -

Beacons

-
@@ -18308,14 +18277,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.PilotGroups - -

tables

-
@@ -18410,17 +18376,6 @@ However, if you create a new folder inside the miz file, which contains the soun -
- -
-
-
- - #number -CTLD.TroopCounter - - -
@@ -18956,7 +18911,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number + CTLD.troopdropzoneradius @@ -20533,17 +20488,6 @@ However, if you create a new folder inside the miz file, which contains the soun

Name of the class.

-
- -
-
-
- - #number -CTLD.CrateCounter - - -
@@ -20564,7 +20508,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.CtldUnits @@ -20664,7 +20608,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeFMFrequencies @@ -20691,9 +20635,6 @@ However, if you create a new folder inside the miz file, which contains the soun - -

Beacons

-
@@ -20778,14 +20719,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.PilotGroups - -

tables

-
@@ -20880,17 +20818,6 @@ However, if you create a new folder inside the miz file, which contains the soun -
- -
-
-
- - #number -CTLD.TroopCounter - - -
@@ -21426,7 +21353,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number + CTLD.troopdropzoneradius @@ -25626,6 +25553,17 @@ When moose is loading dynamically (for moose class development), tracing is swit

Flag for direct loading.

+
+ +
+
+
+ + +CTLD_CARGO.Mark + + +
@@ -26752,6 +26690,17 @@ When moose is loading dynamically (for moose class development), tracing is swit

Flag for direct loading.

+
+ + +
+
+ + +CTLD_CARGO.Mark + + +
@@ -30362,17 +30311,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - - - -
-
- - Core.Point#COORDINATE -CTLD_ENGINEERING.currwpt - - -
@@ -31026,17 +30964,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - - - -
-
- - Core.Point#COORDINATE -CTLD_ENGINEERING.currwpt - - -
@@ -34572,17 +34499,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

template for a group of 10 paratroopers

- - - -
-
- - #number -CTLD_HERCULES.j - - -
@@ -35909,17 +35825,6 @@ Use either this method to integrate the Hercules **or** the one from the "normal

template for a group of 10 paratroopers

- - - -
-
- - #number -CTLD_HERCULES.j - - -
diff --git a/Documentation/Ops.RecoveryTanker.html b/Documentation/Ops.RecoveryTanker.html index 16ed29799..a745d7258 100644 --- a/Documentation/Ops.RecoveryTanker.html +++ b/Documentation/Ops.RecoveryTanker.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Ops.RescueHelo.html b/Documentation/Ops.RescueHelo.html index 4c2a03111..1228c66a4 100644 --- a/Documentation/Ops.RescueHelo.html +++ b/Documentation/Ops.RescueHelo.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Sound.Radio.html b/Documentation/Sound.Radio.html index b356f01bb..9767363cf 100644 --- a/Documentation/Sound.Radio.html +++ b/Documentation/Sound.Radio.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Sound.RadioQueue.html b/Documentation/Sound.RadioQueue.html index f5f97bbb7..94e81024a 100644 --- a/Documentation/Sound.RadioQueue.html +++ b/Documentation/Sound.RadioQueue.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Sound.RadioSpeech.html b/Documentation/Sound.RadioSpeech.html index 734011db9..f96e202bd 100644 --- a/Documentation/Sound.RadioSpeech.html +++ b/Documentation/Sound.RadioSpeech.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Sound.SRS.html b/Documentation/Sound.SRS.html new file mode 100644 index 000000000..4045cf2ab --- /dev/null +++ b/Documentation/Sound.SRS.html @@ -0,0 +1,15673 @@ + + + + + + + + + + + + + + + + + + +
+

+ +

+
+
+ + +Banner Image +
+
+

Module Sound.SRS

+
+
+ +

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

+ + + +
+ +

Main Features:

+ +
    +
  • Incease immersion of your missions with more sound output
    • +
  • Play sound files via SRS
    • +
  • Play text-to-speech via SRS
    • +
+ +
+ +

Youtube Videos: None yet

+ +
+ +

Example Missions: GitHub.

+ +
+ +

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

+ +
+ +

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

+ +
+ +

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
    • +
  • You need to de-sanitize os, io and lfs in the missionscripting.lua
    • +
  • Optional: DCS-gRPC as backend to communicate with SRS (vide infra)
    • +
+ +

Knwon Issues

+ +

Pop-up Window

+ +

The text-to-speech conversion of SRS is done via an external exe file. When this file is called, a windows cmd window is briefly opended. That puts DCS out of focus, which is annoying, +expecially in VR but unavoidable (if you have a solution, please feel free to share!).

+ +

NOTE that this is not an issue if the mission is running on a server. +Also NOTE that using DCS-gRPC as backend will avoid the pop-up window.

+ +

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 Voice

+ +

Use a specific voice with the MSRS.SetVoice function, e.g, :SetVoice("Microsoft Hedda Desktop"). +Note that this must be installed on your windows system.

+ +

Note that you can set voices for each provider via the MSRS.SetVoiceProvider function. Also shortcuts are available, i.e. +MSRS.SetVoiceWindows, MSRS.SetVoiceGoogle, MSRS.SetVoiceAzure and MSRS.SetVoiceAmazon.

+ +

For voices there are enumerators in this class to help you out on voice names:

+ +
MSRS.Voices.Microsoft -- e.g. MSRS.Voices.Microsoft.Hedda - the Microsoft enumerator contains all voices known to work with SRS
+MSRS.Voices.Google -- e.g. MSRS.Voices.Google.Standard.en_AU_Standard_A or MSRS.Voices.Google.Wavenet.de_DE_Wavenet_C - The Google enumerator contains voices for EN, DE, IT, FR and ES.
+
+ +

Set Coordinate

+ +

Use MSRS.SetCoordinate to define the origin from where the transmission is broadcasted. +Note that this is only a factor if SRS server has line-of-sight and/or distance limit enabled.

+ +

Set SRS Port

+ +

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

+ +

Set SRS Volume

+ +

Use MSRS.SetVolume to define the SRS volume. Defaults to 1.0. Allowed values are between 0.0 and 1.0, from silent to loudest.

+ +

Config file for many variables, auto-loaded by Moose

+ +

See MSRS.LoadConfigFile for details on how to set this up.

+ +

TTS Providers

+ +

The default provider for generating speech from text is the native Windows TTS service. Note that you need to install the voices you want to use.

+ +

Pro-Tip - use the command line with power shell to call DCS-SR-ExternalAudio.exe - it will tell you what is missing +and also the Google Console error, in case you have missed a step in setting up your Google TTS. +For example, .\DCS-SR-ExternalAudio.exe -t "Text Message" -f 255 -m AM -c 2 -s 2 -z -G "Path_To_You_Google.Json" +plays a message on 255 MHz AM for the blue coalition in-game.

+ +

Google

+ +

In order to use Google Cloud for TTS you need to use MSRS.SetProvider and MSRS.SetProviderOptionsGoogle functions:

+ +
msrs:SetProvider(MSRS.Provider.GOOGLE)
+msrs:SetProviderOptionsGoogle(CredentialsFile, AccessKey)
+
+ +

The parameter CredentialsFile is used with the default 'DCS-SR-ExternalAudio.exe' backend and must be the full path to the credentials JSON file. +The AccessKey parameter is used with the DCS-gRPC backend (see below).

+ +

You can set the voice to use with Google via MSRS.SetVoiceGoogle.

+ +

When using Google it also allows you to utilize SSML in your text for more flexibility. +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

+ +

Amazon Web Service [Only DCS-gRPC backend]

+ +

In order to use Amazon Web Service (AWS) for TTS you need to use MSRS.SetProvider and MSRS.SetProviderOptionsAmazon functions:

+ +
msrs:SetProvider(MSRS.Provider.AMAZON)
+msrs:SetProviderOptionsAmazon(AccessKey, SecretKey, Region)
+
+ +

The parameters AccessKey and SecretKey are your AWS access and secret keys, respectively. The parameter Region is your AWS region.

+ +

You can set the voice to use with AWS via MSRS.SetVoiceAmazon.

+ +

Microsoft Azure [Only DCS-gRPC backend]

+ +

In order to use Microsoft Azure for TTS you need to use MSRS.SetProvider and MSRS.SetProviderOptionsAzure functions:

+ +
msrs:SetProvider(MSRS.Provider.AZURE)
+msrs:SetProviderOptionsAmazon(AccessKey, Region)
+
+ +

The parameter AccessKey is your Azure access key. The parameter Region is your Azure region.

+ +

You can set the voice to use with Azure via MSRS.SetVoiceAzure.

+ +

Backend

+ +

The default interface to SRS is via calling the 'DCS-SR-ExternalAudio.exe'. As noted above, this has the unavoidable drawback that a pop-up briefly appears +and DCS might be put out of focus.

+ +

DCS-gRPC as an alternative to 'DCS-SR-ExternalAudio.exe' for TTS

+ +

Another interface to SRS is DCS-gRPC. This does not call an exe file and therefore avoids the annoying pop-up window. +In addition to Windows and Google cloud, it also offers Microsoft Azure and Amazon Web Service as providers for TTS.

+ +

Use MSRS.SetDefaultBackendGRPC to enable DCS-gRPC as an alternate backend for transmitting text-to-speech over SRS. +This can be useful if 'DCS-SR-ExternalAudio.exe' cannot be used in the environment or to use Azure or AWS clouds for TTS. Note that DCS-gRPC does not (yet?) support +all of the features and options available with 'DCS-SR-ExternalAudio.exe'. Of note, only text-to-speech is supported and it it cannot be used to transmit audio files.

+ +

DCS-gRPC must be installed and configured per the DCS-gRPC documentation and already running via either the 'autostart' mechanism +or a Lua call to 'GRPC.load()' prior to use of the alternate DCS-gRPC backend. If a cloud TTS provider is being used, the API key must be set via the 'Config\dcs-grpc.lua' +configuration file prior DCS-gRPC being started. DCS-gRPC can be used both with DCS dedicated server and regular DCS installations.

+ +

To use the default local Windows TTS with DCS-gRPC, Windows 2019 Server (or newer) or Windows 10/11 are required. Voices for non-local languages and dialects may need to +be explicitly installed.

+ +

To set the MSRS class to use the DCS-gRPC backend for all future instances, call the function MSRS.SetDefaultBackendGRPC().

+ +

Note - When using other classes that use MSRS with the alternate DCS-gRPC backend, pass them strings instead of nil values for non-applicable fields with filesystem paths, +such as the SRS path or Google credential path. This will help maximize compatibility with other classes that were written for the default backend.

+ +

Basic Play Text-To-Speech example using alternate DCS-gRPC backend (DCS-gRPC not previously started):

+ +
-- Start DCS-gRPC
+GRPC.load()
+-- Select the alternate DCS-gRPC backend for new MSRS instances
+MSRS.SetDefaultBackendGRPC()
+-- Create a SOUNDTEXT object.
+local text=SOUNDTEXT:New("All Enemies destroyed")
+-- MOOSE SRS
+local msrs=MSRS:New('', 305.0)
+-- Text-to speech with default voice after 30 seconds.
+msrs:PlaySoundText(text, 30)
+
+ +

Basic example of using another class (ATIS) with SRS and the DCS-gRPC backend (DCS-gRPC not previously started):

+ +
-- Start DCS-gRPC
+GRPC.load()
+-- Select the alternate DCS-gRPC backend for new MSRS instances
+MSRS.SetDefaultBackendGRPC()
+-- Create new ATIS as usual
+atis=ATIS:New("Nellis", 251, radio.modulation.AM)
+-- ATIS:SetSRS() expects a string for the SRS path even though it is not needed with DCS-gRPC
+atis:SetSRS('')
+-- Start ATIS
+atis:Start()
+
+ + +
+ +
+
+ + + + + +

Global MSRSQUEUE

 + +
+
+
+
+ + #MSRSQUEUE +MSRSQUEUE + + + +
+ +
+

Type(s)

+

Type MSRS

+
+ MSRS +, extends Core.Base#BASE +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from MSRSDescription

MSRS:AddFrequencies(Frequencies)

 +

Add frequencies.

+

MSRS:AddModulations(Modulations)

 +

Add modulations.

+

MSRS.Backend

 + +

MSRS.ClassName

 +

Name of the class.

+

MSRS.ConfigFileName

 +

Name of the standard config file.

+

MSRS.ConfigFilePath

 +

Path to the standard config file.

+

MSRS.ConfigLoaded

 +

If true if config file was loaded.

+

MSRS:GetBackend()

 +

Get currently set backend.

+

MSRS:GetCoalition()

 +

Get coalition.

+

MSRS:GetFrequencies()

 +

Get frequencies.

+

MSRS:GetLabel()

 +

Get label.

+

MSRS:GetModulations()

 +

Get modulations.

+

MSRS:GetPath()

 +

Get path to SRS directory.

+

MSRS:GetPort()

 +

Get port.

+

MSRS:GetProvider()

 +

Get provider.

+

MSRS:GetProviderOptions(Provider)

 +

Get provider options.

+

MSRS:GetVoice(Provider)

 +

Get voice.

+

MSRS:GetVolume()

 +

Get SRS volume.

+

MSRS:Help()

 +

Print SRS help to DCS log file.

+

MSRS.Label

 +

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

+

MSRS:LoadConfigFile(Path, Filename)

 +

Get central SRS configuration to be able to play tts over SRS radio using the DCS-SR-ExternalAudio.exe.

+

MSRS:New(Path, Frequency, Modulation, Backend)

 +

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, Coordinate)

 +

Play text message via MSRS.

+

MSRS:PlayTextExt(Text, Delay, Frequencies, Modulations, Gender, Culture, Voice, Volume, Label, Coordinate)

 +

Play text message via MSRS with explicitly specified options.

+

MSRS:PlayTextFile(TextFile, Delay)

 +

Play text file via MSRS.

+

MSRS.Provider

 + +

MSRS:SetBackend(Backend)

 +

Set backend to communicate with SRS.

+

MSRS:SetBackendGRPC()

 +

Set DCS-gRPC as backend to communicate with SRS.

+

MSRS:SetBackendSRSEXE()

 +

Set DCS-SR-ExternalAudio.exe as backend to communicate with SRS.

+

MSRS:SetCoalition(Coalition)

 +

Set coalition.

+

MSRS:SetCoordinate(Coordinate)

 +

Set the coordinate from which the transmissions will be broadcasted.

+

MSRS:SetCulture(Culture)

 +

Set culture.

+

MSRS:SetDefaultBackend(Backend)

 +

Set the default backend.

+

MSRS:SetDefaultBackendGRPC()

 +

Set DCS-gRPC to be the default backend.

+

MSRS:SetFrequencies(Frequencies)

 +

Set frequencies.

+

MSRS:SetGender(Gender)

 +

Set gender.

+

MSRS:SetGoogle(PathToCredentials)

 +

[Deprecated] Use google text-to-speech credentials.

+

MSRS:SetGoogleAPIKey(APIKey)

 +

[Deprecated] Use google text-to-speech set the API key (only for DCS-gRPC).

+

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:SetProvider(Provider)

 +

Set provider used to generate text-to-speech.

+

MSRS:SetProviderOptions(Provider, CredentialsFile, AccessKey, SecretKey, Region)

 +

Set provider options and credentials.

+

MSRS:SetProviderOptionsAmazon(AccessKey, SecretKey, Region)

 +

Set provider options and credentials for Amazon Web Service (AWS).

+

MSRS:SetProviderOptionsAzure(AccessKey, Region)

 +

Set provider options and credentials for Microsoft Azure.

+

MSRS:SetProviderOptionsGoogle(CredentialsFile, AccessKey)

 +

Set provider options and credentials for Google Cloud.

+

MSRS:SetTTSProviderAmazon()

 +

Use Amazon Web Service (AWS) to provide text-to-speech.

+

MSRS:SetTTSProviderAzure()

 +

Use Microsoft Azure to provide text-to-speech.

+

MSRS:SetTTSProviderGoogle()

 +

Use Google to provide text-to-speech.

+

MSRS:SetTTSProviderMicrosoft()

 +

Use Microsoft to provide text-to-speech.

+

MSRS:SetVoice(Voice)

 +

Set to use a specific voice.

+

MSRS:SetVoiceAmazon(Voice)

 +

Set to use a specific voice if Amazon Web Service is use as provider (only DCS-gRPC backend).

+

MSRS:SetVoiceAzure(Voice)

 +

Set to use a specific voice if Microsoft Azure is use as provider (only DCS-gRPC backend).

+

MSRS:SetVoiceGoogle(Voice)

 +

Set to use a specific voice if Google is use as provider.

+

MSRS:SetVoiceProvider(Voice, Provider)

 +

Set to use a specific voice for a given provider.

+

MSRS:SetVoiceWindows(Voice)

 +

Set to use a specific voice if Microsoft Windows' native TTS is use as provider.

+

MSRS:SetVolume(Volume)

 +

Set SRS volume.

+

MSRS.Voices

 + +

MSRS._CreateProviderOptions(Provider, CredentialsFile, AccessKey, SecretKey, Region)

 +

Create MSRS.ProviderOptions.

+

MSRS:_DCSgRPCtts(Text, Frequencies, Gender, Culture, Voice, Volume, Label, Coordinate)

 +

Make DCS-gRPC API call to transmit text-to-speech over SRS.

+

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, coordinate)

 +

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

+

MSRS:_GetLatLongAlt(Coordinate)

 +

Get lat, long and alt from coordinate.

+

MSRS.backend

 +

Backend used as interface to SRS (MSRS.Backend.SRSEXE or MSRS.Backend.GRPC).

+

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.getSpeechTime(length, speed, isGoogle)

 +

Function returns estimated speech time in seconds.

+

MSRS.lid

 +

Class id string for output to DCS log file.

+

MSRS.modulations

 +

Modulations used in the transmissions.

+

MSRS.name

 +

Name. Default "MSRS".

+

MSRS.path

 +

Path to the SRS exe.

+

MSRS.poptions

 +

Provider options. Each element is a data structure of type MSRS.ProvierOptions.

+

MSRS.port

 +

Port. Default 5002.

+

MSRS.provider

 +

Provider of TTS (win, gcloud, azure, amazon).

+

MSRS.uuid()

 +

Function for UUID.

+

MSRS.version

 +

MSRS class version.

+

MSRS.voice

 +

Specific voice. Only used if no explicit provider voice specified.

+

MSRS.volume

 +

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

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from BASEDescription

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, IniObjectCategory)

 +

Creation of a Crash Event.

+

MSRS:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 +

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:CreateEventUnitLost(EventTime, Initiator)

 +

Creation of a Crash 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 Core.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 Event for an object is triggered.

+

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 +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

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 +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

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 +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

MSRS:OnEventMissionStart(EventData)

 +

Occurs when a mission starts +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

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(SchedulerID)

 +

Stops the Schedule.

+

MSRS.Scheduler

 + +

MSRS:SetEventPriority(EventPriority)

 +

Set the Class Core.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)

 +

The main event handling function...

+
+
+ +

Type MSRS.Backend

+
+ MSRS.Backend +
+
+ + + + + + + + + + + + + +
Fields and Methods inherited from MSRS.BackendDescription

MSRS.Backend.GRPC

 +

Use DCS-gRPC.

+

MSRS.Backend.SRSEXE

 +

Use DCS-SR-ExternalAudio.exe.

+
+
+ +

Type MSRS.GRPCOptions

+
+ MSRS.GRPCOptions +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from MSRS.GRPCOptionsDescription

MSRS.GRPCOptions.DefaultProvider

 + +

MSRS.GRPCOptions.aws

 + +

MSRS.GRPCOptions.azure

 + +

MSRS.GRPCOptions.coalition

 + +

MSRS.GRPCOptions.gcloud

 + +

MSRS.GRPCOptions.plaintext

 + +

MSRS.GRPCOptions.position

 + +

MSRS.GRPCOptions.provider

 + +

MSRS.GRPCOptions.srsClientName

 + +

MSRS.GRPCOptions.win

 + +
+
+ +

Type MSRS.Provider

+
+ MSRS.Provider +
+
+ + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from MSRS.ProviderDescription

MSRS.Provider.AMAZON

 +

Amazon Web Service (aws). Only possible with DCS-gRPC backend.

+

MSRS.Provider.AZURE

 +

Microsoft Azure (azure). Only possible with DCS-gRPC backend.

+

MSRS.Provider.GOOGLE

 +

Google (gcloud).

+

MSRS.Provider.WINDOWS

 +

Microsoft windows (win).

+
+
+ +

Type MSRS.ProviderOptions

+
+ MSRS.ProviderOptions +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from MSRS.ProviderOptionsDescription

MSRS.ProviderOptions.credentials

 +

Google credentials JSON file (full path).

+

MSRS.ProviderOptions.defaultVoice

 +

Default voice (not used).

+

MSRS.ProviderOptions.key

 +

Access key (DCS-gRPC with Google, AWS, AZURE as provider).

+

MSRS.ProviderOptions.provider

 +

Provider.

+

MSRS.ProviderOptions.region

 +

Region.

+

MSRS.ProviderOptions.secret

 +

Secret key (DCS-gRPC with AWS as provider)

+

MSRS.ProviderOptions.voice

 +

Voice used.

+
+
+ +

Type MSRS.Voices

+
+ MSRS.Voices +
+
+ + + + + + + + + + + + + +
Fields and Methods inherited from MSRS.VoicesDescription

MSRS.Voices.Google

 + +

MSRS.Voices.Microsoft

 + +
+
+ +

Type MSRSQUEUE

+
+ MSRSQUEUE +, extends Core.Base#BASE +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from MSRSQUEUEDescription

MSRSQUEUE:AddTransmission(transmission)

 +

Add a transmission to the radio queue.

+

MSRSQUEUE:Broadcast(transmission)

 +

Broadcast radio message.

+

MSRSQUEUE:CalcTransmisstionDuration()

 +

Calculate total transmission duration of all transmission in the queue.

+

MSRSQUEUE.ClassName

 +

Name of the class "MSRSQUEUE".

+

MSRSQUEUE:Clear()

 +

Clear the radio queue.

+

MSRSQUEUE.Debugmode

 + +

MSRSQUEUE:New(alias)

 +

Create a new MSRSQUEUE object for a given radio frequency/modulation.

+

MSRSQUEUE:NewTransmission(text, duration, msrs, tstart, interval, subgroups, subtitle, subduration, frequency, modulation, gender, culture, voice, volume, label, coordinate)

 +

Create a new transmission and add it to the radio queue.

+

MSRSQUEUE.PlayerSet

 + +

MSRSQUEUE:SetTransmitOnlyWithPlayers(Switch)

 +

Switch to only transmit if there are players on the server.

+

MSRSQUEUE.Tlast

 +

Time (abs) when the last transmission finished.

+

MSRSQUEUE.TransmitOnlyWithPlayers

 + +

MSRSQUEUE:_CheckRadioQueue(delay)

 +

Check radio queue for transmissions to be broadcasted.

+

MSRSQUEUE.alias

 +

Name of the radio queue.

+

MSRSQUEUE.checking

 +

If true, the queue update function is scheduled to be called again.

+

MSRSQUEUE.dt

 +

Time interval in seconds for checking the radio queue.

+

MSRSQUEUE.lid

 +

ID for dcs.log.

+

MSRSQUEUE.queue

 +

The queue of transmissions.

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from BASEDescription

MSRSQUEUE.ClassID

 +

The ID number of the class.

+

MSRSQUEUE.ClassName

 +

The name of the class.

+

MSRSQUEUE.ClassNameAndID

 +

The name of the class concatenated with the ID number of the class.

+

MSRSQUEUE:ClearState(Object, StateName)

 +

Clear the state of an object.

+

MSRSQUEUE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

 +

Creation of a Birth Event.

+

MSRSQUEUE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Crash Event.

+

MSRSQUEUE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Dead Event.

+

MSRSQUEUE:CreateEventPlayerEnterAircraft(PlayerUnit)

 +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

MSRSQUEUE:CreateEventRemoveUnit(EventTime, Initiator)

 +

Creation of a Remove Unit Event.

+

MSRSQUEUE:CreateEventTakeoff(EventTime, Initiator)

 +

Creation of a Takeoff Event.

+

MSRSQUEUE:CreateEventUnitLost(EventTime, Initiator)

 +

Creation of a Crash Event.

+

MSRSQUEUE:E(Arguments)

 +

Log an exception which will be traced always.

+

MSRSQUEUE:EventDispatcher()

 +

Returns the event dispatcher

+

MSRSQUEUE:EventRemoveAll()

 +

Remove all subscribed events

+

MSRSQUEUE:F(Arguments)

 +

Trace a function call.

+

MSRSQUEUE:F2(Arguments)

 +

Trace a function call level 2.

+

MSRSQUEUE:F3(Arguments)

 +

Trace a function call level 3.

+

MSRSQUEUE:GetClassID()

 +

Get the ClassID of the class instance.

+

MSRSQUEUE:GetClassName()

 +

Get the ClassName of the class instance.

+

MSRSQUEUE:GetClassNameAndID()

 +

Get the ClassName + ClassID of the class instance.

+

MSRSQUEUE:GetEventPriority()

 +

Get the Class Core.Event processing Priority.

+

MSRSQUEUE:GetParent(Child, FromClass)

 +

This is the worker method to retrieve the Parent class.

+

MSRSQUEUE:GetState(Object, Key)

 +

Get a Value given a Key from the Object.

+

MSRSQUEUE:HandleEvent(EventID, EventFunction)

 +

Subscribe to a DCS Event.

+

MSRSQUEUE:I(Arguments)

 +

Log an information which will be traced always.

+

MSRSQUEUE:Inherit(Child, Parent)

 +

This is the worker method to inherit from a parent class.

+

MSRSQUEUE:IsInstanceOf(ClassName)

 +

This is the worker method to check if an object is an (sub)instance of a class.

+

MSRSQUEUE:IsTrace()

 +

Enquires if tracing is on (for the class).

+

MSRSQUEUE:New()

 +

BASE constructor.

+

MSRSQUEUE:OnEvent(EventData)

 +

Occurs when an Event for an object is triggered.

+

MSRSQUEUE:OnEventBDA(EventData)

 +

BDA.

+

MSRSQUEUE:OnEventBaseCaptured(EventData)

 +

Occurs when a ground unit captures either an airbase or a farp.

+

MSRSQUEUE:OnEventBirth(EventData)

 +

Occurs when any object is spawned into the mission.

+

MSRSQUEUE:OnEventCrash(EventData)

 +

Occurs when any aircraft crashes into the ground and is completely destroyed.

+

MSRSQUEUE:OnEventDead(EventData)

 +

Occurs when an object is dead.

+

MSRSQUEUE:OnEventDetailedFailure(EventData)

 +

Unknown precisely what creates this event, likely tied into newer damage model.

+

MSRSQUEUE:OnEventDiscardChairAfterEjection(EventData)

 +

Discard chair after ejection.

+

MSRSQUEUE:OnEventEjection(EventData)

 +

Occurs when a pilot ejects from an aircraft +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

MSRSQUEUE:OnEventEngineShutdown(EventData)

 +

Occurs when any aircraft shuts down its engines.

+

MSRSQUEUE:OnEventEngineStartup(EventData)

 +

Occurs when any aircraft starts its engines.

+

MSRSQUEUE:OnEventHit(EventData)

 +

Occurs whenever an object is hit by a weapon.

+

MSRSQUEUE:OnEventHumanFailure(EventData)

 +

Occurs when any system fails on a human controlled aircraft.

+

MSRSQUEUE:OnEventKill(EventData)

 +

Occurs on the death of a unit.

+

MSRSQUEUE:OnEventLand(EventData)

 +

Occurs when an aircraft lands at an airbase, farp or ship +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

MSRSQUEUE:OnEventLandingAfterEjection(EventData)

 +

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

+

MSRSQUEUE:OnEventLandingQualityMark(EventData)

 +

Landing quality mark.

+

MSRSQUEUE:OnEventMarkAdded(EventData)

 +

Occurs when a new mark was added.

+

MSRSQUEUE:OnEventMarkChange(EventData)

 +

Occurs when a mark text was changed.

+

MSRSQUEUE:OnEventMarkRemoved(EventData)

 +

Occurs when a mark was removed.

+

MSRSQUEUE:OnEventMissionEnd(EventData)

 +

Occurs when a mission ends +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

MSRSQUEUE:OnEventMissionStart(EventData)

 +

Occurs when a mission starts +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

MSRSQUEUE:OnEventParatrooperLanding(EventData)

 +

Weapon add.

+

MSRSQUEUE:OnEventPilotDead(EventData)

 +

Occurs when the pilot of an aircraft is killed.

+

MSRSQUEUE:OnEventPlayerEnterAircraft(EventData)

 +

Occurs when a player enters a slot and takes control of an aircraft.

+

MSRSQUEUE:OnEventPlayerEnterUnit(EventData)

 +

Occurs when any player assumes direct control of a unit.

+

MSRSQUEUE:OnEventPlayerLeaveUnit(EventData)

 +

Occurs when any player relieves control of a unit to the AI.

+

MSRSQUEUE:OnEventRefueling(EventData)

 +

Occurs when an aircraft connects with a tanker and begins taking on fuel.

+

MSRSQUEUE:OnEventRefuelingStop(EventData)

 +

Occurs when an aircraft is finished taking fuel.

+

MSRSQUEUE:OnEventScore(EventData)

 +

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

+

MSRSQUEUE:OnEventShootingEnd(EventData)

 +

Occurs when any unit stops firing its weapon.

+

MSRSQUEUE:OnEventShootingStart(EventData)

 +

Occurs when any unit begins firing a weapon that has a high rate of fire.

+

MSRSQUEUE:OnEventShot(EventData)

 +

Occurs whenever any unit in a mission fires a weapon.

+

MSRSQUEUE:OnEventTakeoff(EventData)

 +

Occurs when an aircraft takes off from an airbase, farp, or ship.

+

MSRSQUEUE:OnEventTriggerZone(EventData)

 +

Trigger zone.

+

MSRSQUEUE:OnEventUnitLost(EventData)

 +

Occurs when the game thinks an object is destroyed.

+

MSRSQUEUE:ScheduleOnce(Start, SchedulerFunction, ...)

 +

Schedule a new time event.

+

MSRSQUEUE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

 +

Schedule a new time event.

+

MSRSQUEUE:ScheduleStop(SchedulerID)

 +

Stops the Schedule.

+

MSRSQUEUE.Scheduler

 + +

MSRSQUEUE:SetEventPriority(EventPriority)

 +

Set the Class Core.Event processing Priority.

+

MSRSQUEUE:SetState(Object, Key, Value)

 +

Set a state or property of the Object given a Key and a Value.

+

MSRSQUEUE:T(Arguments)

 +

Trace a function logic level 1.

+

MSRSQUEUE:T2(Arguments)

 +

Trace a function logic level 2.

+

MSRSQUEUE:T3(Arguments)

 +

Trace a function logic level 3.

+

MSRSQUEUE:TraceAll(TraceAll)

 +

Trace all methods in MOOSE

+

MSRSQUEUE:TraceClass(Class)

 +

Set tracing for a class

+

MSRSQUEUE:TraceClassMethod(Class, Method)

 +

Set tracing for a specific method of class

+

MSRSQUEUE:TraceLevel(Level)

 +

Set trace level

+

MSRSQUEUE:TraceOff()

 +

Set trace off.

+

MSRSQUEUE:TraceOn()

 +

Set trace on.

+

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

+

MSRSQUEUE:UnHandleEvent(EventID)

 +

UnSubscribe to a DCS event.

+

MSRSQUEUE._

 + +

MSRSQUEUE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function call.

+

MSRSQUEUE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

MSRSQUEUE.__

 + +

MSRSQUEUE:onEvent(event)

 +

The main event handling function...

+
+
+ +

Type MSRSQUEUE.Transmission

+
+ MSRSQUEUE.Transmission +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from MSRSQUEUE.TransmissionDescription

MSRSQUEUE.Transmission.PlayerSet

 +

PlayerSet created when TransmitOnlyWithPlayers == true

+

MSRSQUEUE.Transmission.Tplay

 +

Mission time (abs) in seconds when the transmission should be played.

+

MSRSQUEUE.Transmission.TransmitOnlyWithPlayers

 +

If true, only transmit if there are alive Players.

+

MSRSQUEUE.Transmission.Tstarted

 +

Mission time (abs) in seconds when the transmission started.

+

MSRSQUEUE.Transmission.coordinate

 +

Coordinate for this transmission

+

MSRSQUEUE.Transmission.culture

 +

Voice culture

+

MSRSQUEUE.Transmission.duration

 +

Duration in seconds.

+

MSRSQUEUE.Transmission.frequency

 +

Frequency.

+

MSRSQUEUE.Transmission.gender

 +

Voice gender

+

MSRSQUEUE.Transmission.interval

 +

Interval in seconds before next transmission.

+

MSRSQUEUE.Transmission.isplaying

 +

If true, transmission is currently playing.

+

MSRSQUEUE.Transmission.label

 +

Label to be used

+

MSRSQUEUE.Transmission.modulation

 +

Modulation.

+

MSRSQUEUE.Transmission.msrs

 +

MOOSE SRS object.

+

MSRSQUEUE.Transmission.subduration

 +

Duration of the subtitle being displayed.

+

MSRSQUEUE.Transmission.subgroups

 +

Groups to send subtitle to.

+

MSRSQUEUE.Transmission.subtitle

 +

Subtitle of the transmission.

+

MSRSQUEUE.Transmission.text

 +

Text to be transmitted.

+

MSRSQUEUE.Transmission.voice

 +

Voice if any

+

MSRSQUEUE.Transmission.volume

 +

Volume

+
+
+ +

Type Sound.SRS

+
+
+
+ +
+

Type MSRS

+
+
+ +

MSRS class.

+ +
+

Field(s)

+
+
+
+ + #MSRS.Backend +MSRS.Backend + + + +
+ +
+
+
+ + #string +MSRS.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #string +MSRS.ConfigFileName + +

Name of the standard config file.

+ +
+ +
+
+
+ + #string +MSRS.ConfigFilePath + +

Path to the standard config file.

+ +
+ +
+
+
+ + #boolean +MSRS.ConfigLoaded + +

If true if config file was loaded.

+ +
+ +
+
+
+ + #string +MSRS.Label + +

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

+ +
+ +
+
+
+ + #MSRS.Provider +MSRS.Provider + + + +
+ +
+
+
+ + #MSRS.Voices +MSRS.Voices + + + +
+ +
+
+
+ + #string +MSRS.backend + +

Backend used as interface to SRS (MSRS.Backend.SRSEXE or MSRS.Backend.GRPC).

+ +
+ +
+
+
+ + #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.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #table +MSRS.modulations + +

Modulations used in the transmissions.

+ +
+ +
+
+
+ + #string +MSRS.name + +

Name. Default "MSRS".

+ +
+ +
+
+
+ + #string +MSRS.path + +

Path to the SRS exe.

+ +
+ +
+
+
+ + #table +MSRS.poptions + +

Provider options. Each element is a data structure of type MSRS.ProvierOptions.

+ +
+ +
+
+
+ + #number +MSRS.port + +

Port. Default 5002.

+ +
+ +
+
+
+ + #string +MSRS.provider + +

Provider of TTS (win, gcloud, azure, amazon).

+ +
+ +
+
+
+ + #string +MSRS.version + +

MSRS class version.

+ +
+ +
+
+
+ + #string +MSRS.voice + +

Specific voice. Only used if no explicit provider voice specified.

+ +
+ +
+
+
+ + #number +MSRS.volume + +

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

+ +
+ +
+
+

Function(s)

+
+
+ +
+

MSRS:AddFrequencies(Frequencies)

+
+ +

Add 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:AddModulations(Modulations)

+
+ +

Add 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:GetBackend()

+
+ +

Get currently set backend.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#string:

+
+
+ +

Backend.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetCoalition()

+
+ +

Get coalition.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#number:

+
+
+ +

Coalition.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetFrequencies()

+
+ +

Get frequencies.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#table:

+
+
+ +

Frequencies in MHz.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetLabel()

+
+ +

Get label.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#number:

+
+
+ +

Label.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetModulations()

+
+ +

Get modulations.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#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:GetProvider()

+
+ +

Get provider.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetProviderOptions(Provider)

+
+ +

Get provider options.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + Provider +

+
+
+ +

Provider. Default is as set via MSRS.SetProvider.

+ +
+
+

Return value:

+
+
+

#MSRS.ProviderOptions:

+
+
+ +

Provider options.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetVoice(Provider)

+
+ +

Get voice.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + Provider +

+
+
+ +

Provider. Default is the currently set provider (self.provider).

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

Voice.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetVolume()

+
+ +

Get SRS volume.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#number:

+
+
+ +

Volume Volume - 1.0 is max, 0.0 is silence

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:Help()

+
+ +

Print SRS help to DCS log file.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:LoadConfigFile(Path, Filename)

+
+ +

Get central SRS configuration to be able to play tts over SRS radio using the DCS-SR-ExternalAudio.exe.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + Path +

+
+
+ +

Path to config file, defaults to "C:\Users\\Saved Games\DCS\Config"

+ +
+
+
+
+

+ #string + Filename +

+
+
+ +

File to load, defaults to "Moose_MSRS.lua"

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

success

+ +
+
+

Usage:

+ 
 0) Benefits: Centralize configuration of SRS, keep paths and keys out of the mission source code, making it safer and easier to move missions to/between servers,
+ and also make config easier to use in the code.
+ 1) Create a config file named "Moose_MSRS.lua" at this location "C:\Users\<yourname>\Saved Games\DCS\Config" (or wherever your Saved Games folder resides).
+ 2) The file needs the following structure:
+
+    -- Moose MSRS default Config
+    MSRS_Config = {
+      Path = C:\\Program Files\\DCS-SimpleRadio-Standalone, -- Path to SRS install directory.
+      Port = 5002,            -- Port of SRS server. Default 5002.
+      Backend = "srsexe",     -- Interface to SRS: "srsexe" or "grpc".
+      Frequency = {127, 243}, -- Default frequences. Must be a table 1..n entries!
+      Modulation = {0,0},     -- Default modulations. Must be a table, 1..n entries, one for each frequency!
+      Volume = 1.0,           -- Default volume [0,1].
+      Coalition = 0,          -- 0 = Neutral, 1 = Red, 2 = Blue (only a factor if SRS server has encryption enabled).
+      Coordinate = {0,0,0},   -- x, y, alt (only a factor if SRS server has line-of-sight and/or distance limit enabled).
+      Culture = "en-GB",
+      Gender = "male",
+      Voice = "Microsoft Hazel Desktop", -- Voice that is used if no explicit provider voice is specified.
+      Label = "MSRS",   
+      Provider = "win", --Provider for generating TTS (win, gcloud, azure, aws).
+      
+      -- Windows
+      win = {
+        voice = "Microsoft Hazel Desktop",
+      },
+      -- Google Cloud
+      gcloud = {
+        voice = "en-GB-Standard-A", -- The Google Cloud voice to use (see https://cloud.google.com/text-to-speech/docs/voices).
+        credentials="C:\\Program Files\\DCS-SimpleRadio-Standalone\\yourfilename.json", -- Full path to credentials JSON file (only for SRS-TTS.exe backend)
+        key="Your access Key", -- Google API access key (only for DCS-gRPC backend)
+      },
+      -- Amazon Web Service
+      aws = {
+        voice = "Brian", -- The default AWS voice to use (see https://docs.aws.amazon.com/polly/latest/dg/voicelist.html).
+        key="Your access Key",  -- Your AWS key.
+        secret="Your secret key", -- Your AWS secret key.
+        region="eu-central-1", -- Your AWS region (see https://docs.aws.amazon.com/general/latest/gr/pol.html).
+      },
+      -- Microsoft Azure
+      azure = {
+        voice="en-US-AriaNeural",  --The default Azure voice to use (see https://learn.microsoft.com/azure/cognitive-services/speech-service/language-support).
+        key="Your access key", -- Your Azure access key.
+        region="westeurope", -- The Azure region to use (see https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/regions).
+      },
+    }
+
+ 3) The config file is automatically loaded when Moose starts. YOu can also load the config into the MSRS raw class manually before you do anything else:
+
+        MSRS.LoadConfigFile() -- Note the "." here
+
+ Optionally, your might want to provide a specific path and filename:
+
+        MSRS.LoadConfigFile(nil,MyPath,MyFilename) -- Note the "." here
+
+ This will populate variables for the MSRS raw class and all instances you create with e.g. `mysrs = MSRS:New()`
+ Optionally you can also load this per **single instance** if so needed, i.e.
+
+    mysrs:LoadConfigFile(Path,Filename)
+
+ 4) Use the config in your code like so, variable names are basically the same as in the config file, but all lower case, examples:
+
+        -- Needed once only
+        MESSAGE.SetMSRS(MSRS.path,nil,MSRS.google,243,radio.modulation.AM,nil,nil,
+        MSRS.Voices.Google.Standard.de_DE_Standard_B,coalition.side.BLUE)
+
+        -- later on in your code
+
+        MESSAGE:New("Test message!",15,"SPAWN"):ToSRS(243,radio.modulation.AM,nil,nil,MSRS.Voices.Google.Standard.fr_FR_Standard_C)
+
+        -- Create new ATIS as usual
+        atis=ATIS:New(AIRBASE.Caucasus.Batumi, 123, radio.modulation.AM)
+        atis:SetSRS(nil,nil,nil,MSRS.Voices.Google.Standard.en_US_Standard_H)
+        --Start ATIS
+        atis:Start()
+ +
+ +
+
+ +
+ +
+

MSRS:New(Path, Frequency, Modulation, Backend)

+
+ +

Create a new MSRS object.

+ + +

Required argument is the frequency and modulation. +Other parameters are read from the Moose_MSRS.lua config file. If you do not have that file set up you must set up and use the DCS-SR-ExternalAudio.exe (not DCS-gRPC) as backend, you need to still +set the path to the exe file via MSRS.SetPath.

+ + +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + Path +

+
+
+ +

Path to SRS directory. Default C:\\Program Files\\DCS-SimpleRadio-Standalone.

+ +
+
+
+
+

+ #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.

+ +
+
+
+
+

+ #string + Backend +

+
+
+ +

Backend used: MSRS.Backend.SRSEXE (default) or MSRS.Backend.GRPC.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:PlaySoundFile(Soundfile, Delay)

+
+ +

Play sound file (ogg or mp3) via SRS.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ Sound.SoundOutput#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.SoundOutput#SOUNDTEXT + SoundText +

+
+
+ +

Sound text.

+ +
+
+
+
+

+ #number + Delay +

+
+
+ +

Delay in seconds, before the sound file is played.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:PlayText(Text, Delay, Coordinate)

+
+ +

Play text message via MSRS.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + Text +

+
+
+ +

Text message.

+ +
+
+
+
+

+ #number + Delay +

+
+
+ +

Delay in seconds, before the message is played.

+ +
+
+
+
+

+ Core.Point#COORDINATE + Coordinate +

+
+
+ +

Coordinate.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:PlayTextExt(Text, Delay, Frequencies, Modulations, Gender, Culture, Voice, Volume, Label, Coordinate)

+
+ +

Play text message via MSRS with explicitly specified options.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + Text +

+
+
+ +

Text message.

+ +
+
+
+
+

+ #number + Delay +

+
+
+ +

Delay in seconds, before the message is played.

+ +
+
+
+
+

+ #table + Frequencies +

+
+
+ +

Radio frequencies.

+ +
+
+
+
+

+ #table + Modulations +

+
+
+ +

Radio modulations.

+ +
+
+
+
+

+ #string + Gender +

+
+
+ +

Gender.

+ +
+
+
+
+

+ #string + Culture +

+
+
+ +

Culture.

+ +
+
+
+
+

+ #string + Voice +

+
+
+ +

Voice.

+ +
+
+
+
+

+ #number + Volume +

+
+
+ +

Volume.

+ +
+
+
+
+

+ #string + Label +

+
+
+ +

Label.

+ +
+
+
+
+

+ Core.Point#COORDINATE + Coordinate +

+
+
+ +

Coordinate.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:PlayTextFile(TextFile, Delay)

+
+ +

Play text file via MSRS.

+ +
+
+

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:SetBackend(Backend)

+
+ +

Set backend to communicate with SRS.

+ + +

There are two options:

+ +
    +
  • MSRS.Backend.SRSEXE: This is the default and uses the DCS-SR-ExternalAudio.exe.
    • +
  • MSRS.Backend.GRPC: Via DCS-gRPC.
    • +
+ + +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + Backend +

+
+
+ +

Backend used. Default is MSRS.Backend.SRSEXE.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetBackendGRPC()

+
+ +

Set DCS-gRPC as backend to communicate with SRS.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetBackendSRSEXE()

+
+ +

Set DCS-SR-ExternalAudio.exe as backend to communicate with SRS.

+ +
+
+

Defined in:

+
+

MSRS

+
+

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.

+ + +

Note that this is only a factor if SRS has line-of-sight or distance enabled.

+ +
+
+

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

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetDefaultBackend(Backend)

+
+ +

Set the default backend.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ Backend +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRS:SetDefaultBackendGRPC()

+
+ +

Set DCS-gRPC to be the default backend.

+ +
+
+

Defined in:

+
+

MSRS

+
+
+ +
+
+ +
+ +
+

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)

+
+ +

[Deprecated] Use google text-to-speech credentials.

+ + +

Also sets Google as default TTS provider.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + PathToCredentials +

+
+
+ +

Full path to the google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json". Can also be the Google API key.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetGoogleAPIKey(APIKey)

+
+ +

[Deprecated] Use google text-to-speech set the API key (only for DCS-gRPC).

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + APIKey +

+
+
+ +

API Key, usually a string of length 40 with characters and numbers.

+ +
+
+

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-SR-ExternalAudio.exe is located.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + Path +

+
+
+ +

Path to the directory, where the sound file is located. Default is C:\\Program Files\\DCS-SimpleRadio-Standalone.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetPort(Port)

+
+ +

Set port.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #number + Port +

+
+
+ +

Port. Default 5002.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetProvider(Provider)

+
+ +

Set provider used to generate text-to-speech.

+ + +

These options are available:

+ +
    +
  • MSRS.Provider.WINDOWS: Microsoft Windows (default)
    • +
  • MSRS.Provider.GOOGLE: Google Cloud
    • +
  • MSRS.Provider.AZURE: Microsoft Azure (only with DCS-gRPC backend)
    • +
  • MSRS.Provier.AMAZON: Amazone Web Service (only with DCS-gRPC backend)
    • +
+ +

Note that all providers except Microsoft Windows need as additonal information the credentials of your account.

+ + +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + Provider +

+
+
+

+
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetProviderOptions(Provider, CredentialsFile, AccessKey, SecretKey, Region)

+
+ +

Set provider options and credentials.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + Provider +

+
+
+ +

Provider.

+ +
+
+
+
+

+ #string + CredentialsFile +

+
+
+ +

Full path to your credentials file. For Google this is the path to a JSON file.

+ +
+
+
+
+

+ #string + AccessKey +

+
+
+ +

Your API access key.

+ +
+
+
+
+

+ #string + SecretKey +

+
+
+ +

Your secret key.

+ +
+
+
+
+

+ #string + Region +

+
+
+ +

Region to use.

+ +
+
+

Return value:

+
+
+

#MSRS.ProviderOptions:

+
+
+ +

Provider optionas table.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetProviderOptionsAmazon(AccessKey, SecretKey, Region)

+
+ +

Set provider options and credentials for Amazon Web Service (AWS).

+ + +

Only supported in combination with DCS-gRPC as backend.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + AccessKey +

+
+
+ +

Your API access key.

+ +
+
+
+
+

+ #string + SecretKey +

+
+
+ +

Your secret key.

+ +
+
+
+
+

+ #string + Region +

+
+
+ +

Your AWS region.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetProviderOptionsAzure(AccessKey, Region)

+
+ +

Set provider options and credentials for Microsoft Azure.

+ + +

Only supported in combination with DCS-gRPC as backend.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + AccessKey +

+
+
+ +

Your API access key.

+ +
+
+
+
+

+ #string + Region +

+
+
+ +

Your Azure region.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetProviderOptionsGoogle(CredentialsFile, AccessKey)

+
+ +

Set provider options and credentials for Google Cloud.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + CredentialsFile +

+
+
+ +

Full path to your credentials file. For Google this is the path to a JSON file. This is used if DCS-SR-ExternalAudio.exe is used as backend.

+ +
+
+
+
+

+ #string + AccessKey +

+
+
+ +

Your API access key. This is necessary if DCS-gRPC is used as backend.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetTTSProviderAmazon()

+
+ +

Use Amazon Web Service (AWS) to provide text-to-speech.

+ + +

Only supported if used in combination with DCS-gRPC as backend.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetTTSProviderAzure()

+
+ +

Use Microsoft Azure to provide text-to-speech.

+ + +

Only supported if used in combination with DCS-gRPC as backend.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetTTSProviderGoogle()

+
+ +

Use Google to provide text-to-speech.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetTTSProviderMicrosoft()

+
+ +

Use Microsoft to provide text-to-speech.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetVoice(Voice)

+
+ +

Set to use a specific voice.

+ + +

Note that this will override any gender and culture settings as a voice already has a certain gender/culture.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + Voice +

+
+
+ +

Voice.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetVoiceAmazon(Voice)

+
+ +

Set to use a specific voice if Amazon Web Service is use as provider (only DCS-gRPC backend).

+ + +

Note that this will override any gender and culture settings.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + Voice +

+
+
+ +

AWS Voice. Default "Brian".

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetVoiceAzure(Voice)

+
+ +

Set to use a specific voice if Microsoft Azure is use as provider (only DCS-gRPC backend).

+ + +

Note that this will override any gender and culture settings.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + Voice +

+
+
+ +

Azure Voice. Default "en-US-AriaNeural".

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetVoiceGoogle(Voice)

+
+ +

Set to use a specific voice if Google is use as provider.

+ + +

Note that this will override any gender and culture settings.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + Voice +

+
+
+ +

Voice. Default MSRS.Voices.Google.Standard.en_GB_Standard_A.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetVoiceProvider(Voice, Provider)

+
+ +

Set to use a specific voice for a given provider.

+ + +

Note that this will override any gender and culture settings.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + Voice +

+
+
+ +

Voice.

+ +
+
+
+
+

+ #string + Provider +

+
+
+ +

Provider. Default is as set by MSRS.SetProvider, which itself defaults to MSRS.Provider.WINDOWS if not set.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetVoiceWindows(Voice)

+
+ +

Set to use a specific voice if Microsoft Windows' native TTS is use as provider.

+ + +

Note that this will override any gender and culture settings.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #string + Voice +

+
+
+ +

Voice. Default "Microsoft Hazel Desktop".

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetVolume(Volume)

+
+ +

Set SRS volume.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #number + Volume +

+
+
+ +

Volume - 1.0 is max, 0.0 is silence

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS._CreateProviderOptions(Provider, CredentialsFile, AccessKey, SecretKey, Region)

+
+ +

Create MSRS.ProviderOptions.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + Provider +

+
+
+ +

Provider.

+ +
+
+
+
+

+ #string + CredentialsFile +

+
+
+ +

Full path to your credentials file. For Google this is the path to a JSON file.

+ +
+
+
+
+

+ #string + AccessKey +

+
+
+ +

Your API access key.

+ +
+
+
+
+

+ #string + SecretKey +

+
+
+ +

Your secret key.

+ +
+
+
+
+

+ #string + Region +

+
+
+ +

Region to use.

+ +
+
+

Return value:

+
+
+

#MSRS.ProviderOptions:

+
+
+ +

Provider optionas table.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:_DCSgRPCtts(Text, Frequencies, Gender, Culture, Voice, Volume, Label, Coordinate)

+
+ +

Make DCS-gRPC API call to transmit text-to-speech over SRS.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + Text +

+
+
+ +

Text of message to transmit (can also be SSML).

+ +
+
+
+
+

+ #table + Frequencies +

+
+
+ +

Radio frequencies to transmit on. Can also accept a number in MHz.

+ +
+
+
+
+

+ #string + Gender +

+
+
+ +

Gender.

+ +
+
+
+
+

+ #string + Culture +

+
+
+ +

Culture.

+ +
+
+
+
+

+ #string + Voice +

+
+
+ +

Voice.

+ +
+
+
+
+

+ #number + Volume +

+
+
+ +

Volume.

+ +
+
+
+
+

+ #string + Label +

+
+
+ +

Label.

+ +
+
+
+
+

+ Core.Point#COORDINATE + Coordinate +

+
+
+ +

Coordinate.

+ +
+
+

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, coordinate)

+
+ +

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!

+ +
+
+
+
+

+ Core.Point#COORDINATE + coordinate +

+
+
+ +

Coordinate.

+ +
+
+

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 (or 0 if no input coordinate was given).

+ +
+
+

#number:

+
+
+ +

Longitude (or 0 if no input coordinate was given).

+ +
+
+

#number:

+
+
+ +

Altitude (or 0 if no input coordinate was given).

+ +
+
+
+ +
+
+ +
+ +
+

MSRS.getSpeechTime(length, speed, isGoogle)

+
+ +

Function returns estimated speech time in seconds.

+ + +

Assumptions for time calc: 100 Words per min, average of 5 letters for english word so

+ +
    +
  • 5 chars * 100wpm = 500 characters per min = 8.3 chars per second
    • +
+ +

So length of msg / 8.3 = number of seconds needed to read it. rounded down to 8 chars per sec map function:

+ +
    +
  • (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min
    • +
+ + +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #number + length +

+
+
+ +

can also be passed as #string

+ +
+
+
+
+

+ #number + speed +

+
+
+ +

Defaults to 1.0

+ +
+
+
+
+

+ #boolean + isGoogle +

+
+
+ +

We're using Google TTS

+ +
+
+
+ +
+
+ +
+ +
+

MSRS.uuid()

+
+ +

Function for UUID.

+ +
+
+

Defined in:

+
+

MSRS

+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + #MSRS.Backend +MSRS.Backend + + + +
+ +
+
+
+ + #string +MSRS.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #string +MSRS.ConfigFileName + +

Name of the standard config file.

+ +
+ +
+
+
+ + #string +MSRS.ConfigFilePath + +

Path to the standard config file.

+ +
+ +
+
+
+ + #boolean +MSRS.ConfigLoaded + +

If true if config file was loaded.

+ +
+ +
+
+
+ + #string +MSRS.Label + +

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

+ +
+ +
+
+
+ + #MSRS.Provider +MSRS.Provider + + + +
+ +
+
+
+ + #MSRS.Voices +MSRS.Voices + + + +
+ +
+
+
+ + #string +MSRS.backend + +

Backend used as interface to SRS (MSRS.Backend.SRSEXE or MSRS.Backend.GRPC).

+ +
+ +
+
+
+ + #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.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #table +MSRS.modulations + +

Modulations used in the transmissions.

+ +
+ +
+
+
+ + #string +MSRS.name + +

Name. Default "MSRS".

+ +
+ +
+
+
+ + #string +MSRS.path + +

Path to the SRS exe.

+ +
+ +
+
+
+ + #table +MSRS.poptions + +

Provider options. Each element is a data structure of type MSRS.ProvierOptions.

+ +
+ +
+
+
+ + #number +MSRS.port + +

Port. Default 5002.

+ +
+ +
+
+
+ + #string +MSRS.provider + +

Provider of TTS (win, gcloud, azure, amazon).

+ +
+ +
+
+
+ + #string +MSRS.version + +

MSRS class version.

+ +
+ +
+
+
+ + #string +MSRS.voice + +

Specific voice. Only used if no explicit provider voice specified.

+ +
+ +
+
+
+ + #number +MSRS.volume + +

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

+ +
+ +
+
+

Function(s)

+
+
+ +
+

MSRS:ClearState(Object, StateName)

+
+ +

Clear the state of an object.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ StateName +

+
+
+ +

The key that is should be cleared.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

+
+ +

Creation of a Birth Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ #string + IniUnitName +

+
+
+ +

The initiating unit name.

+ +
+
+
+
+

+ place +

+
+
+

+
+
+
+
+

+ subplace +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRS:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

+
+ +

Creation of a Crash Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ IniObjectCategory +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRS:CreateEventDead(EventTime, Initiator, IniObjectCategory)

+
+ +

Creation of a Dead Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ IniObjectCategory +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRS:CreateEventPlayerEnterAircraft(PlayerUnit)

+
+ +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Wrapper.Unit#UNIT + PlayerUnit +

+
+
+ +

The aircraft unit the player entered.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:CreateEventRemoveUnit(EventTime, Initiator)

+
+ +

Creation of a Remove Unit Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:CreateEventTakeoff(EventTime, Initiator)

+
+ +

Creation of a Takeoff Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:CreateEventUnitLost(EventTime, Initiator)

+
+ +

Creation of a Crash Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:E(Arguments)

+
+ +

Log an exception which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRS:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRS:F(Arguments)

+
+ +

Trace a function call.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:F2(Arguments)

+
+ +

Trace a function call level 2.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:F3(Arguments)

+
+ +

Trace a function call level 3.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetClassNameAndID()

+
+ +

Get the ClassName + ClassID of the class instance.

+ + +

The ClassName + ClassID is formatted as '%s#%09d'.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName + ClassID of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetEventPriority()

+
+ +

Get the Class Core.Event processing Priority.

+ + +

The Event processing Priority is a number from 1 to 10, +reflecting the order of the classes subscribed to the Event to be processed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The Core.Event processing Priority.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:GetParent(Child, FromClass)

+
+ +

This is the worker method to retrieve the Parent class.

+ + +

Note that the Parent class must be passed to call the parent class method.

+ +
self:GetParent(self):ParentMethod()
+
+ + + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #BASE + Child +

+
+
+ +

This is the Child class from which the Parent class needs to be retrieved.

+ +
+
+
+
+

+ #BASE + FromClass +

+
+
+ +

(Optional) The class from which to get the parent.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRS:GetState(Object, Key)

+
+ +

Get a Value given a Key from the Object.

+ + +

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ Key +

+
+
+ +

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

+ +
+
+

Return value:

+
+
+
+
+ +

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:HandleEvent(EventID, EventFunction)

+
+ +

Subscribe to a DCS Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+
+
+

+ #function + EventFunction +

+
+
+ +

(optional) The function to be called when the event occurs for the unit.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRS:I(Arguments)

+
+ +

Log an information which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:Inherit(Child, Parent)

+
+ +

This is the worker method to inherit from a parent class.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Child +

+
+
+ +

is the Child class that inherits.

+ +
+
+
+
+

+ #BASE + Parent +

+
+
+ +

is the Parent class that the Child inherits from.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

Child

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:IsInstanceOf(ClassName)

+
+ +

This is the worker method to check if an object is an (sub)instance of a class.

+ + + +

Examples:

+ +
    +

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ ClassName +

+
+
+ +

is the name of the class or the class itself to run the check against

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRS:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRS:New()

+
+ +

BASE constructor.

+ + + +

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

+ +
function EVENT:New()
+  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
+  return self
+end
+
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEvent(EventData)

+
+ +

Occurs when an Event for an object is triggered.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that triggered the event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventBDA(EventData)

+
+ +

BDA.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventBaseCaptured(EventData)

+
+ +

Occurs when a ground unit captures either an airbase or a farp.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that captured the base +place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventBirth(EventData)

+
+ +

Occurs when any object is spawned into the mission.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that was spawned

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventCrash(EventData)

+
+ +

Occurs when any aircraft crashes into the ground and is completely destroyed.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that has crashed

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventDead(EventData)

+
+ +

Occurs when an object is dead.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is dead.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventDetailedFailure(EventData)

+
+ +

Unknown precisely what creates this event, likely tied into newer damage model.

+ + +

Will update this page when new information become available.

+ +
    +
  • initiator: The unit that had the failure.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventDiscardChairAfterEjection(EventData)

+
+ +

Discard chair after ejection.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventEjection(EventData)

+
+ +

Occurs when a pilot ejects from an aircraft +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ + +

initiator : The unit that has ejected

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventEngineShutdown(EventData)

+
+ +

Occurs when any aircraft shuts down its engines.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is stopping its engines.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventEngineStartup(EventData)

+
+ +

Occurs when any aircraft starts its engines.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is starting its engines.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventHit(EventData)

+
+ +

Occurs whenever an object is hit by a weapon.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit object the fired the weapon +weapon: Weapon object that hit the target +target: The Object that was hit.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventHumanFailure(EventData)

+
+ +

Occurs when any system fails on a human controlled aircraft.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that had the failure

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventKill(EventData)

+
+ +

Occurs on the death of a unit.

+ + +

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
    +
  • initiator: The unit that killed the target
    • +
  • target: Target Object
    • +
  • weapon: Weapon Object
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventLand(EventData)

+
+ +

Occurs when an aircraft lands at an airbase, farp or ship +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ + +

initiator : The unit that has landed +place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventLandingAfterEjection(EventData)

+
+ +

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

+ + +

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
    +
  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
    • +
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
    • +
  • subplace: is always 0 for unknown reasons.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventLandingQualityMark(EventData)

+
+ +

Landing quality mark.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventMarkAdded(EventData)

+
+ +

Occurs when a new mark was added.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventMarkChange(EventData)

+
+ +

Occurs when a mark text was changed.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventMarkRemoved(EventData)

+
+ +

Occurs when a mark was removed.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventMissionEnd(EventData)

+
+ +

Occurs when a mission ends +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventMissionStart(EventData)

+
+ +

Occurs when a mission starts +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventParatrooperLanding(EventData)

+
+ +

Weapon add.

+ + +

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventPilotDead(EventData)

+
+ +

Occurs when the pilot of an aircraft is killed.

+ + +

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. +Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that the pilot has died in.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventPlayerEnterAircraft(EventData)

+
+ +

Occurs when a player enters a slot and takes control of an aircraft.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. +initiator : The unit that is being taken control of.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventPlayerEnterUnit(EventData)

+
+ +

Occurs when any player assumes direct control of a unit.

+ + +

Note - not Mulitplayer safe. Use PlayerEnterAircraft. +Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is being taken control of.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventPlayerLeaveUnit(EventData)

+
+ +

Occurs when any player relieves control of a unit to the AI.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that the player left.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventRefueling(EventData)

+
+ +

Occurs when an aircraft connects with a tanker and begins taking on fuel.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is receiving fuel.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventRefuelingStop(EventData)

+
+ +

Occurs when an aircraft is finished taking fuel.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that was receiving fuel.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventScore(EventData)

+
+ +

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

+ + +

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventShootingEnd(EventData)

+
+ +

Occurs when any unit stops firing its weapon.

+ + +

Event will always correspond with a shooting start event. +Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that was doing the shooting.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventShootingStart(EventData)

+
+ +

Occurs when any unit begins firing a weapon that has a high rate of fire.

+ + +

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. +Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is doing the shooting. +target: The unit that is being targeted.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventShot(EventData)

+
+ +

Occurs whenever any unit in a mission fires a weapon.

+ + +

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventTakeoff(EventData)

+
+ +

Occurs when an aircraft takes off from an airbase, farp, or ship.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that tookoff +place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventTriggerZone(EventData)

+
+ +

Trigger zone.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:OnEventUnitLost(EventData)

+
+ +

Occurs when the game thinks an object is destroyed.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
    +
  • initiator: The unit that is was destroyed.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:ScheduleOnce(Start, SchedulerFunction, ...)

+
+ +

Schedule a new time event.

+ + +

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

The Schedule ID of the planned schedule.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

+
+ +

Schedule a new time event.

+ + +

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

+ +
+
+
+
+

+ #number + Repeat +

+
+
+ +

Specifies the interval in seconds when the scheduler will call the event function.

+ +
+
+
+
+

+ #number + RandomizeFactor +

+
+
+ +

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

+ +
+
+
+
+

+ #number + Stop +

+
+
+ +

Specifies the amount of seconds when the scheduler will be stopped.

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

The Schedule ID of the planned schedule.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:ScheduleStop(SchedulerID)

+
+ +

Stops the Schedule.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + SchedulerID +

+
+
+ +

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetEventPriority(EventPriority)

+
+ +

Set the Class Core.Event processing Priority.

+ + +

The Event processing Priority is a number from 1 to 10, +reflecting the order of the classes subscribed to the Event to be processed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + EventPriority +

+
+
+ +

The Core.Event processing Priority.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:SetState(Object, Key, Value)

+
+ +

Set a state or property of the Object given a Key and a Value.

+ + +

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that will hold the Value set by the Key.

+ +
+
+
+
+

+ Key +

+
+
+ +

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

+ +
+
+
+
+

+ Value +

+
+
+ +

The value to is stored in the object.

+ +
+
+

Return value:

+
+
+
+
+ +

The Value set.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:T(Arguments)

+
+ +

Trace a function logic level 1.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:T2(Arguments)

+
+ +

Trace a function logic level 2.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:T3(Arguments)

+
+ +

Trace a function logic level 3.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

+ +
+
+
+
+

+ #string + Method +

+
+
+ +

Method.

+ +
+
+
+ +
+
+ +
+ +
+

MSRS:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRS:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing Off
+BASE:TraceOff()
+ +
+ +
+
+ +
+ +
+

MSRS:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing On
+BASE:TraceOn()
+ +
+ +
+
+ +
+ +
+

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.

+ + +

So tracing must be switched on manually in your mission if you are using Moose statically. +When moose is loading dynamically (for moose class development), tracing is switched on by default.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceOnOff +

+
+
+ +

Switch the tracing on or off.

+ +
+
+

Usage:

+ 

+  -- Switch the tracing On
+  BASE:TraceOnOff( true )
+
+  -- Switch the tracing Off
+  BASE:TraceOnOff( false )
+
+ +
+ +
+
+ +
+ +
+

MSRS:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRS:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function call.

+ + +

This function is private.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRS:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRS:onEvent(event)

+
+ +

The main event handling function...

+ + +

This function captures all events generated for the class.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ DCS#Event + event +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

Type MSRS.Backend

+
+
+ +

Backend options to communicate with SRS.

+ +
+

Field(s)

+
+
+
+ + #string +MSRS.Backend.GRPC + +

Use DCS-gRPC.

+ +
+ +
+
+
+ + #string +MSRS.Backend.SRSEXE + +

Use DCS-SR-ExternalAudio.exe.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

Type MSRS.GRPCOptions

+
+
+ +

GRPC options.

+ +
+

Field(s)

+
+
+
+ + #string +MSRS.GRPCOptions.DefaultProvider + + + +
+ +
+ + +
+
+ + #string +MSRS.GRPCOptions.coalition + + + +
+ +
+ +
+
+ + #string +MSRS.GRPCOptions.plaintext + + + +
+ +
+
+
+ + #table +MSRS.GRPCOptions.position + + + +
+ +
+
+
+ + #table +MSRS.GRPCOptions.provider + + + + +

Provider options: voice, credentials

+ +
+ +
+
+
+ + #string +MSRS.GRPCOptions.srsClientName + + + +
+ +
+ +
+

Function(s)

+
+
+ +
+

Type MSRS.Provider

+
+
+ +

Text-to-speech providers.

+ + +

These are compatible with the DCS-gRPC conventions.

+ +
+

Field(s)

+
+
+
+ + #string +MSRS.Provider.AMAZON + +

Amazon Web Service (aws). Only possible with DCS-gRPC backend.

+ +
+ +
+
+
+ + #string +MSRS.Provider.AZURE + +

Microsoft Azure (azure). Only possible with DCS-gRPC backend.

+ +
+ +
+
+
+ + #string +MSRS.Provider.GOOGLE + +

Google (gcloud).

+ +
+ +
+
+
+ + #string +MSRS.Provider.WINDOWS + +

Microsoft windows (win).

+ +
+ +
+
+

Function(s)

+
+
+ +
+

Type MSRS.ProviderOptions

+
+
+ +

Provider options.

+ +
+

Field(s)

+
+
+
+ + #string +MSRS.ProviderOptions.credentials + +

Google credentials JSON file (full path).

+ +
+ +
+
+
+ + #string +MSRS.ProviderOptions.defaultVoice + +

Default voice (not used).

+ +
+ +
+
+
+ + #string +MSRS.ProviderOptions.key + +

Access key (DCS-gRPC with Google, AWS, AZURE as provider).

+ +
+ +
+
+
+ + #string +MSRS.ProviderOptions.provider + +

Provider.

+ +
+ +
+
+
+ + #string +MSRS.ProviderOptions.region + +

Region.

+ +
+ +
+
+
+ + #string +MSRS.ProviderOptions.secret + +

Secret key (DCS-gRPC with AWS as provider)

+ +
+ +
+
+
+ + #string +MSRS.ProviderOptions.voice + +

Voice used.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

Type MSRS.Voices

+
+
+ +

Voices

+ +
+

Field(s)

+
+
+
+ + #table +MSRS.Voices.Google + + + +
+ +
+
+
+ + #table +MSRS.Voices.Microsoft + + + +
+ +
+
+

Function(s)

+
+
+ +
+

Type MSRSQUEUE

+
+
+ +

Manages radio transmissions.

+ + + +

The purpose of the MSRSQUEUE class is to manage SRS text-to-speech (TTS) messages using the MSRS class. +This can be used to submit multiple TTS messages and the class takes care that they are transmitted one after the other (and not overlapping).

+ + +
+

Field(s)

+
+
+
+ + #string +MSRSQUEUE.ClassName + +

Name of the class "MSRSQUEUE".

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Tlast + +

Time (abs) when the last transmission finished.

+ +
+ +
+ +
+
+ + #string +MSRSQUEUE.alias + +

Name of the radio queue.

+ +
+ +
+
+
+ + #boolean +MSRSQUEUE.checking + +

If true, the queue update function is scheduled to be called again.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.dt + +

Time interval in seconds for checking the radio queue.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.lid + +

ID for dcs.log.

+ +
+ +
+
+
+ + #table +MSRSQUEUE.queue + +

The queue of transmissions.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

MSRSQUEUE:AddTransmission(transmission)

+
+ +

Add a transmission to the radio queue.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Parameter:

+
+
+

+ #MSRSQUEUE.Transmission + transmission +

+
+
+ +

The transmission data table.

+ +
+
+

Return value:

+
+
+

#MSRSQUEUE:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:Broadcast(transmission)

+
+ +

Broadcast radio message.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Parameter:

+
+
+

+ #MSRSQUEUE.Transmission + transmission +

+
+
+ +

The transmission.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CalcTransmisstionDuration()

+
+ +

Calculate total transmission duration of all transmission in the queue.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Return value:

+
+
+

#number:

+
+
+ +

Total transmission duration.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:Clear()

+
+ +

Clear the radio queue.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Return value:

+
+
+

#MSRSQUEUE:

+
+
+ +

self The MSRSQUEUE object.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:New(alias)

+
+ +

Create a new MSRSQUEUE object for a given radio frequency/modulation.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Parameter:

+
+
+

+ #string + alias +

+
+
+ +

(Optional) Name of the radio queue.

+ +
+
+

Return value:

+
+
+

#MSRSQUEUE:

+
+
+ +

self The MSRSQUEUE object.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:NewTransmission(text, duration, msrs, tstart, interval, subgroups, subtitle, subduration, frequency, modulation, gender, culture, voice, volume, label, coordinate)

+
+ +

Create a new transmission and add it to the radio queue.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Parameters:

+
+
+

+ #string + text +

+
+
+ +

Text to play.

+ +
+
+
+
+

+ #number + duration +

+
+
+ +

Duration in seconds the file lasts. Default is determined by number of characters of the text message.

+ +
+
+
+
+

+ Sound.SRS#MSRS + msrs +

+
+
+ +

MOOSE SRS object.

+ +
+
+
+
+

+ #number + tstart +

+
+
+ +

Start time (abs) seconds. Default now.

+ +
+
+
+
+

+ #number + interval +

+
+
+ +

Interval in seconds after the last transmission finished.

+ +
+
+
+
+

+ #table + subgroups +

+
+
+ +

Groups that should receive the subtiltle.

+ +
+
+
+
+

+ #string + subtitle +

+
+
+ +

Subtitle displayed when the message is played.

+ +
+
+
+
+

+ #number + subduration +

+
+
+ +

Duration [sec] of the subtitle being displayed. Default 5 sec.

+ +
+
+
+
+

+ #number + frequency +

+
+
+ +

Radio frequency if other than MSRS default.

+ +
+
+
+
+

+ #number + modulation +

+
+
+ +

Radio modulation if other then MSRS default.

+ +
+
+
+
+

+ #string + gender +

+
+
+ +

Gender of the voice

+ +
+
+
+
+

+ #string + culture +

+
+
+ +

Culture of the voice

+ +
+
+
+
+

+ #string + voice +

+
+
+ +

Specific voice

+ +
+
+
+
+

+ #number + volume +

+
+
+ +

Volume setting

+ +
+
+
+
+

+ #string + label +

+
+
+ +

Label to be used

+ +
+
+
+
+

+ Core.Point#COORDINATE + coordinate +

+
+
+ +

Coordinate to be used

+ +
+
+

Return value:

+
+
+

#MSRSQUEUE.Transmission:

+
+
+ +

Radio transmission table.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:SetTransmitOnlyWithPlayers(Switch)

+
+ +

Switch to only transmit if there are players on the server.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Parameter:

+
+
+

+ #boolean + Switch +

+
+
+ +

If true, only send SRS if there are alive Players.

+ +
+
+

Return value:

+
+
+

#MSRSQUEUE:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:_CheckRadioQueue(delay)

+
+ +

Check radio queue for transmissions to be broadcasted.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Parameter:

+
+
+

+ #number + delay +

+
+
+ +

Delay in seconds before checking.

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + #string +MSRSQUEUE.ClassName + +

Name of the class "MSRSQUEUE".

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Tlast + +

Time (abs) when the last transmission finished.

+ +
+ +
+ +
+
+ + #string +MSRSQUEUE.alias + +

Name of the radio queue.

+ +
+ +
+
+
+ + #boolean +MSRSQUEUE.checking + +

If true, the queue update function is scheduled to be called again.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.dt + +

Time interval in seconds for checking the radio queue.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.lid + +

ID for dcs.log.

+ +
+ +
+
+
+ + #table +MSRSQUEUE.queue + +

The queue of transmissions.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

MSRSQUEUE:ClearState(Object, StateName)

+
+ +

Clear the state of an object.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ StateName +

+
+
+ +

The key that is should be cleared.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

+
+ +

Creation of a Birth Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ #string + IniUnitName +

+
+
+ +

The initiating unit name.

+ +
+
+
+
+

+ place +

+
+
+

+
+
+
+
+

+ subplace +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

+
+ +

Creation of a Crash Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ IniObjectCategory +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

+
+ +

Creation of a Dead Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ IniObjectCategory +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventPlayerEnterAircraft(PlayerUnit)

+
+ +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Wrapper.Unit#UNIT + PlayerUnit +

+
+
+ +

The aircraft unit the player entered.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventRemoveUnit(EventTime, Initiator)

+
+ +

Creation of a Remove Unit Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventTakeoff(EventTime, Initiator)

+
+ +

Creation of a Takeoff Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventUnitLost(EventTime, Initiator)

+
+ +

Creation of a Crash Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:E(Arguments)

+
+ +

Log an exception which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:F(Arguments)

+
+ +

Trace a function call.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:F2(Arguments)

+
+ +

Trace a function call level 2.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:F3(Arguments)

+
+ +

Trace a function call level 3.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetClassNameAndID()

+
+ +

Get the ClassName + ClassID of the class instance.

+ + +

The ClassName + ClassID is formatted as '%s#%09d'.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName + ClassID of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetEventPriority()

+
+ +

Get the Class Core.Event processing Priority.

+ + +

The Event processing Priority is a number from 1 to 10, +reflecting the order of the classes subscribed to the Event to be processed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The Core.Event processing Priority.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetParent(Child, FromClass)

+
+ +

This is the worker method to retrieve the Parent class.

+ + +

Note that the Parent class must be passed to call the parent class method.

+ +
self:GetParent(self):ParentMethod()
+
+ + + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #BASE + Child +

+
+
+ +

This is the Child class from which the Parent class needs to be retrieved.

+ +
+
+
+
+

+ #BASE + FromClass +

+
+
+ +

(Optional) The class from which to get the parent.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetState(Object, Key)

+
+ +

Get a Value given a Key from the Object.

+ + +

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ Key +

+
+
+ +

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

+ +
+
+

Return value:

+
+
+
+
+ +

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:HandleEvent(EventID, EventFunction)

+
+ +

Subscribe to a DCS Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+
+
+

+ #function + EventFunction +

+
+
+ +

(optional) The function to be called when the event occurs for the unit.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:I(Arguments)

+
+ +

Log an information which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:Inherit(Child, Parent)

+
+ +

This is the worker method to inherit from a parent class.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Child +

+
+
+ +

is the Child class that inherits.

+ +
+
+
+
+

+ #BASE + Parent +

+
+
+ +

is the Parent class that the Child inherits from.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

Child

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:IsInstanceOf(ClassName)

+
+ +

This is the worker method to check if an object is an (sub)instance of a class.

+ + + +

Examples:

+ +
    +

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ ClassName +

+
+
+ +

is the name of the class or the class itself to run the check against

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:New()

+
+ +

BASE constructor.

+ + + +

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

+ +
function EVENT:New()
+  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
+  return self
+end
+
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEvent(EventData)

+
+ +

Occurs when an Event for an object is triggered.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that triggered the event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventBDA(EventData)

+
+ +

BDA.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventBaseCaptured(EventData)

+
+ +

Occurs when a ground unit captures either an airbase or a farp.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that captured the base +place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventBirth(EventData)

+
+ +

Occurs when any object is spawned into the mission.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that was spawned

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventCrash(EventData)

+
+ +

Occurs when any aircraft crashes into the ground and is completely destroyed.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that has crashed

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventDead(EventData)

+
+ +

Occurs when an object is dead.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is dead.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventDetailedFailure(EventData)

+
+ +

Unknown precisely what creates this event, likely tied into newer damage model.

+ + +

Will update this page when new information become available.

+ +
    +
  • initiator: The unit that had the failure.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventDiscardChairAfterEjection(EventData)

+
+ +

Discard chair after ejection.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventEjection(EventData)

+
+ +

Occurs when a pilot ejects from an aircraft +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ + +

initiator : The unit that has ejected

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventEngineShutdown(EventData)

+
+ +

Occurs when any aircraft shuts down its engines.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is stopping its engines.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventEngineStartup(EventData)

+
+ +

Occurs when any aircraft starts its engines.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is starting its engines.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventHit(EventData)

+
+ +

Occurs whenever an object is hit by a weapon.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit object the fired the weapon +weapon: Weapon object that hit the target +target: The Object that was hit.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventHumanFailure(EventData)

+
+ +

Occurs when any system fails on a human controlled aircraft.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that had the failure

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventKill(EventData)

+
+ +

Occurs on the death of a unit.

+ + +

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
    +
  • initiator: The unit that killed the target
    • +
  • target: Target Object
    • +
  • weapon: Weapon Object
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventLand(EventData)

+
+ +

Occurs when an aircraft lands at an airbase, farp or ship +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ + +

initiator : The unit that has landed +place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventLandingAfterEjection(EventData)

+
+ +

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

+ + +

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
    +
  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
    • +
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
    • +
  • subplace: is always 0 for unknown reasons.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventLandingQualityMark(EventData)

+
+ +

Landing quality mark.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventMarkAdded(EventData)

+
+ +

Occurs when a new mark was added.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventMarkChange(EventData)

+
+ +

Occurs when a mark text was changed.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventMarkRemoved(EventData)

+
+ +

Occurs when a mark was removed.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventMissionEnd(EventData)

+
+ +

Occurs when a mission ends +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventMissionStart(EventData)

+
+ +

Occurs when a mission starts +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventParatrooperLanding(EventData)

+
+ +

Weapon add.

+ + +

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventPilotDead(EventData)

+
+ +

Occurs when the pilot of an aircraft is killed.

+ + +

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. +Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that the pilot has died in.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventPlayerEnterAircraft(EventData)

+
+ +

Occurs when a player enters a slot and takes control of an aircraft.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. +initiator : The unit that is being taken control of.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventPlayerEnterUnit(EventData)

+
+ +

Occurs when any player assumes direct control of a unit.

+ + +

Note - not Mulitplayer safe. Use PlayerEnterAircraft. +Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is being taken control of.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventPlayerLeaveUnit(EventData)

+
+ +

Occurs when any player relieves control of a unit to the AI.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that the player left.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventRefueling(EventData)

+
+ +

Occurs when an aircraft connects with a tanker and begins taking on fuel.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is receiving fuel.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventRefuelingStop(EventData)

+
+ +

Occurs when an aircraft is finished taking fuel.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that was receiving fuel.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventScore(EventData)

+
+ +

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

+ + +

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventShootingEnd(EventData)

+
+ +

Occurs when any unit stops firing its weapon.

+ + +

Event will always correspond with a shooting start event. +Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that was doing the shooting.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventShootingStart(EventData)

+
+ +

Occurs when any unit begins firing a weapon that has a high rate of fire.

+ + +

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. +Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that is doing the shooting. +target: The unit that is being targeted.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventShot(EventData)

+
+ +

Occurs whenever any unit in a mission fires a weapon.

+ + +

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. +Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventTakeoff(EventData)

+
+ +

Occurs when an aircraft takes off from an airbase, farp, or ship.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that tookoff +place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventTriggerZone(EventData)

+
+ +

Trigger zone.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventUnitLost(EventData)

+
+ +

Occurs when the game thinks an object is destroyed.

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+ +
    +
  • initiator: The unit that is was destroyed.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:ScheduleOnce(Start, SchedulerFunction, ...)

+
+ +

Schedule a new time event.

+ + +

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

The Schedule ID of the planned schedule.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

+
+ +

Schedule a new time event.

+ + +

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

+ +
+
+
+
+

+ #number + Repeat +

+
+
+ +

Specifies the interval in seconds when the scheduler will call the event function.

+ +
+
+
+
+

+ #number + RandomizeFactor +

+
+
+ +

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

+ +
+
+
+
+

+ #number + Stop +

+
+
+ +

Specifies the amount of seconds when the scheduler will be stopped.

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

The Schedule ID of the planned schedule.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:ScheduleStop(SchedulerID)

+
+ +

Stops the Schedule.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + SchedulerID +

+
+
+ +

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:SetEventPriority(EventPriority)

+
+ +

Set the Class Core.Event processing Priority.

+ + +

The Event processing Priority is a number from 1 to 10, +reflecting the order of the classes subscribed to the Event to be processed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + EventPriority +

+
+
+ +

The Core.Event processing Priority.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:SetState(Object, Key, Value)

+
+ +

Set a state or property of the Object given a Key and a Value.

+ + +

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that will hold the Value set by the Key.

+ +
+
+
+
+

+ Key +

+
+
+ +

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

+ +
+
+
+
+

+ Value +

+
+
+ +

The value to is stored in the object.

+ +
+
+

Return value:

+
+
+
+
+ +

The Value set.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:T(Arguments)

+
+ +

Trace a function logic level 1.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:T2(Arguments)

+
+ +

Trace a function logic level 2.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:T3(Arguments)

+
+ +

Trace a function logic level 3.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

+ +
+
+
+
+

+ #string + Method +

+
+
+ +

Method.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing Off
+BASE:TraceOff()
+ +
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing On
+BASE:TraceOn()
+ +
+ +
+
+ +
+ +
+

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

+ + +

So tracing must be switched on manually in your mission if you are using Moose statically. +When moose is loading dynamically (for moose class development), tracing is switched on by default.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceOnOff +

+
+
+ +

Switch the tracing on or off.

+ +
+
+

Usage:

+ 

+  -- Switch the tracing On
+  BASE:TraceOnOff( true )
+
+  -- Switch the tracing Off
+  BASE:TraceOnOff( false )
+
+ +
+ +
+
+ +
+ +
+

MSRSQUEUE:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function call.

+ + +

This function is private.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:onEvent(event)

+
+ +

The main event handling function...

+ + +

This function captures all events generated for the class.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ DCS#Event + event +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

Type MSRSQUEUE.Transmission

+
+
+ +

Radio queue transmission data.

+ +
+

Field(s)

+
+
+
+ + Core.Set#SET_CLIENT +MSRSQUEUE.Transmission.PlayerSet + +

PlayerSet created when TransmitOnlyWithPlayers == true

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.Tplay + +

Mission time (abs) in seconds when the transmission should be played.

+ +
+ +
+
+
+ + #boolean +MSRSQUEUE.Transmission.TransmitOnlyWithPlayers + +

If true, only transmit if there are alive Players.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.Tstarted + +

Mission time (abs) in seconds when the transmission started.

+ +
+ +
+
+
+ + Core.Point#COORDINATE +MSRSQUEUE.Transmission.coordinate + +

Coordinate for this transmission

+ +
+ +
+
+
+ + #string +MSRSQUEUE.Transmission.culture + +

Voice culture

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.duration + +

Duration in seconds.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.frequency + +

Frequency.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.Transmission.gender + +

Voice gender

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.interval + +

Interval in seconds before next transmission.

+ +
+ +
+
+
+ + #boolean +MSRSQUEUE.Transmission.isplaying + +

If true, transmission is currently playing.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.Transmission.label + +

Label to be used

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.modulation + +

Modulation.

+ +
+ +
+
+
+ + Sound.SRS#MSRS +MSRSQUEUE.Transmission.msrs + +

MOOSE SRS object.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.subduration + +

Duration of the subtitle being displayed.

+ +
+ +
+
+
+ + #table +MSRSQUEUE.Transmission.subgroups + +

Groups to send subtitle to.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.Transmission.subtitle + +

Subtitle of the transmission.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.Transmission.text + +

Text to be transmitted.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.Transmission.voice + +

Voice if any

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.volume + +

Volume

+ +
+ +
+
+

Function(s)

+
+
+ +
+
+ + +
+ + + + diff --git a/Documentation/Sound.SoundOutput.html b/Documentation/Sound.SoundOutput.html index da8b2e100..91cc93933 100644 --- a/Documentation/Sound.SoundOutput.html +++ b/Documentation/Sound.SoundOutput.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Sound.UserSound.html b/Documentation/Sound.UserSound.html index a9f6a6296..17403b847 100644 --- a/Documentation/Sound.UserSound.html +++ b/Documentation/Sound.UserSound.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.CommandCenter.html b/Documentation/Tasking.CommandCenter.html index fab6e0987..3650a6985 100644 --- a/Documentation/Tasking.CommandCenter.html +++ b/Documentation/Tasking.CommandCenter.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.DetectionManager.html b/Documentation/Tasking.DetectionManager.html index 00b2adc5f..6d928f822 100644 --- a/Documentation/Tasking.DetectionManager.html +++ b/Documentation/Tasking.DetectionManager.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.Mission.html b/Documentation/Tasking.Mission.html index 1816ba8f5..5b42c7da1 100644 --- a/Documentation/Tasking.Mission.html +++ b/Documentation/Tasking.Mission.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index 44e6af63b..23435a0e7 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -2927,17 +2938,6 @@ but can separately be modified later in your mission using the - - - -
-
- - -TASK.TaskControlMenu - - -
@@ -7574,17 +7574,6 @@ If the Unit is part of the Task, true is returned.

- - - -
-
- - -TASK.TaskControlMenu - - -
diff --git a/Documentation/Tasking.TaskInfo.html b/Documentation/Tasking.TaskInfo.html index b9bf6169f..b7bfaccea 100644 --- a/Documentation/Tasking.TaskInfo.html +++ b/Documentation/Tasking.TaskInfo.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.Task_A2A.html b/Documentation/Tasking.Task_A2A.html index f3b9eb4dd..f82cb1505 100644 --- a/Documentation/Tasking.Task_A2A.html +++ b/Documentation/Tasking.Task_A2A.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index 75b526672..34058e877 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.Task_A2G.html b/Documentation/Tasking.Task_A2G.html index b57d692ba..398f8bc8e 100644 --- a/Documentation/Tasking.Task_A2G.html +++ b/Documentation/Tasking.Task_A2G.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index cf089d467..81ab791f5 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -3198,11 +3209,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -3775,11 +3789,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -4962,11 +4979,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -6451,11 +6471,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
diff --git a/Documentation/Tasking.Task_CARGO.html b/Documentation/Tasking.Task_CARGO.html index 7f7fab723..a44970960 100644 --- a/Documentation/Tasking.Task_CARGO.html +++ b/Documentation/Tasking.Task_CARGO.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -3267,7 +3278,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4689,7 +4700,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -9221,7 +9232,7 @@ If the Unit is part of the Task, true is returned.

- #number + TASK_CARGO.CargoLimit diff --git a/Documentation/Tasking.Task_Capture_Dispatcher.html b/Documentation/Tasking.Task_Capture_Dispatcher.html index 648e1e77a..c9c958a5a 100644 --- a/Documentation/Tasking.Task_Capture_Dispatcher.html +++ b/Documentation/Tasking.Task_Capture_Dispatcher.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+
+
+
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.Task_Capture_Zone.html b/Documentation/Tasking.Task_Capture_Zone.html index ee11129af..24332f2e5 100644 --- a/Documentation/Tasking.Task_Capture_Zone.html +++ b/Documentation/Tasking.Task_Capture_Zone.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.Task_Cargo_CSAR.html b/Documentation/Tasking.Task_Cargo_CSAR.html index 2bf3997ae..8cd2ed959 100644 --- a/Documentation/Tasking.Task_Cargo_CSAR.html +++ b/Documentation/Tasking.Task_Cargo_CSAR.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index c9312d0be..bb921fa68 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -3205,18 +3216,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number -TASK_CARGO_DISPATCHER.CountCSAR - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4322,18 +4322,7 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5191,18 +5180,7 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -6691,18 +6669,7 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Tasking.Task_Cargo_Transport.html b/Documentation/Tasking.Task_Cargo_Transport.html index 473157ce5..40dff3cc4 100644 --- a/Documentation/Tasking.Task_Cargo_Transport.html +++ b/Documentation/Tasking.Task_Cargo_Transport.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+
+
+
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Tasking.Task_Manager.html b/Documentation/Tasking.Task_Manager.html index aa789b78b..5f9562527 100644 --- a/Documentation/Tasking.Task_Manager.html +++ b/Documentation/Tasking.Task_Manager.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+
+
+
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Utilities.Enums.html b/Documentation/Utilities.Enums.html index 5bae5c445..f584d38fe 100644 --- a/Documentation/Utilities.Enums.html +++ b/Documentation/Utilities.Enums.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+
+ +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Utilities.FiFo.html b/Documentation/Utilities.FiFo.html index fef97d4b6..9f4ee0aa3 100644 --- a/Documentation/Utilities.FiFo.html +++ b/Documentation/Utilities.FiFo.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Utilities.Profiler.html b/Documentation/Utilities.Profiler.html index 899fbe9e3..de3953dc5 100644 --- a/Documentation/Utilities.Profiler.html +++ b/Documentation/Utilities.Profiler.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Utilities.STTS.html b/Documentation/Utilities.STTS.html index cc66a39d7..89c5cef89 100644 --- a/Documentation/Utilities.STTS.html +++ b/Documentation/Utilities.STTS.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Utilities.Socket.html b/Documentation/Utilities.Socket.html index 9452f7ae4..aeaff9cea 100644 --- a/Documentation/Utilities.Socket.html +++ b/Documentation/Utilities.Socket.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Utilities.Templates.html b/Documentation/Utilities.Templates.html index 6a2b83213..3b2e2b3a2 100644 --- a/Documentation/Utilities.Templates.html +++ b/Documentation/Utilities.Templates.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Utilities.Utils.html b/Documentation/Utilities.Utils.html index 369250de0..aa0eb25ce 100644 --- a/Documentation/Utilities.Utils.html +++ b/Documentation/Utilities.Utils.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Airbase.html b/Documentation/Wrapper.Airbase.html index 8cbcedd7a..380162ccd 100644 --- a/Documentation/Wrapper.Airbase.html +++ b/Documentation/Wrapper.Airbase.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index 240bc105d..2dbeeb7a5 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Controllable.html b/Documentation/Wrapper.Controllable.html index 964dfaeae..ff68c6396 100644 --- a/Documentation/Wrapper.Controllable.html +++ b/Documentation/Wrapper.Controllable.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index f0578c2cd..12275da8a 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -5238,7 +5249,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ + +
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -9950,7 +9972,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -22176,7 +22209,18 @@ Note that when WayPointInitialize is called, the Mission of the controllable is
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -26265,7 +26309,18 @@ Coordinates are dependent on the position of the maps origin.

-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -26890,7 +26945,18 @@ If the Identifiable is alive, true is returned.

-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -27132,7 +27198,18 @@ If the Identifiable is alive, true is returned.

-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter diff --git a/Documentation/Wrapper.Identifiable.html b/Documentation/Wrapper.Identifiable.html index e4c1b4baa..7e43663c7 100644 --- a/Documentation/Wrapper.Identifiable.html +++ b/Documentation/Wrapper.Identifiable.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+
+
+
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 838aee0fc..70a16f17d 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+
+
+
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Net.html b/Documentation/Wrapper.Net.html index dbfaf17f9..a1688e8e1 100644 --- a/Documentation/Wrapper.Net.html +++ b/Documentation/Wrapper.Net.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Object.html b/Documentation/Wrapper.Object.html index 7dc3a9cdd..8e5b54fa8 100644 --- a/Documentation/Wrapper.Object.html +++ b/Documentation/Wrapper.Object.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index d45e1554c..6389f78cc 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Scenery.html b/Documentation/Wrapper.Scenery.html index b51d90d36..e532a0b5e 100644 --- a/Documentation/Wrapper.Scenery.html +++ b/Documentation/Wrapper.Scenery.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Static.html b/Documentation/Wrapper.Static.html index 82963f866..bedce6fbb 100644 --- a/Documentation/Wrapper.Static.html +++ b/Documentation/Wrapper.Static.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Storage.html b/Documentation/Wrapper.Storage.html index fababddea..d96ca526f 100644 --- a/Documentation/Wrapper.Storage.html +++ b/Documentation/Wrapper.Storage.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Unit.html b/Documentation/Wrapper.Unit.html index ad44695e7..8b514f712 100644 --- a/Documentation/Wrapper.Unit.html +++ b/Documentation/Wrapper.Unit.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/Wrapper.Weapon.html b/Documentation/Wrapper.Weapon.html index 3c0888409..b505d4b2d 100644 --- a/Documentation/Wrapper.Weapon.html +++ b/Documentation/Wrapper.Weapon.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

diff --git a/Documentation/index.html b/Documentation/index.html index ad2cea152..0ee435844 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -1151,6 +1151,17 @@

Core - Makes the radio talk.

+

+ + +
+
+
+ Image +

Sound.SRS

+
+

+

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

@@ -2811,6 +2822,18 @@

Sound.RadioSpeech

Core - Makes the radio talk.

+

+ + + +
+
+ Image +
+
+

Sound.SRS

+

+

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