From 9732d948698863b1a1c867b270087102adcaac3c Mon Sep 17 00:00:00 2001 From: MooseBotter Date: Sun, 24 Dec 2023 02:24:23 +0000 Subject: [PATCH] Auto commit by GitHub Actions Workflow --- Documentation/AI.AI_A2A_Dispatcher.html | 20 +- Documentation/AI.AI_A2G_Dispatcher.html | 44 + Documentation/AI.AI_Air_Dispatcher.html | 44 + Documentation/AI.AI_Cargo.html | 12 + Documentation/AI.AI_Cargo_Airplane.html | 36 - Documentation/AI.AI_Cargo_Helicopter.html | 40 +- Documentation/Cargo.CargoUnit.html | 22 + Documentation/Core.Settings.html | 32 +- Documentation/Core.Spawn.html | 110 +- Documentation/Core.SpawnStatic.html | 84 + Documentation/Core.Zone.html | 91 +- Documentation/Functional.ATC_Ground.html | 10 +- Documentation/Functional.Detection.html | 6 +- Documentation/Functional.Mantis.html | 76 +- Documentation/Functional.Movement.html | 28 + Documentation/Functional.RAT.html | 6 - Documentation/Functional.Scoring.html | 10 +- Documentation/Ops.ATIS.html | 4 +- Documentation/Ops.Airboss.html | 16 +- Documentation/Ops.CSAR.html | 21 +- Documentation/Ops.CTLD.html | 111 +- Documentation/Sound.SRS.html | 2387 ++++++++++++----- Documentation/Tasking.Task.html | 22 - .../Tasking.Task_A2A_Dispatcher.html | 8 +- Documentation/Tasking.Task_CARGO.html | 6 +- Documentation/Utilities.FiFo.html | 44 +- Documentation/Wrapper.Marker.html | 72 +- Documentation/Wrapper.Positionable.html | 44 - 28 files changed, 2348 insertions(+), 1058 deletions(-) diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index 0dbf08969..218364666 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -4876,11 +4876,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean AI_A2A_DISPATCHER.SetSendPlayerMessages + +

Flash messages to player

+
@@ -11540,11 +11543,14 @@ They will lock the parking spot.

- + #boolean AI_A2A_DISPATCHER.SetSendPlayerMessages + +

Flash messages to player

+
@@ -12802,11 +12808,14 @@ They will lock the parking spot.

- + #boolean AI_A2A_DISPATCHER.SetSendPlayerMessages + +

Flash messages to player

+
@@ -14366,11 +14375,14 @@ They will lock the parking spot.

- + #boolean AI_A2A_DISPATCHER.SetSendPlayerMessages + +

Flash messages to player

+
diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 60720110e..7ea00863a 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4756,6 +4756,17 @@ 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 + + +
@@ -13278,6 +13289,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
diff --git a/Documentation/AI.AI_Air_Dispatcher.html b/Documentation/AI.AI_Air_Dispatcher.html index e5f79260b..16ab626f0 100644 --- a/Documentation/AI.AI_Air_Dispatcher.html +++ b/Documentation/AI.AI_Air_Dispatcher.html @@ -4516,6 +4516,17 @@ 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,6 +9824,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_AIR_DISPATCHER.DefenderPatrolIndex + + +
@@ -12749,6 +12782,17 @@ 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_Cargo.html b/Documentation/AI.AI_Cargo.html index ad13105cf..b29a37a21 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2797,6 +2797,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

No loading happened, so we need to pickup something else.

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

No loading happened, so we need to pickup something else.

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

No loading happened, so we need to pickup something else.

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

No loading happened, so we need to pickup something else.

+ diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 033406c59..fb816bf4c 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2754,9 +2754,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

- @@ -6769,9 +6736,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_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index dcf9819bc..1088c9eae 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -2911,22 +2911,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -4829,22 +4835,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -5499,22 +5511,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -7057,22 +7075,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 0fec1ae3d..6907ca09f 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1834,6 +1834,17 @@ Therefore, this class is considered to be deprecated

Set cargo object.

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

Set cargo object.

+ + + +
+
+ + #number +CARGO_UNIT.RunCount + + +
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 76eb1bc57..773036e17 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2864,11 +2864,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + SETTINGS.A2GSystem + +

BASE:E( {PlayerUnit:GetName(), A2GSystem } )

+
@@ -2913,6 +2916,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SETTINGS.PlayerMenu + + +
@@ -5021,11 +5035,14 @@ It is advised to use this method at the start of the mission.

- #string + SETTINGS.A2GSystem + +

BASE:E( {PlayerUnit:GetName(), A2GSystem } )

+
@@ -5070,6 +5087,17 @@ It is advised to use this method at the start of the mission.

+ + + +
+
+ + +SETTINGS.PlayerMenu + + +
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 9510d130d..b521b9364 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -3018,12 +3018,6 @@ and any spaces before and after the resulting name are removed.

SPAWN.skill

- - - -

SPAWN.uncontrolled

- - @@ -3583,14 +3577,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.

