weyne/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-08-15 10:47:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into issue437

Browse Source
This commit is contained in:
Grey-Echo
2017-04-22 15:21:43 +02:00
parent f1a9029bc6 cb50facd9a
commit 7bb60f51bb
23 changed files with 1056 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/Documentation/Set.html
View File

@@ -170,7 +170,7 @@
<tr>
<td class="name" nowrap="nowrap"><a href="#SET_CARGO">SET_CARGO</a></td>
<td class="summary">
<h1>SET_CARGO class, extends <a href="Set.html##(SET_BASE)">Set#SET_BASE</a></h1>
<h1>(R2.1) SET_CARGO class, extends <a href="Set.html##(SET_BASE)">Set#SET_BASE</a></h1>
<p>Mission designers can use the <a href="Set.html##(SET_CARGO)">Set#SET_CARGO</a> class to build sets of cargos optionally belonging to certain:</p>
@@ -520,97 +520,97 @@
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).AddCargosByName">SET_CARGO:AddCargosByName(AddCargoNames)</a></td>
<td class="summary">
<p>Add CARGOs to SET_CARGO.</p>
<p>(R2.1) Add CARGOs to SET_CARGO.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).AddInDatabase">SET_CARGO: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>
<p>(R2.1) 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_CARGO).FilterCoalitions">SET_CARGO:FilterCoalitions(Coalitions)</a></td>
<td class="summary">
<p>Builds a set of cargos of coalitions.</p>
<p>(R2.1) Builds a set of cargos of coalitions.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).FilterCountries">SET_CARGO:FilterCountries(Countries)</a></td>
<td class="summary">
<p>Builds a set of cargos of defined countries.</p>
<p>(R2.1) Builds a set of cargos of defined countries.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).FilterPrefixes">SET_CARGO:FilterPrefixes(Prefixes)</a></td>
<td class="summary">
<p>Builds a set of cargos of defined cargo prefixes.</p>
<p>(R2.1) Builds a set of cargos of defined cargo prefixes.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).FilterStart">SET_CARGO:FilterStart()</a></td>
<td class="summary">
<p>Starts the filtering.</p>
<p>(R2.1) Starts the filtering.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).FilterTypes">SET_CARGO:FilterTypes(Types)</a></td>
<td class="summary">
<p>Builds a set of cargos of defined cargo types.</p>
<p>(R2.1) Builds a set of cargos of defined cargo types.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).FindCargo">SET_CARGO:FindCargo(CargoName)</a></td>
<td class="summary">
<p>Finds a Cargo based on the Cargo Name.</p>
<p>(R2.1) Finds a Cargo based on the Cargo Name.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).FindInDatabase">SET_CARGO:FindInDatabase(Event)</a></td>
<td class="summary">
<p>Handles the Database to check on any event that Object exists in the Database.</p>
<p>(R2.1) Handles the Database to check on any event that Object exists in the Database.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).FindNearestCargoFromPointVec2">SET_CARGO:FindNearestCargoFromPointVec2(PointVec2)</a></td>
<td class="summary">
<p>Iterate the SET_CARGO while identifying the nearest <a href="Cargo.html##(CARGO)">Cargo#CARGO</a> from a <a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a>.</p>
<p>(R2.1) Iterate the SET_CARGO while identifying the nearest <a href="Cargo.html##(CARGO)">Cargo#CARGO</a> from a <a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).ForEachCargo">SET_CARGO:ForEachCargo(IteratorFunction, ...)</a></td>
<td class="summary">
<p>Iterate the SET_CARGO and call an interator function for each CARGO, providing the CARGO and optional parameters.</p>
<p>(R2.1) Iterate the SET_CARGO and call an interator function for each CARGO, providing the CARGO and optional parameters.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).IsIncludeObject">SET_CARGO:IsIncludeObject(MCargo)</a></td>
<td class="summary">
<p>(R2.1) </p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).New">SET_CARGO:New()</a></td>
<td class="summary">
<p>Creates a new SET_CARGO object, building a set of cargos belonging to a coalitions and categories.</p>
<p>(R2.1) Creates a new SET_CARGO object, building a set of cargos belonging to a coalitions and categories.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).OnEventDeleteCargo">SET_CARGO:OnEventDeleteCargo(EventData)</a></td>
<td class="summary">
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<p>(R2.1) Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).OnEventNewCargo">SET_CARGO:OnEventNewCargo(EventData)</a></td>
<td class="summary">
<p>Handles the OnEventNewCargo event for the Set.</p>
<p>(R2.1) Handles the OnEventNewCargo event for the Set.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_CARGO).RemoveCargosByName">SET_CARGO:RemoveCargosByName(RemoveCargoNames)</a></td>
<td class="summary">
<p>Remove CARGOs from SET_CARGO.</p>
<p>(R2.1) Remove CARGOs from SET_CARGO.</p>
</td>
</tr>
</table>
@@ -1143,7 +1143,7 @@ You can set the <strong>"yield interval"</strong>, and the <strong>"time interva
</dt>
<dd>
<h1>SET_CARGO class, extends <a href="Set.html##(SET_BASE)">Set#SET_BASE</a></h1>
<h1>(R2.1) SET_CARGO class, extends <a href="Set.html##(SET_BASE)">Set#SET_BASE</a></h1>
<p>Mission designers can use the <a href="Set.html##(SET_CARGO)">Set#SET_CARGO</a> class to build sets of cargos optionally belonging to certain:</p>
@@ -2513,7 +2513,7 @@ The Object found.</p>
</dt>
<dd>
<p>Add CARGOs to SET_CARGO.</p>
<p>(R2.1) Add CARGOs to SET_CARGO.</p>
<h3>Parameter</h3>
<ul>
@@ -2540,7 +2540,7 @@ A single name or an array of CARGO names.</p>
</dt>
<dd>
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
<p>(R2.1) Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE birth event gets called later than the SET</em>BASE birth event!</p>
@@ -2579,7 +2579,7 @@ The CARGO</p>
</dt>
<dd>
<p>Builds a set of cargos of coalitions.</p>
<p>(R2.1) Builds a set of cargos of coalitions.</p>
<p>Possible current coalitions are red, blue and neutral.</p>
@@ -2609,7 +2609,7 @@ self</p>
</dt>
<dd>
<p>Builds a set of cargos of defined countries.</p>
<p>(R2.1) Builds a set of cargos of defined countries.</p>
<p>Possible current countries are those known within DCS world.</p>
@@ -2639,7 +2639,7 @@ self</p>
</dt>
<dd>
<p>Builds a set of cargos of defined cargo prefixes.</p>
<p>(R2.1) Builds a set of cargos of defined cargo prefixes.</p>
<p>All the cargos starting with the given prefixes will be included within the set.</p>
@@ -2669,7 +2669,7 @@ self</p>
</dt>
<dd>
<p>Starts the filtering.</p>
<p>(R2.1) Starts the filtering.</p>
<h3>Return value</h3>
@@ -2687,7 +2687,7 @@ self</p>
</dt>
<dd>
<p>Builds a set of cargos of defined cargo types.</p>
<p>(R2.1) Builds a set of cargos of defined cargo types.</p>
<p>Possible current types are those types known within DCS world.</p>
@@ -2717,7 +2717,7 @@ self</p>
</dt>
<dd>
<p>Finds a Cargo based on the Cargo Name.</p>
<p>(R2.1) Finds a Cargo based on the Cargo Name.</p>
<h3>Parameter</h3>
<ul>
@@ -2743,7 +2743,7 @@ The found Cargo.</p>
</dt>
<dd>
<p>Handles the Database to check on any event that Object exists in the Database.</p>
<p>(R2.1) Handles the Database to check on any event that Object exists in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE event gets called later than the SET</em>BASE event or vise versa!</p>
@@ -2782,7 +2782,7 @@ The CARGO</p>
</dt>
<dd>
<p>Iterate the SET_CARGO while identifying the nearest <a href="Cargo.html##(CARGO)">Cargo#CARGO</a> from a <a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a>.</p>
<p>(R2.1) Iterate the SET_CARGO while identifying the nearest <a href="Cargo.html##(CARGO)">Cargo#CARGO</a> from a <a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a>.</p>
<h3>Parameter</h3>
<ul>
@@ -2809,7 +2809,7 @@ The closest <a href="Cargo.html##(CARGO)">Cargo#CARGO</a>.</p>
</dt>
<dd>
<p>Iterate the SET_CARGO and call an interator function for each CARGO, providing the CARGO and optional parameters.</p>
<p>(R2.1) Iterate the SET_CARGO and call an interator function for each CARGO, providing the CARGO and optional parameters.</p>
<h3>Parameters</h3>
<ul>
@@ -2841,7 +2841,7 @@ self</p>
</dt>
<dd>
<p>(R2.1) </p>
<h3>Parameter</h3>
<ul>
@@ -2867,7 +2867,7 @@ self</p>
</dt>
<dd>
<p>Creates a new SET_CARGO object, building a set of cargos belonging to a coalitions and categories.</p>
<p>(R2.1) Creates a new SET_CARGO object, building a set of cargos belonging to a coalitions and categories.</p>
<h3>Return value</h3>
@@ -2889,7 +2889,7 @@ DatabaseSet = SET_CARGO:New()</code></pre>
</dt>
<dd>
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<p>(R2.1) Handles the OnDead or OnCrash event for alive units set.</p>
<h3>Parameter</h3>
<ul>
@@ -2910,7 +2910,7 @@ DatabaseSet = SET_CARGO:New()</code></pre>
</dt>
<dd>
<p>Handles the OnEventNewCargo event for the Set.</p>
<p>(R2.1) Handles the OnEventNewCargo event for the Set.</p>
<h3>Parameter</h3>
<ul>
@@ -2931,7 +2931,7 @@ DatabaseSet = SET_CARGO:New()</code></pre>
</dt>
<dd>
<p>Remove CARGOs from SET_CARGO.</p>
<p>(R2.1) Remove CARGOs from SET_CARGO.</p>
<h3>Parameter</h3>
<ul>