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
@@ -2204,7 +2204,7 @@ This class is an abstract BASE class for derived classes, and is not meant to be
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).GetAllProperties">ZONE_BASE:GetAllProperties()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Returns the zone Properties table.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2288,7 +2288,7 @@ This class is an abstract BASE class for derived classes, and is not meant to be
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).GetProperty">ZONE_BASE:GetProperty(PropertyName)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Returns the Value of the zone with the given PropertyName, or nil if no matching property exists.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3319,7 +3319,7 @@ 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">Description</th>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_ELASTIC).AddSetGroup">ZONE_ELASTIC:AddSetGroup(SetGroup, GroupSet)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_ELASTIC).AddSetGroup">ZONE_ELASTIC:AddSetGroup(GroupSet)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Add a set of groups.</p>
|
||||
</td>
|
||||
@@ -3640,6 +3640,12 @@ 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_BASE).GetBoundingVec2">ZONE_POLYGON_BASE:GetBoundingVec2()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Get the bounding 2D vectors of the 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_BASE).GetRadius">ZONE_POLYGON_BASE:GetRadius()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Get the smallest radius encompassing all points of the polygon zone. </p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3717,7 +3723,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_POLYGON_BASE).GetZoneRadius">ZONE_POLYGON_BASE:GetZoneRadius(ZoneName, DoNotRegisterZone)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Get the smallest circular zone encompassing all points points of the polygon zone. </p>
|
||||
<p>Get the smallest circular zone encompassing all points of the polygon zone. </p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -4900,12 +4906,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<h2><a id="#(ZONE_BASE).GetAllProperties" ><strong>ZONE_BASE:GetAllProperties()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Returns the zone Properties table.
|
||||
@param #ZONE_BASE self
|
||||
@return #table The Key:Value table of TriggerZone properties of the zone.</p>
|
||||
<p>Returns the zone Properties table.</p>
|
||||
|
||||
<div id= "#Functions##GetAllProperties" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -4913,6 +4914,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div class="w3-margin-left">
|
||||
<p>ZONE_BASE</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>The Key:Value table of TriggerZone properties of the zone.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -5359,19 +5371,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<h2><a id="#(ZONE_BASE).GetProperty" ><strong>ZONE_BASE:GetProperty(PropertyName)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Returns the Value of the zone with the given PropertyName, or nil if no matching property exists.
|
||||
@param #ZONE_BASE self
|
||||
@param #string PropertyName The name of a the TriggerZone Property to be retrieved.
|
||||
@return #string The Value of the TriggerZone Property with the given PropertyName, or nil if absent.
|
||||
@usage</p>
|
||||
|
||||
<p> local PropertiesZone = ZONE:FindByName("Properties Zone")
|
||||
local Property = "ExampleProperty"
|
||||
local PropertyValue = PropertiesZone:GetProperty(Property)</p>
|
||||
|
||||
<p>Returns the Value of the zone with the given PropertyName, or nil if no matching property exists.</p>
|
||||
|
||||
<div id= "#Functions##GetProperty" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -5383,13 +5383,34 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>PropertyName</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>The name of a the TriggerZone Property to be retrieved.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#string:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The Value of the TriggerZone Property with the given PropertyName, or nil if absent.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>
|
||||
local PropertiesZone = ZONE:FindByName("Properties Zone")
|
||||
local Property = "ExampleProperty"
|
||||
local PropertyValue = PropertiesZone:GetProperty(Property)
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -11432,7 +11453,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_ELASTIC).AddSetGroup" ><strong>ZONE_ELASTIC:AddSetGroup(SetGroup, GroupSet)</strong></a></h2>
|
||||
<h2><a id="#(ZONE_ELASTIC).AddSetGroup" ><strong>ZONE_ELASTIC:AddSetGroup(GroupSet)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Add a set of groups.</p>
|
||||
@@ -11446,12 +11467,12 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
<div class="w3-margin-left">
|
||||
<p>ZONE_ELASTIC</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<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.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
||||
<strong><strong>SetGroup</strong></strong>
|
||||
<strong><strong>GroupSet</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
@@ -11460,16 +11481,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<strong><strong>GroupSet</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">
|
||||
@@ -13438,6 +13449,36 @@ Note that <strong>only after</strong> a zone has been scanned, the zone can be e
|
||||
</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_BASE).GetRadius" ><strong>ZONE_POLYGON_BASE:GetRadius()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Get the smallest radius encompassing all points of the polygon zone. </p>
|
||||
|
||||
<div id= "#Functions##GetRadius" 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_BASE</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>Radius of the zone in meters.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -13873,7 +13914,7 @@ Note that <strong>only after</strong> a zone has been scanned, the zone can be e
|
||||
<h2><a id="#(ZONE_POLYGON_BASE).GetZoneRadius" ><strong>ZONE_POLYGON_BASE:GetZoneRadius(ZoneName, DoNotRegisterZone)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Get the smallest circular zone encompassing all points points of the polygon zone. </p>
|
||||
<p>Get the smallest circular zone encompassing all points of the polygon zone. </p>
|
||||
|
||||
<div id= "#Functions##GetZoneRadius" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
|
||||
Reference in New Issue
Block a user