MOOSE/docs/DEPLOYTASK.html
FlightControl 77b5e10613 Succeeded in generating the new documentation using luadocumentor
Had to recompile lua and using luarocks had to compile luadocumentor
2016-04-02 11:05:05 +02:00

369 lines
7.1 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="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>DEPLOYTASK</li>
<li><a href="DESTROYBASETASK.html">DESTROYBASETASK</a></li>
<li><a href="DESTROYGROUPSTASK.html">DESTROYGROUPSTASK</a></li>
<li><a href="DESTROYRADARSTASK.html">DESTROYRADARSTASK</a></li>
<li><a href="DESTROYUNITTYPESTASK.html">DESTROYUNITTYPESTASK</a></li>
<li><a href="Database.html">Database</a></li>
<li><a href="Escort.html">Escort</a></li>
<li><a href="GOHOMETASK.html">GOHOMETASK</a></li>
<li><a href="Group.html">Group</a></li>
<li><a href="MISSION.html">MISSION</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="NOTASK.html">NOTASK</a></li>
<li><a href="PICKUPTASK.html">PICKUPTASK</a></li>
<li><a href="ROUTETASK.html">ROUTETASK</a></li>
<li><a href="STAGE.html">STAGE</a></li>
<li><a href="Sead.html">Sead</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="TASK.html">TASK</a></li>
<li><a href="Unit.html">Unit</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>DEPLOYTASK</code></h1>
<p>A DEPLOYTASK orchestrates the deployment of CARGO within a specific landing zone.</p>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#DEPLOYTASK">DEPLOYTASK</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(DEPLOYTASK)" >Type <code>DEPLOYTASK</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(DEPLOYTASK).AddCargoMenus">DEPLOYTASK:AddCargoMenus(Client, Cargos, TransportRadius)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DEPLOYTASK).ClassName">DEPLOYTASK.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DEPLOYTASK).GoalVerb">DEPLOYTASK.GoalVerb</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DEPLOYTASK).InitCargo">DEPLOYTASK:InitCargo(InitCargos)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DEPLOYTASK).LoadCargo">DEPLOYTASK:LoadCargo(LoadCargos)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DEPLOYTASK).New">DEPLOYTASK.New(CargoType)</a></td>
<td class="summary">
<p>Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DEPLOYTASK).RemoveCargoMenus">DEPLOYTASK:RemoveCargoMenus(Client)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DEPLOYTASK).SetCargoTargetZoneName">DEPLOYTASK.SetCargoTargetZoneName(string, self, TargetZoneName)</a></td>
<td class="summary">
<p>When the cargo is unloaded, it will move to the target zone name.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DEPLOYTASK).TEXT">DEPLOYTASK.TEXT</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DEPLOYTASK).ToZone">DEPLOYTASK:ToZone(LandingZone)</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(DEPLOYTASK)">#DEPLOYTASK</a></em>
<a id="DEPLOYTASK" >
<strong>DEPLOYTASK</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(DEPLOYTASK)" >Type <code>DEPLOYTASK</code></a></h2>
<p>A DeployTask</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(DEPLOYTASK).AddCargoMenus" >
<strong>DEPLOYTASK:AddCargoMenus(Client, Cargos, TransportRadius)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> Client </em></code>: </p>
</li>
<li>
<p><code><em> Cargos </em></code>: </p>
</li>
<li>
<p><code><em> TransportRadius </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(DEPLOYTASK).ClassName" >
<strong>DEPLOYTASK.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(DEPLOYTASK).GoalVerb" >
<strong>DEPLOYTASK.GoalVerb</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DEPLOYTASK).InitCargo" >
<strong>DEPLOYTASK:InitCargo(InitCargos)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> InitCargos </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DEPLOYTASK).LoadCargo" >
<strong>DEPLOYTASK:LoadCargo(LoadCargos)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> LoadCargos </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DEPLOYTASK).New" >
<strong>DEPLOYTASK.New(CargoType)</strong>
</a>
</dt>
<dd>
<p>Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#string CargoType </em></code>:
Type of the Cargo.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(DEPLOYTASK)">#DEPLOYTASK</a>:</em>
The created DeployTask</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DEPLOYTASK).RemoveCargoMenus" >
<strong>DEPLOYTASK:RemoveCargoMenus(Client)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> Client </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DEPLOYTASK).SetCargoTargetZoneName" >
<strong>DEPLOYTASK.SetCargoTargetZoneName(string, self, TargetZoneName)</strong>
</a>
</dt>
<dd>
<p>When the cargo is unloaded, it will move to the target zone name.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> string </em></code>:
TargetZoneName Name of the Zone to where the Cargo should move after unloading.</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
<li>
<p><code><em> TargetZoneName </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(DEPLOYTASK).TEXT" >
<strong>DEPLOYTASK.TEXT</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DEPLOYTASK).ToZone" >
<strong>DEPLOYTASK:ToZone(LandingZone)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> LandingZone </em></code>: </p>
</li>
</ul>
</dd>
</dl>
</div>
</div>
</body>
</html>