mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
Applevangelist
@@ -1775,12 +1775,12 @@ This class implements the inherited functions from <a href="Core.Zone.html##(ZON
|
||||
|
||||
<h2>Declare a ZONE_POLYGON directly in the DCS mission editor!</h2>
|
||||
|
||||
<p>You can declare a ZONE_POLYGON using the DCS mission editor by adding the ~ZONE_POLYGON tag in the group name.</p>
|
||||
<p>You can declare a ZONE_POLYGON using the DCS mission editor by adding the #ZONE_POLYGON tag in the group name.</p>
|
||||
|
||||
<p>So, imagine you have a group declared in the mission editor, with group name <code>DefenseZone~ZONE_POLYGON</code>.
|
||||
<p>So, imagine you have a group declared in the mission editor, with group name <code>DefenseZone#ZONE_POLYGON</code>.
|
||||
Then during mission startup, when loading Moose.lua, this group will be detected as a ZONE_POLYGON declaration.
|
||||
Within the background, a ZONE_POLYGON object will be created within the <a href="Core.Database.html">Core.Database</a> using the properties of the group.
|
||||
The ZONE_POLYGON name will be the group name without the ~ZONE_POLYGON tag.</p>
|
||||
The ZONE_POLYGON name will be the group name without the #ZONE_POLYGON tag.</p>
|
||||
|
||||
<p>So, you can search yourself for the ZONE_POLYGON by using the <a href="##(ZONE_POLYGON).FindByName">ZONE_POLYGON.FindByName</a>() method.
|
||||
In this example, <code>local PolygonZone = ZONE_POLYGON:FindByName( "DefenseZone" )</code> would return the ZONE_POLYGON object
|
||||
@@ -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 land height 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>
|
||||
</ul>
|
||||
|
||||
<h2>Draw zone</h2>
|
||||
@@ -1980,24 +1980,36 @@ This class is an abstract BASE class for derived classes, and is not meant to be
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_AIRBASE).GetRandomPointVec2">ZONE_AIRBASE:GetRandomPointVec2(inner, outer)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object reflecting a random 2D 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_AIRBASE).GetRandomVec2">ZONE_AIRBASE:GetRandomVec2()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns a random location within the zone of the <a href="Wrapper.Group.html">Wrapper.Group</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_AIRBASE).GetVec2">ZONE_AIRBASE:GetVec2()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns the current location of the <a href="Wrapper.Group.html">Wrapper.Group</a>.</p>
|
||||
<p>Returns the current location of the AIRBASE.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_AIRBASE).New">ZONE_AIRBASE:New(AirbaseName, Radius)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Constructor to create a ZONE_AIRBASE instance, taking the zone name, a zone <a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a> and a radius.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_AIRBASE).isAirdrome">ZONE_AIRBASE.isAirdrome</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>If <code>true</code>, airbase is an airdrome.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_AIRBASE).isHelipad">ZONE_AIRBASE.isHelipad</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>If <code>true</code>, airbase is a helipad.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_AIRBASE).isShip">ZONE_AIRBASE.isShip</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>If <code>true</code>, airbase is a ship.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -2037,6 +2049,12 @@ This class is an abstract BASE class for derived classes, and is not meant to be
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).DrawID">ZONE_BASE.DrawID</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Unique ID of the drawn zone on the F10 map.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).Get2DDistance">ZONE_BASE:Get2DDistance(Coordinate)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Get 2D distance to a coordinate.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3335,7 +3353,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_RADIUS).GetRandomCoordinate">ZONE_RADIUS:GetRandomCoordinate(inner, outer)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_RADIUS).GetRandomCoordinate">ZONE_RADIUS: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>
|
||||
@@ -3353,7 +3371,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_RADIUS).GetRandomVec2">ZONE_RADIUS:GetRandomVec2(inner, outer)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_RADIUS).GetRandomVec2">ZONE_RADIUS: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>
|
||||
@@ -3664,7 +3682,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_UNIT).GetRandomCoordinate">ZONE_UNIT:GetRandomCoordinate(inner, outer)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_UNIT).GetRandomCoordinate">ZONE_UNIT: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>
|
||||
@@ -3682,7 +3700,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_UNIT).GetRandomVec2">ZONE_UNIT:GetRandomVec2(inner, outer)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_UNIT).GetRandomVec2">ZONE_UNIT: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>
|
||||
@@ -3976,6 +3994,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<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">
|
||||
|
||||
#boolean
|
||||
<a id="#(ZONE_AIRBASE).isAirdrome" ><strong>ZONE_AIRBASE.isAirdrome</strong></a>
|
||||
|
||||
<p>If <code>true</code>, airbase is an airdrome.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(ZONE_AIRBASE).isHelipad" ><strong>ZONE_AIRBASE.isHelipad</strong></a>
|
||||
|
||||
<p>If <code>true</code>, airbase is a helipad.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(ZONE_AIRBASE).isShip" ><strong>ZONE_AIRBASE.isShip</strong></a>
|
||||
|
||||
<p>If <code>true</code>, airbase is a ship.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="functions w3-container w3-theme-l2">
|
||||
<h2>Function(s)</h2>
|
||||
</div>
|
||||
@@ -4063,36 +4114,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(ZONE_AIRBASE).GetRandomVec2" ><strong>ZONE_AIRBASE:GetRandomVec2()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns a random location within the zone of the <a href="Wrapper.Group.html">Wrapper.Group</a>.</p>
|
||||
|
||||
<div id= "#Functions##GetRandomVec2" 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_AIRBASE</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="DCS.html##(Vec2)">DCS#Vec2</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The random location of the zone based on the <a href="Wrapper.Group.html">Wrapper.Group</a> location.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -4102,7 +4123,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<h2><a id="#(ZONE_AIRBASE).GetVec2" ><strong>ZONE_AIRBASE:GetVec2()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns the current location of the <a href="Wrapper.Group.html">Wrapper.Group</a>.</p>
|
||||
<p>Returns the current location of the AIRBASE.</p>
|
||||
|
||||
<div id= "#Functions##GetVec2" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -4117,7 +4138,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The location of the zone based on the <a href="Wrapper.Group.html">Wrapper.Group</a> location.</p>
|
||||
<p>The location of the zone based on the AIRBASE location.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -4269,6 +4290,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(ZONE_BASE).Get2DDistance" ><strong>ZONE_BASE:Get2DDistance(Coordinate)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Get 2D distance to a coordinate.</p>
|
||||
|
||||
<div id= "#Functions##Get2DDistance" 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_BASE</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>
|
||||
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
||||
<strong><strong>Coordinate</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Reference coordinate. Can also be a DCS#Vec2 or DCS#Vec3 object.</p>
|
||||
|
||||
</div>
|
||||
</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>Distance to the reference coordinate in meters.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -12090,7 +12155,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(ZONE_RADIUS).GetRandomCoordinate" ><strong>ZONE_RADIUS:GetRandomCoordinate(inner, outer)</strong></a></h2>
|
||||
<h2><a id="#(ZONE_RADIUS).GetRandomCoordinate" ><strong>ZONE_RADIUS: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>
|
||||
@@ -12111,7 +12176,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
</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>
|
||||
@@ -12124,7 +12189,20 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
</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>
|
||||
@@ -12135,7 +12213,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>The random coordinate.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -12261,7 +12339,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(ZONE_RADIUS).GetRandomVec2" ><strong>ZONE_RADIUS:GetRandomVec2(inner, outer)</strong></a></h2>
|
||||
<h2><a id="#(ZONE_RADIUS).GetRandomVec2" ><strong>ZONE_RADIUS:GetRandomVec2(inner, outer, surfacetypes)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns a random Vec2 location within the zone.</p>
|
||||
@@ -12282,7 +12360,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
</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>
|
||||
@@ -12295,7 +12373,20 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
</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>
|
||||
@@ -12662,7 +12753,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">
|
||||
@@ -12787,10 +12878,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>
|
||||
|
||||
@@ -12838,10 +12927,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>
|
||||
|
||||
@@ -12857,7 +12944,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>
|
||||
|
||||
@@ -12877,7 +12964,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>
|
||||
@@ -12893,10 +12980,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>
|
||||
|
||||
@@ -14139,7 +14224,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(ZONE_UNIT).GetRandomCoordinate" ><strong>ZONE_UNIT:GetRandomCoordinate(inner, outer)</strong></a></h2>
|
||||
<h2><a id="#(ZONE_UNIT).GetRandomCoordinate" ><strong>ZONE_UNIT: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>
|
||||
@@ -14160,7 +14245,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
|
||||
</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>
|
||||
@@ -14173,7 +14258,20 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
|
||||
</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>
|
||||
@@ -14184,7 +14282,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>The random coordinate.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -14310,7 +14408,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(ZONE_UNIT).GetRandomVec2" ><strong>ZONE_UNIT:GetRandomVec2(inner, outer)</strong></a></h2>
|
||||
<h2><a id="#(ZONE_UNIT).GetRandomVec2" ><strong>ZONE_UNIT:GetRandomVec2(inner, outer, surfacetypes)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns a random Vec2 location within the zone.</p>
|
||||
@@ -14331,7 +14429,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
|
||||
</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>
|
||||
@@ -14344,7 +14442,20 @@ Note that once a zone has been scanned, multiple evaluations can be done on the
|
||||
</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>
|
||||
@@ -14711,7 +14822,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">
|
||||
@@ -14836,10 +14947,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>
|
||||
|
||||
@@ -14887,10 +14996,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>
|
||||
|
||||
@@ -14906,7 +15013,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>
|
||||
|
||||
@@ -14926,7 +15033,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>
|
||||
@@ -14942,10 +15049,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>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user