From 67471a572375780ad82d2bba19470d1ceb586266 Mon Sep 17 00:00:00 2001
From: Applevangelist
Date: Fri, 13 Oct 2023 14:28:03 +0000
Subject: [PATCH] MOOSE generated documentation [skip ci]
---
Documentation/AI.AI_A2A_Dispatcher.html | 20 +-
Documentation/AI.AI_Air.html | 132 ----
Documentation/AI.AI_Cargo_Airplane.html | 36 +-
Documentation/AI.AI_Cargo_Helicopter.html | 40 +-
Documentation/AI.AI_Patrol.html | 12 +
Documentation/Cargo.CargoCrate.html | 22 +
Documentation/Cargo.CargoGroup.html | 56 +-
Documentation/Cargo.CargoUnit.html | 22 +
Documentation/Core.Point.html | 33 +
Documentation/Core.Settings.html | 32 +-
Documentation/Core.Spawn.html | 350 +++++----
Documentation/Core.SpawnStatic.html | 84 ---
Documentation/Functional.Designate.html | 55 --
Documentation/Functional.Mantis.html | 164 +---
Documentation/Functional.Movement.html | 28 -
Documentation/Functional.RAT.html | 65 +-
Documentation/Functional.Scoring.html | 18 +-
Documentation/Ops.Airboss.html | 79 +-
Documentation/Ops.CSAR.html | 30 +-
Documentation/Ops.CTLD.html | 126 ++--
Documentation/Sound.SRS.html | 700 +++++++++++++++++-
Documentation/Tasking.Task_CARGO.html | 8 +-
.../Tasking.Task_Cargo_Dispatcher.html | 44 --
23 files changed, 1267 insertions(+), 889 deletions(-)
diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html
index abe745b2e..6234f6ff6 100644
--- a/Documentation/AI.AI_A2A_Dispatcher.html
+++ b/Documentation/AI.AI_A2A_Dispatcher.html
@@ -4873,14 +4873,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -11540,14 +11537,11 @@ They will lock the parking spot.
@@ -12805,14 +12799,11 @@ They will lock the parking spot.
@@ -14372,14 +14363,11 @@ They will lock the parking spot.
diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html
index e316b7fe4..3c4436d9d 100644
--- a/Documentation/AI.AI_Air.html
+++ b/Documentation/AI.AI_Air.html
@@ -3075,17 +3075,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3185,28 +3174,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
-
@@ -5914,17 +5881,6 @@ A random value in this bracket is then applied in the waypoint routing generatio
-
-
-
-
@@ -6024,28 +5980,6 @@ A random value in this bracket is then applied in the waypoint routing generatio
-
-
-
-
-
@@ -6672,17 +6606,6 @@ A random value in this bracket is then applied in the waypoint routing generatio
-
-
-
-
@@ -6782,28 +6705,6 @@ A random value in this bracket is then applied in the waypoint routing generatio
-
-
-
-
-
@@ -8318,17 +8219,6 @@ A random value in this bracket is then applied in the waypoint routing generatio
-
-
-
-
@@ -8428,28 +8318,6 @@ A random value in this bracket is then applied in the waypoint routing generatio
-
-
-
-
-
diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html
index 86cb687bc..677456d58 100644
--- a/Documentation/AI.AI_Cargo_Airplane.html
+++ b/Documentation/AI.AI_Cargo_Airplane.html
@@ -2751,9 +2751,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- Set destination airbase for next :Route() command.
-
@@ -2787,9 +2784,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- Aircraft is on a depoly mission.
-
@@ -2815,6 +2809,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+ Aircraft is on a pickup mission.
+
@@ -4541,9 +4538,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- Set destination airbase for next :Route() command.
-
@@ -4577,9 +4571,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- Aircraft is on a depoly mission.
-
@@ -4605,6 +4596,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+ Aircraft is on a pickup mission.
+
@@ -5173,9 +5167,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- Set destination airbase for next :Route() command.
-
@@ -5209,9 +5200,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- Aircraft is on a depoly mission.
-
@@ -5237,6 +5225,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+ Aircraft is on a pickup mission.
+
@@ -6693,9 +6684,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- Set destination airbase for next :Route() command.
-
@@ -6729,9 +6717,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- Aircraft is on a depoly mission.
-
@@ -6757,6 +6742,9 @@ 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 ba7072f07..b6c23e96f 100644
--- a/Documentation/AI.AI_Cargo_Helicopter.html
+++ b/Documentation/AI.AI_Cargo_Helicopter.html
@@ -2908,28 +2908,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -4832,28 +4826,22 @@ Adjust if necessary.
@@ -5508,28 +5496,22 @@ Adjust if necessary.
@@ -7072,28 +7054,22 @@ Adjust if necessary.
diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html
index 7493116d0..6f771e1ea 100644
--- a/Documentation/AI.AI_Patrol.html
+++ b/Documentation/AI.AI_Patrol.html
@@ -3259,6 +3259,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+ This table contains the targets detected during patrol.
+
@@ -6506,6 +6509,9 @@ Note that this method is required, as triggers the next route when patrolling fo
+
+ This table contains the targets detected during patrol.
+
@@ -7250,6 +7256,9 @@ Note that this method is required, as triggers the next route when patrolling fo
+
+ This table contains the targets detected during patrol.
+
@@ -8882,6 +8891,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/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html
index 58b55730c..f1bcf0170 100644
--- a/Documentation/Cargo.CargoCrate.html
+++ b/Documentation/Cargo.CargoCrate.html
@@ -1864,6 +1864,17 @@ Therefore, this class is considered to be deprecated
Field(s)
+
@@ -2532,6 +2543,17 @@ Therefore, this class is considered to be deprecated
Field(s)
+
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html
index f28ad1aff..fba1ae4b4 100644
--- a/Documentation/Cargo.CargoGroup.html
+++ b/Documentation/Cargo.CargoGroup.html
@@ -1935,20 +1935,6 @@ Therefore, this class is considered to be deprecated
-
-
-
+
@@ -3256,20 +3256,6 @@ This works for ground only groups.
-
-
-
+
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html
index 9542e15a1..80bceac50 100644
--- a/Documentation/Cargo.CargoUnit.html
+++ b/Documentation/Cargo.CargoUnit.html
@@ -1813,6 +1813,17 @@ Therefore, this class is considered to be deprecated
+
+
+
+
+
+
CARGO_UNIT.CargoInAir
@@ -2528,6 +2539,17 @@ Therefore, this class is considered to be deprecated
+
+
+
+
+
+
CARGO_UNIT.CargoInAir
diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html
index 22f0c6e09..0619af89e 100644
--- a/Documentation/Core.Point.html
+++ b/Documentation/Core.Point.html
@@ -18145,6 +18145,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
the y coordinate in meters.
+
+
+
+
@@ -18943,6 +18954,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
the y coordinate in meters.
+
+
+
+
@@ -27766,6 +27788,17 @@ Creates a line on the F10 map from one point to another.
the y coordinate in meters.
+
+
+
+
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html
index ad7ea7b43..3f445af04 100644
--- a/Documentation/Core.Settings.html
+++ b/Documentation/Core.Settings.html
@@ -2861,11 +2861,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -2910,6 +2913,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -5018,11 +5032,14 @@ It is advised to use this method at the start of the mission.
@@ -5067,6 +5084,17 @@ It is advised to use this method at the start of the mission.
+
+
+
+
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html
index 669d22366..9704eeea7 100644
--- a/Documentation/Core.Spawn.html
+++ b/Documentation/Core.Spawn.html
@@ -2940,7 +2940,31 @@ and any spaces before and after the resulting name are removed.
- SPAWN.uncontrolled |
+ SPAWN.communication |
+
+
+ |
+
+
+ SPAWN.frequency |
+
+
+ |
+
+
+ SPAWN.livery_id |
+
+
+ |
+
+
+ SPAWN.modulation |
+
+
+ |
+
+
+ SPAWN.skill |
|
@@ -3502,11 +3526,14 @@ 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.
+
@@ -3576,6 +3603,9 @@ 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.
+
@@ -3631,6 +3661,20 @@ 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.
+
@@ -3664,17 +3708,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3711,17 +3744,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3755,17 +3777,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3821,6 +3832,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3832,49 +3857,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
-
-
-
-
@@ -3940,7 +3924,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #number
SPAWN.SpawnMaxGroups
@@ -3954,7 +3938,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #number
SPAWN.SpawnMaxUnitsAlive
@@ -4218,7 +4202,51 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
+
+
+
+
SPAWN.skill
@@ -9348,11 +9376,14 @@ 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.
+
@@ -9422,6 +9453,9 @@ 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.
+
@@ -9477,6 +9511,20 @@ 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.
+
@@ -9510,17 +9558,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
@@ -9557,17 +9594,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
@@ -9601,17 +9627,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
@@ -9667,6 +9682,20 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -9678,49 +9707,8 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
-
-
-
-
@@ -9786,7 +9774,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
+ #number
SPAWN.SpawnMaxGroups
@@ -9800,7 +9788,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
+
+
+
+
+
+
+
SPAWN.skill
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html
index 6fff7c603..b4aba2de2 100644
--- a/Documentation/Core.SpawnStatic.html
+++ b/Documentation/Core.SpawnStatic.html
@@ -1993,24 +1993,6 @@ 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 |
-
-
|
@@ -2925,39 +2907,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
-
-
@@ -4311,39 +4260,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
-
-
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html
index 3d80c844a..7cea8f12b 100644
--- a/Documentation/Functional.Designate.html
+++ b/Documentation/Functional.Designate.html
@@ -3551,17 +3551,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -6726,17 +6715,6 @@ Using the menu system, the player can "forget" a designation, so that gradually
-
-
-
-
@@ -7536,17 +7514,6 @@ Using the menu system, the player can "forget" a designation, so that gradually
-
-
-
-
@@ -8316,17 +8283,6 @@ Using the menu system, the player can "forget" a designation, so that gradually
-
-
-
-
@@ -9984,17 +9940,6 @@ Using the menu system, the player can "forget" a designation, so that gradually
-
-
-
-
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html
index 2a2d89205..d05d27303 100644
--- a/Documentation/Functional.Mantis.html
+++ b/Documentation/Functional.Mantis.html
@@ -3909,8 +3909,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
@@ -4057,17 +4046,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
The ME name of the HQ object
-
-
-
-
@@ -4096,7 +4074,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
MANTIS.SAM_Table_Long
@@ -4107,7 +4085,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
MANTIS.SAM_Table_Medium
@@ -4118,7 +4096,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
MANTIS.SAM_Table_Short
@@ -4492,50 +4470,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Prefix for logging
-
-
-
-
-
-
-
@@ -4594,6 +4528,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
switch alarm state RED
+
@@ -4605,9 +4542,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
self.SAMCheckRanges = {}
-
@@ -8493,8 +8427,8 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
-
@@ -8641,17 +8564,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
The ME name of the HQ object
-
-
-
-
@@ -8680,7 +8592,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- #table
+
MANTIS.SAM_Table_Long
@@ -8691,7 +8603,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- #table
+
MANTIS.SAM_Table_Medium
@@ -8702,7 +8614,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- #table
+
MANTIS.SAM_Table_Short
@@ -9076,50 +8988,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
Prefix for logging
-
-
-
-
-
-
-
@@ -9178,6 +9046,9 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
+
+
switch alarm state RED
+
@@ -9189,9 +9060,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
-
-
self.SAMCheckRanges = {}
-
diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html
index f52009b30..1671a249f 100644
--- a/Documentation/Functional.Movement.html
+++ b/Documentation/Functional.Movement.html
@@ -2265,20 +2265,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.
-
-
-
-
@@ -2509,20 +2495,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.RAT.html b/Documentation/Functional.RAT.html
index abd5eff5a..048ef40be 100644
--- a/Documentation/Functional.RAT.html
+++ b/Documentation/Functional.RAT.html
@@ -3468,12 +3468,6 @@ manager:Stop(7200)
RAT.termtype |
Type of terminal to be used when spawning at an airbase.
- |
-
-
- RAT.type |
-
-
|
@@ -4522,7 +4516,31 @@ and any spaces before and after the resulting name are removed.
- RAT.uncontrolled |
+ RAT.communication |
+
+
+ |
+
+
+ RAT.frequency |
+
+
+ |
+
+
+ RAT.livery_id |
+
+
+ |
+
+
+ RAT.modulation |
+
+
+ |
+
+
+ RAT.skill |
|
@@ -6916,17 +6934,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Type of terminal to be used when spawning at an airbase.
-
-
-
-
@@ -14807,17 +14814,6 @@ Initializes the ratcraft array and group menu.
Type of terminal to be used when spawning at an airbase.
-
-
-
-
@@ -21140,17 +21136,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.Type of terminal to be used when spawning at an airbase.
-
-
-
-
diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html
index b68dac0dd..5f4d0049c 100644
--- a/Documentation/Functional.Scoring.html
+++ b/Documentation/Functional.Scoring.html
@@ -2863,11 +2863,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -3050,7 +3053,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #boolean
SCORING.penaltyoncoalitionchange
@@ -3061,7 +3064,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #boolean
SCORING.penaltyonfratricide
@@ -5449,11 +5452,14 @@ The scale magnifies the scores given to the players.
@@ -5636,7 +5642,7 @@ The scale magnifies the scores given to the players.
-
+ #boolean
SCORING.penaltyoncoalitionchange
@@ -5647,7 +5653,7 @@ The scale magnifies the scores given to the players.
-
+ #boolean
SCORING.penaltyonfratricide
diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html
index 119651cc1..c8d2a10b4 100644
--- a/Documentation/Ops.Airboss.html
+++ b/Documentation/Ops.Airboss.html
@@ -9604,6 +9604,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Radio queue of LSO.
+
+
+
+
@@ -9615,6 +9626,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Radio queue of marshal.
+
+
+
+
@@ -29803,6 +29825,17 @@ If removed flight is the section lead, we try to find a new leader.
Radio queue of LSO.
+
+
+
+
@@ -29814,6 +29847,17 @@ If removed flight is the section lead, we try to find a new leader.
Radio queue of marshal.
+
+
+
+
@@ -32882,6 +32926,17 @@ If removed flight is the section lead, we try to find a new leader.
Radio queue of LSO.
+
+
+
+
@@ -32893,6 +32948,17 @@ If removed flight is the section lead, we try to find a new leader.
Radio queue of marshal.
+
+
+
+
@@ -40581,17 +40647,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
Data table at each position in the groove. Elements are of type AIRBOSS.GrooveData.
-
-
-
-
@@ -40728,7 +40783,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
- Set section lead of player flight.
+ Make player section lead if he was not before.
diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html
index 2b0126db4..882170125 100644
--- a/Documentation/Ops.CSAR.html
+++ b/Documentation/Ops.CSAR.html
@@ -4373,11 +4373,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -4398,11 +4401,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -10380,11 +10386,14 @@ callsigns from playername or group name.
@@ -10405,11 +10414,14 @@ callsigns from playername or group name.
@@ -12872,11 +12884,14 @@ callsigns from playername or group name.
@@ -12897,11 +12912,14 @@ callsigns from playername or group name.
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html
index f2c885f30..fbf8b3361 100644
--- a/Documentation/Ops.CTLD.html
+++ b/Documentation/Ops.CTLD.html
@@ -7629,17 +7629,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Name of the class.
-
-
-
-
@@ -7660,7 +7649,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
CTLD.CtldUnits
@@ -7682,7 +7671,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.DroppedTroops
@@ -7707,11 +7696,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -7754,7 +7746,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeUHFFrequencies
@@ -7873,11 +7865,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -8375,7 +8370,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
time to repairor build a unit/group
+
noob catch
@@ -8463,7 +8458,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number
+
CTLD.troopdropzoneradius
@@ -17213,17 +17208,6 @@ However, if you create a new folder inside the miz file, which contains the soun
Name of the class.
-
-
-
-
@@ -17244,7 +17228,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table
+
CTLD.CtldUnits
@@ -17266,7 +17250,7 @@ However, if you create a new folder inside the miz file, which contains the soun
-
+ #table
CTLD.DroppedTroops
@@ -17291,11 +17275,14 @@ However, if you create a new folder inside the miz file, which contains the soun
@@ -17338,7 +17325,7 @@ However, if you create a new folder inside the miz file, which contains the soun
-
+ #table
CTLD.FreeUHFFrequencies
@@ -17457,11 +17444,14 @@ However, if you create a new folder inside the miz file, which contains the soun
@@ -17959,7 +17949,7 @@ However, if you create a new folder inside the miz file, which contains the soun
-
time to repairor build a unit/group
+
noob catch
@@ -18047,7 +18037,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number
+
CTLD.troopdropzoneradius
@@ -19624,17 +19614,6 @@ However, if you create a new folder inside the miz file, which contains the soun
Name of the class.
-
-
-
-
@@ -19655,7 +19634,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table
+
CTLD.CtldUnits
@@ -19677,7 +19656,7 @@ However, if you create a new folder inside the miz file, which contains the soun
-
+ #table
CTLD.DroppedTroops
@@ -19702,11 +19681,14 @@ However, if you create a new folder inside the miz file, which contains the soun
@@ -19749,7 +19731,7 @@ However, if you create a new folder inside the miz file, which contains the soun
-
+ #table
CTLD.FreeUHFFrequencies
@@ -19868,11 +19850,14 @@ However, if you create a new folder inside the miz file, which contains the soun
@@ -20370,7 +20355,7 @@ However, if you create a new folder inside the miz file, which contains the soun
-
time to repairor build a unit/group
+
noob catch
@@ -20458,7 +20443,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number
+
CTLD.troopdropzoneradius
@@ -24472,17 +24457,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
Can transport crate.
-
-
-
-
@@ -33615,6 +33589,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
template for a group of 10 paratroopers
+
+
+
+
@@ -34941,6 +34926,17 @@ Use either this method to integrate the Hercules **or** the one from the "normal
template for a group of 10 paratroopers
+
+
+
+
diff --git a/Documentation/Sound.SRS.html b/Documentation/Sound.SRS.html
index ec1360f73..3a445e171 100644
--- a/Documentation/Sound.SRS.html
+++ b/Documentation/Sound.SRS.html
@@ -1738,6 +1738,52 @@ For voices there are enumerators in this class to help you out on voice names:
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.
+
Set DCS-gRPC as an alternative to 'DCS-SR-ExternalAudio.exe' 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()
+
+
@@ -1775,6 +1821,12 @@ For voices there are enumerators in this class to help you out on voice names:
Fields and Methods inherited from MSRS |
Description |
+
+ MSRS.APIKey |
+
+
+ |
+
MSRS:AddFrequencies(Frequencies) |
@@ -1785,6 +1837,12 @@ For voices there are enumerators in this class to help you out on voice names:
| MSRS:AddModulations(Modulations) |
Add modulations.
+ |
+
+
+ MSRS.AltBackend |
+
+ Table containing functions and variables to enable an alternate backend to transmit to SRS.
|
@@ -1848,7 +1906,7 @@ For voices there are enumerators in this class to help you out on voice names:
- MSRS:New(PathToSRS, Frequency, Modulation, Volume) |
+ MSRS:New(PathToSRS, Frequency, Modulation, Volume, AltBackend) |
Create a new MSRS object.
|
@@ -1881,6 +1939,12 @@ For voices there are enumerators in this class to help you out on voice names:
MSRS:PlayTextFile(TextFile, Delay) |
Play text file via STTS.
+ |
+
+
+ MSRS.ResetDefaultBackend() |
+
+ Restores default SRS backend (DCS-SR-ExternalAudio.exe) to be used by all new MSRS class instances to transmit over SRS.
|
@@ -1899,6 +1963,24 @@ For voices there are enumerators in this class to help you out on voice names:
MSRS:SetCulture(Culture) |
Set culture.
+ |
+
+
+ MSRS.SetDefaultBackend(Backend) |
+
+ Sets an alternate SRS backend to be used by MSRS to transmit over SRS for all new MSRS class instances.
+ |
+
+
+ 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.
|
@@ -1917,6 +1999,12 @@ For voices there are enumerators in this class to help you out on voice names:
MSRS:SetGoogle(PathToCredentials) |
Use google text-to-speech.
+ |
+
+
+ MSRS:SetGoogleAPIKey(APIKey) |
+
+ Use google text-to-speech.
|
@@ -1977,6 +2065,12 @@ For voices there are enumerators in this class to help you out on voice names:
MSRS:_GetLatLongAlt(Coordinate) |
Get lat, long and alt from coordinate.
+ |
+
+
+ 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.
|
@@ -1995,6 +2089,12 @@ For voices there are enumerators in this class to help you out on voice names:
MSRS.culture |
Culture. Default "en-GB".
+ |
+
+
+ MSRS.defaultVoice |
+
+
|
@@ -2043,6 +2143,12 @@ For voices there are enumerators in this class to help you out on voice names:
MSRS.port |
Port. Default 5002.
+ |
+
+
+ MSRS.provider |
+
+
|
@@ -2681,7 +2787,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- MSRSQUEUE:NewTransmission(text, duration, msrs, tstart, interval, subgroups, subtitle, subduration, frequency, modulation) |
+ MSRSQUEUE:NewTransmission(text, duration, msrs, tstart, interval, subgroups, subtitle, subduration, frequency, modulation, gender, culture, voice, volume, label) |
Create a new transmission and add it to the radio queue.
|
@@ -3317,6 +3423,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
MSRSQUEUE.Transmission.Tstarted |
Mission time (abs) in seconds when the transmission started.
+ |
+
+
+ MSRSQUEUE.Transmission.culture |
+
+ Voice culture
|
@@ -3329,6 +3441,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
MSRSQUEUE.Transmission.frequency |
Frequency.
+ |
+
+
+ MSRSQUEUE.Transmission.gender |
+
+ Voice gender
|
@@ -3341,6 +3459,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
MSRSQUEUE.Transmission.isplaying |
If true, transmission is currently playing.
+ |
+
+
+ MSRSQUEUE.Transmission.label |
+
+ Label to be used
|
@@ -3377,6 +3501,49 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
MSRSQUEUE.Transmission.text |
Text to be transmitted.
+ |
+
+
+ MSRSQUEUE.Transmission.voice |
+
+ Voice if any
+ |
+
+
+ MSRSQUEUE.Transmission.volume |
+
+ Volume
+ |
+
+
+
+
+
+
+
+
@@ -3397,6 +3564,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
+
+
+
+ #table
+
MSRS.AltBackend
+
+
Table containing functions and variables to enable an alternate backend to transmit to SRS.
+
+
+
+
@@ -3460,6 +3649,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Culture. Default "en-GB".
+
+
+
+
@@ -3548,6 +3748,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Port. Default 5002.
+
+
+
+
@@ -3922,7 +4133,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Create a new MSRS object.
@@ -3984,6 +4195,19 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
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.
+
Return value:
@@ -4375,6 +4599,36 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
+
+
Restores default SRS backend (DCS-SR-ExternalAudio.exe) to be used by all new MSRS class instances to transmit over SRS.
+
+
+
+
Defined in:
+
+
Return value:
+
+
+
+
+
Returns 'true' on success.
+
+
+
+
+
@@ -4507,6 +4761,127 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
+
+
Sets an alternate SRS backend to be used by MSRS to transmit over SRS for all new MSRS class instances.
+
+
+
+
Defined in:
+
+
Parameter:
+
+
+
+
+
A table containing a table Functions with new/replacement class functions and Vars with new/replacement variables.
+
+
+
+
Return value:
+
+
+
+
+
Returns 'true' on success.
+
+
+
+
+
+
+
+
+
+
+
+
+
Sets DCS-gRPC as the default SRS backend for all new MSRS class instances.
+
+
+
+
Defined in:
+
+
Return value:
+
+
+
+
+
Returns 'true' on success.
+
+
+
+
+
+
+
+
+
+
+
+
+
Set to use a specific voice.
+
+
+
Will override gender and culture settings.
+
+
+
+
Defined in:
+
+
Parameter:
+
+
Return value:
+
+
+
@@ -4616,6 +4991,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ #string
PathToCredentials
@@ -4638,6 +5014,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
+
+
Use google text-to-speech.
+
+
+
+
Defined in:
+
+
Parameter:
+
+
+
+
+
API Key, usually a string of length 40 with characters and numbers.
+
+
+
+
Return value:
+
+
+
@@ -5173,12 +5593,88 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
+
+
Adds or replaces functions and variables in the current MSRS class instance to enable an alternate backends for transmitting to SRS.
+
+
+
+
Defined in:
+
+
Parameters:
+
+
+
+
+
table containing a table Functions with new/replacement class functions and Vars with new/replacement variables.
+
+
+
+
+
Return value:
+
+
+
Field(s)
+
+
+
+
+ #table
+
MSRS.AltBackend
+
+
Table containing functions and variables to enable an alternate backend to transmit to SRS.
+
+
+
+
@@ -5242,6 +5738,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Culture. Default "en-GB".
+
+
+
+
@@ -5330,6 +5837,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Port. Default 5002.
+
+
+
+
@@ -9046,7 +9564,7 @@ This can be used to submit multiple TTS messages and the class takes care that t
Create a new transmission and add it to the radio queue.
@@ -9186,6 +9704,71 @@ This can be used to submit multiple TTS messages and the class takes care that t
Radio modulation if other then MSRS default.
+
+
+
+
+
+
+
Gender of the voice
+
+
+
+
+
+
+ #string
+ culture
+
+
+
+
+
Culture of the voice
+
+
+
+
+
+
Return value:
@@ -12777,6 +13360,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
@@ -12799,6 +13393,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
@@ -12821,6 +13426,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
@@ -12887,6 +13503,82 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
+
+
+
Function(s)
+
+
+
+
+
+
-