mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
Documentation
This commit is contained in:
svenvandevelde
@@ -3,7 +3,7 @@
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>MOOSE</title>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>MOOSE</h1>
|
||||
<h1>ldoc</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
@@ -49,6 +49,7 @@
|
||||
<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>
|
||||
@@ -57,11 +58,11 @@
|
||||
<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>
|
||||
<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'">
|
||||
@@ -72,10 +73,6 @@
|
||||
<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>
|
||||
|
||||
@@ -83,9 +80,7 @@
|
||||
|
||||
<h1>Class <code>CLEANUP</code></h1>
|
||||
<p>CLEANUP Classes</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p></p>
|
||||
<h3>Info:</h3>
|
||||
<ul>
|
||||
<li><strong>Author</strong>: Flightcontrol</li>
|
||||
@@ -99,8 +94,32 @@
|
||||
<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:_DestroyGroup">CLEANUP:_DestroyGroup (GroupObject, CleanUpGroupName)</a></td>
|
||||
<td class="summary">Destroys a group from the simulator, but checks first if it is still existing!</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLEANUP:_DestroyUnit">CLEANUP:_DestroyUnit (CleanUpUnit, CleanUpUnitName)</a></td>
|
||||
<td class="summary">Destroys a unit from the simulator, but checks first if it is still existing!</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLEANUP:_DestroyMissile">CLEANUP:_DestroyMissile (MissileObject)</a></td>
|
||||
<td class="summary">Destroys a missile from the simulator, but checks first if it is still existing!</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLEANUP:_EventCrash">CLEANUP:_EventCrash (event)</a></td>
|
||||
<td class="summary">Detects if an SA site was shot with an anti radiation missile.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLEANUP:_EventShot">CLEANUP:_EventShot (event)</a></td>
|
||||
<td class="summary">Detects if an SA site was shot with an anti radiation missile.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLEANUP:_EventHitCleanUp">CLEANUP:_EventHitCleanUp (event)</a></td>
|
||||
<td class="summary">Detects if the Unit has an S_EVENT_HIT within the given ZoneNames.</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>
|
||||
<td class="summary">Detects if the Unit has an S_EVENT_ENGINE_SHUTDOWN or an S_EVENT_HIT within the given ZoneNames.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLEANUP:_Scheduler">CLEANUP:_Scheduler ()</a></td>
|
||||
@@ -140,8 +159,6 @@
|
||||
|
||||
<span class="types"><a class="type" href="../classes/CLEANUP.html#">CLEANUP</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
@@ -158,19 +175,163 @@
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLEANUP:_EventAddForCleanUp"></a>
|
||||
<strong>CLEANUP:_EventAddForCleanUp (event)</strong>
|
||||
<a name = "CLEANUP:_DestroyGroup"></a>
|
||||
<strong>CLEANUP:_DestroyGroup (GroupObject, CleanUpGroupName)</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.
|
||||
Destroys a group from the simulator, but checks first if it is still existing!
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">GroupObject</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">CleanUpGroupName</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h3>See also:</h3>
|
||||
<ul>
|
||||
<a href="../classes/CLEANUP.html#">CLEANUP</a>
|
||||
</ul>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLEANUP:_DestroyUnit"></a>
|
||||
<strong>CLEANUP:_DestroyUnit (CleanUpUnit, CleanUpUnitName)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Destroys a unit from the simulator, but checks first if it is still existing!
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">CleanUpUnit</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">CleanUpUnitName</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h3>See also:</h3>
|
||||
<ul>
|
||||
<a href="../classes/CLEANUP.html#">CLEANUP</a>
|
||||
</ul>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLEANUP:_DestroyMissile"></a>
|
||||
<strong>CLEANUP:_DestroyMissile (MissileObject)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Destroys a missile from the simulator, but checks first if it is still existing!
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">MissileObject</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h3>See also:</h3>
|
||||
<ul>
|
||||
<a href="../classes/CLEANUP.html#">CLEANUP</a>
|
||||
</ul>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLEANUP:_EventCrash"></a>
|
||||
<strong>CLEANUP:_EventCrash (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Detects if an SA site was shot with an anti radiation missile. In this case, take evasive actions based on the skill level set within the ME.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h3>See also:</h3>
|
||||
<ul>
|
||||
<a href="../classes/CLEANUP.html#">CLEANUP</a>
|
||||
</ul>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLEANUP:_EventShot"></a>
|
||||
<strong>CLEANUP:_EventShot (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Detects if an SA site was shot with an anti radiation missile. In this case, take evasive actions based on the skill level set within the ME.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h3>See also:</h3>
|
||||
<ul>
|
||||
<a href="../classes/CLEANUP.html#">CLEANUP</a>
|
||||
</ul>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLEANUP:_EventHitCleanUp"></a>
|
||||
<strong>CLEANUP:_EventHitCleanUp (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Detects if the Unit has an S_EVENT_HIT within the given ZoneNames. If this is the case, destroy the unit.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLEANUP:_EventAddForCleanUp"></a>
|
||||
<strong>CLEANUP:_EventAddForCleanUp (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Detects if the Unit has an S_EVENT_ENGINE_SHUTDOWN or an S_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>
|
||||
|
||||
@@ -200,7 +361,7 @@
|
||||
</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>
|
||||
<i style="float:right;">Last updated 2016-03-14 10:50:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user