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
2022-10-23 14:53:42 +00:00
parent ffeb91ddff
commit f3e47adf8e
57 changed files with 1187 additions and 967 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/Wrapper.Unit.html
View File

@@ -1636,7 +1636,7 @@ Controls a network of short range air/missile defense groups.</p>
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>UNIT</strong></h2></p></td>
<td class="style="width:60%;">
<p>For each DCS Unit object alive within a running mission, a UNIT wrapper object (instance) will be created within the _<a href="DATABASE.html">DATABASE</a> object.</p>
<p>For each DCS Unit object alive within a running mission, a UNIT wrapper object (instance) will be created within the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>).</p>
</td>
</tr>
</table>
@@ -1647,10 +1647,10 @@ Controls a network of short range air/missile defense groups.</p>
<a href="##(UNIT)">#UNIT</a>
<a id="UNIT" ><strong>UNIT</strong></a>
<p>For each DCS Unit object alive within a running mission, a UNIT wrapper object (instance) will be created within the _<a href="DATABASE.html">DATABASE</a> object.</p>
<p>For each DCS Unit object alive within a running mission, a UNIT wrapper object (instance) will be created within the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>).</p>
<p>This is done at the beginning of the mission (when the mission starts), and dynamically when new DCS Unit objects are spawned (using the <a href="SPAWN.html">SPAWN</a> class).</p>
<p>This is done at the beginning of the mission (when the mission starts), and dynamically when new DCS Unit objects are spawned (using the <a href="Core.Spawn.html">Core.Spawn</a> class).</p>
<p>The UNIT class <strong>does not contain a :New()</strong> method, rather it provides <strong>:Find()</strong> methods to retrieve the object reference
using the DCS Unit or the DCS UnitName.</p>
@@ -1662,8 +1662,8 @@ If the DCS Unit object does not exist or is nil, the UNIT methods will return ni
<p>The UNIT class provides the following functions to retrieve quickly the relevant UNIT instance:</p>
<ul>
<li><a href="##(UNIT).Find">UNIT.Find</a>(): Find a UNIT instance from the _DATABASE object using a DCS Unit object.</li>
<li><a href="##(UNIT).FindByName">UNIT.FindByName</a>(): Find a UNIT instance from the _DATABASE object using a DCS Unit name.</li>
<li><a href="##(UNIT).Find">UNIT.Find</a>(): Find a UNIT instance from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using a DCS Unit object.</li>
<li><a href="##(UNIT).FindByName">UNIT.FindByName</a>(): Find a UNIT instance from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using a DCS Unit name.</li>
</ul>
<p>IMPORTANT: ONE SHOULD NEVER SANITIZE these UNIT OBJECT REFERENCES! (make the UNIT object references nil).</p>
@@ -3270,7 +3270,7 @@ If you want to obtain the complete <strong>3D position</strong> including orient
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).GetVelocity">UNIT:GetVelocity()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the a <a href="Velocity.html">Velocity</a> object from the POSITIONABLE.</p>
<p>Returns the <a href="Core.Velocity.html">Core.Velocity</a> object from the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
@@ -5069,7 +5069,7 @@ If any unit in the group is destroyed, the numbers of another units will not be
<p>A prefix name is a part of the name before a '#'-sign.
DCS Units spawned with the <a href="SPAWN.html">SPAWN</a> class contain a '#'-sign to indicate the end of the (base) DCS Unit name.
DCS Units spawned with the <a href="Core.Spawn.html##(SPAWN)">Core.Spawn#SPAWN</a> class contain a '#'-sign to indicate the end of the (base) DCS Unit name.
The spawn sequence number and unit number are contained within the name after the '#' sign. </p>
<div id= "#Functions##GetPrefix" class="w3-show w3-white">
@@ -17217,7 +17217,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<h2><a id="#(UNIT).GetVelocity" ><strong>UNIT:GetVelocity()</strong></a></h2>
</div>
<p>Returns the a <a href="Velocity.html">Velocity</a> object from the POSITIONABLE.</p>
<p>Returns the <a href="Core.Velocity.html">Core.Velocity</a> object from the POSITIONABLE.</p>
<div id= "#Functions##GetVelocity" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">