-
@@ -3715,20 +3706,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

-
@@ -3952,17 +3929,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #string -SPAWN.SpawnInitSkill - - -
@@ -4165,17 +4131,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -4342,17 +4297,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWN.uncontrolled - - -
@@ -9595,14 +9539,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.

-
@@ -9727,20 +9668,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

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

- - -
-
- - #string -SPAWN.SpawnInitSkill - - -
@@ -10177,17 +10093,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -10354,17 +10259,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - -SPAWN.uncontrolled - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 5285688c4..27c7a141a 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1996,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

+ + @@ -2910,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 + + +
@@ -4263,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.Zone.html b/Documentation/Core.Zone.html index 70309d998..064a880b9 100644 --- a/Documentation/Core.Zone.html +++ b/Documentation/Core.Zone.html @@ -3606,7 +3606,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_OVAL:GetMajorAxis()

-

Gets the major axis of the oval.

+

Gets the major axis of the oval.

@@ -3658,7 +3658,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

ZONE_OVAL.New(vec2, major_axis, minor_axis, angle, self, name)

+

ZONE_OVAL:New(name, vec2, major_axis, minor_axis, angle)

Creates a new ZONE_OVAL from a center point, major axis, minor axis, and angle.

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

ZONE_OVAL:UndrawZone()

Remove drawing from F10 map

+ + + +

ZONE_OVAL.ZoneName

+ + @@ -15349,6 +15355,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + +ZONE_OVAL.ZoneName + + +
@@ -15551,7 +15568,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

ZONE_OVAL:GetMajorAxis()

-

Gets the major axis of the oval.

+

Gets the major axis of the oval.

@@ -15782,7 +15799,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
-

ZONE_OVAL.New(vec2, major_axis, minor_axis, angle, self, name)

+

ZONE_OVAL:New(name, vec2, major_axis, minor_axis, angle)

Creates a new ZONE_OVAL from a center point, major axis, minor axis, and angle.

@@ -15799,6 +15816,19 @@ When moose is loading dynamically (for moose class development), tracing is swit

ZONE_OVAL

Parameters:

+
+
+

+ #string + name +

+
+
+ +

Name of the zone.

+ +
+

@@ -15851,26 +15881,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

-
-
-

- self -

-
-
-

-
-
-
-
-

- name -

-
-
-

-
-

Return value:

@@ -16054,6 +16064,17 @@ When moose is loading dynamically (for moose class development), tracing is swit +
+ +
+
+
+ + +ZONE_OVAL.ZoneName + + +
@@ -17996,6 +18017,17 @@ end +
+ +
+
+
+ + +ZONE_OVAL.ZoneName + + +
@@ -19496,6 +19528,17 @@ end + + + +
+
+ + +ZONE_OVAL.ZoneName + + +
diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index 863dca688..f44b5f116 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -3878,7 +3878,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + ATC_GROUND.Airbases @@ -3894,9 +3894,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Kickspeed

-
@@ -4466,7 +4463,7 @@ An airbase can be specified to set the maximum kick speed for.

- #table + ATC_GROUND.Airbases @@ -4482,9 +4479,6 @@ An airbase can be specified to set the maximum kick speed for.

- -

Kickspeed

-
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index a93bb141b..db29ed0e0 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -19525,7 +19525,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
- #number + DETECTION_BASE.RefreshTimeInterval @@ -24294,7 +24294,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #number + DETECTION_BASE.RefreshTimeInterval @@ -26058,7 +26058,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #number + DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index c91e67d02..ccd6e62e7 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -2021,6 +2021,12 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%

MANTIS:GetCommandCenter()

Function to get the HQ object for further use

+ + + +

MANTIS.Groupset

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

The #DETECTION_AREAS object for AWACS

+
+ +
+
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -4048,6 +4065,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +MANTIS.Groupset + + +
@@ -4098,7 +4126,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + MANTIS.SAM_Table_Long @@ -4109,7 +4137,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + MANTIS.SAM_Table_Medium @@ -4120,7 +4148,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + MANTIS.SAM_Table_Short @@ -4277,8 +4305,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number -MANTIS.SkateNumber + +MANTIS.SkateZones @@ -4585,6 +4613,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

switch alarm state RED

+
@@ -8558,6 +8589,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

The #DETECTION_AREAS object for AWACS

+
+ +
+
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -8657,6 +8699,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` +
+ +
+
+
+ + +MANTIS.Groupset + + +
@@ -8707,7 +8760,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- #table + MANTIS.SAM_Table_Long @@ -8718,7 +8771,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- #table + MANTIS.SAM_Table_Medium @@ -8729,7 +8782,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- #table + MANTIS.SAM_Table_Short @@ -8886,8 +8939,8 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- #number -MANTIS.SkateNumber + +MANTIS.SkateZones @@ -9194,6 +9247,9 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` + +

switch alarm state RED

+
diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index fcc4c7970..e9de5230c 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -2268,6 +2268,20 @@ 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.

