FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
FlightControl
2017-05-29 18:02:57 +02:00
parent 4e29565382
commit 9984055f7d
101 changed files with 1131 additions and 1993 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
docs/Documentation/Identifiable.html
View File

@@ -100,38 +100,15 @@
<div id="content">
<h1>Module <code>Identifiable</code></h1>
<p>This module contains the IDENTIFIABLE class.</p>
<p><strong>Wrapper</strong> -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.</p>
<h1>1) <a href="##(IDENTIFIABLE)">#IDENTIFIABLE</a> class, extends <a href="Object.html##(OBJECT)">Object#OBJECT</a></h1>
<p>The <a href="##(IDENTIFIABLE)">#IDENTIFIABLE</a> class is a wrapper class to handle the DCS Identifiable objects:</p>
<hr/>
<ul>
<li>Support all DCS Identifiable APIs.</li>
<li>Enhance with Identifiable specific APIs not in the DCS Identifiable API set.</li>
<li>Manage the "state" of the DCS Identifiable.</li>
</ul>
<h2>1.1) IDENTIFIABLE constructor:</h2>
<p>The IDENTIFIABLE class provides the following functions to construct a IDENTIFIABLE instance:</p>
<ul>
<li><a href="##(IDENTIFIABLE).New">IDENTIFIABLE.New</a>(): Create a IDENTIFIABLE instance.</li>
</ul>
<h2>1.2) IDENTIFIABLE methods:</h2>
<p>The following methods can be used to identify an identifiable object:</p>
<ul>
<li><a href="##(IDENTIFIABLE).GetName">IDENTIFIABLE.GetName</a>(): Returns the name of the Identifiable.</li>
<li><a href="##(IDENTIFIABLE).IsAlive">IDENTIFIABLE.IsAlive</a>(): Returns if the Identifiable is alive.</li>
<li><a href="##(IDENTIFIABLE).GetTypeName">IDENTIFIABLE.GetTypeName</a>(): Returns the type name of the Identifiable.</li>
<li><a href="##(IDENTIFIABLE).GetCoalition">IDENTIFIABLE.GetCoalition</a>(): Returns the coalition of the Identifiable.</li>
<li><a href="##(IDENTIFIABLE).GetCountry">IDENTIFIABLE.GetCountry</a>(): Returns the country of the Identifiable.</li>
<li><a href="##(IDENTIFIABLE).GetDesc">IDENTIFIABLE.GetDesc</a>(): Returns the descriptor structure of the Identifiable.</li>
</ul>
<h3>Author: <strong>Sven Van de Velde (FlightControl)</strong></h3>
<h3>Contributions:</h3>
<hr/>
@@ -141,19 +118,19 @@
<tr>
<td class="name" nowrap="nowrap"><a href="#IDENTIFIABLE">IDENTIFIABLE</a></td>
<td class="summary">
<h1>IDENTIFIABLE class, extends <a href="Object.html##(OBJECT)">Object#OBJECT</a></h1>
<p>The IDENTIFIABLE class is a wrapper class to handle the DCS Identifiable objects:</p>
<ul>
<li>Support all DCS Identifiable APIs.</li>
</ul>
</td>
</tr>
</table>
<h2><a id="#(IDENTIFIABLE)">Type <code>IDENTIFIABLE</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(IDENTIFIABLE).ClassName">IDENTIFIABLE.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(IDENTIFIABLE).GetCallsign">IDENTIFIABLE:GetCallsign()</a></td>
<td class="summary">
<p>Gets the CallSign of the IDENTIFIABLE, which is a blank by default.</p>
@@ -238,6 +215,27 @@
</dt>
<dd>
<h1>IDENTIFIABLE class, extends <a href="Object.html##(OBJECT)">Object#OBJECT</a></h1>
<p>The IDENTIFIABLE class is a wrapper class to handle the DCS Identifiable objects:</p>
<ul>
<li>Support all DCS Identifiable APIs.</li>
</ul>
<ul>
<li>Enhance with Identifiable specific APIs not in the DCS Identifiable API set.</li>
<li>Manage the "state" of the DCS Identifiable.</li>
</ul>
<h2>IDENTIFIABLE constructor</h2>
<p>The IDENTIFIABLE class provides the following functions to construct a IDENTIFIABLE instance:</p>
<ul>
<li><a href="##(IDENTIFIABLE).New">IDENTIFIABLE.New</a>(): Create a IDENTIFIABLE instance.</li>
</ul>
</dd>
@@ -245,24 +243,7 @@
<h2><a id="#(Identifiable)" >Type <code>Identifiable</code></a></h2>
<h2><a id="#(IDENTIFIABLE)" >Type <code>IDENTIFIABLE</code></a></h2>
<p>The IDENTIFIABLE class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(IDENTIFIABLE).ClassName" >
<strong>IDENTIFIABLE.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h3>Field(s)</h3>
<dl class="function">
<dt>