MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2021-12-09 17:00:14 +00:00
parent e98a65d3de
commit a42c1ca70c
25 changed files with 647 additions and 1125 deletions

View File

@@ -1545,6 +1545,7 @@ ATIS broadcasts contain essential information, such as current weather informati
<h3>Author: <strong>funkyfranky</strong></h3>
</div>
<div class="w3-container w3-theme-d2"><h2><strong>Global(s)</strong></h2></div>
<div class="w3-theme-d2 w3-margin-top ">
@@ -1606,7 +1607,7 @@ The parameter <em>frequency</em> is the frequency the ATIS broadcasts in MHz.</p
<h2>Subtitles</h2>
<p>Currently, DCS allows for displaying subtitles of radio transmissions only from airborne units, <em>i.e.</em> airplanes and helicopters. Therefore, if you want to have subtitles, it is necessary to place an
additonal aircraft on the ATIS airport and set it to uncontrolled. This unit can then function as a radio relay to transmit messages with subtitles. These subtitles will only be displayed, if the
additional aircraft on the ATIS airport and set it to uncontrolled. This unit can then function as a radio relay to transmit messages with subtitles. These subtitles will only be displayed, if the
player has tuned in the correct ATIS frequency.</p>
<p>Radio transmissions via an airborne unit can be set via the <a href="##(ATIS).SetRadioRelayUnitName">ATIS.SetRadioRelayUnitName</a>(<em>unitname</em>) function, where the parameter <em>unitname</em> is the name of the unit passed as string, <em>e.g.</em></p>
@@ -1623,7 +1624,7 @@ Setting a <em>duration</em> of 0 will completely disable all subtitles.</p>
<h2>Active Runway</h2>
<p>By default, the currently active runway is determined automatically by analysing the wind direction. Therefore, you should obviously set the wind speed to be greater zero in your mission.</p>
<p>By default, the currently active runway is determined automatically by analyzing the wind direction. Therefore, you should obviously set the wind speed to be greater zero in your mission.</p>
<p>Note however, there are a few special cases, where automatic detection does not yield the correct or desired result.
For example, there are airports with more than one runway facing in the same direction (usually denoted left and right). In this case, there is obviously no <em>unique</em> result depending on the wind vector.</p>
@@ -1653,7 +1654,7 @@ An explicit correction factor can be set via <a href="##(ATIS).SetRunwayCorrecti
<h2>Nav Aids</h2>
<p>Frequencies or channels of navigation aids can be specified by the user and are then provided as additional information. Unfortunately, it is <strong>not possible</strong> to aquire this information via the DCS API
<p>Frequencies or channels of navigation aids can be specified by the user and are then provided as additional information. Unfortunately, it is <strong>not possible</strong> to acquire this information via the DCS API
we have access to.</p>
<p>As they say, all road lead to Rome but (for me) the easiest way to obtain the available nav aids data of an airport, is to start a mission and click on an airport symbol.</p>
@@ -1747,7 +1748,7 @@ If the parameter <em>runway</em> is omitted (nil) then the frequency is supposed
<h1>Text-To-Speech</h1>
<p>You can enable text-to-speech ATIS information with the <a href="##(ATIS).SetSRS">ATIS.SetSRS</a>() function. This uses <a href="http://dcssimpleradio.com/">SRS</a> (Version >= 1.9.6.0) for broadcasing.
<p>You can enable text-to-speech ATIS information with the <a href="##(ATIS).SetSRS">ATIS.SetSRS</a>() function. This uses <a href="http://dcssimpleradio.com/">SRS</a> (Version >= 1.9.6.0) for broadcasting.
Advantages are that <strong>no sound files</strong> or radio relay units are necessary. Also the issue that FC3 aircraft hear all transmissions will be circumvented.</p>
<p>The <a href="##(ATIS).SetSRS">ATIS.SetSRS</a>() requires you to specify the path to the SRS install directory or more specifically the path to the DCS-SR-ExternalAudio.exe file.</p>