+ +
+ +
@@ -2498,6 +2512,20 @@ 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.RAT.html b/Documentation/Functional.RAT.html index 3c9230551..a75838a31 100644 --- a/Documentation/Functional.RAT.html +++ b/Documentation/Functional.RAT.html @@ -4594,12 +4594,6 @@ and any spaces before and after the resulting name are removed.

RAT.skill

- - - -

RAT.uncontrolled

- - diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html index 991bde3b6..38fd87f7e 100644 --- a/Documentation/Functional.Scoring.html +++ b/Documentation/Functional.Scoring.html @@ -2866,14 +2866,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SCORING.AutoSave - -

Create the CSV file.

-
@@ -5455,14 +5452,11 @@ The scale magnifies the scores given to the players.

- #boolean + SCORING.AutoSave - -

Create the CSV file.

-
diff --git a/Documentation/Ops.ATIS.html b/Documentation/Ops.ATIS.html index 968e9b67d..38071a917 100644 --- a/Documentation/Ops.ATIS.html +++ b/Documentation/Ops.ATIS.html @@ -6790,7 +6790,7 @@ Note that the dew point is only an artificial information as DCS does not have a
-

Path to SRS directory.

+

Path to SRS directory (only necessary if SRS exe backend is used).

@@ -6855,7 +6855,7 @@ Note that the dew point is only an artificial information as DCS does not have a
-

Path to Google JSON-Key.

+

Path to Google JSON-Key (SRS exe backend) or Google API key (DCS-gRPC backend).

diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 7677d00d2..f714fa24c 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -40567,7 +40567,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Also decrease flag for section members of flight.

+

Set stack flag.

@@ -40729,9 +40729,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

Make player section lead if he was not before.

-
@@ -40945,6 +40942,17 @@ 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 e23e60280..84a8f3556 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -4340,7 +4340,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Core.Point#COORDINATE + CSAR.coordinate @@ -4429,14 +4429,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.csarUnits - -

table of CSAR unit names

-
@@ -10355,7 +10352,7 @@ callsigns from playername or group name.

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

- #table + CSAR.csarUnits - -

table of CSAR unit names

-
@@ -12855,7 +12849,7 @@ callsigns from playername or group name.

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

- #table + CSAR.csarUnits - -

table of CSAR unit names

-
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index 2c6d2bafb..e73cf5b77 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -7752,7 +7752,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -7777,11 +7777,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -7824,7 +7827,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -7835,14 +7838,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.FreeVHFFrequencies - -

Beacons

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

tables

+
@@ -7960,11 +7963,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + CTLD.RadioPath + +

Folderpath.

+
@@ -8462,7 +8468,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

noob catch

+

time to repairor build a unit/group

@@ -18035,7 +18041,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.DroppedTroops @@ -18060,11 +18066,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -18107,7 +18116,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeUHFFrequencies @@ -18118,14 +18127,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeVHFFrequencies - -

Beacons

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

tables

+
@@ -18243,11 +18252,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- #string + CTLD.RadioPath + +

Folderpath.

+
@@ -18745,7 +18757,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

noob catch

+

time to repairor build a unit/group

@@ -20452,7 +20464,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.DroppedTroops @@ -20477,11 +20489,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -20524,7 +20539,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeUHFFrequencies @@ -20535,14 +20550,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeVHFFrequencies - -

Beacons

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

tables

+
@@ -20660,11 +20675,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- #string + CTLD.RadioPath + +

Folderpath.

+
@@ -21162,7 +21180,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

noob catch

+

time to repairor build a unit/group

@@ -25264,6 +25282,17 @@ When moose is loading dynamically (for moose class development), tracing is swit

Can transport crate.

+
+ +
+
+
+ + #number +CTLD.UnitTypeCapabilities.length + + +
@@ -25450,17 +25479,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Flag for direct loading.

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

Flag for direct loading.

-
- -
-
-
- - -CTLD_CARGO.Mark - - -
diff --git a/Documentation/Sound.SRS.html b/Documentation/Sound.SRS.html index 472f12ec6..8366856be 100644 --- a/Documentation/Sound.SRS.html +++ b/Documentation/Sound.SRS.html @@ -1613,8 +1613,9 @@

Main Features:

    +
  • Incease immersion of your missions with more sound output
  • Play sound files via SRS
    • -
  • Play text-to-speach via SRS
    • +
  • Play text-to-speech via SRS
@@ -1673,7 +1674,21 @@

Prerequisites

-

This script needs SRS version >= 1.9.6.

+
    +
  • This script needs SRS version >= 1.9.6
    • +
  • You need to de-sanitize os, io and lfs in hte 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

@@ -1689,7 +1704,7 @@ msrs:PlaySoundFile(soundfile) 
-- Create a SOUNDTEXT object.
 local text=SOUNDTEXT:New("All Enemies destroyed")
 
--- MOOSE SRS 
+-- MOOSE SRS
 local msrs=MSRS:New("D:\\DCS\\_SRS\\", 305, radio.modulation.AM)
 
 -- Text-to speech with default voice after 2 seconds.
