MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2023-10-17 09:15:23 +00:00
parent 67471a5723
commit 01fe4a7712
30 changed files with 1686 additions and 750 deletions
+619 -4
View File
@@ -1849,6 +1849,30 @@ atis:Start()
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).ClassName">MSRS.ClassName</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Name of the class.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).ConfigFileName">MSRS.ConfigFileName</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Name of the standard config file</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).ConfigFilePath">MSRS.ConfigFilePath</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Path to the standard config file</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).ConfigLoaded">MSRS.ConfigLoaded</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).GRPCOptions">MSRS.GRPCOptions</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -1903,6 +1927,12 @@ atis:Start()
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).Label">MSRS.Label</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Label showing up on the SRS radio overlay. Default is "ROBOT". No spaces allowed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).LoadConfigFile">MSRS:LoadConfigFile(Path, Filename, ConfigLoaded)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get central SRS configuration to be able to play tts over SRS radio using the <code>DCS-SR-ExternalAudio.exe</code>.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2149,6 +2179,18 @@ atis:Start()
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).provider">MSRS.provider</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).region">MSRS.region</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).secret">MSRS.secret</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2160,7 +2202,7 @@ atis:Start()
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).voice">MSRS.voice</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Specifc voce.</p>
<p>Specific voce.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2703,6 +2745,122 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS).onEvent">MSRS:onEvent(event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>The main event handling function...</p>
</td>
</tr>
</table>
</div>
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(MSRS.GRPCOptions)">Type <strong>MSRS.GRPCOptions</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(MSRS.GRPCOptions)">MSRS.GRPCOptions</a></strong>
</div>
<div class="w3-card w3-margin">
<table class="w3-table w3-border-bottom w3-border-theme-l2">
<tr class="w3-theme-l1">
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from MSRS.GRPCOptions</th>
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.GRPCOptions).DefaultProvider">MSRS.GRPCOptions.DefaultProvider</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.GRPCOptions).aws">MSRS.GRPCOptions.aws</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.GRPCOptions).azure">MSRS.GRPCOptions.azure</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.GRPCOptions).coalition">MSRS.GRPCOptions.coalition</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.GRPCOptions).gcloud">MSRS.GRPCOptions.gcloud</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.GRPCOptions).plaintext">MSRS.GRPCOptions.plaintext</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.GRPCOptions).position">MSRS.GRPCOptions.position</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.GRPCOptions).provider">MSRS.GRPCOptions.provider</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.GRPCOptions).srsClientName">MSRS.GRPCOptions.srsClientName</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.GRPCOptions).win">MSRS.GRPCOptions.win</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
</div>
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(MSRS.ProviderOptions)">Type <strong>MSRS.ProviderOptions</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(MSRS.ProviderOptions)">MSRS.ProviderOptions</a></strong>
</div>
<div class="w3-card w3-margin">
<table class="w3-table w3-border-bottom w3-border-theme-l2">
<tr class="w3-theme-l1">
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from MSRS.ProviderOptions</th>
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.ProviderOptions).defaultVoice">MSRS.ProviderOptions.defaultVoice</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.ProviderOptions).key">MSRS.ProviderOptions.key</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.ProviderOptions).region">MSRS.ProviderOptions.region</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.ProviderOptions).secret">MSRS.ProviderOptions.secret</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MSRS.ProviderOptions).voice">MSRS.ProviderOptions.voice</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@@ -3594,6 +3752,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of the class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS).ConfigFileName" ><strong>MSRS.ConfigFileName</strong></a>
<p>Name of the standard config file</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS).ConfigFilePath" ><strong>MSRS.ConfigFilePath</strong></a>
<p>Path to the standard config file</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(MSRS).ConfigLoaded" ><strong>MSRS.ConfigLoaded</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(MSRS.GRPCOptions)">#MSRS.GRPCOptions</a>
<a id="#(MSRS).GRPCOptions" ><strong>MSRS.GRPCOptions</strong></a>
</div>
</div>
@@ -3759,6 +3961,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(MSRS).region" ><strong>MSRS.region</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(MSRS).secret" ><strong>MSRS.secret</strong></a>
</div>
</div>
@@ -3779,7 +4003,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#string
<a id="#(MSRS).voice" ><strong>MSRS.voice</strong></a>
<p>Specifc voce.</p>
<p>Specific voce.</p>
</div>
@@ -4127,6 +4351,139 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MSRS).LoadConfigFile" ><strong>MSRS:LoadConfigFile(Path, Filename, ConfigLoaded)</strong></a></h2>
</div>
<p>Get central SRS configuration to be able to play tts over SRS radio using the <code>DCS-SR-ExternalAudio.exe</code>.</p>
<div id= "#Functions##LoadConfigFile" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>MSRS</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Path</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Path to config file, defaults to "C:\Users\<yourname>\Saved Games\DCS\Config"</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Filename</strong></strong>
</p>
</div>
<div class="w3-half">
<p>File to load, defaults to "Moose_MSRS.lua"</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>ConfigLoaded</strong></strong>
</p>
</div>
<div class="w3-half">
<ul>
<li>if true, skip the loading</li>
</ul>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>success</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> 0) Benefits: Centralize configuration of SRS, keep paths and keys out of the mission source code, making it safer and easier to move missions to/between servers,
and also make config easier to use in the code.
1) Create a config file named "Moose_MSRS.lua" at this location "C:\Users\&lt;yourname&gt;\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
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,
Coalition = 0, -- 0 = Neutral, 1 = Red, 2 = Blue
Coordinate = {0,0,0}, -- x,y,alt - optional
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",
-- 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 = "&lt;API Google Key&gt;", -- 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",
},
}
}
3) Load the config into the MSRS raw class before you do anything else:
MSRS.LoadConfigFile() -- 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:LoadConfig(Path,Filename)
4) Use the config in your code like so, variable names are basically the same as in the config file, but all lower case, examples:
-- Needed once only
MESSAGE.SetMSRS(MSRS.path,nil,MSRS.google,243,radio.modulation.AM,nil,nil,
MSRS.Voices.Google.Standard.de_DE_Standard_B,coalition.side.BLUE)
-- later on in your code
MESSAGE:New("Test message!",15,"SPAWN"):ToSRS(243,radio.modulation.AM,nil,nil,MSRS.Voices.Google.Standard.fr_FR_Standard_C)
-- Create new ATIS as usual
atis=ATIS:New(AIRBASE.Caucasus.Batumi, 123, radio.modulation.AM)
atis:SetSRS(nil,nil,nil,MSRS.Voices.Google.Standard.en_US_Standard_H)
--Start ATIS
atis:Start()</code></pre>
</div>
</div>
</div>
@@ -4997,7 +5354,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>Full path to the google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".</p>
<p>Full path to the google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json". Can also be the Google API key.</p>
</div>
</div>
@@ -5683,6 +6040,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of the class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS).ConfigFileName" ><strong>MSRS.ConfigFileName</strong></a>
<p>Name of the standard config file</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS).ConfigFilePath" ><strong>MSRS.ConfigFilePath</strong></a>
<p>Path to the standard config file</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(MSRS).ConfigLoaded" ><strong>MSRS.ConfigLoaded</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(MSRS.GRPCOptions)">#MSRS.GRPCOptions</a>
<a id="#(MSRS).GRPCOptions" ><strong>MSRS.GRPCOptions</strong></a>
</div>
</div>
@@ -5848,6 +6249,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(MSRS).region" ><strong>MSRS.region</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(MSRS).secret" ><strong>MSRS.secret</strong></a>
</div>
</div>
@@ -5868,7 +6291,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#string
<a id="#(MSRS).voice" ><strong>MSRS.voice</strong></a>
<p>Specifc voce.</p>
<p>Specific voce.</p>
</div>
@@ -9234,6 +9657,198 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
</div>
</div>
<div onclick="myFunction('#Types##MSRS.GRPCOptions')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(MSRS.GRPCOptions)">Type <strong>MSRS.GRPCOptions</strong></a></h2></div>
<div id= "#Types##MSRS.GRPCOptions" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p>GRPC options</p>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS.GRPCOptions).DefaultProvider" ><strong>MSRS.GRPCOptions.DefaultProvider</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(MSRS.ProviderOptions)">#MSRS.ProviderOptions</a>
<a id="#(MSRS.GRPCOptions).aws" ><strong>MSRS.GRPCOptions.aws</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(MSRS.ProviderOptions)">#MSRS.ProviderOptions</a>
<a id="#(MSRS.GRPCOptions).azure" ><strong>MSRS.GRPCOptions.azure</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS.GRPCOptions).coalition" ><strong>MSRS.GRPCOptions.coalition</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(MSRS.ProviderOptions)">#MSRS.ProviderOptions</a>
<a id="#(MSRS.GRPCOptions).gcloud" ><strong>MSRS.GRPCOptions.gcloud</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS.GRPCOptions).plaintext" ><strong>MSRS.GRPCOptions.plaintext</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MSRS.GRPCOptions).position" ><strong>MSRS.GRPCOptions.position</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MSRS.GRPCOptions).provider" ><strong>MSRS.GRPCOptions.provider</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS.GRPCOptions).srsClientName" ><strong>MSRS.GRPCOptions.srsClientName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(MSRS.ProviderOptions)">#MSRS.ProviderOptions</a>
<a id="#(MSRS.GRPCOptions).win" ><strong>MSRS.GRPCOptions.win</strong></a>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>
</div>
</div>
<div onclick="myFunction('#Types##MSRS.ProviderOptions')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(MSRS.ProviderOptions)">Type <strong>MSRS.ProviderOptions</strong></a></h2></div>
<div id= "#Types##MSRS.ProviderOptions" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS.ProviderOptions).defaultVoice" ><strong>MSRS.ProviderOptions.defaultVoice</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS.ProviderOptions).key" ><strong>MSRS.ProviderOptions.key</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS.ProviderOptions).region" ><strong>MSRS.ProviderOptions.region</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS.ProviderOptions).secret" ><strong>MSRS.ProviderOptions.secret</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MSRS.ProviderOptions).voice" ><strong>MSRS.ProviderOptions.voice</strong></a>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>
</div>
</div>