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:
@@ -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>
|
||||
@@ -2545,7 +2578,13 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).CallScheduler">RANGE.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="##(RANGE).ClassName">RANGE.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">
|
||||
@@ -2557,7 +2596,7 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).GetCurrentState">RANGE: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">
|
||||
@@ -2579,7 +2618,7 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).GetScores">RANGE:GetScores()</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).GetScores">RANGE: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>
|
||||
@@ -2593,7 +2632,7 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).GetState">RANGE: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">
|
||||
@@ -2609,15 +2648,15 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).Is">RANGE:Is(State)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).Is">RANGE: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="##(RANGE).LoadCallBacks">RANGE: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">
|
||||
@@ -2629,7 +2668,7 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).Scores">RANGE.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">
|
||||
@@ -2683,73 +2722,73 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE)._add_to_map">RANGE:_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="##(RANGE)._call_handler">RANGE:_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="##(RANGE)._create_transition">RANGE:_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="##(RANGE)._delayed_transition">RANGE:_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="##(RANGE)._eventmap">RANGE:_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="##(RANGE)._gosub">RANGE:_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="##(RANGE)._handler">RANGE:_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="##(RANGE)._isendstate">RANGE:_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="##(RANGE)._submap">RANGE:_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="##(RANGE).can">RANGE: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="##(RANGE).cannot">RANGE: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="##(RANGE).current">RANGE.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">
|
||||
@@ -2759,21 +2798,21 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).is">RANGE:is(state)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RANGE).is">RANGE: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="##(RANGE).options">RANGE.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="##(RANGE).subs">RANGE.subs</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Subs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -9490,11 +9529,14 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -9819,7 +9861,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE).GetCurrentState" ><strong>RANGE: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">
|
||||
@@ -9827,6 +9869,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -9846,6 +9899,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -9912,7 +9976,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>Sub processes.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -9924,7 +9988,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(RANGE).GetScores" ><strong>RANGE:GetScores()</strong></a></h2>
|
||||
<h2><a id="#(RANGE).GetScores" ><strong>RANGE:GetScores(Scores)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns a table with the scores defined.</p>
|
||||
@@ -9935,6 +9999,18 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -9976,7 +10052,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE).GetState" ><strong>RANGE: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">
|
||||
@@ -9984,6 +10060,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10003,6 +10090,17 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10029,7 +10127,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>Transitions.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -10041,10 +10139,10 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(RANGE).Is" ><strong>RANGE:Is(State)</strong></a></h2>
|
||||
<h2><a id="#(RANGE).Is" ><strong>RANGE: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">
|
||||
@@ -10052,15 +10150,31 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10074,7 +10188,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE).LoadCallBacks" ><strong>RANGE: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">
|
||||
@@ -10086,11 +10200,14 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10217,7 +10334,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE)._add_to_map" ><strong>RANGE:_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">
|
||||
@@ -10229,21 +10346,27 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10257,7 +10380,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE)._call_handler" ><strong>RANGE:_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">
|
||||
@@ -10269,43 +10392,65 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10317,7 +10462,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE)._create_transition" ><strong>RANGE:_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">
|
||||
@@ -10329,13 +10474,27 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10347,7 +10506,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE)._delayed_transition" ><strong>RANGE:_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">
|
||||
@@ -10359,13 +10518,27 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10377,7 +10550,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE)._eventmap" ><strong>RANGE:_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">
|
||||
@@ -10389,21 +10562,27 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10417,7 +10596,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE)._gosub" ><strong>RANGE:_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">
|
||||
@@ -10429,23 +10608,40 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10457,7 +10653,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE)._handler" ><strong>RANGE:_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">
|
||||
@@ -10469,11 +10665,14 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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">
|
||||
@@ -10483,7 +10682,9 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>Arguments.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -10497,7 +10698,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE)._isendstate" ><strong>RANGE:_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">
|
||||
@@ -10509,13 +10710,35 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10527,7 +10750,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE)._submap" ><strong>RANGE:_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">
|
||||
@@ -10539,31 +10762,40 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10577,7 +10809,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE).can" ><strong>RANGE: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">
|
||||
@@ -10589,13 +10821,35 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10607,7 +10861,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<h2><a id="#(RANGE).cannot" ><strong>RANGE: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">
|
||||
@@ -10619,13 +10873,27 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
@@ -10634,10 +10902,10 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(RANGE).is" ><strong>RANGE:is(state)</strong></a></h2>
|
||||
<h2><a id="#(RANGE).is" ><strong>RANGE: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">
|
||||
@@ -10645,7 +10913,33 @@ If a zone is not explicitly specified, the range zone is determined by its locat
|
||||
<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>
|
||||
|
||||
Reference in New Issue
Block a user