@@ -1704,34 +1719,24 @@ msrs:PlaySoundText(text, 2)
 
 
Use a specific "culture" with the MSRS.SetCulture function, e.g. :SetCulture("en-US") or :SetCulture("de-DE").

 
-
Set Google

-
-
Use Google's text-to-speech engine with the MSRS.SetGoogle function, e.g. ':SetGoogle()'.
-By enabling this it also allows you to utilize SSML in your text for added 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

-
-
-
Pro-Tipp - 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. 

-E.g. .\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 255AM for the blue coalition in-game.

-
 
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.
-If enabling SetGoogle(), you can use voices provided by Google
-Google's supported voices: https://cloud.google.com/text-to-speech/docs/voices
-For voices there are enumerators in this class to help you out on voice names:

+Note that this must be installed on your windows system.

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

+
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

 
@@ -1745,14 +1750,72 @@ For voices there are enumerators in this class to help you out on voice names:See MSRS.LoadConfigFile for details on how to set this up.

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

+
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 (ASW) 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 ASW access and secret keys, respectively. The parameter Region is your ASW region.

+
+
You can set the voice to use with ASW 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' 
+
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
@@ -1760,7 +1823,7 @@ 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, 
+
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):

@@ -1770,8 +1833,8 @@ 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 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)
@@ -1828,12 +1891,6 @@ atis:Start()
             Fields and Methods inherited from MSRS
             Description
           
-          
-            
MSRS.APIKey

-            
-
-
-          
           
             
MSRS:AddFrequencies(Frequencies)

             
@@ -1847,9 +1904,9 @@ atis:Start()
 
           
           
-            
MSRS.AltBackend

+            
MSRS.Backend

             
-
Table containing functions and variables to enable an alternate backend to transmit to SRS.

+
 
           
           
@@ -1861,25 +1918,25 @@ atis:Start()
           
             
MSRS.ConfigFileName

             
-
Name of the standard config file

+
Name of the standard config file.

 
           
           
             
MSRS.ConfigFilePath

             
-
Path to the standard config file

+
Path to the standard config file.

 
           
           
             
MSRS.ConfigLoaded

             
-
+
If true if config file was loaded.

 
           
           
-            
MSRS.GRPCOptions

+            
MSRS:GetBackend()

             
-
+
Get currently set backend.

 
           
           
@@ -1889,7 +1946,7 @@ atis:Start()
 
           
           
-            
MSRS:GetFrequencies(Frequencies)

+            
MSRS:GetFrequencies()

             
 
Get frequencies.

 
@@ -1901,7 +1958,7 @@ atis:Start()
 
           
           
-            
MSRS:GetModulations(Modulations)

+            
MSRS:GetModulations()

             
 
Get modulations.

 
@@ -1916,6 +1973,24 @@ atis:Start()
             
MSRS:GetPort()

             
 
Get port.

+
+          
+          
+            
MSRS:GetProvider()

+            
+
Get provider.

+
+          
+          
+            
MSRS:GetProviderOptions(Provider)

+            
+
Get provider options.

+
+          
+          
+            
MSRS:GetVoice(Provider)

+            
+
Get voice.

 
           
           
@@ -1943,7 +2018,7 @@ atis:Start()
 
           
           
-            
MSRS:New(PathToSRS, Frequency, Modulation, Volume, AltBackend)

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

             
 
Create a new MSRS object.

 
@@ -1979,9 +2054,27 @@ atis:Start()
 
           
           
-            
MSRS.ResetDefaultBackend()

+            
MSRS.Provider

             
-
Restores default SRS backend (DCS-SR-ExternalAudio.exe) to be used by all new MSRS class instances to transmit over SRS.

+
+
+          
+          
+            
MSRS:SetBackend(Backend)

+            
+
Set backend to communicate with SRS.

+
+          
+          
+            
MSRS:SetBackendGRPC()

+            
+
Set DCS-gRPC as backend to communicate with SRS.

+
+          
+          
+            
MSRS:SetBackendSRSEXE(Backend)

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

 
           
           
@@ -2003,21 +2096,15 @@ atis:Start()
 
           
           
-            
MSRS.SetDefaultBackend(Backend)

+            
MSRS:SetDefaultBackend(Backend)

             
-
Sets an alternate SRS backend to be used by MSRS to transmit over SRS for all new MSRS class instances.

+
Set the default backend.

 
           
           
-            
MSRS.SetDefaultBackendGRPC()

+            
MSRS:SetDefaultBackendGRPC()

             
-
Sets DCS-gRPC as the default SRS backend for all new MSRS class instances.

-
-          
-          
-            
MSRS:SetDefaultVoice(Voice)

-            
-
Set to use a specific voice.

+
Set DCS-gRPC to be the default backend.

 
           
           
@@ -2035,13 +2122,13 @@ atis:Start()
           
             
MSRS:SetGoogle(PathToCredentials)

             
-
Use google text-to-speech credentials.

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

 
           
           
             
