MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2021-01-12 12:55:17 +00:00
parent 368ac306b9
commit 57ceea156f
25 changed files with 982 additions and 358 deletions

View File

@@ -1800,6 +1800,18 @@ is implemented in the AIRBASE class as <a href="##(AIRBASE).GetName">AIRBASE.Get
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).SetActiveRunway">AIRBASE:SetActiveRunway(iactive)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the active runway in case it cannot be determined by the wind direction.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).SetParkingSpotBlacklist">AIRBASE:SetParkingSpotBlacklist(TerminalIdBlacklist)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set parking spot blacklist.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).SetParkingSpotWhitelist">AIRBASE:SetParkingSpotWhitelist(TerminalIdBlacklist, TerminalIdWhitelist)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set parking spot whitelist.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1868,6 +1880,12 @@ is implemented in the AIRBASE class as <a href="##(AIRBASE).GetName">AIRBASE.Get
<li>AIRBASE.TheChannel.High_Halden</li>
</ul>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE)._CheckParkingLists">AIRBASE:_CheckParkingLists(TerminalID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check black and white lists.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1928,12 +1946,24 @@ is implemented in the AIRBASE class as <a href="##(AIRBASE).GetName">AIRBASE.Get
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).parking">AIRBASE.parking</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Parking spot data.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).parkingBlacklist">AIRBASE.parkingBlacklist</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>List of parking spot terminal IDs <strong>not</strong> considered for spawning.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).parkingByID">AIRBASE.parkingByID</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Parking spot data table with ID as key.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).parkingWhitelist">AIRBASE.parkingWhitelist</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>List of parking spot terminal IDs considered for spawning.</p>
</td>
</tr>
</table>
@@ -3685,6 +3715,17 @@ 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">
#table
<a id="#(AIRBASE).parkingBlacklist" ><strong>AIRBASE.parkingBlacklist</strong></a>
<p>List of parking spot terminal IDs <strong>not</strong> considered for spawning.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -3696,6 +3737,17 @@ 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">
#table
<a id="#(AIRBASE).parkingWhitelist" ><strong>AIRBASE.parkingWhitelist</strong></a>
<p>List of parking spot terminal IDs considered for spawning.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
@@ -5042,6 +5094,164 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AIRBASE).SetParkingSpotBlacklist" ><strong>AIRBASE:SetParkingSpotBlacklist(TerminalIdBlacklist)</strong></a></h2>
</div>
<p>Set parking spot blacklist.</p>
<p>These parking spots will <em>not</em> be used for spawning.
Black listed spots overrule white listed spots.
<strong>NOTE</strong> that terminal IDs are not necessarily the same as those displayed in the mission editor!</p>
<div id= "#Functions##SetParkingSpotBlacklist" 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>AIRBASE</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>TerminalIdBlacklist</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Table of black listed terminal IDs.</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="##(AIRBASE)">#AIRBASE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>AIRBASE:FindByName("Batumi"):SetParkingSpotBlacklist({2, 3, 4}) --Forbit terminal IDs 2, 3, 4</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AIRBASE).SetParkingSpotWhitelist" ><strong>AIRBASE:SetParkingSpotWhitelist(TerminalIdBlacklist, TerminalIdWhitelist)</strong></a></h2>
</div>
<p>Set parking spot whitelist.</p>
<p>Only these spots will be considered for spawning.
Black listed spots overrule white listed spots.
<strong>NOTE</strong> that terminal IDs are not necessarily the same as those displayed in the mission editor!</p>
<div id= "#Functions##SetParkingSpotWhitelist" 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>AIRBASE</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>
#table
<strong><strong>TerminalIdBlacklist</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Table of white listed terminal IDs.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>TerminalIdWhitelist</strong></strong>
</p>
</div>
<div class="w3-half">
<p></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="##(AIRBASE)">#AIRBASE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>AIRBASE:FindByName("Batumi"):SetParkingSpotWhitelist({2, 3, 4}) --Only allow terminal IDs 2, 3, 4</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AIRBASE)._CheckParkingLists" ><strong>AIRBASE:_CheckParkingLists(TerminalID)</strong></a></h2>
</div>
<p>Check black and white lists.</p>
<div id= "#Functions##_CheckParkingLists" 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>AIRBASE</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>TerminalID</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Terminal ID to check.</p>
</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><code>true</code> if this is a valid spot.</p>
</div>
</div>
</div>
</div>
</div>
@@ -5577,6 +5787,17 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(AIRBASE).parkingBlacklist" ><strong>AIRBASE.parkingBlacklist</strong></a>
<p>List of parking spot terminal IDs <strong>not</strong> considered for spawning.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -5588,6 +5809,17 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(AIRBASE).parkingWhitelist" ><strong>AIRBASE.parkingWhitelist</strong></a>
<p>List of parking spot terminal IDs considered for spawning.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
@@ -9319,6 +9551,17 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(AIRBASE).parkingBlacklist" ><strong>AIRBASE.parkingBlacklist</strong></a>
<p>List of parking spot terminal IDs <strong>not</strong> considered for spawning.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -9330,6 +9573,17 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(AIRBASE).parkingWhitelist" ><strong>AIRBASE.parkingWhitelist</strong></a>
<p>List of parking spot terminal IDs considered for spawning.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
@@ -10251,6 +10505,17 @@ If the Identifiable is alive, true is returned. </p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(AIRBASE).parkingBlacklist" ><strong>AIRBASE.parkingBlacklist</strong></a>
<p>List of parking spot terminal IDs <strong>not</strong> considered for spawning.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -10262,6 +10527,17 @@ If the Identifiable is alive, true is returned. </p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(AIRBASE).parkingWhitelist" ><strong>AIRBASE.parkingWhitelist</strong></a>
<p>List of parking spot terminal IDs considered for spawning.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
@@ -10789,6 +11065,17 @@ If the Identifiable is alive, true is returned. </p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(AIRBASE).parkingBlacklist" ><strong>AIRBASE.parkingBlacklist</strong></a>
<p>List of parking spot terminal IDs <strong>not</strong> considered for spawning.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -10800,6 +11087,17 @@ If the Identifiable is alive, true is returned. </p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(AIRBASE).parkingWhitelist" ><strong>AIRBASE.parkingWhitelist</strong></a>
<p>List of parking spot terminal IDs considered for spawning.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>