MOOSE/docs/Documentation/Process_Smoke.html
2016-12-18 13:11:58 +01:00

488 lines
11 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="AIBalancer.html">AIBalancer</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="Controllable.html">Controllable</a></li>
<li><a href="DCSAirbase.html">DCSAirbase</a></li>
<li><a href="DCSCoalitionObject.html">DCSCoalitionObject</a></li>
<li><a href="DCSCommand.html">DCSCommand</a></li>
<li><a href="DCSController.html">DCSController</a></li>
<li><a href="DCSGroup.html">DCSGroup</a></li>
<li><a href="DCSObject.html">DCSObject</a></li>
<li><a href="DCSTask.html">DCSTask</a></li>
<li><a href="DCSTypes.html">DCSTypes</a></li>
<li><a href="DCSUnit.html">DCSUnit</a></li>
<li><a href="DCSWorld.html">DCSWorld</a></li>
<li><a href="DCScountry.html">DCScountry</a></li>
<li><a href="DCStimer.html">DCStimer</a></li>
<li><a href="DCStrigger.html">DCStrigger</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="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="Patrol.html">Patrol</a></li>
<li><a href="Point.html">Point</a></li>
<li><a href="Positionable.html">Positionable</a></li>
<li><a href="Process.html">Process</a></li>
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
<li><a href="Process_Pickup.html">Process_Pickup</a></li>
<li>Process_Smoke</li>
<li><a href="Route.html">Route</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="Spawn.html">Spawn</a></li>
<li><a href="StateMachine.html">StateMachine</a></li>
<li><a href="Static.html">Static</a></li>
<li><a href="StaticObject.html">StaticObject</a></li>
<li><a href="Task.html">Task</a></li>
<li><a href="Task_A2G.html">Task_A2G</a></li>
<li><a href="Task_Client_Menu.html">Task_Client_Menu</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="Zone.html">Zone</a></li>
<li><a href="env.html">env</a></li>
<li><a href="land.html">land</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>Process_Smoke</code></h1>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#PROCESS_SMOKE_TARGETS">PROCESS_SMOKE_TARGETS</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(PROCESS_SMOKE_TARGETS)">Type <code>PROCESS_SMOKE_TARGETS</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).ClassName">PROCESS_SMOKE_TARGETS.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).Menu">PROCESS_SMOKE_TARGETS.Menu</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).MenuSmokeBlue">PROCESS_SMOKE_TARGETS.MenuSmokeBlue</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).MenuSmokeGreen">PROCESS_SMOKE_TARGETS.MenuSmokeGreen</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).MenuSmokeOrange">PROCESS_SMOKE_TARGETS.MenuSmokeOrange</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).MenuSmokeRed">PROCESS_SMOKE_TARGETS.MenuSmokeRed</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).MenuSmokeWhite">PROCESS_SMOKE_TARGETS.MenuSmokeWhite</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).New">PROCESS_SMOKE_TARGETS:New(Task, Unit, ProcessUnit, TargetSetUnit, TargetZone)</a></td>
<td class="summary">
<p>Creates a new task assignment state machine.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).OnSmoking">PROCESS_SMOKE_TARGETS:OnSmoking(Fsm, Event, From, To)</a></td>
<td class="summary">
<p>StateMachine callback function for a TASK2</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).OnStart">PROCESS_SMOKE_TARGETS:OnStart(Fsm, Event, From, To)</a></td>
<td class="summary">
<p>StateMachine callback function for a TASK2</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).ProcessUnit">PROCESS_SMOKE_TARGETS.ProcessUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).TargetSetUnit">PROCESS_SMOKE_TARGETS.TargetSetUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).TargetZone">PROCESS_SMOKE_TARGETS.TargetZone</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROCESS_SMOKE_TARGETS).Task">PROCESS_SMOKE_TARGETS.Task</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(PROCESS_SMOKE_TARGETS)">#PROCESS_SMOKE_TARGETS</a></em>
<a id="PROCESS_SMOKE_TARGETS" >
<strong>PROCESS_SMOKE_TARGETS</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(Process_Smoke)" >Type <code>Process_Smoke</code></a></h2>
<h2><a id="#(PROCESS_SMOKE_TARGETS)" >Type <code>PROCESS_SMOKE_TARGETS</code></a></h2>
<p>PROCESS<em>SMOKE</em>TARGETS class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(PROCESS_SMOKE_TARGETS).ClassName" >
<strong>PROCESS_SMOKE_TARGETS.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROCESS_SMOKE_TARGETS).Menu" >
<strong>PROCESS_SMOKE_TARGETS.Menu</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROCESS_SMOKE_TARGETS).MenuSmokeBlue" >
<strong>PROCESS_SMOKE_TARGETS.MenuSmokeBlue</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROCESS_SMOKE_TARGETS).MenuSmokeGreen" >
<strong>PROCESS_SMOKE_TARGETS.MenuSmokeGreen</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROCESS_SMOKE_TARGETS).MenuSmokeOrange" >
<strong>PROCESS_SMOKE_TARGETS.MenuSmokeOrange</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROCESS_SMOKE_TARGETS).MenuSmokeRed" >
<strong>PROCESS_SMOKE_TARGETS.MenuSmokeRed</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROCESS_SMOKE_TARGETS).MenuSmokeWhite" >
<strong>PROCESS_SMOKE_TARGETS.MenuSmokeWhite</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROCESS_SMOKE_TARGETS).New" >
<strong>PROCESS_SMOKE_TARGETS:New(Task, Unit, ProcessUnit, TargetSetUnit, TargetZone)</strong>
</a>
</dt>
<dd>
<p>Creates a new task assignment state machine.</p>
<p>The process will request from the menu if it accepts the task, if not, the unit is removed from the simulator.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Task.html##(TASK)">Task#TASK</a> Task </em></code>: </p>
</li>
<li>
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> Unit </em></code>: </p>
</li>
<li>
<p><code><em> ProcessUnit </em></code>: </p>
</li>
<li>
<p><code><em> TargetSetUnit </em></code>: </p>
</li>
<li>
<p><code><em> TargetZone </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(PROCESS_SMOKE_TARGETS)">#PROCESS<em>SMOKE</em>TARGETS</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROCESS_SMOKE_TARGETS).OnSmoking" >
<strong>PROCESS_SMOKE_TARGETS:OnSmoking(Fsm, Event, From, To)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function for a TASK2</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="StateMachine.html##(STATEMACHINE_PROCESS)">StateMachine#STATEMACHINE_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_SMOKE_TARGETS).OnStart" >
<strong>PROCESS_SMOKE_TARGETS:OnStart(Fsm, Event, From, To)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function for a TASK2</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="StateMachine.html##(STATEMACHINE_TASK)">StateMachine#STATEMACHINE_TASK</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="Unit.html##(UNIT)">Unit#UNIT</a></em>
<a id="#(PROCESS_SMOKE_TARGETS).ProcessUnit" >
<strong>PROCESS_SMOKE_TARGETS.ProcessUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Set.html##(SET_UNIT)">Set#SET_UNIT</a></em>
<a id="#(PROCESS_SMOKE_TARGETS).TargetSetUnit" >
<strong>PROCESS_SMOKE_TARGETS.TargetSetUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Zone.html##(ZONE_BASE)">Zone#ZONE_BASE</a></em>
<a id="#(PROCESS_SMOKE_TARGETS).TargetZone" >
<strong>PROCESS_SMOKE_TARGETS.TargetZone</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Task.html##(TASK_BASE)">Task#TASK_BASE</a></em>
<a id="#(PROCESS_SMOKE_TARGETS).Task" >
<strong>PROCESS_SMOKE_TARGETS.Task</strong>
</a>
</dt>
<dd>
</dd>
</dl>
</div>
</div>
</body>
</html>