MSRS:SetGoogleAPIKey(APIKey)

             
-
gRPC Backend: Use google text-to-speech set the API key.

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

 
           
           
@@ -2066,24 +2153,96 @@ atis:Start()
             
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 (ASW).

+
+          
+          
+            
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 (ASW) to provide text-to-speech.

+
+          
+          
+            
MSRS:SetTTSProviderAzure()

+            
+
Use Microsoft Azure to provide text-to-speech.

 
           
           
             
MSRS:SetTTSProviderGoogle()

             
-
Use Google text-to-speech as default.

+
Use Google to provide text-to-speech.

 
           
           
             
MSRS:SetTTSProviderMicrosoft()

             
-
Use Microsoft text-to-speech as default.

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

 
           
           
@@ -2096,6 +2255,18 @@ atis:Start()
             
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.

 
           
           
@@ -2117,9 +2288,9 @@ atis:Start()
 
           
           
-            
MSRS:_NewAltBackend(A, Backend)

+            
MSRS.backend

             
-
Adds or replaces functions and variables in the current MSRS class instance to enable an alternate backends for transmitting to SRS.

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

 
           
           
@@ -2138,12 +2309,6 @@ atis:Start()
             
MSRS.culture

             
 
Culture. Default "en-GB".

-
-          
-          
-            
MSRS.defaultVoice

-            
-
 
           
           
@@ -2156,12 +2321,6 @@ atis:Start()
             
MSRS.gender

             
 
Gender. Default "female".

-
-          
-          
-            
MSRS.google

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

 
           
           
@@ -2185,7 +2344,13 @@ atis:Start()
           
             
MSRS.path

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

+
Path to the SRS exe.

+
+          
+          
+            
MSRS.poptions

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

 
           
           
@@ -2197,25 +2362,7 @@ atis:Start()
           
             
MSRS.provider

             
-
-
-          
-          
-            
MSRS.region

-            
-
-
-          
-          
-            
MSRS.secret

-            
-
-
-          
-          
-            
MSRS.ttsprovider

-            
-
Default provider TTS backend, e.g. "Google" or "Microsoft", default is Microsoft

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

 
           
           
@@ -2227,7 +2374,7 @@ atis:Start()
           
             
MSRS.voice

             
-
Specific voce.

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

 
           
           
@@ -2770,6 +2917,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
             
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.
@@ -2843,6 +3015,43 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MSRS.GRPCOptions.win

+ + + +
+ +

Type MSRS.Provider

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

MSRS.Provider.AMAZON

 +

Amazon Web Service (asw). 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).
@@ -2858,34 +3067,46 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from MSRS.ProviderOptions Description + +

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, ASW, AZURE as provider).

+ + + +

MSRS.ProviderOptions.provider

+ +

Provider.

MSRS.ProviderOptions.region

- +

Region.

MSRS.ProviderOptions.secret

- +

Secret key (DCS-gRPC with ASW as provider)

MSRS.ProviderOptions.voice

- +

Voice used.

@@ -3020,7 +3241,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MSRSQUEUE.dt

-

Time interval in seconds for checking the radio queue.

+

Time interval in seconds for checking the radio queue.

@@ -3702,37 +3923,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MSRSQUEUE.Transmission.volume

Volume

- - - -
- -

Type MSRS_BACKEND_DCSGRPC

-
- MSRS_BACKEND_DCSGRPC -
-
- - - - - - - - - - - - - - - -
Fields and Methods inherited from MSRS_BACKEND_DCSGRPCDescription

MSRS_BACKEND_DCSGRPC.Functions

 -

A table of functions that will add or replace the default MSRS class functions.

-

MSRS_BACKEND_DCSGRPC.Vars

 -

A table of variables that will add or replace the default MSRS class variables.

-

MSRS_BACKEND_DCSGRPC.version

 -

Version number of this alternate backend.
@@ -3756,22 +3946,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
-
- - #table -MSRS.AltBackend - -

Table containing functions and variables to enable an alternate backend to transmit to SRS.

-
@@ -3792,7 +3971,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #string MSRS.ConfigFileName -

Name of the standard config file

+

Name of the standard config file.

@@ -3803,7 +3982,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #string MSRS.ConfigFilePath -

Path to the standard config file

+

Path to the standard config file.

@@ -3814,18 +3993,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #boolean MSRS.ConfigLoaded - - -
- -
-
-
- - #MSRS.GRPCOptions -MSRS.GRPCOptions - - +

If true if config file was loaded.

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

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

+
+ +
+ @@ -3849,6 +4028,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #string +MSRS.backend + +

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

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

Culture. Default "en-GB".

-
- -
-
-
- - -MSRS.defaultVoice - - -
@@ -3917,17 +4096,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
- - #string -MSRS.google - -

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

- -
-
@@ -3968,7 +4136,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #string MSRS.path -

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

+

Path to the SRS exe.

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

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

@@ -3990,40 +4169,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #string MSRS.provider - - -
- -
-
-
- - -MSRS.region - - - -
- -
-
-
- - -MSRS.secret - - - -
- -
-
-
- - #string -MSRS.ttsprovider - -

