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>
|
||||
@@ -2329,7 +2362,13 @@ If enabled, text messages about the tanker status will be displayed on screen an
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RECOVERYTANKER).CallScheduler">RECOVERYTANKER.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="##(RECOVERYTANKER).ClassName">RECOVERYTANKER.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">
|
||||
@@ -2341,7 +2380,7 @@ If enabled, text messages about the tanker status will be displayed on screen an
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RECOVERYTANKER).GetCurrentState">RECOVERYTANKER: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">
|
||||
@@ -2363,7 +2402,7 @@ If enabled, text messages about the tanker status will be displayed on screen an
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RECOVERYTANKER).GetScores">RECOVERYTANKER:GetScores()</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RECOVERYTANKER).GetScores">RECOVERYTANKER: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>
|
||||
@@ -2377,7 +2416,7 @@ If enabled, text messages about the tanker status will be displayed on screen an
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RECOVERYTANKER).GetState">RECOVERYTANKER: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">
|
||||
@@ -2393,15 +2432,15 @@ If enabled, text messages about the tanker status will be displayed on screen an
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RECOVERYTANKER).Is">RECOVERYTANKER:Is(State)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RECOVERYTANKER).Is">RECOVERYTANKER: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="##(RECOVERYTANKER).LoadCallBacks">RECOVERYTANKER: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">
|
||||
@@ -2413,7 +2452,7 @@ If enabled, text messages about the tanker status will be displayed on screen an
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RECOVERYTANKER).Scores">RECOVERYTANKER.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">
|
||||
@@ -2467,73 +2506,73 @@ If enabled, text messages about the tanker status will be displayed on screen an
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RECOVERYTANKER)._add_to_map">RECOVERYTANKER:_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="##(RECOVERYTANKER)._call_handler">RECOVERYTANKER:_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="##(RECOVERYTANKER)._create_transition">RECOVERYTANKER:_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="##(RECOVERYTANKER)._delayed_transition">RECOVERYTANKER:_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="##(RECOVERYTANKER)._eventmap">RECOVERYTANKER:_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="##(RECOVERYTANKER)._gosub">RECOVERYTANKER:_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="##(RECOVERYTANKER)._handler">RECOVERYTANKER:_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="##(RECOVERYTANKER)._isendstate">RECOVERYTANKER:_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="##(RECOVERYTANKER)._submap">RECOVERYTANKER:_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="##(RECOVERYTANKER).can">RECOVERYTANKER: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="##(RECOVERYTANKER).cannot">RECOVERYTANKER: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="##(RECOVERYTANKER).current">RECOVERYTANKER.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">
|
||||
@@ -2543,21 +2582,21 @@ If enabled, text messages about the tanker status will be displayed on screen an
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RECOVERYTANKER).is">RECOVERYTANKER:is(state)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RECOVERYTANKER).is">RECOVERYTANKER: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="##(RECOVERYTANKER).options">RECOVERYTANKER.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="##(RECOVERYTANKER).subs">RECOVERYTANKER.subs</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Subs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -7051,11 +7090,14 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7380,7 +7422,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER).GetCurrentState" ><strong>RECOVERYTANKER: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">
|
||||
@@ -7388,6 +7430,17 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7407,6 +7460,17 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7473,7 +7537,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>Sub processes.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -7485,7 +7549,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(RECOVERYTANKER).GetScores" ><strong>RECOVERYTANKER:GetScores()</strong></a></h2>
|
||||
<h2><a id="#(RECOVERYTANKER).GetScores" ><strong>RECOVERYTANKER:GetScores(Scores)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns a table with the scores defined.</p>
|
||||
@@ -7496,6 +7560,18 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7537,7 +7613,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER).GetState" ><strong>RECOVERYTANKER: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">
|
||||
@@ -7545,6 +7621,17 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7564,6 +7651,17 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7590,7 +7688,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>Transitions.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -7602,10 +7700,10 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(RECOVERYTANKER).Is" ><strong>RECOVERYTANKER:Is(State)</strong></a></h2>
|
||||
<h2><a id="#(RECOVERYTANKER).Is" ><strong>RECOVERYTANKER: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">
|
||||
@@ -7613,15 +7711,31 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7635,7 +7749,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER).LoadCallBacks" ><strong>RECOVERYTANKER: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">
|
||||
@@ -7647,11 +7761,14 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7778,7 +7895,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER)._add_to_map" ><strong>RECOVERYTANKER:_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">
|
||||
@@ -7790,21 +7907,27 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7818,7 +7941,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER)._call_handler" ><strong>RECOVERYTANKER:_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">
|
||||
@@ -7830,43 +7953,65 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7878,7 +8023,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER)._create_transition" ><strong>RECOVERYTANKER:_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">
|
||||
@@ -7890,13 +8035,27 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7908,7 +8067,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER)._delayed_transition" ><strong>RECOVERYTANKER:_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">
|
||||
@@ -7920,13 +8079,27 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7938,7 +8111,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER)._eventmap" ><strong>RECOVERYTANKER:_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">
|
||||
@@ -7950,21 +8123,27 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -7978,7 +8157,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER)._gosub" ><strong>RECOVERYTANKER:_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">
|
||||
@@ -7990,23 +8169,40 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -8018,7 +8214,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER)._handler" ><strong>RECOVERYTANKER:_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">
|
||||
@@ -8030,11 +8226,14 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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">
|
||||
@@ -8044,7 +8243,9 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>Arguments.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -8058,7 +8259,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER)._isendstate" ><strong>RECOVERYTANKER:_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">
|
||||
@@ -8070,13 +8271,35 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -8088,7 +8311,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER)._submap" ><strong>RECOVERYTANKER:_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">
|
||||
@@ -8100,31 +8323,40 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -8138,7 +8370,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER).can" ><strong>RECOVERYTANKER: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">
|
||||
@@ -8150,13 +8382,35 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -8168,7 +8422,7 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<h2><a id="#(RECOVERYTANKER).cannot" ><strong>RECOVERYTANKER: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">
|
||||
@@ -8180,13 +8434,27 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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>
|
||||
@@ -8195,10 +8463,10 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(RECOVERYTANKER).is" ><strong>RECOVERYTANKER:is(state)</strong></a></h2>
|
||||
<h2><a id="#(RECOVERYTANKER).is" ><strong>RECOVERYTANKER: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">
|
||||
@@ -8206,7 +8474,33 @@ The group name is the one specified in the <a href="##(RECOVERYTANKER).New">RECO
|
||||
<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