mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
Applevangelist
@@ -1488,7 +1488,7 @@
|
||||
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Group.html">Wrapper.Group</a></strong></h2></div>
|
||||
</div>
|
||||
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
||||
<p>-- <strong>Wrapper</strong> - GROUP wraps the DCS Class Group objects.</p>
|
||||
<p><strong>Wrapper</strong> - GROUP wraps the DCS Class Group objects.</p>
|
||||
</p></div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -2117,7 +2117,7 @@
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).DoString">UTILS.DoString(s)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Porting in Slmod's dostring - execute a string as LUA code with error handling.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2489,6 +2489,12 @@
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).OneLineSerialize">UTILS.OneLineSerialize(tbl)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Porting in Slmod's serialize_slmod2.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).PlotRacetrack">UTILS.PlotRacetrack(Coordinate, Altitude, Speed, Heading, Leg, Coalition, Color, Alpha, LineType, ReadOnly)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Helper function to plot a racetrack on the F10 Map - curtesy of Buur.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2747,19 +2753,19 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).kpairs">UTILS.kpairs(t, getkey, order)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Here is a customized version of pairs, which I called kpairs because it iterates over the table in a sorted order, based on a function that will determine the keys as reference first.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).rpairs">UTILS.rpairs(t)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Here is a customized version of pairs, which I called rpairs because it iterates over the table in a random order.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).spairs">UTILS.spairs(t, order)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Here is a customized version of pairs, which I called spairs because it iterates over the table in a sorted order.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3594,10 +3600,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<h2><a id="#(UTILS).DoString" ><strong>UTILS.DoString(s)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> porting in Slmod's dostring</p>
|
||||
<p>Porting in Slmod's dostring - execute a string as LUA code with error handling.</p>
|
||||
|
||||
<div id= "#Functions##DoString" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -3609,13 +3612,35 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>s</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>The code as string to be executed</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return values:</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>success If true, code was successfully executed, else false</p>
|
||||
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p>#string:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Outcome Code outcome if successful or error string if not successful</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -6665,6 +6690,152 @@ Returns nil when file cannot be read.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS).PlotRacetrack" ><strong>UTILS.PlotRacetrack(Coordinate, Altitude, Speed, Heading, Leg, Coalition, Color, Alpha, LineType, ReadOnly)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Helper function to plot a racetrack on the F10 Map - curtesy of Buur.</p>
|
||||
|
||||
<div id= "#Functions##PlotRacetrack" 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>UTILS</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>
|
||||
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
||||
<strong><strong>Coordinate</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Altitude</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Altitude in feet</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Speed</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Speed in knots</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Heading</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Heading in degrees</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Leg</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Leg in NM</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. coaltion.side.RED or coaltion.side.BLUE</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#table
|
||||
<strong><strong>Color</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Color of the line in RGB, e.g. {1,0,0} for 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>Alpha</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Transparency factor, between 0.1 and 1</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>LineType</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Line type to be used, line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>ReadOnly</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -9020,10 +9191,7 @@ The data will be a simple comma separated list of name and state etc, with one h
|
||||
<h2><a id="#(UTILS).kpairs" ><strong>UTILS.kpairs(t, getkey, order)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Here is a customized version of pairs, which I called kpairs because it iterates over the table in a sorted order, based on a function that will determine the keys as reference first.</p>
|
||||
<p>Here is a customized version of pairs, which I called kpairs because it iterates over the table in a sorted order, based on a function that will determine the keys as reference first.</p>
|
||||
|
||||
<div id= "#Functions##kpairs" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -9035,33 +9203,66 @@ The data will be a simple comma separated list of name and state etc, with one h
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#table
|
||||
<strong><strong>t</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>The table</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>getkey</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>The function to determine the keys for sorting</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>order</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>(Optional) The sorting function itself</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return values:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#string:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>key The index key</p>
|
||||
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p>#string:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>value The value at the indexed key</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code> for key,value in UTILS.kpairs(mytable, getkeyfunc) do
|
||||
-- your code here
|
||||
end</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9073,10 +9274,7 @@ The data will be a simple comma separated list of name and state etc, with one h
|
||||
<h2><a id="#(UTILS).rpairs" ><strong>UTILS.rpairs(t)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Here is a customized version of pairs, which I called rpairs because it iterates over the table in a random order.</p>
|
||||
<p>Here is a customized version of pairs, which I called rpairs because it iterates over the table in a random order.</p>
|
||||
|
||||
<div id= "#Functions##rpairs" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -9088,13 +9286,40 @@ The data will be a simple comma separated list of name and state etc, with one h
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#table
|
||||
<strong><strong>t</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>The table</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return values:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#string:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>key The index key</p>
|
||||
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p>#string:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>value The value at the indexed key</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code> for key,value in UTILS.rpairs(mytable) do
|
||||
-- your code here
|
||||
end</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9106,10 +9331,7 @@ The data will be a simple comma separated list of name and state etc, with one h
|
||||
<h2><a id="#(UTILS).spairs" ><strong>UTILS.spairs(t, order)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Here is a customized version of pairs, which I called spairs because it iterates over the table in a sorted order.</p>
|
||||
<p>Here is a customized version of pairs, which I called spairs because it iterates over the table in a sorted order.</p>
|
||||
|
||||
<div id= "#Functions##spairs" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -9121,23 +9343,53 @@ The data will be a simple comma separated list of name and state etc, with one h
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#table
|
||||
<strong><strong>t</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>The table</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>order</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>(Optional) The sorting function</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return values:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#string:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>key The index key</p>
|
||||
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p>#string:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>value The value at the indexed key</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code> for key,value in UTILS.spairs(mytable) do
|
||||
-- your code here
|
||||
end</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user