weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2022-09-20 14:02:22 +00:00
parent 41a606795d
commit d2664c8207
26 changed files with 1162 additions and 588 deletions
Download Patch File Download Diff File Expand all files Collapse all files

570
Documentation/Functional.Range.html
View File

@@ -1628,6 +1628,7 @@ by a script by SNAFU <a href="https://forums.eagle.ru/showthread.php?t=109174">s
<h3>Author: <strong><a href="https://forums.eagle.ru/member.php?u=115026">funkyfranky</a></strong></h3>
<h3>Contributions: <a href="https://forums.eagle.ru/member.php?u=89536">FlightControl</a>, <a href="https://forums.eagle.ru/member.php?u=112175">Ciribob</a></h3>
<h3>SRS Additions: Applevangelist</h3>
<hr/>
@@ -1790,6 +1791,11 @@ This can be enabled via the <a href="##(RANGE).SetInstructorRadio">RANGE.SetInst
<p>By default, the sound files are placed in the "Range Soundfiles/" folder inside the mission (.miz) file. Another folder can be specified via the <a href="##(RANGE).SetSoundfilesPath">RANGE.SetSoundfilesPath</a>(<em>path</em>) function.</p>
<h2>Voice output via SRS</h2>
<p>Alternatively, the voice output can be fully done via SRS, <strong>no sound file additions needed</strong>. Set up SRS with <a href="##(RANGE).SetSRS">RANGE.SetSRS</a>(). Range control and instructor frequencies and voices can then be
set via <a href="##(RANGE).SetSRSRangeControl">RANGE.SetSRSRangeControl</a>() and <a href="##(RANGE).SetSRSRangeInstructor">RANGE.SetSRSRangeInstructor</a>()</p>
<h1>Persistence</h1>
<p>To automatically save bombing results to disk, use the <a href="##(RANGE).SetAutosave">RANGE.SetAutosave</a>() function. Bombing results will be saved as csv file in your "Saved Games\DCS.openbeta\Logs" directory.
@@ -2128,7 +2134,7 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).SetInstructorRadio">RANGE:SetInstructorRadio(frequency, relayunitname)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Enable instructor radio and set frequency.</p>
<p>Enable instructor radio and set frequency (non-SRS).</p>
</td>
</tr>
<tr class="w3-border">
@@ -2164,7 +2170,7 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).SetRangeControl">RANGE:SetRangeControl(frequency, relayunitname)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Enable range control and set frequency.</p>
<p>Enable range control and set frequency (non-SRS).</p>
</td>
</tr>
<tr class="w3-border">
@@ -2183,6 +2189,24 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).SetRangeZone">RANGE:SetRangeZone(zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set range zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).SetSRS">RANGE:SetSRS(PathToSRS, Port, Coalition, Frequency, Modulation, Volume, PathToGoogleKey)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Use SRS Simple-Text-To-Speech for transmissions.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).SetSRSRangeControl">RANGE:SetSRSRangeControl(frequency, modulation, voice, culture, gender, relayunitname)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(SRS) Set range control frequency and voice.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).SetSRSRangeInstructor">RANGE:SetSRSRangeInstructor(frequency, modulation, voice, culture, gender, relayunitname)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(SRS) Set range instructor frequency and voice.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2579,6 +2603,18 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).bombingTargets">RANGE.bombingTargets</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Table of targets to bomb.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).controlmsrs">RANGE.controlmsrs</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="##(RANGE).controlsrsQ">RANGE.controlsrsQ</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2633,6 +2669,12 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).illuminationminalt">RANGE.illuminationminalt</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Minimum altitude in meters AGL at which illumination bombs are fired. Default is 500 m.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).instructmsrs">RANGE.instructmsrs</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2651,6 +2693,12 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).instructorrelayname">RANGE.instructorrelayname</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Name of relay unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).instructsrsQ">RANGE.instructsrsQ</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2867,6 +2915,12 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).trackrockets">RANGE.trackrockets</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>If true (default), all rocket types are tracked and impact point to closest bombing target is evaluated.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).useSRS">RANGE.useSRS</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -4726,6 +4780,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Table of targets to bomb.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRS)">Sound.SRS#MSRS</a>
<a id="#(RANGE).controlmsrs" ><strong>RANGE.controlmsrs</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRSQUEUE)">Sound.SRS#MSRSQUEUE</a>
<a id="#(RANGE).controlsrsQ" ><strong>RANGE.controlsrsQ</strong></a>
</div>
</div>
@@ -4825,6 +4901,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Minimum altitude in meters AGL at which illumination bombs are fired. Default is 500 m.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRS)">Sound.SRS#MSRS</a>
<a id="#(RANGE).instructmsrs" ><strong>RANGE.instructmsrs</strong></a>
</div>
</div>
@@ -4858,6 +4945,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of relay unit.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRSQUEUE)">Sound.SRS#MSRSQUEUE</a>
<a id="#(RANGE).instructsrsQ" ><strong>RANGE.instructsrsQ</strong></a>
</div>
</div>
@@ -5133,6 +5231,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>If true (default), all rocket types are tracked and impact point to closest bombing target is evaluated.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(RANGE).useSRS" ><strong>RANGE.useSRS</strong></a>
</div>
</div>
@@ -6883,7 +6992,7 @@ Furthermore, the player must not be too high and fly in the direction of the pit
<h2><a id="#(RANGE).SetInstructorRadio" ><strong>RANGE:SetInstructorRadio(frequency, relayunitname)</strong></a></h2>
</div>
<p>Enable instructor radio and set frequency.</p>
<p>Enable instructor radio and set frequency (non-SRS).</p>
<div id= "#Functions##SetInstructorRadio" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -7154,7 +7263,7 @@ Furthermore, the player must not be too high and fly in the direction of the pit
<h2><a id="#(RANGE).SetRangeControl" ><strong>RANGE:SetRangeControl(frequency, relayunitname)</strong></a></h2>
</div>
<p>Enable range control and set frequency.</p>
<p>Enable range control and set frequency (non-SRS).</p>
<div id= "#Functions##SetRangeControl" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -7345,6 +7454,349 @@ If a zone is not explicitly specified, the range zone is determined by its locat
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(RANGE).SetSRS" ><strong>RANGE:SetSRS(PathToSRS, Port, Coalition, Frequency, Modulation, Volume, PathToGoogleKey)</strong></a></h2>
</div>
<p>Use SRS Simple-Text-To-Speech for transmissions.</p>
<p>No sound files necessary.</p>
<div id= "#Functions##SetSRS" 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>RANGE</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>PathToSRS</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Path to SRS directory.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Port</strong></strong>
</p>
</div>
<div class="w3-half">
<p>SRS port. Default 5002.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Coalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Coalition side, e.g. coalition.side.BLUE or coalition.side.RED</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Frequency</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Frequency to use, defaults to 256 (same as rangecontrol)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Modulation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Modulation to use, defaults to radio.modulation.AM</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Volume</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Volume, between 0.0 and 1.0. Defaults to 1.0</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>PathToGoogleKey</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Path to Google TTS credentials.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(RANGE)">#RANGE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(RANGE).SetSRSRangeControl" ><strong>RANGE:SetSRSRangeControl(frequency, modulation, voice, culture, gender, relayunitname)</strong></a></h2>
</div>
<p>(SRS) Set range control frequency and voice.</p>
<div id= "#Functions##SetSRSRangeControl" 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>RANGE</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>
#number
<strong><strong>frequency</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Frequency in MHz. Default 256 MHz.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>modulation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Modulation, defaults to radio.modulation.AM.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>voice</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Voice.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>culture</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Culture, defaults to "en-US".</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>gender</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Gender, defaults to "female".</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>relayunitname</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Name of the unit used for transmission location.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(RANGE)">#RANGE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(RANGE).SetSRSRangeInstructor" ><strong>RANGE:SetSRSRangeInstructor(frequency, modulation, voice, culture, gender, relayunitname)</strong></a></h2>
</div>
<p>(SRS) Set range instructor frequency and voice.</p>
<div id= "#Functions##SetSRSRangeInstructor" 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>RANGE</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>
#number
<strong><strong>frequency</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Frequency in MHz. Default 305 MHz.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>modulation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Modulation, defaults to radio.modulation.AM.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>voice</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Voice.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>culture</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Culture, defaults to "en-US".</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>gender</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Gender, defaults to "male".</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>relayunitname</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Name of the unit used for transmission location.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(RANGE)">#RANGE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -10470,6 +10922,28 @@ If a zone is not explicitly specified, the range zone is determined by its locat
<p>Table of targets to bomb.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRS)">Sound.SRS#MSRS</a>
<a id="#(RANGE).controlmsrs" ><strong>RANGE.controlmsrs</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRSQUEUE)">Sound.SRS#MSRSQUEUE</a>
<a id="#(RANGE).controlsrsQ" ><strong>RANGE.controlsrsQ</strong></a>
</div>
</div>
@@ -10569,6 +11043,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat
<p>Minimum altitude in meters AGL at which illumination bombs are fired. Default is 500 m.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRS)">Sound.SRS#MSRS</a>
<a id="#(RANGE).instructmsrs" ><strong>RANGE.instructmsrs</strong></a>
</div>
</div>
@@ -10602,6 +11087,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat
<p>Name of relay unit.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRSQUEUE)">Sound.SRS#MSRSQUEUE</a>
<a id="#(RANGE).instructsrsQ" ><strong>RANGE.instructsrsQ</strong></a>
</div>
</div>
@@ -10877,6 +11373,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat
<p>If true (default), all rocket types are tracked and impact point to closest bombing target is evaluated.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(RANGE).useSRS" ><strong>RANGE.useSRS</strong></a>
</div>
</div>
@@ -12553,6 +13060,28 @@ If a zone is not explicitly specified, the range zone is determined by its locat
<p>Table of targets to bomb.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRS)">Sound.SRS#MSRS</a>
<a id="#(RANGE).controlmsrs" ><strong>RANGE.controlmsrs</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRSQUEUE)">Sound.SRS#MSRSQUEUE</a>
<a id="#(RANGE).controlsrsQ" ><strong>RANGE.controlsrsQ</strong></a>
</div>
</div>
@@ -12652,6 +13181,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat
<p>Minimum altitude in meters AGL at which illumination bombs are fired. Default is 500 m.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRS)">Sound.SRS#MSRS</a>
<a id="#(RANGE).instructmsrs" ><strong>RANGE.instructmsrs</strong></a>
</div>
</div>
@@ -12685,6 +13225,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat
<p>Name of relay unit.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Sound.SRS.html##(MSRSQUEUE)">Sound.SRS#MSRSQUEUE</a>
<a id="#(RANGE).instructsrsQ" ><strong>RANGE.instructsrsQ</strong></a>
</div>
</div>
@@ -12960,6 +13511,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat
<p>If true (default), all rocket types are tracked and impact point to closest bombing target is evaluated.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(RANGE).useSRS" ><strong>RANGE.useSRS</strong></a>
</div>
</div>