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
2021-12-28 10:09:15 +00:00
parent 823c49c6a2
commit d99593df6b
53 changed files with 1174 additions and 1245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
Documentation/Core.Zone.html
View File

@@ -1505,7 +1505,7 @@ Controls a network of short range air/missile defense groups.</p>
<li>Create polygon zones.</li>
<li>Create moving zones around a unit.</li>
<li>Create moving zones around a group.</li>
<li>Provide the zone behaviour. Some zones are static, while others are moveable.</li>
<li>Provide the zone behavior. Some zones are static, while others are moveable.</li>
<li>Enquiry if a coordinate is within a zone.</li>
<li>Smoke zones.</li>
<li>Set a zone probability to control zone selection.</li>
@@ -1517,11 +1517,11 @@ Controls a network of short range air/missile defense groups.</p>
</ul>
<p>There are essentially two core functions that zones accomodate:</p>
<p>There are essentially two core functions that zones accommodate:</p>
<ul>
<li>Test if an object is within the zone boundaries.</li>
<li>Provide the zone behaviour. Some zones are static, while others are moveable.</li>
<li>Provide the zone behavior. Some zones are static, while others are moveable.</li>
</ul>
<p>The object classes are using the zone classes to test the zone boundaries, which can take various forms:</p>
@@ -1826,7 +1826,7 @@ This class is an abstract BASE class for derived classes, and is not meant to be
<ul>
<li><a href="##(ZONE_POLYGON_BASE).GetRandomVec2">ZONE_POLYGON_BASE.GetRandomVec2</a>(): Gets a random 2D point in the zone.</li>
<li><a href="##(ZONE_POLYGON_BASE).GetRandomPointVec2">ZONE_POLYGON_BASE.GetRandomPointVec2</a>(): Return a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object representing a random 2D point within the zone.</li>
<li><a href="##(ZONE_POLYGON_BASE).GetRandomPointVec3">ZONE_POLYGON_BASE.GetRandomPointVec3</a>(): Return a <a href="Core.Point.html##(POINT_VEC3)">Core.Point#POINT_VEC3</a> object representing a random 3D point at landheight within the zone.</li>
<li><a href="##(ZONE_POLYGON_BASE).GetRandomPointVec3">ZONE_POLYGON_BASE.GetRandomPointVec3</a>(): Return a <a href="Core.Point.html##(POINT_VEC3)">Core.Point#POINT_VEC3</a> object representing a random 3D point at land height within the zone.</li>
</ul>
<h2>Draw zone</h2>
@@ -12662,7 +12662,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 specifed coalition is inside the zone and noone else.</p>
<p>Check if only the specified 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">
@@ -12787,8 +12787,10 @@ 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>
@@ -12836,8 +12838,10 @@ 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>
@@ -12853,7 +12857,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 coaltion is inside the zone and the specifed coalition is one of them.
<p>Check if more than one coalition is inside the zone and the specified 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>
@@ -12873,7 +12877,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 coaliton which is checked to be inside the zone.</p>
<p>ID of the coalition which is checked to be inside the zone.</p>
</div>
</div>
@@ -12889,8 +12893,10 @@ 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>
@@ -14705,7 +14711,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 specifed coalition is inside the zone and noone else.</p>
<p>Check if only the specified 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">
@@ -14830,8 +14836,10 @@ 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>
@@ -14879,8 +14887,10 @@ 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>
@@ -14896,7 +14906,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 coaltion is inside the zone and the specifed coalition is one of them.
<p>Check if more than one coalition is inside the zone and the specified 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>
@@ -14916,7 +14926,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 coaliton which is checked to be inside the zone.</p>
<p>ID of the coalition which is checked to be inside the zone.</p>
</div>
</div>
@@ -14932,8 +14942,10 @@ 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>