MOOSE/doc/classes/DESTROYGROUPSTASK.html
2016-03-15 17:56:41 +01:00

216 lines
6.5 KiB
HTML

<!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>Reference</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>ldoc</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Tables">Tables</a></li>
<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><strong>DESTROYGROUPSTASK</strong></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/GROUP.html">GROUP</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/SPAWN.html">SPAWN</a></li>
<li><a href="../classes/STAGE.html">STAGE</a></li>
<li><a href="../classes/TASK.html">TASK</a></li>
<li><a href="../classes/UNIT.html">UNIT</a></li>
<li><a href="../classes/ZONE.html">ZONE</a></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>
</div>
<div id="content">
<h1>Class <code>DESTROYGROUPSTASK</code></h1>
<p>DESTROYGROUPSTASK</p>
<p></p>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#DESTROYGROUPSTASK.DESTROYGROUPSTASK">DESTROYGROUPSTASK.DESTROYGROUPSTASK</a></td>
<td class="summary">To monitor and score the destruction of Groups in the DCSRTE.</td>
</tr>
</table>
<h2><a href="#Methods">Methods</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#DESTROYGROUPSTASK:New">DESTROYGROUPSTASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage)</a></td>
<td class="summary">Creates a new DESTROYGROUPSTASK.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#DESTROYGROUPSTASK:ReportGoalProgress">DESTROYGROUPSTASK:ReportGoalProgress (DestroyGroup, DestroyUnit)</a></td>
<td class="summary">Report Goal Progress.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Tables"></a>Tables</h2>
<dl class="function">
<dt>
<a name = "DESTROYGROUPSTASK.DESTROYGROUPSTASK"></a>
<strong>DESTROYGROUPSTASK.DESTROYGROUPSTASK</strong>
</dt>
<dd>
To monitor and score the destruction of Groups in the DCSRTE.
<h3>Fields:</h3>
<ul>
<li><span class="parameter">ClassName</span>
</li>
<li><span class="parameter">GoalVerb</span>
</li>
</ul>
</dd>
</dl>
<h2><a name="Methods"></a>Methods</h2>
<dl class="function">
<dt>
<a name = "DESTROYGROUPSTASK:New"></a>
<strong>DESTROYGROUPSTASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage)</strong>
</dt>
<dd>
Creates a new DESTROYGROUPSTASK.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">DestroyGroupType</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
String describing the group to be destroyed.
</li>
<li><span class="parameter">DestroyUnitType</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
String describing the unit to be destroyed.
</li>
<li><span class="parameter">DestroyGroupNames</span>
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table{string,...}</a></span>
Table of string containing the name of the groups to be destroyed before task is completed.
</li>
<li><span class="parameter">DestroyPercentage</span>
<span class="types">optional <span class="type">number</span></span>
defines the %-tage that needs to be destroyed to achieve mission success. eg. If in the Group there are 10 units, then a value of 75 would require 8 units to be destroyed from the Group to complete the <a href="../classes/TASK.html#">TASK</a>.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/DESTROYGROUPSTASK.html#">DESTROYGROUPSTASK</a></span>
</ol>
</dd>
<dt>
<a name = "DESTROYGROUPSTASK:ReportGoalProgress"></a>
<strong>DESTROYGROUPSTASK:ReportGoalProgress (DestroyGroup, DestroyUnit)</strong>
</dt>
<dd>
Report Goal Progress.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">DestroyGroup</span>
<span class="types"><span class="type">Group</span></span>
Group structure describing the group to be evaluated.
</li>
<li><span class="parameter">DestroyUnit</span>
<span class="types"><span class="type">Unit</span></span>
Unit structure describing the Unit to be evaluated.
</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 2016-03-14 10:50:59 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>