mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
Documentation
This commit is contained in:
@@ -100,32 +100,15 @@
|
||||
<div id="content">
|
||||
<h1>Module <code>Object</code></h1>
|
||||
|
||||
<p>This module contains the OBJECT class.</p>
|
||||
<p><strong>Wrapper</strong> -- OBJECT wraps the DCS Object derived objects.</p>
|
||||
|
||||
|
||||
|
||||
<h1>1) <a href="Object.html##(OBJECT)">Object#OBJECT</a> class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
||||
<p>The <a href="Object.html##(OBJECT)">Object#OBJECT</a> class is a wrapper class to handle the DCS Object objects:</p>
|
||||
<hr/>
|
||||
|
||||
<ul>
|
||||
<li>Support all DCS Object APIs.</li>
|
||||
<li>Enhance with Object specific APIs not in the DCS Object API set.</li>
|
||||
<li>Manage the "state" of the DCS Object.</li>
|
||||
</ul>
|
||||
<h3>Author: <strong>Sven Van de Velde (FlightControl)</strong></h3>
|
||||
|
||||
<h2>1.1) OBJECT constructor:</h2>
|
||||
<p>The OBJECT class provides the following functions to construct a OBJECT instance:</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="Object.html##(OBJECT).New">Object#OBJECT.New</a>(): Create a OBJECT instance.</li>
|
||||
</ul>
|
||||
|
||||
<h2>1.2) OBJECT methods:</h2>
|
||||
<p>The following methods can be used to identify an Object object:</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="Object.html##(OBJECT).GetID">Object#OBJECT.GetID</a>(): Returns the ID of the Object object.</li>
|
||||
</ul>
|
||||
<h3>Contributions:</h3>
|
||||
|
||||
<hr/>
|
||||
|
||||
@@ -135,7 +118,13 @@
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="#OBJECT">OBJECT</a></td>
|
||||
<td class="summary">
|
||||
<h1>OBJECT class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
||||
|
||||
<p>OBJECT handles the DCS Object objects:</p>
|
||||
|
||||
<ul>
|
||||
<li>Support all DCS Object APIs.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -152,12 +141,6 @@
|
||||
<h2><a id="#(OBJECT)">Type <code>OBJECT</code></a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(OBJECT).ClassName">OBJECT.ClassName</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(OBJECT).Destroy">OBJECT:Destroy()</a></td>
|
||||
<td class="summary">
|
||||
<p>Destroys the OBJECT.</p>
|
||||
@@ -194,6 +177,27 @@
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<h1>OBJECT class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
||||
|
||||
<p>OBJECT handles the DCS Object objects:</p>
|
||||
|
||||
<ul>
|
||||
<li>Support all DCS Object APIs.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<ul>
|
||||
<li>Enhance with Object specific APIs not in the DCS Object API set.</li>
|
||||
<li>Manage the "state" of the DCS Object.</li>
|
||||
</ul>
|
||||
|
||||
<h2>OBJECT constructor:</h2>
|
||||
|
||||
<p>The OBJECT class provides the following functions to construct a OBJECT instance:</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="Object.html##(OBJECT).New">Object#OBJECT.New</a>(): Create a OBJECT instance.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
</dd>
|
||||
@@ -220,24 +224,7 @@
|
||||
</dl>
|
||||
|
||||
<h2><a id="#(OBJECT)" >Type <code>OBJECT</code></a></h2>
|
||||
|
||||
<p>The OBJECT class</p>
|
||||
|
||||
<h3>Field(s)</h3>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#string</em>
|
||||
<a id="#(OBJECT).ClassName" >
|
||||
<strong>OBJECT.ClassName</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h3>Field(s)</h3>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user