weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
FlightControl-User
2020-09-01 22:12:11 +00:00
parent e86496765e
commit d697cb3b87
28 changed files with 944 additions and 647 deletions
Download Patch File Download Diff File Expand all files Collapse all files

189
Documentation/Wrapper.Client.html
View File

@@ -5243,24 +5243,16 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>#string:</p>
</div>
<div class="w3-half">
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>The Callsign of the Unit.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
@@ -5688,14 +5680,6 @@ The spawn sequence number and unit number are contained within the name after th
<p>The object of the radar's interest. Not nil only if at least one radar of the unit is tracking a target.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
@@ -5750,24 +5734,16 @@ The spawn sequence number and unit number are contained within the name after th
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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##(Unit.Sensors)">DCS#Unit.Sensors</a>:</p>
</div>
<div class="w3-half">
<div class="w3-half">
<p><a href="DCS.html##(Unit.Sensors)">DCS#Unit.Sensors</a>:</p>
</div>
<div class="w3-half">
<p>Table of sensors. </p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
@@ -6178,24 +6154,16 @@ The spawn sequence number and unit number are contained within the name after th
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>#boolean:</p>
</div>
<div class="w3-half">
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>returns true if the unit is SEADable. </p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
@@ -6227,24 +6195,16 @@ The spawn sequence number and unit number are contained within the name after th
<p></p>
</div>
</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>#boolean:</p>
</div>
<div class="w3-half">
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>returns true if the unit has specified types of sensors. This function is more preferable than Unit.getSensors() if you don't want to get information about all the unit's sensors, and just want to check if the unit has specified types of sensors. </p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
@@ -6295,24 +6255,16 @@ The spawn sequence number and unit number are contained within the name after th
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>#boolean:</p>
</div>
<div class="w3-half">
<p>true if Unit is activated.</p>
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p><code>true</code> if Unit is activated. <code>nil</code> The DCS Unit is not existing or alive. </p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
@@ -6338,32 +6290,16 @@ If the Unit is alive but not active, false is returned. </p>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>#boolean:</p>
</div>
<div class="w3-half">
<p>true if Unit is alive and active.</p>
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p><code>true</code> if Unit is alive and active. <code>false</code> if Unit is alive but not active. <code>nil</code> if the Unit is not existing or is not alive.</p>
</div>
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>false if Unit is alive but not active.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>if the Unit is not existing or is not alive. </p>
</div>
</div>
</div>
</div>
@@ -15524,7 +15460,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
<p>The DCS Unit is not existing or alive.</p>
</div>
</div>
@@ -15687,7 +15623,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
@@ -15785,7 +15721,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
@@ -15818,7 +15754,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>(Optional) If bounding box is smaller than this value, mindist is returned. </p>
<p>(Optional) If bounding box is smaller than this value, mindist is returned.</p>
</div>
</div>
@@ -15829,7 +15765,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>The bounding radius of the POSITIONABLE or #nil if the POSITIONABLE is not existing or alive. </p>
<p>The bounding radius of the POSITIONABLE or #nil if the POSITIONABLE is not existing or alive.</p>
</div>
</div>
@@ -16088,7 +16024,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
@@ -16458,7 +16394,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
<p>X, Y, Z values are unit vectors defining the objects orientation.
X is the orientation parallel to the movement of the object, Z perpendicular and Y vertical orientation. </p>
X is the orientation parallel to the movement of the object, Z perpendicular and Y vertical orientation.</p>
<div id= "#Functions##GetOrientation" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -16656,7 +16592,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
@@ -16694,7 +16630,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
@@ -16766,7 +16702,7 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
@@ -16849,13 +16785,12 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
-- If Radius is ignored, returns the DCS#Vec3 of first UNIT of the GROUP</code></pre>
<pre class="example"><code>-- If Radius is ignored, returns the DCS#Vec3 of first UNIT of the GROUP</code></pre>
</div>
@@ -17036,7 +16971,7 @@ Coordinates are dependent on the position of the maps origin.</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>
<p>The 3D point vector of the POSITIONABLE or <code>nil</code> if it is not existing or alive.</p>
</div>
</div>
@@ -17074,7 +17009,7 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
@@ -17202,7 +17137,7 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
@@ -17314,7 +17249,7 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
@@ -17352,7 +17287,7 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive. </p>
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>