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/doc/classes/TASK.html
svenvandevelde 4d9bcbe6b7 Documentation
2015-10-25 10:41:34 +01:00

953 lines
28 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>MOOSE</title>
<link rel="stylesheet" href="../ldoc.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> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>MOOSE</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Methods">Methods</a></li>
</ul>
<h2>Classes</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../classes/BASE.html">BASE</a></li>
<li><a href="../classes/CARGO.html">CARGO</a></li>
<li><a href="../classes/CLEANUP.html">CLEANUP</a></li>
<li><a href="../classes/CLIENT.html">CLIENT</a></li>
<li><a href="../classes/DATABASE.html">DATABASE</a></li>
<li><a href="../classes/DEPLOYTASK.html">DEPLOYTASK</a></li>
<li><a href="../classes/DESTROYBASETASK.html">DESTROYBASETASK</a></li>
<li><a href="../classes/DESTROYGROUPSTASK.html">DESTROYGROUPSTASK</a></li>
<li><a href="../classes/DESTROYRADARSTASK.html">DESTROYRADARSTASK</a></li>
<li><a href="../classes/DESTROYUNITTYPESTASK.html">DESTROYUNITTYPESTASK</a></li>
<li><a href="../classes/GOHOMETASK.html">GOHOMETASK</a></li>
<li><a href="../classes/MENU.html">MENU</a></li>
<li><a href="../classes/MESSAGE.html">MESSAGE</a></li>
<li><a href="../classes/MISSION.html">MISSION</a></li>
<li><a href="../classes/MOVEMENT.html">MOVEMENT</a></li>
<li><a href="../classes/NOTASK.html">NOTASK</a></li>
<li><a href="../classes/PICKUPTASK.html">PICKUPTASK</a></li>
<li><a href="../classes/ROUTETASK.html">ROUTETASK</a></li>
<li><a href="../classes/SEAD.html">SEAD</a></li>
<li><a href="../classes/SLINGLOADHOOKTASK.html">SLINGLOADHOOKTASK</a></li>
<li><a href="../classes/SLINGLOADUNHOOKTASK.html">SLINGLOADUNHOOKTASK</a></li>
<li><a href="../classes/SPAWN.html">SPAWN</a></li>
<li><a href="../classes/STAGE.html">STAGE</a></li>
<li><strong>TASK</strong></li>
</ul>
<h2>Modules</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../modules/routines.html">routines</a></li>
<li><a href="../modules/trace.html">trace</a></li>
</ul>
<h2>Scripts</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../scripts/eStatHandler.html">eStatHandler</a></li>
</ul>
<h2>Topics</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../topics/manual.md.html">manual</a></li>
</ul>
</div>
<div id="content">
<h1>Class <code>TASK</code></h1>
<p>The TASK Classes define major end-to-end activities within a MISSION.</p>
<p> The TASK Class is the Master Class to orchestrate these activities. From this class, many concrete TASK classes are inherited.</p>
<h2><a href="#Methods">Methods</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#TASK:New">TASK:New ()</a></td>
<td class="summary">Instantiates a new TASK Base.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:GetGoalProgress">TASK:GetGoalProgress ()</a></td>
<td class="summary">Get progress of a TASK.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:ShowGoalProgress">TASK:ShowGoalProgress (Mission, Client)</a></td>
<td class="summary">Show progress of a TASK.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:Done">TASK:Done ()</a></td>
<td class="summary">Sets a TASK to status Done.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:IsDone">TASK:IsDone ()</a></td>
<td class="summary">Returns if a TASK is done.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:Failed">TASK:Failed ()</a></td>
<td class="summary">Sets a TASK to status failed.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:IsFailed">TASK:IsFailed ()</a></td>
<td class="summary">Returns if a TASk has failed.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:GetGoals">TASK:GetGoals ()</a></td>
<td class="summary">Returns the Goals of a TASK</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:Goal">TASK:Goal (GoalVerb)</a></td>
<td class="summary">Returns if a TASK has Goal(s).</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:SetGoalTotal">TASK:SetGoalTotal (GoalTotal, GoalVerb)</a></td>
<td class="summary">Sets the total Goals to be achieved of the Goal Name</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:GetGoalTotal">TASK:GetGoalTotal (GoalVerb)</a></td>
<td class="summary">Gets the total of Goals to be achieved within the TASK of the GoalVerb.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:SetGoalCount">TASK:SetGoalCount (GoalCount, GoalVerb)</a></td>
<td class="summary">Sets the total of Goals currently achieved within the TASK of the GoalVerb.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:IncreaseGoalCount">TASK:IncreaseGoalCount (GoalCountIncrease, GoalVerb)</a></td>
<td class="summary">Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:GetGoalCount">TASK:GetGoalCount (GoalVerb)</a></td>
<td class="summary">Gets the total of Goals currently achieved within the TASK of the GoalVerb.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:GetGoalPercentage">TASK:GetGoalPercentage (GoalVerb)</a></td>
<td class="summary">Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:IsGoalReached">TASK:IsGoalReached ()</a></td>
<td class="summary">Returns if all the Goals of the TASK were achieved.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddGoalCompletion">TASK:AddGoalCompletion (GoalVerb, GoalTask, GoalIncrease)</a></td>
<td class="summary">Adds an Additional Goal for the TASK to be achieved.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:GetGoalCompletion">TASK:GetGoalCompletion (GoalVerb)</a></td>
<td class="summary">Returns if the additional Goal for the TASK was completed.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddSignal">TASK:AddSignal (SignalUnitNames, SignalType, SignalColor, SignalHeight)</a></td>
<td class="summary">Work function to set signal events within a TASK.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddSmokeRed">TASK:AddSmokeRed (SignalUnitNames, SignalHeight)</a></td>
<td class="summary">When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddSmokeGreen">TASK:AddSmokeGreen (SignalUnitNames, SignalHeight)</a></td>
<td class="summary">When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddSmokeBlue">TASK:AddSmokeBlue (SignalUnitNames, SignalHeight)</a></td>
<td class="summary">When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddSmokeWhite">TASK:AddSmokeWhite (SignalUnitNames, SignalHeight)</a></td>
<td class="summary">When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddSmokeOrange">TASK:AddSmokeOrange (SignalUnitNames, SignalHeight)</a></td>
<td class="summary">When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddFlareRed">TASK:AddFlareRed (SignalUnitNames, SignalHeight)</a></td>
<td class="summary">When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddFlareGreen">TASK:AddFlareGreen (SignalUnitNames, SignalHeight)</a></td>
<td class="summary">When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddFlareBlue">TASK:AddFlareBlue (SignalUnitNames, SignalHeight)</a></td>
<td class="summary">When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddFlareWhite">TASK:AddFlareWhite (SignalUnitNames, SignalHeight)</a></td>
<td class="summary">When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TASK:AddFlareOrange">TASK:AddFlareOrange (SignalUnitNames, SignalHeight)</a></td>
<td class="summary">When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Methods"></a>Methods</h2>
<dl class="function">
<dt>
<a name = "TASK:New"></a>
<strong>TASK:New ()</strong>
</dt>
<dd>
Instantiates a new TASK Base. Should never be used. Interface Class.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/TASK.html#">TASK</a></span>
</ol>
</dd>
<dt>
<a name = "TASK:GetGoalProgress"></a>
<strong>TASK:GetGoalProgress ()</strong>
</dt>
<dd>
Get progress of a TASK.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
GoalsText
</ol>
</dd>
<dt>
<a name = "TASK:ShowGoalProgress"></a>
<strong>TASK:ShowGoalProgress (Mission, Client)</strong>
</dt>
<dd>
Show progress of a TASK.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">Mission</span>
<span class="types"><a class="type" href="../classes/MISSION.html#">MISSION</a></span>
<pre><code> Group structure describing the Mission.
</code></pre>
</li>
<li><span class="parameter">Client</span>
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
<pre><code> Group structure describing the Client.
</code></pre>
</li>
</ul>
</dd>
<dt>
<a name = "TASK:Done"></a>
<strong>TASK:Done ()</strong>
</dt>
<dd>
Sets a TASK to status Done.
</dd>
<dt>
<a name = "TASK:IsDone"></a>
<strong>TASK:IsDone ()</strong>
</dt>
<dd>
Returns if a TASK is done.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
</ol>
</dd>
<dt>
<a name = "TASK:Failed"></a>
<strong>TASK:Failed ()</strong>
</dt>
<dd>
Sets a TASK to status failed.
</dd>
<dt>
<a name = "TASK:IsFailed"></a>
<strong>TASK:IsFailed ()</strong>
</dt>
<dd>
Returns if a TASk has failed.
<h3>Returns:</h3>
<ol>
bool
</ol>
</dd>
<dt>
<a name = "TASK:GetGoals"></a>
<strong>TASK:GetGoals ()</strong>
</dt>
<dd>
Returns the Goals of a TASK
<h3>Returns:</h3>
<ol>
Goals
</ol>
</dd>
<dt>
<a name = "TASK:Goal"></a>
<strong>TASK:Goal (GoalVerb)</strong>
</dt>
<dd>
Returns if a TASK has Goal(s).
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">GoalVerb</span>
<span class="types">optional <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
is the name of the Goal of the TASK.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
</ol>
</dd>
<dt>
<a name = "TASK:SetGoalTotal"></a>
<strong>TASK:SetGoalTotal (GoalTotal, GoalVerb)</strong>
</dt>
<dd>
Sets the total Goals to be achieved of the Goal Name
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">GoalTotal</span>
<span class="types"><span class="type">number</span></span>
is the number of times the GoalVerb needs to be achieved.
</li>
<li><span class="parameter">GoalVerb</span>
<span class="types">optional <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
</li>
</ul>
</dd>
<dt>
<a name = "TASK:GetGoalTotal"></a>
<strong>TASK:GetGoalTotal (GoalVerb)</strong>
</dt>
<dd>
Gets the total of Goals to be achieved within the TASK of the GoalVerb.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">GoalVerb</span>
<span class="types">optional <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
</li>
</ul>
</dd>
<dt>
<a name = "TASK:SetGoalCount"></a>
<strong>TASK:SetGoalCount (GoalCount, GoalVerb)</strong>
</dt>
<dd>
Sets the total of Goals currently achieved within the TASK of the GoalVerb.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">GoalCount</span>
<span class="types"><span class="type">number</span></span>
is the total number of Goals achieved within the TASK.
</li>
<li><span class="parameter">GoalVerb</span>
<span class="types">optional <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/TASK.html#">TASK</a></span>
</ol>
</dd>
<dt>
<a name = "TASK:IncreaseGoalCount"></a>
<strong>TASK:IncreaseGoalCount (GoalCountIncrease, GoalVerb)</strong>
</dt>
<dd>
Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">GoalCountIncrease</span>
<span class="types"><span class="type">number</span></span>
is the number of new Goals achieved within the TASK.
</li>
<li><span class="parameter">GoalVerb</span>
<span class="types">optional <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/TASK.html#">TASK</a></span>
</ol>
</dd>
<dt>
<a name = "TASK:GetGoalCount"></a>
<strong>TASK:GetGoalCount (GoalVerb)</strong>
</dt>
<dd>
Gets the total of Goals currently achieved within the TASK of the GoalVerb.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">GoalVerb</span>
<span class="types">optional <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/TASK.html#">TASK</a></span>
</ol>
</dd>
<dt>
<a name = "TASK:GetGoalPercentage"></a>
<strong>TASK:GetGoalPercentage (GoalVerb)</strong>
</dt>
<dd>
Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">GoalVerb</span>
<span class="types">optional <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/TASK.html#">TASK</a></span>
</ol>
</dd>
<dt>
<a name = "TASK:IsGoalReached"></a>
<strong>TASK:IsGoalReached ()</strong>
</dt>
<dd>
Returns if all the Goals of the TASK were achieved.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
</ol>
</dd>
<dt>
<a name = "TASK:AddGoalCompletion"></a>
<strong>TASK:AddGoalCompletion (GoalVerb, GoalTask, GoalIncrease)</strong>
</dt>
<dd>
Adds an Additional Goal for the TASK to be achieved.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">GoalVerb</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
is the name of the Goal of the TASK.
</li>
<li><span class="parameter">GoalTask</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
is a text describing the Goal of the TASK to be achieved.
</li>
<li><span class="parameter">GoalIncrease</span>
<span class="types"><span class="type">number</span></span>
is a number by which the Goal achievement is increasing.
</li>
</ul>
</dd>
<dt>
<a name = "TASK:GetGoalCompletion"></a>
<strong>TASK:GetGoalCompletion (GoalVerb)</strong>
</dt>
<dd>
Returns if the additional Goal for the TASK was completed.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">GoalVerb</span>
<span class="types">optional <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Goals
</ol>
</dd>
<dt>
<a name = "TASK:AddSignal"></a>
<strong>TASK:AddSignal (SignalUnitNames, SignalType, SignalColor, SignalHeight)</strong>
</dt>
<dd>
Work function to set signal events within a TASK.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">SignalUnitNames</span>
</li>
<li><span class="parameter">SignalType</span>
</li>
<li><span class="parameter">SignalColor</span>
</li>
<li><span class="parameter">SignalHeight</span>
</li>
</ul>
</dd>
<dt>
<a name = "TASK:AddSmokeRed"></a>
<strong>TASK:AddSmokeRed (SignalUnitNames, SignalHeight)</strong>
</dt>
<dd>
When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">SignalUnitNames</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
</li>
<li><span class="parameter">SignalHeight</span>
<span class="types"><span class="type">number</span></span>
Altitude that the Signal should be fired...
</li>
</ul>
</dd>
<dt>
<a name = "TASK:AddSmokeGreen"></a>
<strong>TASK:AddSmokeGreen (SignalUnitNames, SignalHeight)</strong>
</dt>
<dd>
When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">SignalUnitNames</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
</li>
<li><span class="parameter">SignalHeight</span>
<span class="types"><span class="type">number</span></span>
Altitude that the Signal should be fired...
</li>
</ul>
</dd>
<dt>
<a name = "TASK:AddSmokeBlue"></a>
<strong>TASK:AddSmokeBlue (SignalUnitNames, SignalHeight)</strong>
</dt>
<dd>
When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">SignalUnitNames</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
</li>
<li><span class="parameter">SignalHeight</span>
<span class="types"><span class="type">number</span></span>
Altitude that the Signal should be fired...
</li>
</ul>
</dd>
<dt>
<a name = "TASK:AddSmokeWhite"></a>
<strong>TASK:AddSmokeWhite (SignalUnitNames, SignalHeight)</strong>
</dt>
<dd>
When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">SignalUnitNames</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
</li>
<li><span class="parameter">SignalHeight</span>
<span class="types"><span class="type">number</span></span>
Altitude that the Signal should be fired...
</li>
</ul>
</dd>
<dt>
<a name = "TASK:AddSmokeOrange"></a>
<strong>TASK:AddSmokeOrange (SignalUnitNames, SignalHeight)</strong>
</dt>
<dd>
When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">SignalUnitNames</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
</li>
<li><span class="parameter">SignalHeight</span>
<span class="types"><span class="type">number</span></span>
Altitude that the Signal should be fired...
</li>
</ul>
</dd>
<dt>
<a name = "TASK:AddFlareRed"></a>
<strong>TASK:AddFlareRed (SignalUnitNames, SignalHeight)</strong>
</dt>
<dd>
When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">SignalUnitNames</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
</li>
<li><span class="parameter">SignalHeight</span>
<span class="types"><span class="type">number</span></span>
Altitude that the Signal should be fired...
</li>
</ul>
</dd>
<dt>
<a name = "TASK:AddFlareGreen"></a>
<strong>TASK:AddFlareGreen (SignalUnitNames, SignalHeight)</strong>
</dt>
<dd>
When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">SignalUnitNames</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
</li>
<li><span class="parameter">SignalHeight</span>
<span class="types"><span class="type">number</span></span>
Altitude that the Signal should be fired...
</li>
</ul>
</dd>
<dt>
<a name = "TASK:AddFlareBlue"></a>
<strong>TASK:AddFlareBlue (SignalUnitNames, SignalHeight)</strong>
</dt>
<dd>
When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">SignalUnitNames</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
</li>
<li><span class="parameter">SignalHeight</span>
<span class="types"><span class="type">number</span></span>
Altitude that the Signal should be fired...
</li>
</ul>
</dd>
<dt>
<a name = "TASK:AddFlareWhite"></a>
<strong>TASK:AddFlareWhite (SignalUnitNames, SignalHeight)</strong>
</dt>
<dd>
When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">SignalUnitNames</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
</li>
<li><span class="parameter">SignalHeight</span>
<span class="types"><span class="type">number</span></span>
Altitude that the Signal should be fired...
</li>
</ul>
</dd>
<dt>
<a name = "TASK:AddFlareOrange"></a>
<strong>TASK:AddFlareOrange (SignalUnitNames, SignalHeight)</strong>
</dt>
<dd>
When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">SignalUnitNames</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
</li>
<li><span class="parameter">SignalHeight</span>
<span class="types"><span class="type">number</span></span>
Altitude that the Signal should be fired...
</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2015-01-29 21:06:10 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink