mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
Documentation Update
This commit is contained in:
Grey-Echo
@@ -349,6 +349,18 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(SET_BASE).Filter">SET_BASE.Filter</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SET_BASE).FilterCrashes">SET_BASE:FilterCrashes()</a></td>
|
||||
<td class="summary">
|
||||
<p>Starts the filtering of the Crash events for the collection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SET_BASE).FilterDeads">SET_BASE:FilterDeads()</a></td>
|
||||
<td class="summary">
|
||||
<p>Starts the filtering of the Dead events for the collection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -715,6 +727,24 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(SET_GROUP).AddInDatabase">SET_GROUP:AddInDatabase(Event)</a></td>
|
||||
<td class="summary">
|
||||
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SET_GROUP).AllCompletelyInZone">SET_GROUP:AllCompletelyInZone(ZoneObject, Zone)</a></td>
|
||||
<td class="summary">
|
||||
<p>Iterate the SET_GROUP and return true if all the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> are completely in the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SET_GROUP).AnyCompletelyInZone">SET_GROUP:AnyCompletelyInZone(ZoneObject, Zone)</a></td>
|
||||
<td class="summary">
|
||||
<p>Iterate the SET_GROUP and return true if at least one of the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> is completely inside the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SET_GROUP).AnyPartlyInZone">SET_GROUP:AnyPartlyInZone(ZoneObject, Zone)</a></td>
|
||||
<td class="summary">
|
||||
<p>Iterate the SET_GROUP and return true if at least one <a href="##(UNIT)">#UNIT</a> of one <a href="GROUP.html">GROUP</a> of the <a href="SET_GROUP.html">SET_GROUP</a> is in <a href="ZONE.html">ZONE</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -799,6 +829,14 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(SET_GROUP).New">SET_GROUP:New()</a></td>
|
||||
<td class="summary">
|
||||
<p>Creates a new SET_GROUP object, building a set of groups belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SET_GROUP).NoneInZone">SET_GROUP:NoneInZone(ZoneObject, Zone)</a></td>
|
||||
<td class="summary">
|
||||
<p>Iterate the SET_GROUP and return true if no <a href="GROUP.html">GROUP</a> of the <a href="SET_GROUP.html">SET_GROUP</a> is in <a href="ZONE.html">ZONE</a>
|
||||
This could also be achieved with <code>not SET_GROUP:AnyPartlyInZone(Zone)</code>, but it's easier for the
|
||||
mission designer to add a dedicated method</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -1856,6 +1894,42 @@ Count</p>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(SET_BASE).FilterCrashes" >
|
||||
<strong>SET_BASE:FilterCrashes()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Starts the filtering of the Crash events for the collection.</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(SET_BASE)">#SET_BASE</a>:</em>
|
||||
self</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(SET_BASE).FilterDeads" >
|
||||
<strong>SET_BASE:FilterDeads()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Starts the filtering of the Dead events for the collection.</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(SET_BASE)">#SET_BASE</a>:</em>
|
||||
self</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -3412,6 +3486,135 @@ The GROUP</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(SET_GROUP).AllCompletelyInZone" >
|
||||
<strong>SET_GROUP:AllCompletelyInZone(ZoneObject, Zone)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Iterate the SET_GROUP and return true if all the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> are completely in the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a></p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a> ZoneObject </em></code>:
|
||||
The Zone to be tested for.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Zone </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#boolean:</em>
|
||||
true if all the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> are completly in the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>, false otherwise</p>
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<pre class="example"><code>local MyZone = ZONE:New("Zone1")
|
||||
local MySetGroup = SET_GROUP:New()
|
||||
MySetGroup:AddGroupsByName({"Group1", "Group2"})
|
||||
|
||||
if MySetGroup:AllCompletelyInZone(MyZone) then
|
||||
MESSAGE:New("All the SET's GROUP are in zone !", 10):ToAll()
|
||||
else
|
||||
MESSAGE:New("Some or all SET's GROUP are outside zone !", 10):ToAll()
|
||||
end</code></pre>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(SET_GROUP).AnyCompletelyInZone" >
|
||||
<strong>SET_GROUP:AnyCompletelyInZone(ZoneObject, Zone)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Iterate the SET_GROUP and return true if at least one of the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> is completely inside the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a></p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a> ZoneObject </em></code>:
|
||||
The Zone to be tested for.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Zone </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#boolean:</em>
|
||||
true if at least one of the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> is completly inside the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>, false otherwise.</p>
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<pre class="example"><code>local MyZone = ZONE:New("Zone1")
|
||||
local MySetGroup = SET_GROUP:New()
|
||||
MySetGroup:AddGroupsByName({"Group1", "Group2"})
|
||||
|
||||
if MySetGroup:AnyCompletelyInZone(MyZone) then
|
||||
MESSAGE:New("At least one GROUP is completely in zone !", 10):ToAll()
|
||||
else
|
||||
MESSAGE:New("No GROUP is completely in zone !", 10):ToAll()
|
||||
end</code></pre>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(SET_GROUP).AnyPartlyInZone" >
|
||||
<strong>SET_GROUP:AnyPartlyInZone(ZoneObject, Zone)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Iterate the SET_GROUP and return true if at least one <a href="##(UNIT)">#UNIT</a> of one <a href="GROUP.html">GROUP</a> of the <a href="SET_GROUP.html">SET_GROUP</a> is in <a href="ZONE.html">ZONE</a></p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a> ZoneObject </em></code>:
|
||||
The Zone to be tested for.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Zone </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#boolean:</em>
|
||||
true if at least one of the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> is partly or completly inside the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>, false otherwise.</p>
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<pre class="example"><code>local MyZone = ZONE:New("Zone1")
|
||||
local MySetGroup = SET_GROUP:New()
|
||||
MySetGroup:AddGroupsByName({"Group1", "Group2"})
|
||||
|
||||
if MySetGroup:AnyPartlyInZone(MyZone) then
|
||||
MESSAGE:New("At least one GROUP has at least one UNIT in zone !", 10):ToAll()
|
||||
else
|
||||
MESSAGE:New("No UNIT of any GROUP is in zone !", 10):ToAll()
|
||||
end</code></pre>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(SET_GROUP).FilterCategories" >
|
||||
<strong>SET_GROUP:FilterCategories(Categories)</strong>
|
||||
</a>
|
||||
@@ -3836,6 +4039,51 @@ DBObject = SET_GROUP:New()</code></pre>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(SET_GROUP).NoneInZone" >
|
||||
<strong>SET_GROUP:NoneInZone(ZoneObject, Zone)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Iterate the SET_GROUP and return true if no <a href="GROUP.html">GROUP</a> of the <a href="SET_GROUP.html">SET_GROUP</a> is in <a href="ZONE.html">ZONE</a>
|
||||
This could also be achieved with <code>not SET_GROUP:AnyPartlyInZone(Zone)</code>, but it's easier for the
|
||||
mission designer to add a dedicated method</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a> ZoneObject </em></code>:
|
||||
The Zone to be tested for.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Zone </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#boolean:</em>
|
||||
true if no <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> is inside the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a> in any way, false otherwise.</p>
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<pre class="example"><code>local MyZone = ZONE:New("Zone1")
|
||||
local MySetGroup = SET_GROUP:New()
|
||||
MySetGroup:AddGroupsByName({"Group1", "Group2"})
|
||||
|
||||
if MySetGroup:NoneInZone(MyZone) then
|
||||
MESSAGE:New("No GROUP is completely in zone !", 10):ToAll()
|
||||
else
|
||||
MESSAGE:New("No UNIT of any GROUP is in zone !", 10):ToAll()
|
||||
end</code></pre>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(SET_GROUP).RemoveGroupsByName" >
|
||||
<strong>SET_GROUP:RemoveGroupsByName(RemoveGroupNames)</strong>
|
||||
</a>
|
||||
|
||||
Reference in New Issue
Block a user