MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-08-30 12:49:38 +00:00
parent 4a805f4fed
commit bb5d4b6a91
133 changed files with 10931 additions and 599 deletions

View File

@@ -549,6 +549,17 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Models the process to achieve goal(s).</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/MOOSE_Core.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.MarkerOps_Base.html">Core.MarkerOps_Base</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - MarkerOps_Base.</p>
</p></div>
</div>
</div>
@@ -2432,6 +2443,12 @@ We start the monitoring after 5 seconds, and will repeat every 30 seconds a chec
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_CAPTURE_COALITION).GetRandomCoordinate">ZONE_CAPTURE_COALITION:GetRandomCoordinate(inner, outer, surfacetypes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a <a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> object reflecting a random 3D location within the zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_CAPTURE_COALITION).GetRandomCoordinateWithoutBuildings">ZONE_CAPTURE_COALITION:GetRandomCoordinateWithoutBuildings(inner, outer, distance, markbuildings, markfinal)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a <a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> object reflecting a random location within the zone where there are no <strong>map objects</strong> of type "Building".</p>
</td>
</tr>
<tr class="w3-border">
@@ -5649,6 +5666,105 @@ end
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_CAPTURE_COALITION).GetRandomCoordinateWithoutBuildings" ><strong>ZONE_CAPTURE_COALITION:GetRandomCoordinateWithoutBuildings(inner, outer, distance, markbuildings, markfinal)</strong></a></h2>
</div>
<p>Returns a <a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> object reflecting a random location within the zone where there are no <strong>map objects</strong> of type "Building".</p>
<p>Does not find statics you might have placed there. <strong>Note</strong> This might be quite CPU intensive, use with care.</p>
<div id= "#Functions##GetRandomCoordinateWithoutBuildings" 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><a href="Core.Zone.html##(ZONE_RADIUS)">Core.Zone#ZONE_RADIUS</a></p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>inner</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Minimal distance from the center of the zone in meters. Default is 0m.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>outer</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Maximal distance from the outer edge of the zone in meters. Default is the radius of the zone.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>distance</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Minumum distance from any building coordinate. Defaults to 100m.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>markbuildings</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Place markers on found buildings (if any).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>markfinal</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Place marker on the final coordinate (if any).</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</p>
</div>
<div class="w3-half">
<p>The random coordinate or <code>nil</code> if cannot be found in 1000 iterations.</p>
</div>
</div>
</div>
</div>
</div>