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:
FlightControl-User
@@ -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>
|
||||
@@ -2512,7 +2545,13 @@ All derived classes from CARGO follow the same state machine, expose the same ca
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CARGO).CallScheduler">CARGO.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="##(CARGO).ClassName">CARGO.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">
|
||||
@@ -2524,7 +2563,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CARGO).GetCurrentState">CARGO: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">
|
||||
@@ -2546,7 +2585,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CARGO).GetScores">CARGO:GetScores()</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CARGO).GetScores">CARGO: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>
|
||||
@@ -2560,7 +2599,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CARGO).GetState">CARGO: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">
|
||||
@@ -2576,15 +2615,15 @@ All derived classes from CARGO follow the same state machine, expose the same ca
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CARGO).Is">CARGO:Is(State)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CARGO).Is">CARGO: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="##(CARGO).LoadCallBacks">CARGO: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">
|
||||
@@ -2596,7 +2635,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CARGO).Scores">CARGO.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">
|
||||
@@ -2650,73 +2689,73 @@ All derived classes from CARGO follow the same state machine, expose the same ca
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CARGO)._add_to_map">CARGO:_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="##(CARGO)._call_handler">CARGO:_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="##(CARGO)._create_transition">CARGO:_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="##(CARGO)._delayed_transition">CARGO:_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="##(CARGO)._eventmap">CARGO:_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="##(CARGO)._gosub">CARGO:_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="##(CARGO)._handler">CARGO:_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="##(CARGO)._isendstate">CARGO:_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="##(CARGO)._submap">CARGO:_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="##(CARGO).can">CARGO: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="##(CARGO).cannot">CARGO: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="##(CARGO).current">CARGO.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">
|
||||
@@ -2726,21 +2765,21 @@ All derived classes from CARGO follow the same state machine, expose the same ca
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CARGO).is">CARGO:is(state)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CARGO).is">CARGO: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="##(CARGO).options">CARGO.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="##(CARGO).subs">CARGO.subs</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Subs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -7905,11 +7944,14 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8234,7 +8276,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO).GetCurrentState" ><strong>CARGO: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">
|
||||
@@ -8242,6 +8284,17 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8261,6 +8314,17 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8327,7 +8391,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>Sub processes.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -8339,7 +8403,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CARGO).GetScores" ><strong>CARGO:GetScores()</strong></a></h2>
|
||||
<h2><a id="#(CARGO).GetScores" ><strong>CARGO:GetScores(Scores)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns a table with the scores defined.</p>
|
||||
@@ -8350,6 +8414,18 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8391,7 +8467,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO).GetState" ><strong>CARGO: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">
|
||||
@@ -8399,6 +8475,17 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8418,6 +8505,17 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8444,7 +8542,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>Transitions.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -8456,10 +8554,10 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CARGO).Is" ><strong>CARGO:Is(State)</strong></a></h2>
|
||||
<h2><a id="#(CARGO).Is" ><strong>CARGO: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">
|
||||
@@ -8467,15 +8565,31 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8489,7 +8603,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO).LoadCallBacks" ><strong>CARGO: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">
|
||||
@@ -8501,11 +8615,14 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8632,7 +8749,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO)._add_to_map" ><strong>CARGO:_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">
|
||||
@@ -8644,21 +8761,27 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8672,7 +8795,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO)._call_handler" ><strong>CARGO:_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">
|
||||
@@ -8684,43 +8807,65 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8732,7 +8877,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO)._create_transition" ><strong>CARGO:_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">
|
||||
@@ -8744,13 +8889,27 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8762,7 +8921,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO)._delayed_transition" ><strong>CARGO:_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">
|
||||
@@ -8774,13 +8933,27 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8792,7 +8965,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO)._eventmap" ><strong>CARGO:_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">
|
||||
@@ -8804,21 +8977,27 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8832,7 +9011,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO)._gosub" ><strong>CARGO:_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">
|
||||
@@ -8844,23 +9023,40 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8872,7 +9068,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO)._handler" ><strong>CARGO:_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">
|
||||
@@ -8884,11 +9080,14 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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">
|
||||
@@ -8898,7 +9097,9 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>Arguments.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -8912,7 +9113,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO)._isendstate" ><strong>CARGO:_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">
|
||||
@@ -8924,13 +9125,35 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8942,7 +9165,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO)._submap" ><strong>CARGO:_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">
|
||||
@@ -8954,31 +9177,40 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -8992,7 +9224,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO).can" ><strong>CARGO: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">
|
||||
@@ -9004,13 +9236,35 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -9022,7 +9276,7 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<h2><a id="#(CARGO).cannot" ><strong>CARGO: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">
|
||||
@@ -9034,13 +9288,27 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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>
|
||||
@@ -9049,10 +9317,10 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CARGO).is" ><strong>CARGO:is(state)</strong></a></h2>
|
||||
<h2><a id="#(CARGO).is" ><strong>CARGO: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">
|
||||
@@ -9060,7 +9328,33 @@ The cargo must be in the <strong>Loaded</strong> state.</p>
|
||||
<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