MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2020-08-29 20:18:04 +00:00
parent 5e09807ca2
commit e78fc537c9
120 changed files with 46952 additions and 4751 deletions

View File

@@ -664,6 +664,17 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Management of spotting logistics, that can be activated and deactivated upon command.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/CORE_Timer.png" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Timer.html">Core.Timer</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Timer scheduler.</p>
</p></div>
</div>
</div>
@@ -1173,6 +1184,17 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> - Creates and manages player TASK_ZONE_CAPTURE tasks.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.PROFILER.html">Utilities.PROFILER</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Utils</strong> - Lua Profiler.</p>
</p></div>
</div>
</div>
@@ -1239,6 +1261,17 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Wrapper</strong> -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/Wrapper_Marker.png" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Marker.html">Wrapper.Marker</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Wrapper</strong> - Markers On the F10 map.</p>
</p></div>
</div>
</div>
@@ -1777,7 +1810,13 @@ and setup a new capture zone task and assign it to a group of players, while you
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).CallScheduler">TASK_CAPTURE_DISPATCHER.CallScheduler</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Call scheduler.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).ClassName">TASK_CAPTURE_DISPATCHER.ClassName</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Name of the class.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1789,7 +1828,7 @@ and setup a new capture zone task and assign it to a group of players, while you
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).GetCurrentState">TASK_CAPTURE_DISPATCHER:GetCurrentState()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get current state.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1811,7 +1850,7 @@ and setup a new capture zone task and assign it to a group of players, while you
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).GetScores">TASK_CAPTURE_DISPATCHER:GetScores()</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).GetScores">TASK_CAPTURE_DISPATCHER:GetScores(Scores)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a table with the scores defined.</p>
</td>
@@ -1825,7 +1864,7 @@ and setup a new capture zone task and assign it to a group of players, while you
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).GetState">TASK_CAPTURE_DISPATCHER:GetState()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get current state.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1841,15 +1880,15 @@ and setup a new capture zone task and assign it to a group of players, while you
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).Is">TASK_CAPTURE_DISPATCHER:Is(State)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).Is">TASK_CAPTURE_DISPATCHER:Is(State, If)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if FSM is in state.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).LoadCallBacks">TASK_CAPTURE_DISPATCHER:LoadCallBacks(CallBackTable)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Load call backs.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1861,7 +1900,7 @@ and setup a new capture zone task and assign it to a group of players, while you
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).Scores">TASK_CAPTURE_DISPATCHER.Scores</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Scores.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1915,73 +1954,73 @@ and setup a new capture zone task and assign it to a group of players, while you
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER)._add_to_map">TASK_CAPTURE_DISPATCHER:_add_to_map(Map, Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add to map.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER)._call_handler">TASK_CAPTURE_DISPATCHER:_call_handler(step, trigger, params, EventName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Call handler.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER)._create_transition">TASK_CAPTURE_DISPATCHER:_create_transition(EventName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create transition.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER)._delayed_transition">TASK_CAPTURE_DISPATCHER:_delayed_transition(EventName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Delayed transition.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER)._eventmap">TASK_CAPTURE_DISPATCHER:_eventmap(Events, EventStructure)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Event map.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER)._gosub">TASK_CAPTURE_DISPATCHER:_gosub(ParentFrom, ParentEvent)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Go sub.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER)._handler">TASK_CAPTURE_DISPATCHER:_handler(EventName, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handler.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER)._isendstate">TASK_CAPTURE_DISPATCHER:_isendstate(Current)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Is end state.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER)._submap">TASK_CAPTURE_DISPATCHER:_submap(subs, sub, name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Sub maps.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).can">TASK_CAPTURE_DISPATCHER:can(e)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if can do an event.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).cannot">TASK_CAPTURE_DISPATCHER:cannot(e)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if cannot do an event.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).current">TASK_CAPTURE_DISPATCHER.current</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Current state name.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1991,21 +2030,21 @@ and setup a new capture zone task and assign it to a group of players, while you
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).is">TASK_CAPTURE_DISPATCHER:is(state)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).is">TASK_CAPTURE_DISPATCHER:is(State, If, state)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if FSM is in state.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).options">TASK_CAPTURE_DISPATCHER.options</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Options.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CAPTURE_DISPATCHER).subs">TASK_CAPTURE_DISPATCHER.subs</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Subs.</p>
</td>
</tr>
</table>
@@ -3852,11 +3891,14 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>State</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>The FSM state.</p>
</div>
</div>
</div>
@@ -4181,7 +4223,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER).GetCurrentState" ><strong>TASK_CAPTURE_DISPATCHER:GetCurrentState()</strong></a></h2>
</div>
<p>Get current state.</p>
<div id= "#Functions##GetCurrentState" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4189,6 +4231,17 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-margin-left">
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
</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>Current FSM state. </p>
</div>
</div>
</div>
</div>
@@ -4208,6 +4261,17 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-margin-left">
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></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>End states.</p>
</div>
</div>
</div>
</div>
@@ -4274,7 +4338,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
</div>
<div class="w3-half">
<p>Sub processes.</p>
</div>
</div>
@@ -4286,7 +4350,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(TASK_CAPTURE_DISPATCHER).GetScores" ><strong>TASK_CAPTURE_DISPATCHER:GetScores()</strong></a></h2>
<h2><a id="#(TASK_CAPTURE_DISPATCHER).GetScores" ><strong>TASK_CAPTURE_DISPATCHER:GetScores(Scores)</strong></a></h2>
</div>
<p>Returns a table with the scores defined.</p>
@@ -4297,6 +4361,18 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-margin-left">
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></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>
#table
<strong><strong>Scores</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
@@ -4338,7 +4414,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER).GetState" ><strong>TASK_CAPTURE_DISPATCHER:GetState()</strong></a></h2>
</div>
<p>Get current state.</p>
<div id= "#Functions##GetState" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4346,6 +4422,17 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-margin-left">
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
</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>Current FSM state.</p>
</div>
</div>
</div>
</div>
@@ -4365,6 +4452,17 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-margin-left">
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></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>Sub processes.</p>
</div>
</div>
</div>
</div>
@@ -4391,7 +4489,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
</div>
<div class="w3-half">
<p>Transitions.</p>
</div>
</div>
@@ -4403,10 +4501,10 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(TASK_CAPTURE_DISPATCHER).Is" ><strong>TASK_CAPTURE_DISPATCHER:Is(State)</strong></a></h2>
<h2><a id="#(TASK_CAPTURE_DISPATCHER).Is" ><strong>TASK_CAPTURE_DISPATCHER:Is(State, If)</strong></a></h2>
</div>
<p>Check if FSM is in state.</p>
<div id= "#Functions##Is" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4414,15 +4512,31 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-margin-left">
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<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>State</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>State name.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>If</strong></strong>
</p>
</div>
<div class="w3-half">
<p>true, FSM is in this state.</p>
</div>
</div>
</div>
@@ -4436,7 +4550,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER).LoadCallBacks" ><strong>TASK_CAPTURE_DISPATCHER:LoadCallBacks(CallBackTable)</strong></a></h2>
</div>
<p>Load call backs.</p>
<div id= "#Functions##LoadCallBacks" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4448,11 +4562,14 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>CallBackTable</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Table of call backs. </p>
</div>
</div>
</div>
@@ -4579,7 +4696,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER)._add_to_map" ><strong>TASK_CAPTURE_DISPATCHER:_add_to_map(Map, Event)</strong></a></h2>
</div>
<p>Add to map.</p>
<div id= "#Functions##_add_to_map" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4591,21 +4708,27 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Map</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Map.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event table.</p>
</div>
</div>
</div>
@@ -4619,7 +4742,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER)._call_handler" ><strong>TASK_CAPTURE_DISPATCHER:_call_handler(step, trigger, params, EventName)</strong></a></h2>
</div>
<p>Call handler.</p>
<div id= "#Functions##_call_handler" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4631,43 +4754,65 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>step</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Step "onafter", "onbefore", "onenter", "onleave".</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>trigger</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Trigger.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>params</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Parameters.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>EventName</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event name.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
</div>
<div class="w3-half">
<p>Value.</p>
</div>
</div>
</div>
</div>
@@ -4679,7 +4824,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER)._create_transition" ><strong>TASK_CAPTURE_DISPATCHER:_create_transition(EventName)</strong></a></h2>
</div>
<p>Create transition.</p>
<div id= "#Functions##_create_transition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4691,13 +4836,27 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>EventName</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event name. </p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#function:</p>
</div>
<div class="w3-half">
<p>Function. </p>
</div>
</div>
</div>
</div>
@@ -4709,7 +4868,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER)._delayed_transition" ><strong>TASK_CAPTURE_DISPATCHER:_delayed_transition(EventName)</strong></a></h2>
</div>
<p>Delayed transition.</p>
<div id= "#Functions##_delayed_transition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4721,13 +4880,27 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>EventName</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event name. </p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#function:</p>
</div>
<div class="w3-half">
<p>Function.</p>
</div>
</div>
</div>
</div>
@@ -4739,7 +4912,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER)._eventmap" ><strong>TASK_CAPTURE_DISPATCHER:_eventmap(Events, EventStructure)</strong></a></h2>
</div>
<p>Event map.</p>
<div id= "#Functions##_eventmap" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4751,21 +4924,27 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Events</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Events.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>EventStructure</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event structure.</p>
</div>
</div>
</div>
@@ -4779,7 +4958,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER)._gosub" ><strong>TASK_CAPTURE_DISPATCHER:_gosub(ParentFrom, ParentEvent)</strong></a></h2>
</div>
<p>Go sub.</p>
<div id= "#Functions##_gosub" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4791,23 +4970,40 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>ParentFrom</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Parent 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>ParentEvent</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Parent event name.</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>Subs.</p>
</div>
</div>
</div>
</div>
@@ -4819,7 +5015,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER)._handler" ><strong>TASK_CAPTURE_DISPATCHER:_handler(EventName, ...)</strong></a></h2>
</div>
<p>Handler.</p>
<div id= "#Functions##_handler" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4831,11 +5027,14 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>EventName</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event name.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
@@ -4845,7 +5044,9 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
</p>
</div>
<div class="w3-half">
<p></p>
<p>Arguments.</p>
</div>
</div>
</div>
@@ -4859,7 +5060,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER)._isendstate" ><strong>TASK_CAPTURE_DISPATCHER:_isendstate(Current)</strong></a></h2>
</div>
<p>Is end state.</p>
<div id= "#Functions##_isendstate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4871,13 +5072,35 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Current</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Current state name.</p>
</div>
</div>
<h2><strong>Return values:</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>FSM parent.</p>
</div>
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>Event name.</p>
</div>
</div>
</div>
</div>
@@ -4889,7 +5112,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER)._submap" ><strong>TASK_CAPTURE_DISPATCHER:_submap(subs, sub, name)</strong></a></h2>
</div>
<p>Sub maps.</p>
<div id= "#Functions##_submap" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4901,31 +5124,40 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>subs</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Subs.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>sub</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Sub.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>name</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Name. </p>
</div>
</div>
</div>
@@ -4939,7 +5171,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER).can" ><strong>TASK_CAPTURE_DISPATCHER:can(e)</strong></a></h2>
</div>
<p>Check if can do an event.</p>
<div id= "#Functions##can" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4951,13 +5183,35 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>e</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event name.</p>
</div>
</div>
<h2><strong>Return values:</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, FSM can do the event.</p>
</div>
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>To state.</p>
</div>
</div>
</div>
</div>
@@ -4969,7 +5223,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<h2><a id="#(TASK_CAPTURE_DISPATCHER).cannot" ><strong>TASK_CAPTURE_DISPATCHER:cannot(e)</strong></a></h2>
</div>
<p>Check if cannot do an event.</p>
<div id= "#Functions##cannot" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4981,13 +5235,27 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>e</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event name.</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, FSM cannot do the event.</p>
</div>
</div>
</div>
</div>
@@ -4996,10 +5264,10 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(TASK_CAPTURE_DISPATCHER).is" ><strong>TASK_CAPTURE_DISPATCHER:is(state)</strong></a></h2>
<h2><a id="#(TASK_CAPTURE_DISPATCHER).is" ><strong>TASK_CAPTURE_DISPATCHER:is(State, If, state)</strong></a></h2>
</div>
<p>Check if FSM is in state.</p>
<div id= "#Functions##is" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5007,7 +5275,33 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
<div class="w3-margin-left">
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<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>State</strong></strong>
</p>
</div>
<div class="w3-half">
<p>State name.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>If</strong></strong>
</p>
</div>
<div class="w3-half">
<p>true, FSM is in this state. </p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>