weyne/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-08-15 10:47:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
MOOSE/docs/Documentation/Route.html
FlightControl 52f4051901 Various Fixes 
-- Documentation fixes with links not working.
-- MENU_CLIENT_COMMAND had a small glitch, fixed that one too.
-- Implemented new Event Dispatcher.
--
2017-02-04 15:16:32 +01:00

768 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<link rel="stylesheet" href="stylesheet.css" type="text/css"/>
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div>
<div id="main">
<div id="navigation">
<h2>Modules</h2>
<ul><li>
<a href="index.html">index</a>
</li></ul>
<ul>
<li><a href="AI_Balancer.html">AI_Balancer</a></li>
<li><a href="AI_Cap.html">AI_Cap</a></li>
<li><a href="AI_Cas.html">AI_Cas</a></li>
<li><a href="AI_Patrol.html">AI_Patrol</a></li>
<li><a href="Account.html">Account</a></li>
<li><a href="Airbase.html">Airbase</a></li>
<li><a href="AirbasePolice.html">AirbasePolice</a></li>
<li><a href="Assign.html">Assign</a></li>
<li><a href="Base.html">Base</a></li>
<li><a href="Cargo.html">Cargo</a></li>
<li><a href="CleanUp.html">CleanUp</a></li>
<li><a href="Client.html">Client</a></li>
<li><a href="CommandCenter.html">CommandCenter</a></li>
<li><a href="Controllable.html">Controllable</a></li>
<li><a href="Database.html">Database</a></li>
<li><a href="Detection.html">Detection</a></li>
<li><a href="DetectionManager.html">DetectionManager</a></li>
<li><a href="Escort.html">Escort</a></li>
<li><a href="Event.html">Event</a></li>
<li><a href="Fsm.html">Fsm</a></li>
<li><a href="Group.html">Group</a></li>
<li><a href="Identifiable.html">Identifiable</a></li>
<li><a href="MOVEMENT.html">MOVEMENT</a></li>
<li><a href="Menu.html">Menu</a></li>
<li><a href="Message.html">Message</a></li>
<li><a href="MissileTrainer.html">MissileTrainer</a></li>
<li><a href="Mission.html">Mission</a></li>
<li><a href="Object.html">Object</a></li>
<li><a href="Point.html">Point</a></li>
<li><a href="Positionable.html">Positionable</a></li>
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
<li><a href="Process_Pickup.html">Process_Pickup</a></li>
<li>Route</li>
<li><a href="ScheduleDispatcher.html">ScheduleDispatcher</a></li>
<li><a href="Scheduler.html">Scheduler</a></li>
<li><a href="Scoring.html">Scoring</a></li>
<li><a href="Sead.html">Sead</a></li>
<li><a href="Set.html">Set</a></li>
<li><a href="Smoke.html">Smoke</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="Static.html">Static</a></li>
<li><a href="Task.html">Task</a></li>
<li><a href="Task_A2G.html">Task_A2G</a></li>
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
<li><a href="Task_SEAD.html">Task_SEAD</a></li>
<li><a href="Unit.html">Unit</a></li>
<li><a href="Utils.html">Utils</a></li>
<li><a href="Zone.html">Zone</a></li>
<li><a href="routines.html">routines</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>Route</code></h1>
<p>(SP) (MP) (FSM) Route AI or players through waypoints or to zones.</p>
<hr/>
<h1><a href="##(ACT_ROUTE)">#ACT_ROUTE</a> FSM class, extends <a href="Fsm.html##(FSM_PROCESS)">Fsm#FSM_PROCESS</a></h1>
<h2>ACT_ROUTE state machine:</h2>
<p>This class is a state machine: it manages a process that is triggered by events causing state transitions to occur.
All derived classes from this class will start with the class name, followed by a _. See the relevant derived class descriptions below.
Each derived class follows exactly the same process, using the same events and following the same state transitions,
but will have <strong>different implementation behaviour</strong> upon each event or state transition.</p>
<h3>ACT_ROUTE <strong>Events</strong>:</h3>
<p>These are the events defined in this class:</p>
<ul>
<li><strong>Start</strong>: The process is started. The process will go into the Report state.</li>
<li><strong>Report</strong>: The process is reporting to the player the route to be followed.</li>
<li><strong>Route</strong>: The process is routing the controllable.</li>
<li><strong>Pause</strong>: The process is pausing the route of the controllable.</li>
<li><strong>Arrive</strong>: The controllable has arrived at a route point.</li>
<li><strong>More</strong>: There are more route points that need to be followed. The process will go back into the Report state.</li>
<li><strong>NoMore</strong>: There are no more route points that need to be followed. The process will go into the Success state.</li>
</ul>
<h3>ACT_ROUTE <strong>Event methods</strong>:</h3>
<p>Event methods are available (dynamically allocated by the state machine), that accomodate for state transitions occurring in the process.
There are two types of event methods, which you can use to influence the normal mechanisms in the state machine:</p>
<ul>
<li><strong>Immediate</strong>: The event method has exactly the name of the event.</li>
<li><strong>Delayed</strong>: The event method starts with a __ + the name of the event. The first parameter of the event method is a number value, expressing the delay in seconds when the event will be executed. </li>
</ul>
<h3>ACT_ROUTE <strong>States</strong>:</h3>
<ul>
<li><strong>None</strong>: The controllable did not receive route commands.</li>
<li><strong>Arrived (*)</strong>: The controllable has arrived at a route point.</li>
<li><strong>Aborted (*)</strong>: The controllable has aborted the route path.</li>
<li><strong>Routing</strong>: The controllable is understay to the route point.</li>
<li><strong>Pausing</strong>: The process is pausing the routing. AI air will go into hover, AI ground will stop moving. Players can fly around.</li>
<li><strong>Success (*)</strong>: All route points were reached. </li>
<li><strong>Failed (*)</strong>: The process has failed.</li>
</ul>
<p>(*) End states of the process.</p>
<h3>ACT_ROUTE state transition methods:</h3>
<p>State transition functions can be set <strong>by the mission designer</strong> customizing or improving the behaviour of the state.
There are 2 moments when state transition methods will be called by the state machine:</p>
<ul>
<li><p><strong>Before</strong> the state transition.
The state transition method needs to start with the name <strong>OnBefore + the name of the state</strong>.
If the state transition method returns false, then the processing of the state transition will not be done!
If you want to change the behaviour of the AIControllable at this event, return false,
but then you'll need to specify your own logic using the AIControllable!</p></li>
<li><p><strong>After</strong> the state transition.
The state transition method needs to start with the name <strong>OnAfter + the name of the state</strong>.
These state transition methods need to provide a return value, which is specified at the function description.</p></li>
</ul>
<hr/>
<h1>1) <a href="##(ACT_ROUTE_ZONE)">#ACT<em>ROUTE</em>ZONE</a> class, extends <a href="Fsm.Route.html##(ACT_ROUTE)">Fsm.Route#ACT_ROUTE</a></h1>
<p>The ACT<em>ROUTE</em>ZONE class implements the core functions to route an AIR <a href="Controllable.html">Controllable</a> player <a href="Unit.html">Unit</a> to a <a href="Zone.html">Zone</a>.
The player receives on perioding times messages with the coordinates of the route to follow.
Upon arrival at the zone, a confirmation of arrival is sent, and the process will be ended.</p>
<h1>1.1) ACT<em>ROUTE</em>ZONE constructor:</h1>
<ul>
<li><a href="##(ACT_ROUTE_ZONE).New">ACT<em>ROUTE</em>ZONE.New</a>(): Creates a new ACT<em>ROUTE</em>ZONE object.</li>
</ul>
<hr/>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#ACT_ROUTE">ACT_ROUTE</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="#ACT_ROUTE_ZONE">ACT_ROUTE_ZONE</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(ACT_ROUTE)">Type <code>ACT_ROUTE</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE).ClassName">ACT_ROUTE.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE).DisplayCount">ACT_ROUTE.DisplayCount</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE).New">ACT_ROUTE:New()</a></td>
<td class="summary">
<p>Creates a new routing state machine.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE).ProcessUnit">ACT_ROUTE.ProcessUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE).TASK">ACT_ROUTE.TASK</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE).TargetZone">ACT_ROUTE.TargetZone</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE).onafterStart">ACT_ROUTE:onafterStart(ProcessUnit, Event, From, To)</a></td>
<td class="summary">
<p>StateMachine callback function</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE).onbeforeRoute">ACT_ROUTE:onbeforeRoute(ProcessUnit, Event, From, To)</a></td>
<td class="summary">
<p>StateMachine callback function</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE).onfuncHasArrived">ACT_ROUTE:onfuncHasArrived(ProcessUnit)</a></td>
<td class="summary">
<p>Check if the controllable has arrived.</p>
</td>
</tr>
</table>
<h2><a id="#(ACT_ROUTE_ZONE)">Type <code>ACT_ROUTE_ZONE</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).ClassName">ACT_ROUTE_ZONE.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).DisplayCount">ACT_ROUTE_ZONE.DisplayCount</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).DisplayInterval">ACT_ROUTE_ZONE.DisplayInterval</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).DisplayMessage">ACT_ROUTE_ZONE.DisplayMessage</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).DisplayTime">ACT_ROUTE_ZONE.DisplayTime</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).Init">ACT_ROUTE_ZONE:Init(FsmRoute)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).New">ACT_ROUTE_ZONE:New(TargetZone)</a></td>
<td class="summary">
<p>Creates a new routing state machine.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).ProcessUnit">ACT_ROUTE_ZONE.ProcessUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).TASK">ACT_ROUTE_ZONE.TASK</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).TargetZone">ACT_ROUTE_ZONE.TargetZone</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).onenterReporting">ACT_ROUTE_ZONE:onenterReporting(ProcessUnit, Event, From, To)</a></td>
<td class="summary">
<p>StateMachine callback function</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ROUTE_ZONE).onfuncHasArrived">ACT_ROUTE_ZONE:onfuncHasArrived(ProcessUnit)</a></td>
<td class="summary">
<p>Method override to check if the controllable has arrived.</p>
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(ACT_ROUTE)">#ACT_ROUTE</a></em>
<a id="ACT_ROUTE" >
<strong>ACT_ROUTE</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(ACT_ROUTE_ZONE)">#ACT_ROUTE_ZONE</a></em>
<a id="ACT_ROUTE_ZONE" >
<strong>ACT_ROUTE_ZONE</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(Route)" >Type <code>Route</code></a></h2>
<h2><a id="#(ACT_ROUTE)" >Type <code>ACT_ROUTE</code></a></h2>
<p>ACT_ROUTE class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(ACT_ROUTE).ClassName" >
<strong>ACT_ROUTE.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(ACT_ROUTE).DisplayCount" >
<strong>ACT_ROUTE.DisplayCount</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ACT_ROUTE).New" >
<strong>ACT_ROUTE:New()</strong>
</a>
</dt>
<dd>
<p>Creates a new routing state machine.</p>
<p>The process will route a CLIENT to a ZONE until the CLIENT is within that ZONE.</p>
<h3>Return value</h3>
<p><em><a href="##(ACT_ROUTE)">#ACT_ROUTE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></em>
<a id="#(ACT_ROUTE).ProcessUnit" >
<strong>ACT_ROUTE.ProcessUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a></em>
<a id="#(ACT_ROUTE).TASK" >
<strong>ACT_ROUTE.TASK</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a></em>
<a id="#(ACT_ROUTE).TargetZone" >
<strong>ACT_ROUTE.TargetZone</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ACT_ROUTE).onafterStart" >
<strong>ACT_ROUTE:onafterStart(ProcessUnit, Event, From, To)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ACT_ROUTE).onbeforeRoute" >
<strong>ACT_ROUTE:onbeforeRoute(ProcessUnit, Event, From, To)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ACT_ROUTE).onfuncHasArrived" >
<strong>ACT_ROUTE:onfuncHasArrived(ProcessUnit)</strong>
</a>
</dt>
<dd>
<p>Check if the controllable has arrived.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<h2><a id="#(ACT_ROUTE_ZONE)" >Type <code>ACT_ROUTE_ZONE</code></a></h2>
<p>ACT<em>ROUTE</em>ZONE class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(ACT_ROUTE_ZONE).ClassName" >
<strong>ACT_ROUTE_ZONE.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(ACT_ROUTE_ZONE).DisplayCount" >
<strong>ACT_ROUTE_ZONE.DisplayCount</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(ACT_ROUTE_ZONE).DisplayInterval" >
<strong>ACT_ROUTE_ZONE.DisplayInterval</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="#(ACT_ROUTE_ZONE).DisplayMessage" >
<strong>ACT_ROUTE_ZONE.DisplayMessage</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(ACT_ROUTE_ZONE).DisplayTime" >
<strong>ACT_ROUTE_ZONE.DisplayTime</strong>
</a>
</dt>
<dd>
<p> 10 seconds is the default</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ACT_ROUTE_ZONE).Init" >
<strong>ACT_ROUTE_ZONE:Init(FsmRoute)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> FsmRoute </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ACT_ROUTE_ZONE).New" >
<strong>ACT_ROUTE_ZONE:New(TargetZone)</strong>
</a>
</dt>
<dd>
<p>Creates a new routing state machine.</p>
<p>The task will route a controllable to a ZONE until the controllable is within that ZONE.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a> TargetZone </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></em>
<a id="#(ACT_ROUTE_ZONE).ProcessUnit" >
<strong>ACT_ROUTE_ZONE.ProcessUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a></em>
<a id="#(ACT_ROUTE_ZONE).TASK" >
<strong>ACT_ROUTE_ZONE.TASK</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a></em>
<a id="#(ACT_ROUTE_ZONE).TargetZone" >
<strong>ACT_ROUTE_ZONE.TargetZone</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ACT_ROUTE_ZONE).onenterReporting" >
<strong>ACT_ROUTE_ZONE:onenterReporting(ProcessUnit, Event, From, To)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ACT_ROUTE_ZONE).onfuncHasArrived" >
<strong>ACT_ROUTE_ZONE:onfuncHasArrived(ProcessUnit)</strong>
</a>
</dt>
<dd>
<p>Method override to check if the controllable has arrived.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink