MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2023-01-08 18:44:25 +00:00
parent df763f0937
commit 0e02e872c0
28 changed files with 934 additions and 868 deletions

View File

@@ -2219,6 +2219,12 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(COORDINATE).GetLandHeight">COORDINATE:GetLandHeight()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the height of the land at the coordinate.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(COORDINATE).GetMagneticDeclination">COORDINATE:GetMagneticDeclination(Month, Year)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the magnetic declination at the given coordinate.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3975,6 +3981,12 @@ 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="##(POINT_VEC2).GetLandHeight">POINT_VEC2:GetLandHeight()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the height of the land at the coordinate.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(POINT_VEC2).GetMagneticDeclination">POINT_VEC2:GetMagneticDeclination(Month, Year)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the magnetic declination at the given coordinate.</p>
</td>
</tr>
<tr class="w3-border">
@@ -7860,6 +7872,67 @@ 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="#(COORDINATE).GetMagneticDeclination" ><strong>COORDINATE:GetMagneticDeclination(Month, Year)</strong></a></h2>
</div>
<p>Returns the magnetic declination at the given coordinate.</p>
<p>NOTE that this needs <code>require</code> to be available so you need to desanitize the <code>MissionScripting.lua</code> file in your DCS/Scrips folder.
If <code>require</code> is not available, a constant value for the whole map.</p>
<div id= "#Functions##GetMagneticDeclination" 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>COORDINATE</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>Month</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) The month at which the declination is calculated. Default is the mission month.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Year</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) The year at which the declination is calculated. Default is the mission year.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Magnetic declination in degrees.</p>
</div>
</div>
</div>
</div>
</div>
@@ -17652,6 +17725,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>
@@ -18450,6 +18534,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>
@@ -20817,6 +20912,67 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(POINT_VEC2).GetMagneticDeclination" ><strong>POINT_VEC2:GetMagneticDeclination(Month, Year)</strong></a></h2>
</div>
<p>Returns the magnetic declination at the given coordinate.</p>
<p>NOTE that this needs <code>require</code> to be available so you need to desanitize the <code>MissionScripting.lua</code> file in your DCS/Scrips folder.
If <code>require</code> is not available, a constant value for the whole map.</p>
<div id= "#Functions##GetMagneticDeclination" 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><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a></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>Month</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) The month at which the declination is calculated. Default is the mission month.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Year</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) The year at which the declination is calculated. Default is the mission year.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Magnetic declination in degrees.</p>
</div>
</div>
</div>
</div>
</div>
@@ -26897,6 +27053,17 @@ Creates a line on the F10 map from one point to another.</p>
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>