Default provider TTS backend, e.g. "Google" or "Microsoft", default is Microsoft

+

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

@@ -4045,7 +4191,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #string MSRS.voice -

Specific voce.

+

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

@@ -4149,6 +4295,36 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ + + +
+ +
+

MSRS:GetBackend()

+
+ +

Get currently set backend.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#string:

+
+
+ +

Backend.

+ +
+
+
+
@@ -4185,7 +4361,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

MSRS:GetFrequencies(Frequencies)

+

MSRS:GetFrequencies()

Get frequencies.

@@ -4196,20 +4372,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MSRS

-

Parameter:

-
-
-

- #table - Frequencies -

-
-
- -

in MHz.

+

Return value:

+
+
+

#table:

+
+
+ +

Frequencies in MHz.

-
-
+
+
@@ -4248,7 +4421,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

MSRS:GetModulations(Modulations)

+

MSRS:GetModulations()

Get modulations.

@@ -4259,18 +4432,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MSRS

-

Parameter:

-
-
-

- #table - Modulations -

-
-
-

-
-
+

Return value:

+
+
+

#table:

+
+
+ +

Modulations.

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

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.

+ +
+
+
+
@@ -4454,52 +4744,62 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau 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", -- adjust as needed, note double \\ - Port = 5002, -- adjust as needed - Frequency = {127,243}, -- must be a table, 1..n entries! - Modulation = {0,0}, -- must be a table, 1..n entries, one for each frequency! - Volume = 1.0, -- 0.0 to 1.0 - Coalition = 0, -- 0 = Neutral, 1 = Red, 2 = Blue - Coordinate = {0,0,0}, -- x,y,altitude - optional, all in meters - Culture = "en-GB", - Gender = "male", - Google = "C:\\Program Files\\DCS-SimpleRadio-Standalone\\yourfilename.json", -- path to google json key file - optional. - Label = "MSRS", - Voice = "Microsoft Hazel Desktop", - Provider = "Microsoft", -- this is the default TTS provider, e.g. "Google" or "Microsoft" - -- gRPC (optional) - GRPC = { -- see https://github.com/DCS-gRPC/rust-server - coalition = "blue", -- blue, red, neutral - DefaultProvider = "gcloud", -- win, gcloud, aws, or azure, some of the values below depend on your cloud provider - gcloud = { - key = "<API Google Key>", -- for gRPC Google API key - --secret = "", -- needed for aws - --region = "",-- needed for aws - defaultVoice = MSRS.Voices.Google.Standard.en_GB_Standard_F, - }, - win = { - defaultVoice = "Hazel", - }, - } - } - + -- 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, asw). + + -- 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) - + + 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) @@ -4507,12 +4807,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -- 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() + + -- 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() @@ -4522,11 +4822,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

MSRS:New(PathToSRS, Frequency, Modulation, Volume, AltBackend)

+

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:

@@ -4538,12 +4844,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

#string - PathToSRS + Path

-

Path to the directory, where SRS is located.

+

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

@@ -4576,26 +4882,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

- #number - Volume + #string + Backend

-

Volume - 1.0 is max, 0.0 is silence

- -
-
-
-
-

- #table - AltBackend -

-
-
- -

Optional table containing tables 'Functions' and 'Vars' which add/replace functions and variables for the MSRS instance to allow alternate backends for transmitting to SRS.

+

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

@@ -5020,12 +5313,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

MSRS.ResetDefaultBackend()

+

MSRS:SetBackend(Backend)

-

Restores default SRS backend (DCS-SR-ExternalAudio.exe) to be used by all new MSRS class instances to transmit over SRS.

+

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:

@@ -5034,11 +5380,52 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Return value:

-

#boolean:

+

#MSRS:

-

Returns 'true' on success.

+

self

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

MSRS:SetBackendSRSEXE(Backend)

+
+ +

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

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ Backend +

+
+
+

+
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

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

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:

@@ -5159,7 +5549,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

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

+

Culture, e.g. "en-GB".

@@ -5182,10 +5572,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

MSRS.SetDefaultBackend(Backend)

+

MSRS:SetDefaultBackend(Backend)

-

Sets an alternate SRS backend to be used by MSRS to transmit over SRS for all new MSRS class instances.

+

Set the default backend.

@@ -5197,27 +5587,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

- #table Backend

- -

A table containing a table Functions with new/replacement class functions and Vars with new/replacement variables.

- +

-

Return value:

-
-
-

#boolean:

-
-
- -

Returns 'true' on success.

- -
-
@@ -5226,10 +5602,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

MSRS.SetDefaultBackendGRPC()

+

MSRS:SetDefaultBackendGRPC()

-

Sets DCS-gRPC as the default SRS backend for all new MSRS class instances.

+

Set DCS-gRPC to be the default backend.

@@ -5237,64 +5613,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MSRS

-

Return value:

-
-
-

#boolean:

-
-
- -

Returns 'true' on success.

