mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
208 lines
6.2 KiB
HTML
208 lines
6.2 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><strong>CLEANUP</strong></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><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>CLEANUP</code></h1>
|
|
<p>CLEANUP Classes</p>
|
|
<p>
|
|
|
|
</p>
|
|
<h3>Info:</h3>
|
|
<ul>
|
|
<li><strong>Author</strong>: Flightcontrol</li>
|
|
</ul>
|
|
|
|
|
|
<h2><a href="#Methods">Methods</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLEANUP:New">CLEANUP:New (ZoneNames, TimeInterval)</a></td>
|
|
<td class="summary">Creates the main object which is handling the cleaning of the debris within the given Zone Names.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLEANUP:_EventAddForCleanUp">CLEANUP:_EventAddForCleanUp (event)</a></td>
|
|
<td class="summary">Detects if the Unit has an S<em>EVENT</em>ENGINE<em>SHUTDOWN or an S</em>EVENT_HIT within the given ZoneNames.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLEANUP:_Scheduler">CLEANUP:_Scheduler ()</a></td>
|
|
<td class="summary">At the defined time interval, CleanUp the Groups within the CleanUpList.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2><a name="Methods"></a>Methods</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "CLEANUP:New"></a>
|
|
<strong>CLEANUP:New (ZoneNames, TimeInterval)</strong>
|
|
</dt>
|
|
<dd>
|
|
Creates the main object which is handling the cleaning of the debris within the given Zone Names.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">ZoneNames</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table{string,...}</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
which is a table of zone names where the debris should be cleaned. Also a single string can be passed with one zone name.
|
|
</li>
|
|
<li><span class="parameter">TimeInterval</span>
|
|
<span class="types">optional <span class="type">number</span></span>
|
|
is the interval in seconds when the clean activity takes place. The default is 300 seconds, thus every 5 minutes.
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../classes/CLEANUP.html#">CLEANUP</a></span>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example">
|
|
<span class="comment">-- Clean these Zones.
|
|
</span> CleanUpAirports = CLEANUP:New( { <span class="string">'CLEAN Tbilisi'</span>, <span class="string">'CLEAN Kutaisi'</span> }, <span class="number">150</span> )
|
|
<span class="keyword">or</span>
|
|
CleanUpTbilisi = CLEANUP:New( <span class="string">'CLEAN Tbilisi'</span>, <span class="number">150</span> )
|
|
CleanUpKutaisi = CLEANUP:New( <span class="string">'CLEAN Kutaisi'</span>, <span class="number">600</span> )</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLEANUP:_EventAddForCleanUp"></a>
|
|
<strong>CLEANUP:_EventAddForCleanUp (event)</strong>
|
|
</dt>
|
|
<dd>
|
|
Detects if the Unit has an S<em>EVENT</em>ENGINE<em>SHUTDOWN or an S</em>EVENT_HIT within the given ZoneNames. If this is the case, add the Group to the CLEANUP List.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">event</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLEANUP:_Scheduler"></a>
|
|
<strong>CLEANUP:_Scheduler ()</strong>
|
|
</dt>
|
|
<dd>
|
|
At the defined time interval, CleanUp the Groups within the CleanUpList.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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>
|