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
2023-10-17 14:16:44 +00:00
parent 01fe4a7712
commit d4ca00b69d
30 changed files with 1857 additions and 1112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

593
Documentation/Core.Zone.html
View File

@@ -2150,6 +2150,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).BoundZone">ZONE_BASE:BoundZone()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Bound the zone boundaries with a tires.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).Checktime">ZONE_BASE.Checktime</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check every Checktime seconds, used for ZONE:Trigger()</p>
</td>
</tr>
<tr class="w3-border">
@@ -2354,6 +2360,24 @@ 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).New">ZONE_BASE:New(ZoneName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>ZONE_BASE constructor</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).OnAfterEnteredZone">ZONE_BASE:OnAfterEnteredZone(From, Event, To, Controllable)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>On After "EnteredZone" event.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).OnAfterLeftZone">ZONE_BASE:OnAfterLeftZone(From, Event, To, Controllable)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>On After "LeftZone" event.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).SetCheckTime">ZONE_BASE:SetCheckTime(seconds)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the check time for ZONE:Trigger()</p>
</td>
</tr>
<tr class="w3-border">
@@ -2402,6 +2426,18 @@ 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).Table">ZONE_BASE.Table</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>of any trigger zone properties from the ME. The key is the Name of the property, and the value is the property's Value.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).Trigger">ZONE_BASE:Trigger(Objects)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Start watching if the Object or Objects move into or out of a zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).TriggerStop">ZONE_BASE:TriggerStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Triggers the FSM event "TriggerStop".</p>
</td>
</tr>
<tr class="w3-border">
@@ -2426,12 +2462,42 @@ 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).ZoneProbability">ZONE_BASE.ZoneProbability</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>A value between 0 and 1. 0 = 0% and 1 = 100% probability.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE)._TriggerCheck">ZONE_BASE:_TriggerCheck(fromstart)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Check the assigned objects for being in/out of 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_BASE).__TriggerStop">ZONE_BASE:__TriggerStop(delay)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Triggers the FSM event "TriggerStop" after a delay. </p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).checkobjects">ZONE_BASE.checkobjects</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_BASE).drawCoalition">ZONE_BASE.drawCoalition</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Draw coalition.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(ZONE_BASE).objectset">ZONE_BASE.objectset</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_BASE).onafterTriggerRunCheck">ZONE_BASE:onafterTriggerRunCheck(From, Event, to, To)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Check the assigned objects for being in/out of the zone</p>
</td>
</tr>
</table>
@@ -4638,6 +4704,17 @@ 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">
#number
<a id="#(ZONE_BASE).Checktime" ><strong>ZONE_BASE.Checktime</strong></a>
<p>Check every Checktime seconds, used for ZONE:Trigger()</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -4737,6 +4814,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>A value between 0 and 1. 0 = 0% and 1 = 100% probability.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(ZONE_BASE).checkobjects" ><strong>ZONE_BASE.checkobjects</strong></a>
</div>
</div>
@@ -4748,6 +4836,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Draw coalition.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(ZONE_BASE).objectset" ><strong>ZONE_BASE.objectset</strong></a>
</div>
</div>
@@ -5881,6 +5980,200 @@ end
</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).OnAfterEnteredZone" ><strong>ZONE_BASE:OnAfterEnteredZone(From, Event, To, Controllable)</strong></a></h2>
</div>
<p>On After "EnteredZone" event.</p>
<p>An observed object has entered the zone.</p>
<div id= "#Functions##OnAfterEnteredZone" 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>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p>From state.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Event.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</strong></strong>
</p>
</div>
<div class="w3-half">
<p>To state.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<strong><strong>Controllable</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The controllable entering 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_BASE).OnAfterLeftZone" ><strong>ZONE_BASE:OnAfterLeftZone(From, Event, To, Controllable)</strong></a></h2>
</div>
<p>On After "LeftZone" event.</p>
<p>An observed object has left the zone.</p>
<div id= "#Functions##OnAfterLeftZone" 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>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p>From state.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Event.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</strong></strong>
</p>
</div>
<div class="w3-half">
<p>To state.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<strong><strong>Controllable</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The controllable leaving 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_BASE).SetCheckTime" ><strong>ZONE_BASE:SetCheckTime(seconds)</strong></a></h2>
</div>
<p>Set the check time for ZONE:Trigger()</p>
<div id= "#Functions##SetCheckTime" 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>
#number
<strong><strong>seconds</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Check every seconds for objects entering or leaving the zone. Defaults to 5 secs.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(ZONE_BASE)">#ZONE_BASE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -6160,6 +6453,89 @@ end
</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).Trigger" ><strong>ZONE_BASE:Trigger(Objects)</strong></a></h2>
</div>
<p>Start watching if the Object or Objects move into or out of a zone.</p>
<div id= "#Functions##Trigger" 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="Wrappe.Controllable.html##(CONTROLLABLE)">Wrappe.Controllable#CONTROLLABLE</a>
<strong><strong>Objects</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Object or Objects to watch, can be of type UNIT, GROUP, CLIENT, or SET_UNIT, SET_GROUP, SET_CLIENT</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(ZONE_BASE)">#ZONE_BASE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> -- Create a new zone and start watching it every 5 secs for a certain GROUP entering or leaving
local triggerzone = ZONE:New("ZonetoWatch"):Trigger(GROUP:FindByName("Aerial-1"))
-- function to handle FSM event "EnteredZone"
function triggerzone:OnAfterEnteredZone(From,Event,To,Group)
MESSAGE:New("Group has entered zone!",15):ToAll()
end
-- function to handle FSM event "LeftZone"
function triggerzone:OnAfterLeftZone(From,Event,To,Group)
MESSAGE:New("Group has left zone!",15):ToAll()
end
-- Stop watching the zone after 1 hour
triggerzone:__TriggerStop(3600)</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_BASE).TriggerStop" ><strong>ZONE_BASE:TriggerStop()</strong></a></h2>
</div>
<p>Triggers the FSM event "TriggerStop".</p>
<p>Stops the ZONE_BASE Trigger.</p>
<div id= "#Functions##TriggerStop" 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>
</div>
</div>
</div>
@@ -6204,12 +6580,174 @@ end
</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)._TriggerCheck" ><strong>ZONE_BASE:_TriggerCheck(fromstart)</strong></a></h2>
</div>
<p>(Internal) Check the assigned objects for being in/out of the zone</p>
<div id= "#Functions##_TriggerCheck" 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>
#boolean
<strong><strong>fromstart</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, do the init of the objects</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(ZONE_BASE)">#ZONE_BASE</a>:</p>
</div>
<div class="w3-half">
<p>self</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_BASE).__TriggerStop" ><strong>ZONE_BASE:__TriggerStop(delay)</strong></a></h2>
</div>
<p>Triggers the FSM event "TriggerStop" after a delay. </p>
<div id= "#Functions##__TriggerStop" 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>
#number
<strong><strong>delay</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Delay in seconds.</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_BASE).onafterTriggerRunCheck" ><strong>ZONE_BASE:onafterTriggerRunCheck(From, Event, to, To)</strong></a></h2>
</div>
<p>(Internal) Check the assigned objects for being in/out of the zone</p>
<div id= "#Functions##onafterTriggerRunCheck" 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>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>to</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>To</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><a href="##(ZONE_BASE)">#ZONE_BASE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<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">
#number
<a id="#(ZONE_BASE).Checktime" ><strong>ZONE_BASE.Checktime</strong></a>
<p>Check every Checktime seconds, used for ZONE:Trigger()</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -6309,6 +6847,17 @@ end
<p>A value between 0 and 1. 0 = 0% and 1 = 100% probability.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(ZONE_BASE).checkobjects" ><strong>ZONE_BASE.checkobjects</strong></a>
</div>
</div>
@@ -6320,6 +6869,17 @@ end
<p>Draw coalition.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(ZONE_BASE).objectset" ><strong>ZONE_BASE.objectset</strong></a>
</div>
</div>
@@ -7768,6 +8328,17 @@ end
<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">
#number
<a id="#(ZONE_BASE).Checktime" ><strong>ZONE_BASE.Checktime</strong></a>
<p>Check every Checktime seconds, used for ZONE:Trigger()</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -7867,6 +8438,17 @@ end
<p>A value between 0 and 1. 0 = 0% and 1 = 100% probability.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(ZONE_BASE).checkobjects" ><strong>ZONE_BASE.checkobjects</strong></a>
</div>
</div>
@@ -7878,6 +8460,17 @@ end
<p>Draw coalition.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(ZONE_BASE).objectset" ><strong>ZONE_BASE.objectset</strong></a>
</div>
</div>