mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2026-08-18 05:05:26 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
FlightControl-User
+364
-70
@@ -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>
|
||||
@@ -2095,7 +2128,13 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE.ManageDa
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).CallScheduler">AI_PATROL_ZONE.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="##(AI_PATROL_ZONE).ClassName">AI_PATROL_ZONE.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">
|
||||
@@ -2107,7 +2146,7 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE.ManageDa
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).GetCurrentState">AI_PATROL_ZONE: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">
|
||||
@@ -2129,7 +2168,7 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE.ManageDa
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).GetScores">AI_PATROL_ZONE:GetScores()</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).GetScores">AI_PATROL_ZONE: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>
|
||||
@@ -2143,7 +2182,7 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE.ManageDa
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).GetState">AI_PATROL_ZONE: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">
|
||||
@@ -2159,15 +2198,15 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE.ManageDa
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).Is">AI_PATROL_ZONE:Is(State)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).Is">AI_PATROL_ZONE: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="##(AI_PATROL_ZONE).LoadCallBacks">AI_PATROL_ZONE: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">
|
||||
@@ -2179,7 +2218,7 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE.ManageDa
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).Scores">AI_PATROL_ZONE.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">
|
||||
@@ -2233,73 +2272,73 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE.ManageDa
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE)._add_to_map">AI_PATROL_ZONE:_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="##(AI_PATROL_ZONE)._call_handler">AI_PATROL_ZONE:_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="##(AI_PATROL_ZONE)._create_transition">AI_PATROL_ZONE:_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="##(AI_PATROL_ZONE)._delayed_transition">AI_PATROL_ZONE:_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="##(AI_PATROL_ZONE)._eventmap">AI_PATROL_ZONE:_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="##(AI_PATROL_ZONE)._gosub">AI_PATROL_ZONE:_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="##(AI_PATROL_ZONE)._handler">AI_PATROL_ZONE:_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="##(AI_PATROL_ZONE)._isendstate">AI_PATROL_ZONE:_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="##(AI_PATROL_ZONE)._submap">AI_PATROL_ZONE:_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="##(AI_PATROL_ZONE).can">AI_PATROL_ZONE: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="##(AI_PATROL_ZONE).cannot">AI_PATROL_ZONE: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="##(AI_PATROL_ZONE).current">AI_PATROL_ZONE.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">
|
||||
@@ -2309,21 +2348,21 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE.ManageDa
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).is">AI_PATROL_ZONE:is(state)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).is">AI_PATROL_ZONE: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="##(AI_PATROL_ZONE).options">AI_PATROL_ZONE.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="##(AI_PATROL_ZONE).subs">AI_PATROL_ZONE.subs</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Subs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -7039,11 +7078,14 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7368,7 +7410,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE).GetCurrentState" ><strong>AI_PATROL_ZONE: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">
|
||||
@@ -7376,6 +7418,17 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7395,6 +7448,17 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7461,7 +7525,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>Sub processes.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -7473,7 +7537,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(AI_PATROL_ZONE).GetScores" ><strong>AI_PATROL_ZONE:GetScores()</strong></a></h2>
|
||||
<h2><a id="#(AI_PATROL_ZONE).GetScores" ><strong>AI_PATROL_ZONE:GetScores(Scores)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns a table with the scores defined.</p>
|
||||
@@ -7484,6 +7548,18 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7525,7 +7601,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE).GetState" ><strong>AI_PATROL_ZONE: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">
|
||||
@@ -7533,6 +7609,17 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7552,6 +7639,17 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7578,7 +7676,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>Transitions.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -7590,10 +7688,10 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(AI_PATROL_ZONE).Is" ><strong>AI_PATROL_ZONE:Is(State)</strong></a></h2>
|
||||
<h2><a id="#(AI_PATROL_ZONE).Is" ><strong>AI_PATROL_ZONE: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">
|
||||
@@ -7601,15 +7699,31 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7623,7 +7737,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE).LoadCallBacks" ><strong>AI_PATROL_ZONE: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">
|
||||
@@ -7635,11 +7749,14 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7766,7 +7883,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE)._add_to_map" ><strong>AI_PATROL_ZONE:_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">
|
||||
@@ -7778,21 +7895,27 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7806,7 +7929,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE)._call_handler" ><strong>AI_PATROL_ZONE:_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">
|
||||
@@ -7818,43 +7941,65 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7866,7 +8011,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE)._create_transition" ><strong>AI_PATROL_ZONE:_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">
|
||||
@@ -7878,13 +8023,27 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7896,7 +8055,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE)._delayed_transition" ><strong>AI_PATROL_ZONE:_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">
|
||||
@@ -7908,13 +8067,27 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7926,7 +8099,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE)._eventmap" ><strong>AI_PATROL_ZONE:_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">
|
||||
@@ -7938,21 +8111,27 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -7966,7 +8145,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE)._gosub" ><strong>AI_PATROL_ZONE:_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">
|
||||
@@ -7978,23 +8157,40 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -8006,7 +8202,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE)._handler" ><strong>AI_PATROL_ZONE:_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">
|
||||
@@ -8018,11 +8214,14 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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">
|
||||
@@ -8032,7 +8231,9 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>Arguments.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -8046,7 +8247,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE)._isendstate" ><strong>AI_PATROL_ZONE:_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">
|
||||
@@ -8058,13 +8259,35 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -8076,7 +8299,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE)._submap" ><strong>AI_PATROL_ZONE:_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">
|
||||
@@ -8088,31 +8311,40 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -8126,7 +8358,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE).can" ><strong>AI_PATROL_ZONE: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">
|
||||
@@ -8138,13 +8370,35 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -8156,7 +8410,7 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<h2><a id="#(AI_PATROL_ZONE).cannot" ><strong>AI_PATROL_ZONE: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">
|
||||
@@ -8168,13 +8422,27 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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>
|
||||
@@ -8183,10 +8451,10 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(AI_PATROL_ZONE).is" ><strong>AI_PATROL_ZONE:is(state)</strong></a></h2>
|
||||
<h2><a id="#(AI_PATROL_ZONE).is" ><strong>AI_PATROL_ZONE: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">
|
||||
@@ -8194,7 +8462,33 @@ Note that this method is required, as triggers the next route when patrolling fo
|
||||
<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