MOOSE generated documentation [skip ci]

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

View File

@@ -1497,7 +1497,7 @@ Controls a network of short range air/missile defense groups.</p>
<hr/>
<p>ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition. <br/>
<p>ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition.
Derived classes implement the ways how the achievements can be realized.</p>
<hr/>
@@ -1589,7 +1589,7 @@ Derived classes implement the ways how the achievements can be realized.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_GOAL_COALITION).GetPreviousCoalition">ZONE_GOAL_COALITION:GetPreviousCoalition()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the previous coaliton, i.e.</p>
<p>Get the previous coalition, i.e.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2166,7 +2166,7 @@ Derived classes implement the ways how the achievements can be realized.</p>
<h2><a id="#(ZONE_GOAL_COALITION).GetPreviousCoalition" ><strong>ZONE_GOAL_COALITION:GetPreviousCoalition()</strong></a></h2>
</div>
<p>Get the previous coaliton, i.e.</p>
<p>Get the previous coalition, i.e.</p>
<p>the one owning the zone before the current one. </p>
@@ -3954,7 +3954,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">
@@ -4079,8 +4079,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>
@@ -4128,8 +4130,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>
@@ -4145,7 +4149,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>
@@ -4165,7 +4169,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>
@@ -4181,8 +4185,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>