MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-02-04 08:01:04 +00:00
parent 7b10b23a84
commit d0d5268307
23 changed files with 677 additions and 322 deletions

View File

@@ -1565,13 +1565,13 @@ It uses the in-built detection capabilities of DCS World, but adds new functiona
<p> ## 4.1) Retrieve the Detected Unit Sets and Detected Zones</p>
<p> The methods to manage the DetectedItems[].Set(s) are implemented in <a href="Functional.Detection.html##(DETECTION_BASE)">Functional.Detection#DETECTION_BASE</a> and
the methods to manage the DetectedItems[].Zone(s) is implemented in <a href="Functional.Detection.html##(DETECTION_AREAS)">Functional.Detection#DETECTION_AREAS</a>.</p>
the methods to manage the DetectedItems[].Zone(s) are implemented in <a href="Functional.Detection.html##(DETECTION_AREAS)">Functional.Detection#DETECTION_AREAS</a>.</p>
<p> Retrieve the DetectedItems[].Set with the method <a href="Functional.Detection.html##(DETECTION_BASE).GetDetectedSet">Functional.Detection#DETECTION_BASE.GetDetectedSet</a>(). A <a href="Core.Set.html##(SET_UNIT)">Core.Set#SET_UNIT</a> object will be returned.</p>
<p> Retrieve the formed <a href="Zone.html">Zone</a>s as a result of the grouping the detected units within the DetectionZoneRange, use the method <a href="Functional.Detection.html##(DETECTION_BASE).GetDetectionZones">Functional.Detection#DETECTION_BASE.GetDetectionZones</a>().
To understand the amount of zones created, use the method <a href="Functional.Detection.html##(DETECTION_BASE).GetDetectionZoneCount">Functional.Detection#DETECTION_BASE.GetDetectionZoneCount</a>().
If you want to obtain a specific zone from the DetectedZones, use the method <a href="Functional.Detection.html##(DETECTION_BASE).GetDetectionZone">Functional.Detection#DETECTION_BASE.GetDetectionZone</a>() with a given index.</p>
<p> Retrieve the formed <a href="Zone.html">Zone</a>s as a result of the grouping the detected units within the DetectionZoneRange, use the method <a href="Functional.Detection.html##(DETECTION_AREAS).GetDetectionZones">Functional.Detection#DETECTION_AREAS.GetDetectionZones</a>().
To understand the amount of zones created, use the method <a href="Functional.Detection.html##(DETECTION_AREAS).GetDetectionZoneCount">Functional.Detection#DETECTION_AREAS.GetDetectionZoneCount</a>().
If you want to obtain a specific zone from the DetectedZones, use the method <a href="Functional.Detection.html##(DETECTION_AREAS).GetDetectionZoneByID">Functional.Detection#DETECTION_AREAS.GetDetectionZoneByID</a>() with a given index.</p>
<p> ## 4.4) Flare or Smoke detected units</p>
@@ -1979,6 +1979,24 @@ Beware that when the amount of units detected is large, the DetectedItems list w
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_AREAS).GetChangeText">DETECTION_AREAS:GetChangeText(DetectedItem)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Make text documenting the changes of the detected zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_AREAS).GetDetectionZoneByID">DETECTION_AREAS:GetDetectionZoneByID(ID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieve a specific zone by its ID (number)</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_AREAS).GetDetectionZoneCount">DETECTION_AREAS:GetDetectionZoneCount()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieve number of detected zones.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_AREAS).GetDetectionZones">DETECTION_AREAS:GetDetectionZones()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieve set of detected zones.</p>
</td>
</tr>
<tr class="w3-border">
@@ -9201,6 +9219,108 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DETECTION_AREAS).GetDetectionZoneByID" ><strong>DETECTION_AREAS:GetDetectionZoneByID(ID)</strong></a></h2>
</div>
<p>Retrieve a specific zone by its ID (number)</p>
<div id= "#Functions##GetDetectionZoneByID" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>DETECTION_AREAS</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>ID</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Core.Zone.html##(ZONE_UNIT)">Core.Zone#ZONE_UNIT</a>:</p>
</div>
<div class="w3-half">
<p>The zone or nil if it does not exist</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DETECTION_AREAS).GetDetectionZoneCount" ><strong>DETECTION_AREAS:GetDetectionZoneCount()</strong></a></h2>
</div>
<p>Retrieve number of detected zones.</p>
<div id= "#Functions##GetDetectionZoneCount" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>DETECTION_AREAS</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>The number of zones.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DETECTION_AREAS).GetDetectionZones" ><strong>DETECTION_AREAS:GetDetectionZones()</strong></a></h2>
</div>
<p>Retrieve set of detected zones.</p>
<div id= "#Functions##GetDetectionZones" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>DETECTION_AREAS</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a>:</p>
</div>
<div class="w3-half">
<p>The <a href="Set.html">Set</a> of ZONE_UNIT objects detected.</p>
</div>
</div>
</div>
</div>
</div>
@@ -18913,17 +19033,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(DETECTION_BASE).Locking" ><strong>DETECTION_BASE.Locking</strong></a>
</div>
</div>
@@ -23615,17 +23724,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(DETECTION_BASE).Locking" ><strong>DETECTION_BASE.Locking</strong></a>
</div>
</div>
@@ -25372,17 +25470,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(DETECTION_BASE).Locking" ><strong>DETECTION_BASE.Locking</strong></a>
</div>
</div>