MOOSE/docs/Documentation/Process_Pickup.html
2017-03-10 23:05:02 +01:00

682 lines
14 KiB
HTML

<!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="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="Movement.html">Movement</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>Process_Pickup</li>
<li><a href="Route.html">Route</a></li>
<li><a href="Scenery.html">Scenery</a></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_A2G_Dispatcher.html">Task_A2G_Dispatcher</a></li>
<li><a href="Task_PICKUP.html">Task_PICKUP</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>Process_Pickup</code></h1>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#PROCESS_PICKUP">PROCESS_PICKUP</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(PROCESS_PICKUP)">Type <code>PROCESS_PICKUP</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).ClassName">PROCESS_PICKUP.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).DisplayCategory">PROCESS_PICKUP.DisplayCategory</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).DisplayCount">PROCESS_PICKUP.DisplayCount</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).DisplayInterval">PROCESS_PICKUP.DisplayInterval</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).DisplayMessage">PROCESS_PICKUP.DisplayMessage</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).DisplayTime">PROCESS_PICKUP.DisplayTime</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).EventDead">PROCESS_PICKUP:EventDead(Event)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).Fsm">PROCESS_PICKUP.Fsm</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).New">PROCESS_PICKUP:New(Task, ProcessUnit, TargetSetUnit, ProcessName)</a></td>
<td class="summary">
<p>Creates a new DESTROY process.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).OnDestroyed">PROCESS_PICKUP:OnDestroyed(Fsm, Event, From, To)</a></td>
<td class="summary">
<p>StateMachine callback function for a PROCESS</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).OnHitTarget">PROCESS_PICKUP:OnHitTarget(Fsm, Event, From, To, Event)</a></td>
<td class="summary">
<p>StateMachine callback function for a PROCESS</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).OnKilled">PROCESS_PICKUP:OnKilled(Fsm, Event, From, To, DCSEvent)</a></td>
<td class="summary">
<p>StateMachine callback function for a PROCESS</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).OnMoreTargets">PROCESS_PICKUP:OnMoreTargets(Fsm, Event, From, To)</a></td>
<td class="summary">
<p>StateMachine callback function for a PROCESS</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).OnNavigating">PROCESS_PICKUP:OnNavigating(Fsm, Event, From, To)</a></td>
<td class="summary">
<p>StateMachine callback function for a PROCESS</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).OnRestart">PROCESS_PICKUP:OnRestart(Fsm, Event, From, To)</a></td>
<td class="summary">
<p>StateMachine callback function for a PROCESS</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).OnStart">PROCESS_PICKUP:OnStart(Fsm, Event, From, To)</a></td>
<td class="summary">
<p>StateMachine callback function for a PROCESS</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).ProcessUnit">PROCESS_PICKUP.ProcessUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_PICKUP).TargetSetUnit">PROCESS_PICKUP.TargetSetUnit</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(PROCESS_PICKUP)">#PROCESS_PICKUP</a></em>
<a id="PROCESS_PICKUP" >
<strong>PROCESS_PICKUP</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(Process_Pickup)" >Type <code>Process_Pickup</code></a></h2>
<h2><a id="#(PROCESS_PICKUP)" >Type <code>PROCESS_PICKUP</code></a></h2>
<p>PROCESS_PICKUP class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(PROCESS_PICKUP).ClassName" >
<strong>PROCESS_PICKUP.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(PROCESS_PICKUP).DisplayCategory" >
<strong>PROCESS_PICKUP.DisplayCategory</strong>
</a>
</dt>
<dd>
<p> Targets is the default display category</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(PROCESS_PICKUP).DisplayCount" >
<strong>PROCESS_PICKUP.DisplayCount</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(PROCESS_PICKUP).DisplayInterval" >
<strong>PROCESS_PICKUP.DisplayInterval</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="#(PROCESS_PICKUP).DisplayMessage" >
<strong>PROCESS_PICKUP.DisplayMessage</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(PROCESS_PICKUP).DisplayTime" >
<strong>PROCESS_PICKUP.DisplayTime</strong>
</a>
</dt>
<dd>
<p> 10 seconds is the default</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROCESS_PICKUP).EventDead" >
<strong>PROCESS_PICKUP:EventDead(Event)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a> Event </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROCESS_PICKUP).Fsm" >
<strong>PROCESS_PICKUP.Fsm</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROCESS_PICKUP).New" >
<strong>PROCESS_PICKUP:New(Task, ProcessUnit, TargetSetUnit, ProcessName)</strong>
</a>
</dt>
<dd>
<p>Creates a new DESTROY process.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a> Task </em></code>: </p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
<p><code><em><a href="Core.Set.html##(SET_UNIT)">Core.Set#SET_UNIT</a> TargetSetUnit </em></code>: </p>
</li>
<li>
<p><code><em> ProcessName </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(PROCESS_PICKUP)">#PROCESS_PICKUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROCESS_PICKUP).OnDestroyed" >
<strong>PROCESS_PICKUP:OnDestroyed(Fsm, Event, From, To)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function for a PROCESS</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a> Fsm </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="#(PROCESS_PICKUP).OnHitTarget" >
<strong>PROCESS_PICKUP:OnHitTarget(Fsm, Event, From, To, Event)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function for a PROCESS</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a> Fsm </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>
<li>
<p><code><em><a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a> Event </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROCESS_PICKUP).OnKilled" >
<strong>PROCESS_PICKUP:OnKilled(Fsm, Event, From, To, DCSEvent)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function for a PROCESS</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a> Fsm </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>
<li>
<p><code><em><a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a> DCSEvent </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROCESS_PICKUP).OnMoreTargets" >
<strong>PROCESS_PICKUP:OnMoreTargets(Fsm, Event, From, To)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function for a PROCESS</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a> Fsm </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="#(PROCESS_PICKUP).OnNavigating" >
<strong>PROCESS_PICKUP:OnNavigating(Fsm, Event, From, To)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function for a PROCESS</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a> Fsm </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="#(PROCESS_PICKUP).OnRestart" >
<strong>PROCESS_PICKUP:OnRestart(Fsm, Event, From, To)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function for a PROCESS</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a> Fsm </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="#(PROCESS_PICKUP).OnStart" >
<strong>PROCESS_PICKUP:OnStart(Fsm, Event, From, To)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function for a PROCESS</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a> Fsm </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>
<em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></em>
<a id="#(PROCESS_PICKUP).ProcessUnit" >
<strong>PROCESS_PICKUP.ProcessUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Core.Set.html##(SET_UNIT)">Core.Set#SET_UNIT</a></em>
<a id="#(PROCESS_PICKUP).TargetSetUnit" >
<strong>PROCESS_PICKUP.TargetSetUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
</div>
</div>
</body>
</html>