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

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2022-10-22 09:15:30 +00:00
parent 16abde2bbb
commit ffeb91ddff
140 changed files with 1051 additions and 1233 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
Documentation/Wrapper.Group.html
View File

@@ -405,7 +405,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Act_Account.html">Actions.Act_Account</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Actions</strong> - ACT_ACCOUNT_ classes <strong>account for</strong> (detect, count &amp; report) various DCS events occuring on <a href="Wrapper.Unit.html">Wrapper.Unit</a>s.</p>
<p><strong>Actions</strong> - ACT_ACCOUNT_ classes <strong>account for</strong> (detect, count &amp; report) various DCS events occurring on <a href="Wrapper.Unit.html">Wrapper.Unit</a>s.</p>
</p></div>
</div>
</div>
@@ -1767,16 +1767,16 @@ But again, please refer to the <a href="Wrapper.Controllable.html">Wrapper.Contr
<h2>GROUP Zone validation methods</h2>
<p>The group can be validated whether it is completely, partly or not within a <a href="Zone.html">Zone</a>.
<p>The group can be validated whether it is completely, partly or not within a <a href="Core.Zone.html">Core.Zone</a>.
Use the following Zone validation methods on the group:</p>
<ul>
<li><a href="##(GROUP).IsCompletelyInZone">GROUP.IsCompletelyInZone</a>: Returns true if all units of the group are within a <a href="Zone.html">Zone</a>.</li>
<li><a href="##(GROUP).IsPartlyInZone">GROUP.IsPartlyInZone</a>: Returns true if some units of the group are within a <a href="Zone.html">Zone</a>.</li>
<li><a href="##(GROUP).IsNotInZone">GROUP.IsNotInZone</a>: Returns true if none of the group units of the group are within a <a href="Zone.html">Zone</a>.</li>
<li><a href="##(GROUP).IsCompletelyInZone">GROUP.IsCompletelyInZone</a>: Returns true if all units of the group are within a <a href="Core.Zone.html">Core.Zone</a>.</li>
<li><a href="##(GROUP).IsPartlyInZone">GROUP.IsPartlyInZone</a>: Returns true if some units of the group are within a <a href="Core.Zone.html">Core.Zone</a>.</li>
<li><a href="##(GROUP).IsNotInZone">GROUP.IsNotInZone</a>: Returns true if none of the group units of the group are within a <a href="Core.Zone.html">Core.Zone</a>.</li>
</ul>
<p>The zone can be of any <a href="Zone.html">Zone</a> class derived from <a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>. So, these methods are polymorphic to the zones tested on.</p>
<p>The zone can be of any <a href="Core.Zone.html">Core.Zone</a> class derived from <a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>. So, these methods are polymorphic to the zones tested on.</p>
<h2>GROUP AI methods</h2>
@@ -1868,7 +1868,7 @@ Use the following Zone validation methods on the group:</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).CountInZone">GROUP:CountInZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the number of UNITs that are in the <a href="Zone.html">Zone</a></p>
<p>Returns the number of UNITs that are in the <a href="Core.Zone.html">Core.Zone</a></p>
</td>
</tr>
<tr class="w3-border">
@@ -2280,7 +2280,7 @@ amount of fuel in the group.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).InitRandomizePositionZone">GROUP:InitRandomizePositionZone(PositionZone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Randomize the positions of the units of the respawned group within the <a href="Zone.html">Zone</a>.</p>
<p>Randomize the positions of the units of the respawned group within the <a href="Core.Zone.html">Core.Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2346,7 +2346,7 @@ amount of fuel in the group.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).InitZone">GROUP:InitZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the respawn <a href="Zone.html">Zone</a> for the respawned group.</p>
<p>Set the respawn <a href="Core.Zone.html">Core.Zone</a> for the respawned group.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2388,7 +2388,7 @@ amount of fuel in the group.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).IsCompletelyInZone">GROUP:IsCompletelyInZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns true if all units of the group are within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if all units of the group are within a <a href="Core.Zone.html">Core.Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2406,25 +2406,25 @@ amount of fuel in the group.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).IsInZone">GROUP:IsInZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if any unit of a group is inside a <a href="Zone.html">Zone</a>.</p>
<p>Check if any unit of a group is inside a <a href="Core.Zone.html">Core.Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).IsNotInZone">GROUP:IsNotInZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns true if none of the group units of the group are within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if none of the group units of the group are within a <a href="Core.Zone.html">Core.Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).IsPartlyInZone">GROUP:IsPartlyInZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns true if some but NOT ALL units of the group are within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if some but NOT ALL units of the group are within a <a href="Core.Zone.html">Core.Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).IsPartlyOrCompletelyInZone">GROUP:IsPartlyOrCompletelyInZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns true if part or all units of the group are within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if part or all units of the group are within a <a href="Core.Zone.html">Core.Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3784,7 +3784,7 @@ amount of fuel in the group.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).IsInZone">GROUP:IsInZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns true if the unit is within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if the unit is within a <a href="Core.Zone.html">Core.Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3796,7 +3796,7 @@ amount of fuel in the group.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).IsNotInZone">GROUP:IsNotInZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns true if the unit is not within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if the unit is not within a <a href="Core.Zone.html">Core.Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4981,7 +4981,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
@@ -5228,7 +5239,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(GROUP).CountInZone" ><strong>GROUP:CountInZone(Zone)</strong></a></h2>
</div>
<p>Returns the number of UNITs that are in the <a href="Zone.html">Zone</a></p>
<p>Returns the number of UNITs that are in the <a href="Core.Zone.html">Core.Zone</a></p>
<div id= "#Functions##CountInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5257,7 +5268,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>The number of UNITs that are in the <a href="Zone.html">Zone</a></p>
<p>The number of UNITs that are in the <a href="Core.Zone.html">Core.Zone</a></p>
</div>
</div>
@@ -7805,7 +7816,7 @@ Thus, a band is created around the respawn location where the units will be plac
<h2><a id="#(GROUP).InitRandomizePositionZone" ><strong>GROUP:InitRandomizePositionZone(PositionZone)</strong></a></h2>
</div>
<p>Randomize the positions of the units of the respawned group within the <a href="Zone.html">Zone</a>.</p>
<p>Randomize the positions of the units of the respawned group within the <a href="Core.Zone.html">Core.Zone</a>.</p>
<p>When a Respawn happens, the units of the group will be placed at random positions within the Zone (selected).</p>
@@ -7852,7 +7863,7 @@ Thus, a band is created around the respawn location where the units will be plac
<h2><a id="#(GROUP).InitZone" ><strong>GROUP:InitZone(Zone)</strong></a></h2>
</div>
<p>Set the respawn <a href="Zone.html">Zone</a> for the respawned group.</p>
<p>Set the respawn <a href="Core.Zone.html">Core.Zone</a> for the respawned group.</p>
<div id= "#Functions##InitZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -8119,7 +8130,7 @@ If the first <a href="Wrapper.Unit.html">Wrapper.Unit</a> of the group is inacti
<h2><a id="#(GROUP).IsCompletelyInZone" ><strong>GROUP:IsCompletelyInZone(Zone)</strong></a></h2>
</div>
<p>Returns true if all units of the group are within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if all units of the group are within a <a href="Core.Zone.html">Core.Zone</a>.</p>
<div id= "#Functions##IsCompletelyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -8223,7 +8234,7 @@ If the first <a href="Wrapper.Unit.html">Wrapper.Unit</a> of the group is inacti
<h2><a id="#(GROUP).IsInZone" ><strong>GROUP:IsInZone(Zone)</strong></a></h2>
</div>
<p>Check if any unit of a group is inside a <a href="Zone.html">Zone</a>.</p>
<p>Check if any unit of a group is inside a <a href="Core.Zone.html">Core.Zone</a>.</p>
<div id= "#Functions##IsInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -8267,7 +8278,7 @@ If the first <a href="Wrapper.Unit.html">Wrapper.Unit</a> of the group is inacti
<h2><a id="#(GROUP).IsNotInZone" ><strong>GROUP:IsNotInZone(Zone)</strong></a></h2>
</div>
<p>Returns true if none of the group units of the group are within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if none of the group units of the group are within a <a href="Core.Zone.html">Core.Zone</a>.</p>
<div id= "#Functions##IsNotInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -8311,7 +8322,7 @@ If the first <a href="Wrapper.Unit.html">Wrapper.Unit</a> of the group is inacti
<h2><a id="#(GROUP).IsPartlyInZone" ><strong>GROUP:IsPartlyInZone(Zone)</strong></a></h2>
</div>
<p>Returns true if some but NOT ALL units of the group are within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if some but NOT ALL units of the group are within a <a href="Core.Zone.html">Core.Zone</a>.</p>
<div id= "#Functions##IsPartlyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -8355,7 +8366,7 @@ If the first <a href="Wrapper.Unit.html">Wrapper.Unit</a> of the group is inacti
<h2><a id="#(GROUP).IsPartlyOrCompletelyInZone" ><strong>GROUP:IsPartlyOrCompletelyInZone(Zone)</strong></a></h2>
</div>
<p>Returns true if part or all units of the group are within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if part or all units of the group are within a <a href="Core.Zone.html">Core.Zone</a>.</p>
<div id= "#Functions##IsPartlyOrCompletelyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -8663,9 +8674,9 @@ These settings can be provided by calling the relevant Init...() methods of the
<li><a href="##(GROUP).InitHeading">GROUP.InitHeading</a>: Set the heading for the units in degrees within the respawned group.</li>
<li><a href="##(GROUP).InitHeight">GROUP.InitHeight</a>: Set the height for the units in meters for the respawned group. (This is applicable for air units).</li>
<li><a href="##(GROUP).InitRandomizeHeading">GROUP.InitRandomizeHeading</a>: Randomize the headings for the units within the respawned group.</li>
<li><a href="##(GROUP).InitZone">GROUP.InitZone</a>: Set the respawn <a href="Zone.html">Zone</a> for the respawned group.</li>
<li><a href="##(GROUP).InitRandomizeZones">GROUP.InitRandomizeZones</a>: Randomize the respawn <a href="Zone.html">Zone</a> between one of the <a href="Zone.html">Zone</a>s given for the respawned group.</li>
<li><a href="##(GROUP).InitRandomizePositionZone">GROUP.InitRandomizePositionZone</a>: Randomize the positions of the units of the respawned group within the <a href="Zone.html">Zone</a>.</li>
<li><a href="##(GROUP).InitZone">GROUP.InitZone</a>: Set the respawn <a href="Core.Zone.html">Core.Zone</a> for the respawned group.</li>
<li><a href="##(GROUP).InitRandomizeZones">GROUP.InitRandomizeZones</a>: Randomize the respawn <a href="Core.Zone.html">Core.Zone</a> between one of the <a href="Core.Zone.html">Core.Zone</a>s given for the respawned group.</li>
<li><a href="##(GROUP).InitRandomizePositionZone">GROUP.InitRandomizePositionZone</a>: Randomize the positions of the units of the respawned group within the <a href="Core.Zone.html">Core.Zone</a>.</li>
<li><a href="##(GROUP).InitRandomizePositionRadius">GROUP.InitRandomizePositionRadius</a>: Randomize the positions of the units of the respawned group in a circle band.</li>
<li><a href="##(GROUP).InitRandomizeTemplates">GROUP.InitRandomizeTemplates</a>: Randomize the Template for the respawned group.</li>
</ul>
@@ -9373,7 +9384,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
@@ -18002,7 +18024,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
<p>Use the method <a href="##(CONTROLLABLE).WayPointFunction">CONTROLLABLE.WayPointFunction</a>() to define the hook functions for specific waypoints.
Use the method @{#CONTROLLABLE.WayPointExecute)() to start the execution of the new mission plan.
Use the method <a href="##(CONTROLLABLE).WayPointExecute">CONTROLLABLE.WayPointExecute</a>() to start the execution of the new mission plan.
Note that when WayPointInitialize is called, the Mission of the controllable is RESTARTED!</p>
<div id= "#Functions##WayPointInitialize" class="w3-show w3-white">
@@ -18259,7 +18281,18 @@ Note that when WayPointInitialize is called, the Mission of the controllable is
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
@@ -20528,7 +20561,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<h2><a id="#(GROUP).IsInZone" ><strong>GROUP:IsInZone(Zone)</strong></a></h2>
</div>
<p>Returns true if the unit is within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if the unit is within a <a href="Core.Zone.html">Core.Zone</a>.</p>
<div id= "#Functions##IsInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -20602,7 +20635,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<h2><a id="#(GROUP).IsNotInZone" ><strong>GROUP:IsNotInZone(Zone)</strong></a></h2>
</div>
<p>Returns true if the unit is not within a <a href="Zone.html">Zone</a>.</p>
<p>Returns true if the unit is not within a <a href="Core.Zone.html">Core.Zone</a>.</p>
<div id= "#Functions##IsNotInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -22105,7 +22138,18 @@ Coordinates are dependent on the position of the maps origin.</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
@@ -22730,7 +22774,18 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
@@ -22990,7 +23045,18 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>