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:
Applevangelist
2021-12-12 12:58:58 +00:00
parent 42e90fc163
commit c3ac7e9d66
29 changed files with 811 additions and 886 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
Documentation/Wrapper.Client.html
View File

@@ -3074,7 +3074,7 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetBoundingRadius">CLIENT:GetBoundingRadius(mindist)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetBoundingRadius">CLIENT:GetBoundingRadius(MinDist)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the bounding radius of the underlying POSITIONABLE DCS Object.</p>
</td>
@@ -3100,13 +3100,13 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCoord">CLIENT: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>
<p>Returns a reference to 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="##(CLIENT).GetCoordinate">CLIENT: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>
<p>Returns a new COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3230,7 +3230,7 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetRelativeVelocity">CLIENT:GetRelativeVelocity(positionable)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetRelativeVelocity">CLIENT:GetRelativeVelocity(Positionable)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get relative velocity with respect to another POSITIONABLE.</p>
</td>
@@ -4232,7 +4232,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -5346,7 +5346,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -7610,7 +7610,7 @@ If the Unit is alive but not active, false is returned. </p>
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -16171,7 +16171,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -16716,7 +16716,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetBoundingRadius" ><strong>CLIENT:GetBoundingRadius(mindist)</strong></a></h2>
<h2><a id="#(CLIENT).GetBoundingRadius" ><strong>CLIENT:GetBoundingRadius(MinDist)</strong></a></h2>
</div>
<p>Get the bounding radius of the underlying POSITIONABLE DCS Object.</p>
@@ -16732,12 +16732,12 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
<div class="w3-half">
<p>
#number
<strong><strong>mindist</strong></strong>
<strong><strong>MinDist</strong></strong>
</p>
</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>
@@ -16869,10 +16869,13 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
<h2><a id="#(CLIENT).GetCoord" ><strong>CLIENT:GetCoord()</strong></a></h2>
</div>
<p>Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<p>Returns a reference to a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<p>If the POSITIONABLE has a COORDINATE OBJECT set, it updates it. If not, it creates a new COORDINATE object.</p>
<p>This function works similar to POSITIONABLE.GetCoordinate(), however, this function caches, updates and re-uses the same COORDINATE object stored
within the POSITIONABLE. This has higher performance, but comes with all considerations associated with the possible referencing to the same COORDINATE object.
This should only be used when performance is critical and there is sufficient awareness of the possible pitfalls. However, in most instances, GetCoordinate() is
preferred as it will return a fresh new COORDINATE and thus avoid potentially unexpected issues.</p>
<div id= "#Functions##GetCoord" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -16887,8 +16890,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>The COORDINATE of the POSITIONABLE.
TODO: Seems to have been introduced with Airboss. Should it be renamed to better reflect the difference to "GetCoordinate" (it is currently ambiguous)? Or perhaps just be a switch in the the GetCoordinate function; forceCoordinateUpate?</p>
<p>A reference to the COORDINATE object of the POSITIONABLE.</p>
</div>
</div>
@@ -16903,7 +16905,7 @@ TODO: Seems to have been introduced with Airboss. Should it be renamed to better
<h2><a id="#(CLIENT).GetCoordinate" ><strong>CLIENT:GetCoordinate()</strong></a></h2>
</div>
<p>Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<p>Returns a new COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<div id= "#Functions##GetCoordinate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -16918,7 +16920,7 @@ TODO: Seems to have been introduced with Airboss. Should it be renamed to better
</div>
<div class="w3-half">
<p>The COORDINATE of the POSITIONABLE.</p>
<p>A new COORDINATE object of the POSITIONABLE.</p>
</div>
</div>
@@ -17851,7 +17853,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetRelativeVelocity" ><strong>CLIENT:GetRelativeVelocity(positionable)</strong></a></h2>
<h2><a id="#(CLIENT).GetRelativeVelocity" ><strong>CLIENT:GetRelativeVelocity(Positionable)</strong></a></h2>
</div>
<p>Get relative velocity with respect to another POSITIONABLE.</p>
@@ -17867,7 +17869,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<div class="w3-half">
<p>
<a href="##(POSITIONABLE)">#POSITIONABLE</a>
<strong><strong>positionable</strong></strong>
<strong><strong>Positionable</strong></strong>
</p>
</div>
<div class="w3-half">
@@ -19828,7 +19830,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -20502,7 +20504,7 @@ If the Identifiable is alive, true is returned. </p>
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -20782,7 +20784,7 @@ If the Identifiable is alive, true is returned. </p>
<p> Alive.</p>
<p> Alive2.</p>
</div>