MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-09-28 10:01:57 +00:00
parent de347bb63f
commit 820c701913
32 changed files with 1820 additions and 704 deletions
+706 -5
View File
@@ -1631,7 +1631,7 @@ Controls a network of short range air/missile defense groups.</p>
<hr/>
<h3>Author: <strong>FlightControl</strong></h3>
<h3>Contributions:</h3>
<h3>Contributions: <strong>Applevangelist</strong>, <strong>FunkyFranky</strong></h3>
<hr/>
@@ -3420,10 +3420,88 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from ZONE_POLYGON</th>
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).CheckScannedCoalition">ZONE_POLYGON:CheckScannedCoalition(Coalition)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if a certain coalition is inside a scanned zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).CountScannedCoalitions">ZONE_POLYGON:CountScannedCoalitions()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Count the number of different coalitions inside 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_POLYGON).FindByName">ZONE_POLYGON:FindByName(ZoneName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Find a polygon zone in the _DATABASE using the name of the polygon zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).GetScannedCoalition">ZONE_POLYGON:GetScannedCoalition(Coalition)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get Coalitions of the units in the Zone, or Check if there are units of the given Coalition in 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_POLYGON).GetScannedScenery">ZONE_POLYGON:GetScannedScenery()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get scanned scenery table (currently not implemented in ZONE_POLYGON)</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).GetScannedSceneryType">ZONE_POLYGON:GetScannedSceneryType(SceneryType)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get scanned scenery type (currently not implemented in ZONE_POLYGON)</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).GetScannedSetGroup">ZONE_POLYGON:GetScannedSetGroup()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get a set of scanned units.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).GetScannedSetUnit">ZONE_POLYGON:GetScannedSetUnit()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get a set of scanned units.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).GetScannedUnits">ZONE_POLYGON:GetScannedUnits()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Count the number of different coalitions inside 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_POLYGON).IsAllInZoneOfCoalition">ZONE_POLYGON:IsAllInZoneOfCoalition(Coalition)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Is All in Zone of Coalition?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).IsAllInZoneOfOtherCoalition">ZONE_POLYGON:IsAllInZoneOfOtherCoalition(Coalition)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Is All in Zone of Other Coalition?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).IsNoneInZone">ZONE_POLYGON:IsNoneInZone()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Is None in Zone?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).IsNoneInZoneOfCoalition">ZONE_POLYGON:IsNoneInZoneOfCoalition(Coalition)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Is None in Zone of Coalition?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).IsSomeInZoneOfCoalition">ZONE_POLYGON:IsSomeInZoneOfCoalition(Coalition)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Is Some in Zone of Coalition?</p>
</td>
</tr>
<tr class="w3-border">
@@ -3436,6 +3514,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).NewFromGroupName">ZONE_POLYGON:NewFromGroupName(GroupName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Constructor to create a ZONE_POLYGON instance, taking the zone name and the <strong>name</strong> of the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> defined within the Mission Editor.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).Scan">ZONE_POLYGON:Scan(ObjectCategories, UnitCategories)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Scan the zone for the presence of units of the given ObjectCategories.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).ScanData">ZONE_POLYGON.ScanData</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON).ScanSetGroup">ZONE_POLYGON.ScanSetGroup</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@@ -11886,11 +11982,107 @@ When moose is loading dynamically (for moose class development), tracing is swit
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(ZONE_POLYGON).ScanData" ><strong>ZONE_POLYGON.ScanData</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
<a id="#(ZONE_POLYGON).ScanSetGroup" ><strong>ZONE_POLYGON.ScanSetGroup</strong></a>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_POLYGON).CheckScannedCoalition" ><strong>ZONE_POLYGON:CheckScannedCoalition(Coalition)</strong></a></h2>
</div>
<p>Check if a certain coalition is inside a scanned zone.</p>
<div id= "#Functions##CheckScannedCoalition" 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>ZONE_POLYGON</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>Coalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The coalition id, e.g. coalition.side.BLUE.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>If true, the coalition is inside the zone.</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="#(ZONE_POLYGON).CountScannedCoalitions" ><strong>ZONE_POLYGON:CountScannedCoalitions()</strong></a></h2>
</div>
<p>Count the number of different coalitions inside the zone.</p>
<div id= "#Functions##CountScannedCoalitions" 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>ZONE_POLYGON</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>Counted coalitions.</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="#(ZONE_POLYGON).FindByName" ><strong>ZONE_POLYGON:FindByName(ZoneName)</strong></a></h2>
</div>
@@ -11930,6 +12122,457 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_POLYGON).GetScannedCoalition" ><strong>ZONE_POLYGON:GetScannedCoalition(Coalition)</strong></a></h2>
</div>
<p>Get Coalitions of the units in the Zone, or Check if there are units of the given Coalition in the Zone.</p>
<p>Returns nil if there are none to two Coalitions in the zone!
Returns one Coalition if there are only Units of one Coalition in the Zone.
Returns the Coalition for the given Coalition if there are units of the Coalition in the Zone.</p>
<div id= "#Functions##GetScannedCoalition" 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>ZONE_POLYGON</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>
<strong><strong>Coalition</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>#table:</p>
</div>
<div class="w3-half">
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_POLYGON).GetScannedScenery" ><strong>ZONE_POLYGON:GetScannedScenery()</strong></a></h2>
</div>
<p>Get scanned scenery table (currently not implemented in ZONE_POLYGON)</p>
<div id= "#Functions##GetScannedScenery" 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>ZONE_POLYGON</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>Table of DCS scenery objects.</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="#(ZONE_POLYGON).GetScannedSceneryType" ><strong>ZONE_POLYGON:GetScannedSceneryType(SceneryType)</strong></a></h2>
</div>
<p>Get scanned scenery type (currently not implemented in ZONE_POLYGON)</p>
<div id= "#Functions##GetScannedSceneryType" 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>ZONE_POLYGON</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>
<strong><strong>SceneryType</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>#table:</p>
</div>
<div class="w3-half">
<p>Table of DCS scenery type objects.</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="#(ZONE_POLYGON).GetScannedSetGroup" ><strong>ZONE_POLYGON:GetScannedSetGroup()</strong></a></h2>
</div>
<p>Get a set of scanned units.</p>
<div id= "#Functions##GetScannedSetGroup" 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>ZONE_POLYGON</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_GROUP)">Core.Set#SET_GROUP</a>:</p>
</div>
<div class="w3-half">
<p>Set of groups.</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="#(ZONE_POLYGON).GetScannedSetUnit" ><strong>ZONE_POLYGON:GetScannedSetUnit()</strong></a></h2>
</div>
<p>Get a set of scanned units.</p>
<div id= "#Functions##GetScannedSetUnit" 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>ZONE_POLYGON</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_UNIT)">Core.Set#SET_UNIT</a>:</p>
</div>
<div class="w3-half">
<p>Set of units and statics inside the zone.</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="#(ZONE_POLYGON).GetScannedUnits" ><strong>ZONE_POLYGON:GetScannedUnits()</strong></a></h2>
</div>
<p>Count the number of different coalitions inside the zone.</p>
<div id= "#Functions##GetScannedUnits" 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>ZONE_POLYGON</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>Table of DCS units and DCS statics inside the zone.</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="#(ZONE_POLYGON).IsAllInZoneOfCoalition" ><strong>ZONE_POLYGON:IsAllInZoneOfCoalition(Coalition)</strong></a></h2>
</div>
<p>Is All in Zone of Coalition?</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">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>ZONE_POLYGON</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>Coalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Coalition ID of the coalition which is checked to be the only one in the zone.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>True, if <strong>only</strong> that coalition is inside the zone and no one else.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> self.Zone:Scan()
local IsGuarded = self.Zone:IsAllInZoneOfCoalition( self.Coalition )</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_POLYGON).IsAllInZoneOfOtherCoalition" ><strong>ZONE_POLYGON:IsAllInZoneOfOtherCoalition(Coalition)</strong></a></h2>
</div>
<p>Is All in Zone of Other Coalition?</p>
<p>Check if only one coalition is inside the zone and the specified coalition is not the one.
You first need to use the <a href="##(ZONE_POLYGON).Scan">ZONE_POLYGON.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>
<div id= "#Functions##IsAllInZoneOfOtherCoalition" 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>ZONE_POLYGON</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>Coalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Coalition ID of the coalition which is not supposed to be in the zone.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>True, if and only if only one coalition is inside the zone and the specified coalition is not it.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> self.Zone:Scan()
local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_POLYGON).IsNoneInZone" ><strong>ZONE_POLYGON:IsNoneInZone()</strong></a></h2>
</div>
<p>Is None in Zone?</p>
<p>You first need to use the <a href="##(ZONE_POLYGON).Scan">ZONE_POLYGON.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>
<div id= "#Functions##IsNoneInZone" 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>ZONE_POLYGON</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> self.Zone:Scan()
local IsEmpty = self.Zone:IsNoneInZone()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_POLYGON).IsNoneInZoneOfCoalition" ><strong>ZONE_POLYGON:IsNoneInZoneOfCoalition(Coalition)</strong></a></h2>
</div>
<p>Is None in Zone of Coalition?</p>
<p>You first need to use the <a href="##(ZONE_POLYGON).Scan">ZONE_POLYGON.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>
<div id= "#Functions##IsNoneInZoneOfCoalition" 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>ZONE_POLYGON</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>
<strong><strong>Coalition</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>#boolean:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> self.Zone:Scan()
local IsOccupied = self.Zone:IsNoneInZoneOfCoalition( self.Coalition )</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_POLYGON).IsSomeInZoneOfCoalition" ><strong>ZONE_POLYGON:IsSomeInZoneOfCoalition(Coalition)</strong></a></h2>
</div>
<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.
You first need to use the <a href="##(ZONE_POLYGON).Scan">ZONE_POLYGON.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>
<div id= "#Functions##IsSomeInZoneOfCoalition" 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>ZONE_POLYGON</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>Coalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>ID of the coaliton which is checked to be inside the zone.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>True if more than one coalition is inside the zone and the specified coalition is one of them.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> self.Zone:Scan()
local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )</code></pre>
</div>
</div>
</div>
@@ -12037,6 +12680,66 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(ZONE_POLYGON).Scan" ><strong>ZONE_POLYGON:Scan(ObjectCategories, UnitCategories)</strong></a></h2>
</div>
<p>Scan the zone for the presence of units of the given ObjectCategories.</p>
<p>Does <strong>not</strong> scan for scenery at the moment.
Note that <strong>only after</strong> a zone has been scanned, the zone can be evaluated by:</p>
<ul>
<li><a href="ZONE_POLYGON.IsAllInZoneOfCoalition.html">ZONE_POLYGON.IsAllInZoneOfCoalition</a>(): Scan the presence of units in the zone of a coalition.</li>
<li><a href="ZONE_POLYGON.IsAllInZoneOfOtherCoalition.html">ZONE_POLYGON.IsAllInZoneOfOtherCoalition</a>(): Scan the presence of units in the zone of an other coalition.</li>
<li><a href="ZONE_POLYGON.IsSomeInZoneOfCoalition.html">ZONE_POLYGON.IsSomeInZoneOfCoalition</a>(): Scan if there is some presence of units in the zone of the given coalition.</li>
<li><a href="ZONE_POLYGON.IsNoneInZoneOfCoalition.html">ZONE_POLYGON.IsNoneInZoneOfCoalition</a>(): Scan if there isn't any presence of units in the zone of an other coalition than the given one.</li>
<li><a href="ZONE_POLYGON.IsNoneInZone.html">ZONE_POLYGON.IsNoneInZone</a>(): Scan if the zone is empty.</li>
</ul>
<div id= "#Functions##Scan" 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>ZONE_POLYGON</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>
<strong><strong>ObjectCategories</strong></strong>
</p>
</div>
<div class="w3-half">
<p>An array of categories of the objects to find in the zone. E.g. <code>{Object.Category.UNIT}</code></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>UnitCategories</strong></strong>
</p>
</div>
<div class="w3-half">
<p>An array of unit categories of the objects to find in the zone. E.g. <code>{Unit.Category.GROUND_UNIT,Unit.Category.SHIP}</code></p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> myzone:Scan({Object.Category.UNIT},{Unit.Category.GROUND_UNIT})
local IsAttacked = myzone:IsSomeInZoneOfCoalition( self.Coalition )</code></pre>
</div>
</div>
</div>
@@ -14772,8 +15475,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
<li><a href="ZONE_RADIUS.IsAllInZoneOfOtherCoalition.html">ZONE_RADIUS.IsAllInZoneOfOtherCoalition</a>(): Scan the presence of units in the zone of an other coalition.</li>
<li><a href="ZONE_RADIUS.IsSomeInZoneOfCoalition.html">ZONE_RADIUS.IsSomeInZoneOfCoalition</a>(): Scan if there is some presence of units in the zone of the given coalition.</li>
<li><a href="ZONE_RADIUS.IsNoneInZoneOfCoalition.html">ZONE_RADIUS.IsNoneInZoneOfCoalition</a>(): Scan if there isn't any presence of units in the zone of an other coalition than the given one.</li>
<li><a href="ZONE_RADIUS.IsNoneInZone.html">ZONE_RADIUS.IsNoneInZone</a>(): Scan if the zone is empty.
@{#ZONE_RADIUS.</li>
<li><a href="ZONE_RADIUS.IsNoneInZone.html">ZONE_RADIUS.IsNoneInZone</a>(): Scan if the zone is empty.</li>
</ul>
<div id= "#Functions##Scan" class="w3-show w3-white">
@@ -16940,8 +17642,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
<li><a href="ZONE_RADIUS.IsAllInZoneOfOtherCoalition.html">ZONE_RADIUS.IsAllInZoneOfOtherCoalition</a>(): Scan the presence of units in the zone of an other coalition.</li>
<li><a href="ZONE_RADIUS.IsSomeInZoneOfCoalition.html">ZONE_RADIUS.IsSomeInZoneOfCoalition</a>(): Scan if there is some presence of units in the zone of the given coalition.</li>
<li><a href="ZONE_RADIUS.IsNoneInZoneOfCoalition.html">ZONE_RADIUS.IsNoneInZoneOfCoalition</a>(): Scan if there isn't any presence of units in the zone of an other coalition than the given one.</li>
<li><a href="ZONE_RADIUS.IsNoneInZone.html">ZONE_RADIUS.IsNoneInZone</a>(): Scan if the zone is empty.
@{#ZONE_RADIUS.</li>
<li><a href="ZONE_RADIUS.IsNoneInZone.html">ZONE_RADIUS.IsNoneInZone</a>(): Scan if the zone is empty.</li>
</ul>
<div id= "#Functions##Scan" class="w3-show w3-white">