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:
FlightControl-User
@@ -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>
|
||||
@@ -1820,6 +1853,12 @@ amount of fuel in the group.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).GetTemplateRoutePoints">GROUP:GetTemplateRoutePoints()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns the group template route.points[] (the waypoints) from the <a href="DATABASE.html">DATABASE</a> (_DATABASE object).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).GetThreatLevel">GROUP:GetThreatLevel()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Get threat level of the group.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2060,6 +2099,12 @@ amount of fuel in the group.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).IsHelicopter">GROUP:IsHelicopter()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns if the DCS Group contains Helicopters.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).IsInZone">GROUP:IsInZone(Zone)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Check if any unit of a group is inside a <a href="Zone.html">Zone</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3102,12 +3147,24 @@ amount of fuel in the group.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).GetClimbAngle">GROUP: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="##(GROUP).GetCoord">GROUP: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="##(GROUP).GetCoordinate">GROUP: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="##(GROUP).GetDCSObject">GROUP: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">
|
||||
@@ -3510,6 +3567,18 @@ amount of fuel in the group.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).__">GROUP.__</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="##(GROUP).coordinate">GROUP.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="##(GROUP).pointvec3">GROUP.pointvec3</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Point Vec3 object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -4570,6 +4639,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div class="w3-margin-left">
|
||||
<p>GROUP</p>
|
||||
</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>Number between 0 and 10.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -6159,6 +6239,36 @@ amount of fuel in the group.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(GROUP).GetThreatLevel" ><strong>GROUP:GetThreatLevel()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Get threat level of the group.</p>
|
||||
|
||||
<div id= "#Functions##GetThreatLevel" 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>GROUP</p>
|
||||
</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>Max threat level (a number between 0 and 10).</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -7342,6 +7452,50 @@ If the first <a href="Wrapper.Unit.html">Wrapper.Unit</a> of the group is inacti
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(GROUP).IsInZone" ><strong>GROUP:IsInZone(Zone)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Check if any unit of a group is inside a <a href="Zone.html">Zone</a>.</p>
|
||||
|
||||
<div id= "#Functions##IsInZone" 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>GROUP</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>
|
||||
<a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>
|
||||
<strong><strong>Zone</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The zone to test.</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>Returns true if at least one unit is inside the zone or false if no unit is inside.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -10373,24 +10527,16 @@ If <strong>at least one</strong> detection method is specified, only the methods
|
||||
<div class="w3-margin-left">
|
||||
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>#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>
|
||||
|
||||
@@ -14875,7 +15021,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>
|
||||
@@ -14888,7 +15034,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>
|
||||
@@ -17186,6 +17332,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="#(GROUP).GetCoord" ><strong>GROUP: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>
|
||||
|
||||
@@ -17216,6 +17392,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="#(GROUP).GetDCSObject" ><strong>GROUP: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>
|
||||
|
||||
@@ -17922,7 +18131,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">
|
||||
|
||||
@@ -18197,24 +18406,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>
|
||||
|
||||
@@ -18235,24 +18436,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>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user