MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2020-08-29 20:18:04 +00:00
parent 5e09807ca2
commit e78fc537c9
120 changed files with 46952 additions and 4751 deletions

View File

@@ -664,6 +664,17 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Management of spotting logistics, that can be activated and deactivated upon command.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/CORE_Timer.png" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Timer.html">Core.Timer</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Timer scheduler.</p>
</p></div>
</div>
</div>
@@ -1173,6 +1184,17 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> - Creates and manages player TASK_ZONE_CAPTURE tasks.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.PROFILER.html">Utilities.PROFILER</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Utils</strong> - Lua Profiler.</p>
</p></div>
</div>
</div>
@@ -1239,6 +1261,17 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Wrapper</strong> -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/Wrapper_Marker.png" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Marker.html">Wrapper.Marker</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Wrapper</strong> - Markers On the F10 map.</p>
</p></div>
</div>
</div>
@@ -2475,12 +2508,24 @@ The method <a href="##(CONTROLLABLE).SetTaskWaypoint">CONTROLLABLE.SetTaskWaypoi
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).GetClimbAngle">CONTROLLABLE:GetClimbAngle()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the unit's climb or descent angle.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).GetCoord">CONTROLLABLE:GetCoord()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).GetCoordinate">CONTROLLABLE:GetCoordinate()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).GetDCSObject">CONTROLLABLE:GetDCSObject()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the DCS object.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2883,6 +2928,18 @@ The method <a href="##(CONTROLLABLE).SetTaskWaypoint">CONTROLLABLE.SetTaskWaypoi
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).__">CONTROLLABLE.__</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).coordinate">CONTROLLABLE.coordinate</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Coordinate object.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).pointvec3">CONTROLLABLE.pointvec3</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Point Vec3 object.</p>
</td>
</tr>
</table>
@@ -5569,24 +5626,16 @@ If <strong>at least one</strong> detection method is specified, only the methods
<div class="w3-margin-left">
<p>CONTROLLABLE</p>
</div>
<h2><strong>Return values:</strong></h2>
<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>The controllable health value (unit or group average).</p>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>The controllable health value (unit or group average) or <code>nil</code> if the controllable does not exist.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The controllable is not existing or alive.</p>
</div>
</div>
</div>
</div>
@@ -10071,7 +10120,7 @@ If the task is assigned to the controllable lead unit will be a FAC.</p>
</div>
<div class="w3-half">
<p>Frequency used to communicate with the FAC.</p>
<p>Frequency in MHz used to communicate with the FAC. Default 133 MHz.</p>
</div>
</div>
@@ -10084,7 +10133,7 @@ If the task is assigned to the controllable lead unit will be a FAC.</p>
</div>
<div class="w3-half">
<p>Modulation of radio for communication.</p>
<p>Modulation of radio for communication. Default 0=AM.</p>
</div>
</div>
@@ -12294,6 +12343,36 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CONTROLLABLE).GetCoord" ><strong>CONTROLLABLE:GetCoord()</strong></a></h2>
</div>
<p>Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<div id= "#Functions##GetCoord" 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="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</p>
</div>
<div class="w3-half">
<p>The COORDINATE of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
@@ -12324,6 +12403,39 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CONTROLLABLE).GetDCSObject" ><strong>CONTROLLABLE:GetDCSObject()</strong></a></h2>
</div>
<p>Returns the DCS object.</p>
<p>Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.</p>
<div id= "#Functions##GetDCSObject" 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="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Object)">DCS#Object</a>:</p>
</div>
<div class="w3-half">
<p>The DCS object.</p>
</div>
</div>
</div>
</div>
</div>
@@ -13030,7 +13142,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Position)">DCS#Position</a>:</p>
<p><a href="DCS.html##(Position3)">DCS#Position3</a>:</p>
</div>
<div class="w3-half">
@@ -13305,24 +13417,16 @@ Coordinates are dependent on the position of the maps origin.</p>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec2)">DCS#Vec2</a>:</p>
</div>
<div class="w3-half">
<p>The 2D point vector of the POSITIONABLE.</p>
<div class="w3-half">
<p><a href="DCS.html##(Vec2)">DCS#Vec2</a>:</p>
</div>
<div class="w3-half">
<p>The 2D point vector of the POSITIONABLE or #nil if it is not existing or alive.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
</div>
</div>
</div>
</div>
@@ -13343,24 +13447,16 @@ Coordinates are dependent on the position of the maps origin.</p>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>The 3D point vector of the POSITIONABLE.</p>
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>The 3D point vector of the POSITIONABLE or <code>nil</code> if it is not existing or alive. </p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
</div>
</div>
</div>
</div>