- -
-
-
- -
-
- -
- -
-

MSRS:SetDefaultVoice(Voice)

-
- -

Set to use a specific voice.

- - -

Will override gender and culture settings.

- -
-
-

Defined in:

-
-

MSRS

-
-

Parameter:

-
-
-

- #string - Voice -

-
-
- -

Voice.

- -
-
-

Return value:

-
-
-

#MSRS:

-
-
- -

self

- -
-
@@ -5394,7 +5712,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MSRS:SetGoogle(PathToCredentials)

-

Use google text-to-speech credentials.

+

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

Also sets Google as default TTS provider.

@@ -5441,7 +5759,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MSRS:SetGoogleAPIKey(APIKey)

-

gRPC Backend: Use google text-to-speech set the API key.

+

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

@@ -5576,7 +5894,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Set path to SRS install directory.

-

More precisely, path to where the DCS-

+

More precisely, path to where the DCS-SR-ExternalAudio.exe is located.

@@ -5594,7 +5912,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

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

+

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

@@ -5655,6 +5973,413 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+ +
+ +
+

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 (ASW).

+ + +

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

+ +
+
+
+
@@ -5664,7 +6389,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MSRS:SetTTSProviderGoogle()

-

Use Google text-to-speech as default.

+

Use Google to provide text-to-speech.

@@ -5694,7 +6419,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MSRS:SetTTSProviderMicrosoft()

-

Use Microsoft text-to-speech as default.

+

Use Microsoft to provide text-to-speech.

@@ -5727,7 +6452,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Set to use a specific voice.

-

Will override gender and culture settings.

+

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

@@ -5762,6 +6487,254 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+ +
+ +
+

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 +

+
+
+ +

ASW 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

+ +
+
+
+
@@ -5806,6 +6779,237 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+ +
+ +
+

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

+ +
+
+
+
@@ -6062,7 +7266,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Latitude.

+

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

@@ -6070,7 +7274,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Longitude.

+

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

@@ -6078,66 +7282,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Altitude.

+

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

- - - -
- -
-

MSRS:_NewAltBackend(A, Backend)

-
- -

Adds or replaces functions and variables in the current MSRS class instance to enable an alternate backends for transmitting to SRS.

- -
-
-

Defined in:

-
-

MSRS

-
-

Parameters:

-
-
-

- #table - A -

-
-
- -

table containing a table Functions with new/replacement class functions and Vars with new/replacement variables.

- -
-
-
-
-

- Backend -

-
-
-

-
-
-

Return value:

-
-
-

#MSRS:

-
-
- -

self

- -
-
-
-
@@ -6147,22 +7297,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -MSRS.APIKey + #MSRS.Backend +MSRS.Backend -
- -
-
-
- - #table -MSRS.AltBackend - -

Table containing functions and variables to enable an alternate backend to transmit to SRS.

-
@@ -6183,7 +7322,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #string MSRS.ConfigFileName -

Name of the standard config file

+

Name of the standard config file.

@@ -6194,7 +7333,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #string MSRS.ConfigFilePath -

Path to the standard config file

+

Path to the standard config file.

@@ -6205,18 +7344,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #boolean MSRS.ConfigLoaded - - - - - -
-
- - #MSRS.GRPCOptions -MSRS.GRPCOptions - - +

If true if config file was loaded.

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

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

+
+ + +
+
+ + #MSRS.Provider +MSRS.Provider + + +
@@ -6240,6 +7379,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #string +MSRS.backend + +

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

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

Culture. Default "en-GB".

- - - -
-
- - -MSRS.defaultVoice - - -
@@ -6308,17 +7447,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -
-
- - #string -MSRS.google - -

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

- -
-
@@ -6359,7 +7487,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #string MSRS.path -

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

+

Path to the SRS exe.

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

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

@@ -6381,40 +7520,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #string MSRS.provider - - -
- - -
-
- - -MSRS.region - - - -
- -
-
-
- - -MSRS.secret - - - -
- -
-
-
- - #string -MSRS.ttsprovider - -

Default provider TTS backend, e.g. "Google" or "Microsoft", default is Microsoft

+

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

@@ -6436,7 +7542,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #string MSRS.voice -

Specific voce.

+

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

@@ -9802,6 +10908,43 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +

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)

+
@@ -9809,7 +10952,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
-

GRPC options

+

GRPC options.

Field(s)

@@ -9899,6 +11042,9 @@ When moose is loading dynamically (for moose class development), tracing is swit + +

Provider options: voice, credentials

+
@@ -9930,19 +11076,95 @@ When moose is loading dynamically (for moose class development), tracing is swit
-

Type MSRS.ProviderOptions

-
+

Type MSRS.Provider

+
+ +

Text-to-speech providers.

+ + +

These are compatible with the DCS-gRPC conventions.

+

Field(s)

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

Amazon Web Service (asw). 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).

@@ -9953,7 +11175,18 @@ When moose is loading dynamically (for moose class development), tracing is swit #string MSRS.ProviderOptions.key +

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

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

