weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2026-08-11 19:56:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2022-06-13 13:40:50 +00:00
parent 452bc62ebc
commit d8794379ee
24 changed files with 946 additions and 328 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/Core.Beacon.html
+25 -26
View File
@@ -1557,7 +1557,7 @@ Controls a network of short range air/missile defense groups.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BEACON).AATACAN">BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Activates a TACAN BEACON on an Aircraft.</p>
<p>DEPRECATED: Please use <a href="BEACON.html">BEACON</a>() instead.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1606,7 +1606,7 @@ This uses the very generic singleton function "trigger.action.radioTransmission(
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BEACON).StopRadioBeacon">BEACON:StopRadioBeacon()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the AA TACAN BEACON</p>
<p>Stop the Radio Beacon</p>
</td>
</tr>
<tr class="w3-border">
@@ -2273,7 +2273,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BEACON.System).VOR">BEACON.System.VOR</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Very High Frequency Omnidirectional Range</p>
<p>Very High Frequency Omni-Directional Range</p>
</td>
</tr>
<tr class="w3-border">
@@ -2285,7 +2285,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BEACON.System).VORTAC">BEACON.System.VORTAC</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Radio-based navigational aid for aircraft pilots consisting of a co-located VHF omnidirectional range (VOR) beacon and a tactical air navigation system (TACAN) beacon.</p>
<p>Radio-based navigational aid for aircraft pilots consisting of a co-located VHF omni-directional range (VOR) beacon and a tactical air navigation system (TACAN) beacon.</p>
</td>
</tr>
</table>
@@ -2445,14 +2445,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>After attaching a <a href="##(BEACON)">#BEACON</a> to your <a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a>, you need to select the right function to activate the kind of beacon you want.</p>
<p>There are two types of BEACONs available : the AA TACAN Beacon and the general purpose Radio Beacon.
<p>There are two types of BEACONs available : the (aircraft) TACAN Beacon and the general purpose Radio Beacon.
Note that in both case, you can set an optional parameter : the <code>BeaconDuration</code>. This can be very usefull to simulate the battery time if your BEACON is
attach to a cargo crate, for exemple.</p>
attach to a cargo crate, for exemple. </p>
<h2>AA TACAN Beacon usage</h2>
<h2>Aircraft TACAN Beacon usage</h2>
<p>This beacon only works with airborne <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> or a <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>. Use <a href="##(BEACON)">#BEACON</a>() to set the beacon parameters and start the beacon.
Use @#BEACON:StopAATACAN}() to stop it.</p>
Use @#BEACON:StopRadioBeacon}() to stop it.</p>
<h2>General Purpose Radio Beacon usage</h2>
@@ -2528,6 +2528,9 @@ Use <a href="##(BEACON)">#BEACON</a>() to stop it.</p>
<h2><a id="#(BEACON).AATACAN" ><strong>BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)</strong></a></h2>
</div>
<p>DEPRECATED: Please use <a href="BEACON.html">BEACON</a>() instead.</p>
<p>Activates a TACAN BEACON on an Aircraft.</p>
<div id= "#Functions##AATACAN" class="w3-show w3-white">
@@ -2601,13 +2604,11 @@ Use <a href="##(BEACON)">#BEACON</a>() to stop it.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
-- Let's create a TACAN Beacon for a tanker
local myUnit = UNIT:FindByName("MyUnit")
<pre class="example"><code>-- Let's create a TACAN Beacon for a tanker
local myUnit = UNIT:FindByName("MyUnit")
local myBeacon = myUnit:GetBeacon() -- Creates the beacon
myBeacon:AATACAN(20, "TEXACO", true) -- Activate the beacon
</code></pre>
myBeacon:AATACAN(20, "TEXACO", true) -- Activate the beacon</code></pre>
</div>
@@ -2779,13 +2780,11 @@ myBeacon:AATACAN(20, "TEXACO", true) -- Activate the beacon
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
-- Let's create a TACAN Beacon for a tanker
local myUnit = UNIT:FindByName("MyUnit")
<pre class="example"><code>-- Let's create a TACAN Beacon for a tanker
local myUnit = UNIT:FindByName("MyUnit")
local myBeacon = myUnit:GetBeacon() -- Creates the beacon
myBeacon:ActivateTACAN(20, "Y", "TEXACO", true) -- Activate the beacon
</code></pre>
myBeacon:ActivateTACAN(20, "Y", "TEXACO", true) -- Activate the beacon</code></pre>
</div>
@@ -2831,7 +2830,7 @@ If you want to create a BEACON, you probably should use <a href="Wrapper.Positio
</div>
<div class="w3-half">
<p>Beacon object or #nil if the POSITIONABLE is invalid.</p>
<p>Beacon object or #nil if the positionable is invalid.</p>
</div>
</div>
@@ -2850,8 +2849,8 @@ If you want to create a BEACON, you probably should use <a href="Wrapper.Positio
This uses the very generic singleton function "trigger.action.radioTransmission()" provided by DCS to broadcast a sound file on a specific frequency.</p>
<p>Although any frequency could be used, only 2 DCS Modules can home on radio beacons at the time of writing : the Huey and the Mi-8.
They can home in on these specific frequencies :
<p>Although any frequency could be used, only a few DCS Modules can home on radio beacons at the time of writing, i.e. the Mi-8, Huey, Gazelle etc.
The following e.g. can home in on these specific frequencies :
<em> <strong>Mi8</strong>
</em> R-828 -> 20-60MHz
* ARKUD -> 100-150MHz (canal 1 : 114166, canal 2 : 114333, canal 3 : 114583, canal 4 : 121500, canal 5 : 123100, canal 6 : 124100) AM
@@ -2993,7 +2992,7 @@ UnitBeacon:RadioBeacon("MySoundFileSOS.ogg", 40, radio.modulation.FM, 20, 5*60)<
<h2><a id="#(BEACON).StopRadioBeacon" ><strong>BEACON:StopRadioBeacon()</strong></a></h2>
</div>
<p>Stops the AA TACAN BEACON</p>
<p>Stop the Radio Beacon</p>
<div id= "#Functions##StopRadioBeacon" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -3061,7 +3060,7 @@ UnitBeacon:RadioBeacon("MySoundFileSOS.ogg", 40, radio.modulation.FM, 20, 5*60)<
</div>
<div class="w3-half">
<p>Frequency</p>
<p>Frequecy</p>
</div>
<div class="w3-half">
@@ -6577,7 +6576,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
#number
<a id="#(BEACON.System).VOR" ><strong>BEACON.System.VOR</strong></a>
<p>Very High Frequency Omnidirectional Range</p>
<p>Very High Frequency Omni-Directional Range</p>
</div>
@@ -6599,7 +6598,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
#number
<a id="#(BEACON.System).VORTAC" ><strong>BEACON.System.VORTAC</strong></a>
<p>Radio-based navigational aid for aircraft pilots consisting of a co-located VHF omnidirectional range (VOR) beacon and a tactical air navigation system (TACAN) beacon.</p>
<p>Radio-based navigational aid for aircraft pilots consisting of a co-located VHF omni-directional range (VOR) beacon and a tactical air navigation system (TACAN) beacon.</p>
</div>
@@ -6614,7 +6613,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<div id= "#Types##BEACON.Type" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p>Beacon types supported by DCS.</p>
<p>Beacon types supported by DCS. </p>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>