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.Static.html
View File

@@ -1651,20 +1651,20 @@ The <a href="Wrapper.Static.html##(STATIC)">Wrapper.Static#STATIC</a> class is a
<h2>STATIC reference methods</h2>
<p>For each DCS Static will have a STATIC wrapper object (instance) within the _<a href="DATABASE.html">DATABASE</a> object.
<p>For each DCS Static will have a STATIC wrapper object (instance) 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 STATIC class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference
<p>The <a href="##(STATIC)">#STATIC</a> class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference
using the Static Name.</p>
<p>Another thing to know is that STATIC objects do not "contain" the DCS Static object.
The STATIc methods will reference the DCS Static object by name when it is needed during API execution.
The <a href="##(STATIC)">#STATIC</a> methods will reference the DCS Static object by name when it is needed during API execution.
If the DCS Static object does not exist or is nil, the STATIC methods will return nil and log an exception in the DCS.log file.</p>
<p>The STATIc class provides the following functions to retrieve quickly the relevant STATIC instance:</p>
<p>The <a href="##(STATIC)">#STATIC</a> class provides the following functions to retrieve quickly the relevant STATIC instance:</p>
<ul>
<li><a href="##(STATIC).FindByName">STATIC.FindByName</a>(): Find a STATIC instance from the _DATABASE object using a DCS Static name.</li>
<li><a href="##(STATIC).FindByName">STATIC.FindByName</a>(): Find a STATIC instance from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using a DCS Static name.</li>
</ul>
<p>IMPORTANT: ONE SHOULD NEVER SANITIZE these STATIC OBJECT REFERENCES! (make the STATIC object references nil).</p>
@@ -2059,7 +2059,7 @@ If the DCS Static object does not exist or is nil, the STATIC methods will retur
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(STATIC).GetVelocity">STATIC: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">
@@ -5404,7 +5404,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<h2><a id="#(STATIC).GetVelocity" ><strong>STATIC: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">