mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
217 lines
6.6 KiB
HTML
217 lines
6.6 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>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><strong>DESTROYBASETASK</strong></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><a href="../classes/TASK.html">TASK</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>
|
|
<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>DESTROYBASETASK</code></h1>
|
|
<p>A DESTROYBASETASK will monitor the destruction of Groups and Units.</p>
|
|
<p> This is a BASE class, other classes are derived from this class.</p>
|
|
|
|
|
|
<h2><a href="#Methods">Methods</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DESTROYBASETASK:New">DESTROYBASETASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage)</a></td>
|
|
<td class="summary">Creates a new DESTROYBASETASK.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DESTROYBASETASK:EventDead">DESTROYBASETASK:EventDead (event)</a></td>
|
|
<td class="summary">Handle the S<em>EVENT</em>DEAD events to validate the destruction of units for the task monitoring.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DESTROYBASETASK:ReportGoalProgress">DESTROYBASETASK:ReportGoalProgress (DestroyGroup, DestroyUnit)</a></td>
|
|
<td class="summary">Validate task completeness of DESTROYBASETASK.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2><a name="Methods"></a>Methods</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "DESTROYBASETASK:New"></a>
|
|
<strong>DESTROYBASETASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage)</strong>
|
|
</dt>
|
|
<dd>
|
|
Creates a new DESTROYBASETASK.
|
|
|
|
|
|
<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>
|
|
Text describing the group to be destroyed. f.e. "Radar Installations", "Ships", "Vehicles", "Command Centers".
|
|
</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>
|
|
Text describing the unit types to be destroyed. f.e. "SA-6", "Row Boats", "Tanks", "Tents".
|
|
</li>
|
|
<li><span class="parameter">DestroyGroupPrefixes</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 Prefixes 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/DESTROYBASETASK.html#">DESTROYBASETASK</a></span>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DESTROYBASETASK:EventDead"></a>
|
|
<strong>DESTROYBASETASK:EventDead (event)</strong>
|
|
</dt>
|
|
<dd>
|
|
Handle the S<em>EVENT</em>DEAD events to validate the destruction of units for the task monitoring.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">event</span>
|
|
|
|
<pre><code> Event structure of DCS world.
|
|
</code></pre>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DESTROYBASETASK:ReportGoalProgress"></a>
|
|
<strong>DESTROYBASETASK:ReportGoalProgress (DestroyGroup, DestroyUnit)</strong>
|
|
</dt>
|
|
<dd>
|
|
Validate task completeness of DESTROYBASETASK.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">DestroyGroup</span>
|
|
|
|
<pre><code> Group structure describing the group to be evaluated.
|
|
</code></pre>
|
|
|
|
</li>
|
|
<li><span class="parameter">DestroyUnit</span>
|
|
|
|
<pre><code> Unit structure describing the Unit to be evaluated.
|
|
</code></pre>
|
|
|
|
</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>
|