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

14
Documentation/Wrapper.Client.html
View File

@@ -1651,11 +1651,11 @@ The CLIENT class is a wrapper class to handle the DCS Unit objects that have the
<li>Manage the "state" of the DCS Unit.</li>
</ul>
<p>Clients are being used by the <a href="MISSION.html">MISSION</a> class to follow players and register their successes.</p>
<p>Clients are being used by the <a href="Tasking.Mission.html##(MISSION)">Tasking.Mission#MISSION</a> class to follow players and register their successes.</p>
<h2>CLIENT reference methods</h2>
<p>For each DCS Unit having skill level Player or Client, a CLIENT wrapper object (instance) will be created within the _<a href="DATABASE.html">DATABASE</a> object.
<p>For each DCS Unit having skill level Player or Client, a CLIENT wrapper object (instance) will be created within the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>).
This is done at the beginning of the mission (when the mission starts).</p>
<p>The CLIENT class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference
@@ -1668,8 +1668,8 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
<p>The CLIENT class provides the following functions to retrieve quickly the relevant CLIENT instance:</p>
<ul>
<li><a href="##(CLIENT).Find">CLIENT.Find</a>(): Find a CLIENT instance from the _DATABASE object using a DCS Unit object.</li>
<li><a href="##(CLIENT).FindByName">CLIENT.FindByName</a>(): Find a CLIENT instance from the _DATABASE object using a DCS Unit name.</li>
<li><a href="##(CLIENT).Find">CLIENT.Find</a>(): Find a CLIENT 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="##(CLIENT).FindByName">CLIENT.FindByName</a>(): Find a CLIENT 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><strong>IMPORTANT: ONE SHOULD NEVER SANITIZE these CLIENT OBJECT REFERENCES! (make the CLIENT object references nil).</strong></p>
@@ -3478,7 +3478,7 @@ 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).GetVelocity">CLIENT: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">
@@ -6530,7 +6530,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">
@@ -18970,7 +18970,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<h2><a id="#(CLIENT).GetVelocity" ><strong>CLIENT: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">