Progress!

This commit is contained in:
FlightControl
2017-04-22 13:53:54 +02:00
parent 4138a54e6b
commit 036768d400
23 changed files with 1129 additions and 239 deletions

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>
@@ -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>
@@ -508,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>
@@ -1085,7 +1097,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>
@@ -1856,6 +1868,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">
@@ -2419,7 +2467,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>
@@ -2446,7 +2494,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>
@@ -2485,7 +2533,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>
@@ -2515,7 +2563,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>
@@ -2545,7 +2593,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>
@@ -2575,7 +2623,7 @@ self</p>
</dt>
<dd>
<p>Starts the filtering.</p>
<p>(R2.1) Starts the filtering.</p>
<h3>Return value</h3>
@@ -2593,7 +2641,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>
@@ -2623,7 +2671,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>
@@ -2649,7 +2697,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>
@@ -2688,7 +2736,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>
@@ -2715,7 +2763,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>
@@ -2747,7 +2795,7 @@ self</p>
</dt>
<dd>
<p>(R2.1) </p>
<h3>Parameter</h3>
<ul>
@@ -2773,7 +2821,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>
@@ -2795,7 +2843,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>
@@ -2816,7 +2864,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>
@@ -2837,7 +2885,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>