Provider.

@@ -9964,7 +11197,7 @@ When moose is loading dynamically (for moose class development), tracing is swit #string MSRS.ProviderOptions.region - +

Region.

@@ -9975,7 +11208,7 @@ When moose is loading dynamically (for moose class development), tracing is swit #string MSRS.ProviderOptions.secret - +

Secret key (DCS-gRPC with ASW as provider)

@@ -9986,7 +11219,7 @@ When moose is loading dynamically (for moose class development), tracing is swit #string MSRS.ProviderOptions.voice - +

Voice used.

@@ -10110,7 +11343,7 @@ This can be used to submit multiple TTS messages and the class takes care that t #number MSRSQUEUE.dt -

Time interval in seconds for checking the radio queue.

+

Time interval in seconds for checking the radio queue.

@@ -10164,7 +11397,7 @@ This can be used to submit multiple TTS messages and the class takes care that t
-

The transmission data table.

+

The transmission data table.

@@ -10701,7 +11934,7 @@ This can be used to submit multiple TTS messages and the class takes care that t #number MSRSQUEUE.dt -

Time interval in seconds for checking the radio queue.

+

Time interval in seconds for checking the radio queue.

@@ -14309,60 +15542,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -
-

Function(s)

-
- - - -

Type MSRS_BACKEND_DCSGRPC

-
-
- -

Alternate backend for MSRS to enable text-to-speech via DCS-gRPC.

- - -

Author: dogjutsu

-

A table containing functions and variables for MSRS to use DCS-gRPC DCS-gRPC 0.7.0 or newer as a backend to transmit over SRS. -This is not a standalone class. Instead, variables and functions under the Vars and Functions tables get added to or replace MSRS variables/functions when activated.

- - -
-

Field(s)

-
-
-
- - #table -MSRS_BACKEND_DCSGRPC.Functions - -

A table of functions that will add or replace the default MSRS class functions.

- -
- -
-
-
- - #table -MSRS_BACKEND_DCSGRPC.Vars - -

A table of variables that will add or replace the default MSRS class variables.

- -
- -
-
-
- - #number -MSRS_BACKEND_DCSGRPC.version - -

Version number of this alternate backend.

- -
-

Function(s)

diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index 28ba18190..23435a0e7 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2938,17 +2938,6 @@ but can separately be modified later in your mission using the -
- -
-
-
- - -TASK.TaskControlMenu - - -
@@ -7585,17 +7574,6 @@ If the Unit is part of the Task, true is returned.

-
- - -
-
- - -TASK.TaskControlMenu - - -
diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index b0f6202ea..34058e877 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -2939,7 +2939,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -3664,7 +3664,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -4840,7 +4840,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -6318,7 +6318,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask diff --git a/Documentation/Tasking.Task_CARGO.html b/Documentation/Tasking.Task_CARGO.html index c213a94f7..a9d8a4ebe 100644 --- a/Documentation/Tasking.Task_CARGO.html +++ b/Documentation/Tasking.Task_CARGO.html @@ -3267,7 +3267,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -4689,7 +4689,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -9221,7 +9221,7 @@ If the Unit is part of the Task, true is returned.

- + #number TASK_CARGO.CargoLimit diff --git a/Documentation/Utilities.FiFo.html b/Documentation/Utilities.FiFo.html index 9f4ee0aa3..f2adb0e1e 100644 --- a/Documentation/Utilities.FiFo.html +++ b/Documentation/Utilities.FiFo.html @@ -3254,17 +3254,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Stack by pointer.

-
- -
-
-
- - #number -FIFO.uniquecounter - - -
@@ -4114,17 +4103,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Stack by pointer.

-
- -
-
-
- - #number -FIFO.uniquecounter - - -
@@ -7609,6 +7587,17 @@ When moose is loading dynamically (for moose class development), tracing is swit +
+ +
+
+
+ + #number +LIFO.uniquecounter + + +
@@ -8458,6 +8447,17 @@ When moose is loading dynamically (for moose class development), tracing is swit +
+ +
+
+
+ + #number +LIFO.uniquecounter + + +
diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 70a16f17d..616aeeaa6 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -3022,28 +3022,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -3128,7 +3106,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall @@ -5161,28 +5139,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -5267,7 +5223,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall @@ -6771,28 +6727,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -6877,7 +6811,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 6389f78cc..961ff4fc4 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3732,17 +3732,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- - -
-
- - Core.Spot#SPOT -POSITIONABLE.Spot - - -
@@ -7777,17 +7766,6 @@ Coordinates are dependent on the position of the maps origin.

- - - -
-
- - Core.Spot#SPOT -POSITIONABLE.Spot - - -
@@ -8358,17 +8336,6 @@ If the Identifiable is alive, true is returned.

- - - -
-
- - Core.Spot#SPOT -POSITIONABLE.Spot - - -
@@ -8556,17 +8523,6 @@ If the Identifiable is alive, true is returned.

- - - -
-
- - Core.Spot#SPOT -POSITIONABLE.Spot - - -