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

Fix of bug #97

Browse Source 
-- Fixed GROUP:IsAlive()
--- Returns if the Group is alive.
-- The Group must:
--
--   * Exist at run-time.
--   * Has at least one unit.
--
-- When the first @{Unit} of the Group is active, it will return true.
-- If the first @{Unit} of the Group is inactive, it will return false.
--
-- @param #GROUP self
-- @return #boolean true if the Group is alive and active.
-- @return #boolean false if the Group is alive but inactive.
-- @return #nil if the group does not exist anymore.

-- Fixed Identifiable:IsAlive()
--- Returns if the Identifiable is alive.
-- If the Identifiable is not alive, nil is returned.
-- If the Identifiable is alive, true is returned.
-- @param #IDENTIFIABLE self
-- @return #boolean true if Identifiable is alive.
-- @return #nil if the Identifiable is not existing or is not alive.

-- Fixed UNIT:IsAlive()
--- Returns if the Unit is alive.
-- If the Unit is not alive, nil is returned.
-- If the Unit is alive and active, true is returned.
-- If the Unit is alive but not active, false is returned.
-- @param #UNIT self
-- @return #boolean true if Unit is alive and active.
-- @return #boolean false if Unit is alive but not active.
-- @return #nil if the Unit is not existing or is not alive.

-- Updated all test missions, as this is a core change.
This commit is contained in:
FlightControl
2017-03-27 10:34:51 +02:00
parent 3a453ca7d9
commit 0ebcbb4879
150 changed files with 391 additions and 271 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/Documentation/Group.html
View File

@@ -73,10 +73,12 @@
<div id="content">
<h1>Module <code>Group</code></h1>
<p>This module contains the GROUP class.</p>
<p><strong>Wrapper</strong> -- GROUP is a wrapper class for the DCS Class Group.</p>
<hr/>
<p>The <a href="##(GROUP)">#GROUP</a> class is a wrapper class to handle the DCS Group objects:</p>
<ul>
@@ -138,8 +140,6 @@
<td class="summary">
<h1>GROUP class, extends <a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a></h1>
<h2>GROUP reference methods</h2>
<p>For each DCS Group object alive within a running mission, a GROUP wrapper object (instance) will be created within the _<a href="DATABASE.html">DATABASE</a> object.</p>
</td>
</tr>
@@ -355,7 +355,7 @@
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).IsAlive">GROUP:IsAlive()</a></td>
<td class="summary">
<p>Returns if the DCS Group is alive.</p>
<p>Returns if the Group is alive.</p>
</td>
</tr>
<tr>
@@ -475,8 +475,6 @@
<h1>GROUP class, extends <a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a></h1>
<h2>GROUP reference methods</h2>
<p>For each DCS Group object alive within a running mission, a GROUP wrapper object (instance) will be created within the _<a href="DATABASE.html">DATABASE</a> object.</p>
@@ -1293,16 +1291,41 @@ true if DCS Group contains AirPlanes.</p>
</dt>
<dd>
<p>Returns if the DCS Group is alive.</p>
<p>Returns if the Group is alive.</p>
<p>When the group exists at run-time, this method will return true, otherwise false.</p>
<p>The Group must:</p>
<h3>Return value</h3>
<ul>
<li>Exist at run-time.</li>
<li>Has at least one unit.</li>
</ul>
<p>When the first <a href="Unit.html">Unit</a> of the Group is active, it will return true.
If the first <a href="Unit.html">Unit</a> of the Group is inactive, it will return false.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em>#boolean:</em>
true if the DCS Group is alive.</p>
true if the Group is alive and active.</p>
</li>
<li>
<p><em>#boolean:</em>
false if the Group is alive but inactive.</p>
</li>
<li>
<p><em>#nil:</em>
if the group does not exist anymore.</p>
</li>
</ol>
</dd>
</dl>
<dl class="function">