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-03-23 07:06:17 +00:00
parent ef7fd4f2d0
commit fe5f017eb3
30 changed files with 935 additions and 970 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
Documentation/Functional.ZoneCaptureCoalition.html
View File

@@ -2418,7 +2418,7 @@ We start the monitoring after 5 seconds, and will repeat every 30 seconds a chec
</td>
</tr>
<tr class="w3-border">
<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)</a></p></td>
<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>
@@ -2436,7 +2436,7 @@ We start the monitoring after 5 seconds, and will repeat every 30 seconds a chec
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_CAPTURE_COALITION).GetRandomVec2">ZONE_CAPTURE_COALITION:GetRandomVec2(inner, outer)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_CAPTURE_COALITION).GetRandomVec2">ZONE_CAPTURE_COALITION:GetRandomVec2(inner, outer, surfacetypes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a random Vec2 location within the zone.</p>
</td>
@@ -5574,7 +5574,7 @@ end
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_CAPTURE_COALITION).GetRandomCoordinate" ><strong>ZONE_CAPTURE_COALITION:GetRandomCoordinate(inner, outer)</strong></a></h2>
<h2><a id="#(ZONE_CAPTURE_COALITION).GetRandomCoordinate" ><strong>ZONE_CAPTURE_COALITION:GetRandomCoordinate(inner, outer, surfacetypes)</strong></a></h2>
</div>
<p>Returns a <a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> object reflecting a random 3D location within the zone.</p>
@@ -5595,7 +5595,7 @@ end
</div>
<div class="w3-half">
<p>(optional) Minimal distance from the center of the zone. Default is 0.</p>
<p>(Optional) Minimal distance from the center of the zone. Default is 0.</p>
</div>
</div>
@@ -5608,7 +5608,20 @@ end
</div>
<div class="w3-half">
<p>(optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.</p>
<p>(Optional) Maximal distance from the outer edge of the zone. 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>
#table
<strong><strong>surfacetypes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Table of surface types. Can also be a single surface type. We will try max 1000 times to find the right type!</p>
</div>
</div>
@@ -5619,7 +5632,7 @@ end
</div>
<div class="w3-half">
<p>The random coordinate.</p>
</div>
</div>
@@ -5745,7 +5758,7 @@ end
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_CAPTURE_COALITION).GetRandomVec2" ><strong>ZONE_CAPTURE_COALITION:GetRandomVec2(inner, outer)</strong></a></h2>
<h2><a id="#(ZONE_CAPTURE_COALITION).GetRandomVec2" ><strong>ZONE_CAPTURE_COALITION:GetRandomVec2(inner, outer, surfacetypes)</strong></a></h2>
</div>
<p>Returns a random Vec2 location within the zone.</p>
@@ -5766,7 +5779,7 @@ end
</div>
<div class="w3-half">
<p>(optional) Minimal distance from the center of the zone. Default is 0.</p>
<p>(Optional) Minimal distance from the center of the zone. Default is 0.</p>
</div>
</div>
@@ -5779,7 +5792,20 @@ end
</div>
<div class="w3-half">
<p>(optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.</p>
<p>(Optional) Maximal distance from the outer edge of the zone. 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>
#table
<strong><strong>surfacetypes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Table of surface types. Can also be a single surface type. We will try max 100 times to find the right type!</p>
</div>
</div>
@@ -6146,7 +6172,7 @@ Returns the Coalition for the given Coalition if there are units of the Coalitio
<p>Is All in Zone of Coalition?</p>
<p>Check if only the specified coalition is inside the zone and noone else.</p>
<p>Check if only the specifed coalition is inside the zone and noone else.</p>
<div id= "#Functions##IsAllInZoneOfCoalition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -6271,10 +6297,8 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
self.Zone:Scan()
local IsEmpty = self.Zone:IsNoneInZone()
</code></pre>
<pre class="example"><code> self.Zone:Scan()
local IsEmpty = self.Zone:IsNoneInZone()</code></pre>
</div>
@@ -6322,10 +6346,8 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
self.Zone:Scan()
local IsOccupied = self.Zone:IsNoneInZoneOfCoalition( self.Coalition )
</code></pre>
<pre class="example"><code> self.Zone:Scan()
local IsOccupied = self.Zone:IsNoneInZoneOfCoalition( self.Coalition )</code></pre>
</div>
@@ -6341,7 +6363,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
<p>Is Some in Zone of Coalition?</p>
<p>Check if more than one coalition is inside the zone and the specified coalition is one of them.
<p>Check if more than one coaltion is inside the zone and the specifed coalition is one of them.
You first need to use the <a href="##(ZONE_RADIUS).Scan">ZONE_RADIUS.Scan</a> method to scan the zone before it can be evaluated!
Note that once a zone has been scanned, multiple evaluations can be done on the scan result set.</p>
@@ -6361,7 +6383,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
</div>
<div class="w3-half">
<p>ID of the coalition which is checked to be inside the zone.</p>
<p>ID of the coaliton which is checked to be inside the zone.</p>
</div>
</div>
@@ -6377,10 +6399,8 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
self.Zone:Scan()
local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
</code></pre>
<pre class="example"><code> self.Zone:Scan()
local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )</code></pre>
</div>