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
parent
549c28fafc
commit
4d9bcbe6b7
211
doc/classes/CARGO.html
Normal file
211
doc/classes/CARGO.html
Normal file
@ -0,0 +1,211 @@
|
||||
<!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="#Structures">Structures </a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../classes/BASE.html">BASE</a></li>
|
||||
<li><strong>CARGO</strong></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><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>CARGO</code></h1>
|
||||
<p>CARGO</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Structures">Structures </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CARGO.CARGO_TRANSPORT">CARGO.CARGO_TRANSPORT</a></td>
|
||||
<td class="summary">Internal Table to understand the form of the CARGO.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CARGO.CARGO_TYPE">CARGO.CARGO_TYPE</a></td>
|
||||
<td class="summary">CARGO_TYPE Defines the different types of transports, which has an impact on the menu commands shown in F10.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Structures"></a>Structures </h2>
|
||||
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "CARGO.CARGO_TRANSPORT"></a>
|
||||
<strong>CARGO.CARGO_TRANSPORT</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Internal Table to understand the form of the CARGO.
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">UNIT</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">SLING</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">STATIC</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">INVISIBLE</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CARGO.CARGO_TYPE"></a>
|
||||
<strong>CARGO.CARGO_TYPE</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
CARGO_TYPE Defines the different types of transports, which has an impact on the menu commands shown in F10.
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">TROOPS</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">GOODS</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">VEHICLES</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">INFANTRY</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">ENGINEERS</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">PACKAGE</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">CARGO</span>
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
207
doc/classes/CLEANUP.html
Normal file
207
doc/classes/CLEANUP.html
Normal file
@ -0,0 +1,207 @@
|
||||
<!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>
|
||||
556
doc/classes/CLIENT.html
Normal file
556
doc/classes/CLIENT.html
Normal file
@ -0,0 +1,556 @@
|
||||
<!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="#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><strong>CLIENT</strong></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>CLIENT</code></h1>
|
||||
<p>CLIENT Classes</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT.CLIENT">CLIENT.CLIENT</a></td>
|
||||
<td class="summary">Clients are those Groups defined within the Mission Editor that have the skillset defined as "Client" or "Player".</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:New">CLIENT:New (ClientName, ClientBriefing)</a></td>
|
||||
<td class="summary">Use this method to register new Clients within the MOF.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:Reset">CLIENT:Reset (ClientName)</a></td>
|
||||
<td class="summary">Resets a CLIENT.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:ClientGroup">CLIENT:ClientGroup ()</a></td>
|
||||
<td class="summary">ClientGroup returns the Group of a Client.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:Transport">CLIENT:Transport ()</a></td>
|
||||
<td class="summary">Transport defines that the Client is a Transport.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:AddBriefing">CLIENT:AddBriefing (ClientBriefing)</a></td>
|
||||
<td class="summary">AddBriefing adds a briefing to a Client when a Player joins a Mission.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:IsTransport">CLIENT:IsTransport ()</a></td>
|
||||
<td class="summary">IsTransport returns if a Client is a transport.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:FindCargo">CLIENT:FindCargo (CargoName)</a></td>
|
||||
<td class="summary">FindCargo finds loaded Cargo within a CLIENT instance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:ShowCargo">CLIENT:ShowCargo ()</a></td>
|
||||
<td class="summary">ShowCargo shows the <a href="../classes/CARGO.html#">CARGO</a> within the CLIENT to the Player.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:AddCargo">CLIENT:AddCargo (CargoName, CargoGroupName, CargoType, CargoWeight, CargoGroupTemplate)</a></td>
|
||||
<td class="summary">AddCargo allows to add <a href="../classes/CARGO.html#">CARGO</a> on the CLIENT.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:RemoveCargo">CLIENT:RemoveCargo (CargoName)</a></td>
|
||||
<td class="summary">RemoveCargo removes <a href="../classes/CARGO.html#">CARGO</a> from the CLIENT.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:SwitchMessages">CLIENT:SwitchMessages (PrmTable)</a></td>
|
||||
<td class="summary">SwitchMessages is a local function called by the DCS World Menu system to switch off messages.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLIENT:Message">CLIENT:Message (Message, MessageDuration, MessageId, MessageCategory, MessageInterval)</a></td>
|
||||
<td class="summary">Message is the key Message driver for the CLIENT class.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "CLIENT.CLIENT"></a>
|
||||
<strong>CLIENT.CLIENT</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Clients are those Groups defined within the Mission Editor that have the skillset defined as "Client" or "Player".
|
||||
These clients are defined within the Mission Orchestration Framework (MOF)
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">ONBOARDSIDE</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">LEFT</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">RIGHT</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">BACK</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">FRONT</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "CLIENT:New"></a>
|
||||
<strong>CLIENT:New (ClientName, ClientBriefing)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Use this method to register new Clients within the MOF.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">ClientName</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.
|
||||
</li>
|
||||
<li><span class="parameter">ClientBriefing</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
Text that describes the briefing of the mission when a Player logs into the Client.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Create new Clients.
|
||||
</span> <span class="keyword">local</span> Mission = MISSIONSCHEDULER.AddMission( <span class="string">'Russia Transport Troops SA-6'</span>, <span class="string">'Operational'</span>, <span class="string">'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.'</span>, <span class="string">'Russia'</span> )
|
||||
Mission:AddGoal( DeploySA6TroopsGoal )
|
||||
|
||||
Mission:AddClient( CLIENT:New( <span class="string">'RU MI-8MTV2*HOT-Deploy Troops 1'</span> ):Transport() )
|
||||
Mission:AddClient( CLIENT:New( <span class="string">'RU MI-8MTV2*RAMP-Deploy Troops 3'</span> ):Transport() )
|
||||
Mission:AddClient( CLIENT:New( <span class="string">'RU MI-8MTV2*HOT-Deploy Troops 2'</span> ):Transport() )
|
||||
Mission:AddClient( CLIENT:New( <span class="string">'RU MI-8MTV2*RAMP-Deploy Troops 4'</span> ):Transport() )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLIENT:Reset"></a>
|
||||
<strong>CLIENT:Reset (ClientName)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Resets a CLIENT.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">ClientName</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLIENT:ClientGroup"></a>
|
||||
<strong>CLIENT:ClientGroup ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
ClientGroup returns the Group of a Client.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Group</span></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLIENT:Transport"></a>
|
||||
<strong>CLIENT:Transport ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Transport defines that the Client is a Transport.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLIENT:AddBriefing"></a>
|
||||
<strong>CLIENT:AddBriefing (ClientBriefing)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
AddBriefing adds a briefing to a Client when a Player joins a Mission.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">ClientBriefing</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
is the text defining the Mission briefing.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLIENT:IsTransport"></a>
|
||||
<strong>CLIENT:IsTransport ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
IsTransport returns if a Client is a transport.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLIENT:FindCargo"></a>
|
||||
<strong>CLIENT:FindCargo (CargoName)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
FindCargo finds loaded Cargo within a CLIENT instance.
|
||||
Cargo is loaded when certain PICK-UP or DEPLOY Tasks are properly executed.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">CargoName</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 cargo.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/CARGO.html#">CARGO_TYPE</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLIENT:ShowCargo"></a>
|
||||
<strong>CLIENT:ShowCargo ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
ShowCargo shows the <a href="../classes/CARGO.html#">CARGO</a> within the CLIENT to the Player.
|
||||
The <a href="../classes/CARGO.html#">CARGO</a> is shown throught the MESSAGE system of DCS World.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLIENT:AddCargo"></a>
|
||||
<strong>CLIENT:AddCargo (CargoName, CargoGroupName, CargoType, CargoWeight, CargoGroupTemplate)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
AddCargo allows to add <a href="../classes/CARGO.html#">CARGO</a> on the CLIENT.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">CargoName</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 <a href="../classes/CARGO.html#">CARGO</a>.
|
||||
</li>
|
||||
<li><span class="parameter">CargoGroupName</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 an active Group defined within the Mission Editor or Dynamically Spawned. Note that this is only applicable for Unit <a href="../classes/CARGO.html#">CARGO</a> Types.
|
||||
</li>
|
||||
<li><span class="parameter">CargoType</span>
|
||||
<span class="types"><a class="type" href="../classes/CARGO.html#">CARGO_TYPE</a></span>
|
||||
is the Type of the <a href="../classes/CARGO.html#">CARGO</a>.
|
||||
</li>
|
||||
<li><span class="parameter">CargoWeight</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is the weight of the cargo in Kg.
|
||||
</li>
|
||||
<li><span class="parameter">CargoGroupTemplate</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 an active Group defined within the Mission Editor with "Late Activation".
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLIENT:RemoveCargo"></a>
|
||||
<strong>CLIENT:RemoveCargo (CargoName)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
RemoveCargo removes <a href="../classes/CARGO.html#">CARGO</a> from the CLIENT.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">CargoName</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 <a href="../classes/CARGO.html#">CARGO</a>.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Cargo</span></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLIENT:SwitchMessages"></a>
|
||||
<strong>CLIENT:SwitchMessages (PrmTable)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
SwitchMessages is a local function called by the DCS World Menu system to switch off messages.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">PrmTable</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLIENT:Message"></a>
|
||||
<strong>CLIENT:Message (Message, MessageDuration, MessageId, MessageCategory, MessageInterval)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Message is the key Message driver for the CLIENT class.
|
||||
This function displays various messages to the Player logged into the CLIENT through the DCS World Messaging system.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">Message</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
is the text describing the message.
|
||||
</li>
|
||||
<li><span class="parameter">MessageDuration</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is the duration in seconds that the Message should be displayed.
|
||||
</li>
|
||||
<li><span class="parameter">MessageId</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 identifying the Message in the MessageQueue. The Message system overwrites Messages with the same MessageId
|
||||
</li>
|
||||
<li><span class="parameter">MessageCategory</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
is the category of the message (the title).
|
||||
</li>
|
||||
<li><span class="parameter">MessageInterval</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is the interval in seconds between the display of the Message when the CLIENT is in the air.
|
||||
</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>
|
||||
419
doc/classes/DATABASE.html
Normal file
419
doc/classes/DATABASE.html
Normal file
@ -0,0 +1,419 @@
|
||||
<!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>
|
||||
<li><a href="#Private">Private </a></li>
|
||||
<li><a href="#Events">Events </a></li>
|
||||
<li><a href="#Scheduled">Scheduled </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><strong>DATABASE</strong></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>DATABASE</code></h1>
|
||||
<p>Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.</p>
|
||||
<p> Administers the Spawning of new Groups within the DCSRTE and administers these new Groups within the DATABASE object(s).</p>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DATABASE:New">DATABASE:New ()</a></td>
|
||||
<td class="summary">Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DATABASE:Spawn">DATABASE:Spawn (SpawnTemplate)</a></td>
|
||||
<td class="summary">Instantiate new Groups within the DCSRTE.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DATABASE:SetStatusGroup">DATABASE:SetStatusGroup (GroupName, Status)</a></td>
|
||||
<td class="summary">Set a status to a Group within the Database, this to check crossing events for example.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DATABASE:GetStatusGroup">DATABASE:GetStatusGroup (GroupName)</a></td>
|
||||
<td class="summary">Get a status to a Group within the Database, this to check crossing events for example.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Private">Private </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DATABASE:_RegisterGroup">DATABASE:_RegisterGroup (GroupTemplate)</a></td>
|
||||
<td class="summary">Registers new Group Templates within the DATABASE Object.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DATABASE:_AddPlayerFromUnit">DATABASE:_AddPlayerFromUnit (UnitData)</a></td>
|
||||
<td class="summary">Add a new player entering a Unit.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DATABASE:_AddMissionTaskScore">DATABASE:_AddMissionTaskScore (PlayerUnit, MissionName, Score)</a></td>
|
||||
<td class="summary">Registers Scores the players completing a Mission Task.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DATABASE:_AddMissionScore">DATABASE:_AddMissionScore (MissionName, Score)</a></td>
|
||||
<td class="summary">Registers Mission Scores for possible multiple players that contributed in the Mission.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Events">Events </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DATABASE:OnDeadOrCrash">DATABASE:OnDeadOrCrash (event)</a></td>
|
||||
<td class="summary">Track DCSRTE DEAD or CRASH events for the internal scoring.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Scheduled">Scheduled </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DATABASE:_FollowPlayers">DATABASE:_FollowPlayers ()</a></td>
|
||||
<td class="summary">Follows new players entering Clients within the DCSRTE.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "DATABASE:New"></a>
|
||||
<strong>DATABASE:New ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/DATABASE.html#">DATABASE</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Define a new DATABASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
|
||||
</span> DBObject = DATABASE:New()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "DATABASE:Spawn"></a>
|
||||
<strong>DATABASE:Spawn (SpawnTemplate)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Instantiate new Groups within the DCSRTE.
|
||||
This method expects EXACTLY the same structure as a structure within the ME, and needs 2 additional fields defined:
|
||||
SpawnCountryID, SpawnCategoryID
|
||||
This method is used by the SPAWN class.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnTemplate</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "DATABASE:SetStatusGroup"></a>
|
||||
<strong>DATABASE:SetStatusGroup (GroupName, Status)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set a status to a Group within the Database, this to check crossing events for example.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">GroupName</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">Status</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "DATABASE:GetStatusGroup"></a>
|
||||
<strong>DATABASE:GetStatusGroup (GroupName)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get a status to a Group within the Database, this to check crossing events for example.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">GroupName</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Private"></a>Private </h2>
|
||||
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "DATABASE:_RegisterGroup"></a>
|
||||
<strong>DATABASE:_RegisterGroup (GroupTemplate)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Registers new Group Templates within the DATABASE Object.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">GroupTemplate</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "DATABASE:_AddPlayerFromUnit"></a>
|
||||
<strong>DATABASE:_AddPlayerFromUnit (UnitData)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Add a new player entering a Unit.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">UnitData</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "DATABASE:_AddMissionTaskScore"></a>
|
||||
<strong>DATABASE:_AddMissionTaskScore (PlayerUnit, MissionName, Score)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Registers Scores the players completing a Mission Task.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">PlayerUnit</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">MissionName</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">Score</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "DATABASE:_AddMissionScore"></a>
|
||||
<strong>DATABASE:_AddMissionScore (MissionName, Score)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Registers Mission Scores for possible multiple players that contributed in the Mission.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">MissionName</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">Score</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Events"></a>Events </h2>
|
||||
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "DATABASE:OnDeadOrCrash"></a>
|
||||
<strong>DATABASE:OnDeadOrCrash (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Track DCSRTE DEAD or CRASH events for the internal scoring.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Scheduled"></a>Scheduled </h2>
|
||||
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "DATABASE:_FollowPlayers"></a>
|
||||
<strong>DATABASE:_FollowPlayers ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Follows new players entering Clients within the DCSRTE.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
167
doc/classes/DEPLOYTASK.html
Normal file
167
doc/classes/DEPLOYTASK.html
Normal file
@ -0,0 +1,167 @@
|
||||
<!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><strong>DEPLOYTASK</strong></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>DEPLOYTASK</code></h1>
|
||||
<p>A DEPLOYTASK orchestrates the deployment of CARGO within a specific landing zone.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DEPLOYTASK:New">DEPLOYTASK:New (LandingZones, CargoType)</a></td>
|
||||
<td class="summary">Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DEPLOYTASK:SetCargoTargetZoneName">DEPLOYTASK:SetCargoTargetZoneName (TargetZoneName)</a></td>
|
||||
<td class="summary">When the cargo is unloaded, it will move to the target zone name.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "DEPLOYTASK:New"></a>
|
||||
<strong>DEPLOYTASK:New (LandingZones, CargoType)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">LandingZones</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>
|
||||
Table or name of the zone(s) where Cargo is to be unloaded.
|
||||
</li>
|
||||
<li><span class="parameter">CargoType</span>
|
||||
<span class="types"><a class="type" href="../classes/CARGO.html#">CARGO_TYPE</a></span>
|
||||
Type of the Cargo.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "DEPLOYTASK:SetCargoTargetZoneName"></a>
|
||||
<strong>DEPLOYTASK:SetCargoTargetZoneName (TargetZoneName)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
When the cargo is unloaded, it will move to the target zone name.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">TargetZoneName</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
Name of the Zone to where the Cargo should move after unloading.
|
||||
</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>
|
||||
216
doc/classes/DESTROYBASETASK.html
Normal file
216
doc/classes/DESTROYBASETASK.html
Normal file
@ -0,0 +1,216 @@
|
||||
<!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>
|
||||
241
doc/classes/DESTROYGROUPSTASK.html
Normal file
241
doc/classes/DESTROYGROUPSTASK.html
Normal file
@ -0,0 +1,241 @@
|
||||
<!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="#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/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>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>
|
||||
|
||||
<pre><code>String describing the group to be destroyed.
|
||||
</code></pre>
|
||||
|
||||
</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>
|
||||
|
||||
<pre><code>String describing the unit to be destroyed.
|
||||
</code></pre>
|
||||
|
||||
</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>
|
||||
|
||||
<pre><code>Table of string containing the name of the groups to be destroyed before task is completed.
|
||||
</code></pre>
|
||||
|
||||
</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>
|
||||
|
||||
<pre><code> Group structure describing the group to be evaluated.
|
||||
</code></pre>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">DestroyUnit</span>
|
||||
<span class="types"><span class="type">Unit</span></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>
|
||||
184
doc/classes/DESTROYRADARSTASK.html
Normal file
184
doc/classes/DESTROYRADARSTASK.html
Normal file
@ -0,0 +1,184 @@
|
||||
<!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><strong>DESTROYRADARSTASK</strong></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>DESTROYRADARSTASK</code></h1>
|
||||
<p>Task class to destroy radar installations.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DESTROYRADARSTASK:New">DESTROYRADARSTASK:New (DestroyGroupNames)</a></td>
|
||||
<td class="summary">Creates a new DESTROYRADARSTASK.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DESTROYRADARSTASK:ReportGoalProgress">DESTROYRADARSTASK:ReportGoalProgress (DestroyGroup, DestroyUnit)</a></td>
|
||||
<td class="summary">Report Goal Progress.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "DESTROYRADARSTASK:New"></a>
|
||||
<strong>DESTROYRADARSTASK:New (DestroyGroupNames)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new DESTROYRADARSTASK.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<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>
|
||||
|
||||
<pre><code>Table of string containing the group names of which the radars are be destroyed.
|
||||
</code></pre>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/DESTROYRADARSTASK.html#">DESTROYRADARSTASK</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "DESTROYRADARSTASK:ReportGoalProgress"></a>
|
||||
<strong>DESTROYRADARSTASK: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>
|
||||
|
||||
<pre><code> Group structure describing the group to be evaluated.
|
||||
</code></pre>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">DestroyUnit</span>
|
||||
<span class="types"><span class="type">Unit</span></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>
|
||||
205
doc/classes/DESTROYUNITTYPESTASK.html
Normal file
205
doc/classes/DESTROYUNITTYPESTASK.html
Normal file
@ -0,0 +1,205 @@
|
||||
<!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><strong>DESTROYUNITTYPESTASK</strong></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>DESTROYUNITTYPESTASK</code></h1>
|
||||
<p>Set TASK to destroy certain unit types.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DESTROYUNITTYPESTASK:New">DESTROYUNITTYPESTASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes)</a></td>
|
||||
<td class="summary">Creates a new DESTROYUNITTYPESTASK.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#DESTROYUNITTYPESTASK:ReportGoalProgress">DESTROYUNITTYPESTASK:ReportGoalProgress (DestroyGroup, DestroyUnit)</a></td>
|
||||
<td class="summary">Report Goal Progress.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "DESTROYUNITTYPESTASK:New"></a>
|
||||
<strong>DESTROYUNITTYPESTASK:New (DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new DESTROYUNITTYPESTASK.
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
<pre><code> String describing the group to be destroyed. f.e. "Radar Installations", "Fleet", "Batallion", "Command Centers".
|
||||
</code></pre>
|
||||
|
||||
</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>
|
||||
|
||||
<pre><code> String describing the unit to be destroyed. f.e. "radars", "ships", "tanks", "centers".
|
||||
</code></pre>
|
||||
|
||||
</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>
|
||||
|
||||
<pre><code>Table of string containing the group names of which the radars are be destroyed.
|
||||
</code></pre>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">DestroyUnitTypes</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
|
||||
<pre><code> Table of string containing the type names of the units to achieve mission success.
|
||||
</code></pre>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/DESTROYUNITTYPESTASK.html#">DESTROYUNITTYPESTASK</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "DESTROYUNITTYPESTASK:ReportGoalProgress"></a>
|
||||
<strong>DESTROYUNITTYPESTASK: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>
|
||||
|
||||
<pre><code> Group structure describing the group to be evaluated.
|
||||
</code></pre>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">DestroyUnit</span>
|
||||
<span class="types"><span class="type">Unit</span></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>
|
||||
146
doc/classes/GOHOMETASK.html
Normal file
146
doc/classes/GOHOMETASK.html
Normal file
@ -0,0 +1,146 @@
|
||||
<!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><strong>GOHOMETASK</strong></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>GOHOMETASK</code></h1>
|
||||
<p>A GOHOMETASK orchestrates the travel back to the home base, which is a specific zone defined within the ME.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#GOHOMETASK:New">GOHOMETASK:New (LandingZones)</a></td>
|
||||
<td class="summary">Creates a new GOHOMETASK.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "GOHOMETASK:New"></a>
|
||||
<strong>GOHOMETASK:New (LandingZones)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new GOHOMETASK.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">LandingZones</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>
|
||||
Table of Landing Zone names where Home(s) are located.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/GOHOMETASK.html#">GOHOMETASK</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
102
doc/classes/MENU.html
Normal file
102
doc/classes/MENU.html
Normal file
@ -0,0 +1,102 @@
|
||||
<!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>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><strong>MENU</strong></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>MENU</code></h1>
|
||||
<p>Encapsulation of DCS World Menu system in a set of MENU classes.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
351
doc/classes/MESSAGE.html
Normal file
351
doc/classes/MESSAGE.html
Normal file
@ -0,0 +1,351 @@
|
||||
<!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>
|
||||
<li><a href="#Class_MESSAGEQUEUE">Class MESSAGEQUEUE </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><strong>MESSAGE</strong></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>MESSAGE</code></h1>
|
||||
<p>Message System to display Messages for Clients and Coalitions or All.</p>
|
||||
<p> Messages are grouped on the display panel per Category to improve readability for the players.
|
||||
Messages are shown on the display panel for an amount of seconds, and will then disappear.
|
||||
Messages are identified by an ID. The messages with the same ID belonging to the same category will be overwritten if they were still being displayed on the display panel.
|
||||
Messages are created with MESSAGE:<a href="../classes/MESSAGE.html#MESSAGE:New">New</a>().
|
||||
Messages are sent to Clients with MESSAGE:<a href="../classes/MESSAGE.html#MESSAGE:ToClient">ToClient</a>().
|
||||
Messages are sent to Coalitions with MESSAGE:<a href="../classes/MESSAGE.html#MESSAGE:ToCoalition">ToCoalition</a>().
|
||||
Messages are sent to All Players with MESSAGE:<a href="../classes/MESSAGE.html#MESSAGE:ToAll">ToAll</a>().</p>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MESSAGE:New">MESSAGE:New (MessageText, MessageCategory, MessageDuration, MessageID)</a></td>
|
||||
<td class="summary">Creates a new MESSAGE object.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MESSAGE:ToClient">MESSAGE:ToClient (Client)</a></td>
|
||||
<td class="summary">Sends a MESSAGE to a Client Group.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MESSAGE:ToCoalition">MESSAGE:ToCoalition (CoalitionSide)</a></td>
|
||||
<td class="summary">Sends a MESSAGE to a Coalition.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MESSAGE:ToAll">MESSAGE:ToAll ()</a></td>
|
||||
<td class="summary">Sends a MESSAGE to all players.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Class_MESSAGEQUEUE">Class MESSAGEQUEUE </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MESSAGEQUEUE:_DisplayMessages">MESSAGEQUEUE:_DisplayMessages ()</a></td>
|
||||
<td class="summary">This function is called automatically by the MESSAGEQUEUE scheduler.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MESSAGE._MessageQueue">MESSAGE._MessageQueue</a></td>
|
||||
<td class="summary">The _MessageQueue object is created when the MESSAGE class module is loaded.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "MESSAGE:New"></a>
|
||||
<strong>MESSAGE:New (MessageText, MessageCategory, MessageDuration, MessageID)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new MESSAGE object. Note that these MESSAGE objects are not yet displayed on the display panel. You must use the functions <a href="../classes/MESSAGE.html#MESSAGE:ToClient">ToClient</a> or <a href="../classes/MESSAGE.html#MESSAGE:ToCoalition">ToCoalition</a> or <a href="../classes/MESSAGE.html#MESSAGE:ToAll">ToAll</a> to send these Messages to the respective recipients.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">MessageText</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
is the text of the Message.
|
||||
</li>
|
||||
<li><span class="parameter">MessageCategory</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
is a string expressing the Category of the Message. Messages are grouped on the display panel per Category to improve readability.
|
||||
</li>
|
||||
<li><span class="parameter">MessageDuration</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is a number in seconds of how long the MESSAGE should be shown on the display panel.
|
||||
</li>
|
||||
<li><span class="parameter">MessageID</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
is a string expressing the ID of the Message.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/MESSAGE.html#">MESSAGE</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Create a series of new Messages.
|
||||
</span> <span class="comment">-- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
|
||||
</span> <span class="comment">-- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
|
||||
</span> <span class="comment">-- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
|
||||
</span> <span class="comment">-- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
|
||||
</span> MessageAll = MESSAGE:New( <span class="string">"To all Players: BLUE has won! Each player of BLUE wins 50 points!"</span>, <span class="string">"End of Mission"</span>, <span class="number">25</span>, <span class="string">"Win"</span> )
|
||||
MessageRED = MESSAGE:New( <span class="string">"To the RED Players: You receive a penalty because you've killed one of your own units"</span>, <span class="string">"Penalty"</span>, <span class="number">25</span>, <span class="string">"Score"</span> )
|
||||
MessageClient1 = MESSAGE:New( <span class="string">"Congratulations, you've just hit a target"</span>, <span class="string">"Score"</span>, <span class="number">25</span>, <span class="string">"Score"</span> )
|
||||
MessageClient2 = MESSAGE:New( <span class="string">"Congratulations, you've just killed a target"</span>, <span class="string">"Score"</span>, <span class="number">25</span>, <span class="string">"Score"</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MESSAGE:ToClient"></a>
|
||||
<strong>MESSAGE:ToClient (Client)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sends a MESSAGE to a Client Group. Note that the Group needs to be defined within the ME with the skillset "Client" or "Player".
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">Client</span>
|
||||
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
||||
is the Group of the Client.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/MESSAGE.html#">MESSAGE</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Send the 2 messages created with the <a href="../classes/MESSAGE.html#MESSAGE:New">New</a> method to the Client Group.
|
||||
</span> <span class="comment">-- Note that the Message of MessageClient2 is overwriting the Message of MessageClient1.
|
||||
</span> ClientGroup = Group.getByName( <span class="string">"ClientGroup"</span> )
|
||||
|
||||
MessageClient1 = MESSAGE:New( <span class="string">"Congratulations, you've just hit a target"</span>, <span class="string">"Score"</span>, <span class="number">25</span>, <span class="string">"Score"</span> ):ToClient( ClientGroup )
|
||||
MessageClient2 = MESSAGE:New( <span class="string">"Congratulations, you've just killed a target"</span>, <span class="string">"Score"</span>, <span class="number">25</span>, <span class="string">"Score"</span> ):ToClient( ClientGroup )
|
||||
<span class="keyword">or</span>
|
||||
MESSAGE:New( <span class="string">"Congratulations, you've just hit a target"</span>, <span class="string">"Score"</span>, <span class="number">25</span>, <span class="string">"Score"</span> ):ToClient( ClientGroup )
|
||||
MESSAGE:New( <span class="string">"Congratulations, you've just killed a target"</span>, <span class="string">"Score"</span>, <span class="number">25</span>, <span class="string">"Score"</span> ):ToClient( ClientGroup )
|
||||
<span class="keyword">or</span>
|
||||
MessageClient1 = MESSAGE:New( <span class="string">"Congratulations, you've just hit a target"</span>, <span class="string">"Score"</span>, <span class="number">25</span>, <span class="string">"Score"</span> )
|
||||
MessageClient2 = MESSAGE:New( <span class="string">"Congratulations, you've just killed a target"</span>, <span class="string">"Score"</span>, <span class="number">25</span>, <span class="string">"Score"</span> )
|
||||
MessageClient1:ToClient( ClientGroup )
|
||||
MessageClient2:ToClient( ClientGroup )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MESSAGE:ToCoalition"></a>
|
||||
<strong>MESSAGE:ToCoalition (CoalitionSide)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sends a MESSAGE to a Coalition.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">CoalitionSide</span>
|
||||
needs to be filled out by the defined structure of the standard scripting engine ???.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/MESSAGE.html#">MESSAGE</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Send a message created with the <a href="../classes/MESSAGE.html#MESSAGE:New">New</a> method to the RED coalition.
|
||||
</span> MessageRED = MESSAGE:New( <span class="string">"To the RED Players: You receive a penalty because you've killed one of your own units"</span>, <span class="string">"Penalty"</span>, <span class="number">25</span>, <span class="string">"Score"</span> ):ToCoalition( coalition.side.RED )
|
||||
<span class="keyword">or</span>
|
||||
MESSAGE:New( <span class="string">"To the RED Players: You receive a penalty because you've killed one of your own units"</span>, <span class="string">"Penalty"</span>, <span class="number">25</span>, <span class="string">"Score"</span> ):ToCoalition( coalition.side.RED )
|
||||
<span class="keyword">or</span>
|
||||
MessageRED = MESSAGE:New( <span class="string">"To the RED Players: You receive a penalty because you've killed one of your own units"</span>, <span class="string">"Penalty"</span>, <span class="number">25</span>, <span class="string">"Score"</span> )
|
||||
MessageRED:ToCoalition( coalition.side.RED )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MESSAGE:ToAll"></a>
|
||||
<strong>MESSAGE:ToAll ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sends a MESSAGE to all players.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/MESSAGE.html#">MESSAGE</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Send a message created to all players.
|
||||
</span> MessageAll = MESSAGE:New( <span class="string">"To all Players: BLUE has won! Each player of BLUE wins 50 points!"</span>, <span class="string">"End of Mission"</span>, <span class="number">25</span>, <span class="string">"Win"</span> ):ToAll()
|
||||
<span class="keyword">or</span>
|
||||
MESSAGE:New( <span class="string">"To all Players: BLUE has won! Each player of BLUE wins 50 points!"</span>, <span class="string">"End of Mission"</span>, <span class="number">25</span>, <span class="string">"Win"</span> ):ToAll()
|
||||
<span class="keyword">or</span>
|
||||
MessageAll = MESSAGE:New( <span class="string">"To all Players: BLUE has won! Each player of BLUE wins 50 points!"</span>, <span class="string">"End of Mission"</span>, <span class="number">25</span>, <span class="string">"Win"</span> )
|
||||
MessageAll:ToAll()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Class_MESSAGEQUEUE"></a>Class MESSAGEQUEUE </h2>
|
||||
|
||||
MESSAGEQUEUE
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "MESSAGEQUEUE:_DisplayMessages"></a>
|
||||
<strong>MESSAGEQUEUE:_DisplayMessages ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
This function is called automatically by the MESSAGEQUEUE scheduler.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MESSAGE._MessageQueue"></a>
|
||||
<strong>MESSAGE._MessageQueue</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The _MessageQueue object is created when the MESSAGE class module is loaded.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
973
doc/classes/MISSION.html
Normal file
973
doc/classes/MISSION.html
Normal file
@ -0,0 +1,973 @@
|
||||
<!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="#Tables">Tables</a></li>
|
||||
<li><a href="#Issues">Issues</a></li>
|
||||
<li><a href="#Methods">Methods</a></li>
|
||||
<li><a href="#Class_MISSIONSCHEDULER">Class MISSIONSCHEDULER </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><strong>MISSION</strong></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>MISSION</code></h1>
|
||||
<p>A MISSION is the main owner of a Mission orchestration within MOOSE .</p>
|
||||
<p> The Mission framework orchestrates <a href="../classes/CLIENT.html#">CLIENT</a>s, <a href="../classes/TASK.html#">TASK</a>s, <a href="../classes/STAGE.html#">STAGE</a>s etc.
|
||||
A <a href="../classes/CLIENT.html#">CLIENT</a> needs to be registered within the <a href="../classes/MISSION.html#">MISSION</a> through the function <a href="../classes/MISSION.html#MISSION:AddClient">AddClient</a>. A <a href="../classes/TASK.html#">TASK</a> needs to be registered within the <a href="../classes/MISSION.html#">MISSION</a> through the function <a href="../classes/MISSION.html#MISSION:AddTask">AddTask</a>.</p>
|
||||
|
||||
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION.SpawnCargo">MISSION.SpawnCargo</a></td>
|
||||
<td class="summary">Add Cargo to the mission...</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Issues">Issues</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION.SpawnCargo-todo1">MISSION.SpawnCargo-todo1</a></td>
|
||||
<td class="summary">check this</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION.SpawnCargo-todo1-todo2">MISSION.SpawnCargo-todo1-todo2</a></td>
|
||||
<td class="summary">check this</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:New">MISSION:New (MissionName, MissionPriority, MissionBriefing, MissionCoalition)</a></td>
|
||||
<td class="summary">This is the main MISSION declaration method.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:IsCompleted">MISSION:IsCompleted ()</a></td>
|
||||
<td class="summary">Returns if a Mission has completed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:Completed">MISSION:Completed ()</a></td>
|
||||
<td class="summary">Set a Mission to completed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:IsOngoing">MISSION:IsOngoing ()</a></td>
|
||||
<td class="summary">Returns if a Mission is ongoing.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:Ongoing">MISSION:Ongoing ()</a></td>
|
||||
<td class="summary">Set a Mission to ongoing.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:IsPending">MISSION:IsPending ()</a></td>
|
||||
<td class="summary">Returns if a Mission is pending.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:Pending">MISSION:Pending ()</a></td>
|
||||
<td class="summary">Set a Mission to pending.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:IsFailed">MISSION:IsFailed ()</a></td>
|
||||
<td class="summary">Returns if a Mission has failed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:Failed">MISSION:Failed ()</a></td>
|
||||
<td class="summary">Set a Mission to failed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:StatusToClients">MISSION:StatusToClients ()</a></td>
|
||||
<td class="summary">Send the status of the MISSION to all Clients.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:ReportTrigger">MISSION:ReportTrigger ()</a></td>
|
||||
<td class="summary">Handles the reporting.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:ReportToAll">MISSION:ReportToAll ()</a></td>
|
||||
<td class="summary">Report the status of all MISSIONs to all active Clients.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:AddGoalFunction">MISSION:AddGoalFunction (GoalFunction)</a></td>
|
||||
<td class="summary">Add a goal function to a MISSION.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:ShowBriefing">MISSION:ShowBriefing (Client)</a></td>
|
||||
<td class="summary">Show the briefing of the MISSION to the CLIENT.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:AddClient">MISSION:AddClient (Client)</a></td>
|
||||
<td class="summary">Register a new <a href="../classes/CLIENT.html#">CLIENT</a> to participate within the mission.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:FindClient">MISSION:FindClient (ClientName)</a></td>
|
||||
<td class="summary">Find a <a href="../classes/CLIENT.html#">CLIENT</a> object within the <a href="../classes/MISSION.html#">MISSION</a> by its ClientName.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:AddTask">MISSION:AddTask (Task, TaskNumber)</a></td>
|
||||
<td class="summary">Register a <a href="../classes/TASK.html#">TASK</a> to be completed within the <a href="../classes/MISSION.html#">MISSION</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:GetTask">MISSION:GetTask (TaskNumber)</a></td>
|
||||
<td class="summary">Get the TASK idenified by the TaskNumber from the Mission.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSION:GetTasks">MISSION:GetTasks ()</a></td>
|
||||
<td class="summary">Get all the TASKs from the Mission.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Class_MISSIONSCHEDULER">Class MISSIONSCHEDULER </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSIONSCHEDULER.Scheduler">MISSIONSCHEDULER.Scheduler ()</a></td>
|
||||
<td class="summary">This is the main MISSIONSCHEDULER Scheduler function.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSIONSCHEDULER.Start">MISSIONSCHEDULER.Start ()</a></td>
|
||||
<td class="summary">Start the MISSIONSCHEDULER.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSIONSCHEDULER.Stop">MISSIONSCHEDULER.Stop ()</a></td>
|
||||
<td class="summary">Stop the MISSIONSCHEDULER.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSIONSCHEDULER.AddMission">MISSIONSCHEDULER.AddMission (Mission)</a></td>
|
||||
<td class="summary">This is the main MISSION declaration method.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSIONSCHEDULER.RemoveMission">MISSIONSCHEDULER.RemoveMission (MissionName)</a></td>
|
||||
<td class="summary">Remove a MISSION from the MISSIONSCHEDULER.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSIONSCHEDULER.FindMission">MISSIONSCHEDULER.FindMission (MissionName)</a></td>
|
||||
<td class="summary">Find a MISSION within the MISSIONSCHEDULER.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSIONSCHEDULER.ReportMenu">MISSIONSCHEDULER.ReportMenu ()</a></td>
|
||||
<td class="summary">Enables a MENU option in the communications menu under F10 to control the status of the active missions.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MISSIONSCHEDULER:TimeShow">MISSIONSCHEDULER:TimeShow ()</a></td>
|
||||
<td class="summary">Show the remaining mission time.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "MISSION.SpawnCargo"></a>
|
||||
<strong>MISSION.SpawnCargo</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Add Cargo to the mission... Cargo functionality needs to be reworked a bit, so this is still under construction. I need to make a CARGO Class...
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Issues"></a>Issues</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "MISSION.SpawnCargo-todo1"></a>
|
||||
<strong>MISSION.SpawnCargo-todo1</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
check this
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION.SpawnCargo-todo1-todo2"></a>
|
||||
<strong>MISSION.SpawnCargo-todo1-todo2</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
check this
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "MISSION:New"></a>
|
||||
<strong>MISSION:New (MissionName, MissionPriority, MissionBriefing, MissionCoalition)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
This is the main MISSION declaration method. Each Mission is like the master or a Mission orchestration between, Clients, Tasks, Stages etc.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">MissionName</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 mission. This name will be used to reference the status of each mission by the players.
|
||||
</li>
|
||||
<li><span class="parameter">MissionPriority</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
is a string indicating the "priority" of the Mission. f.e. "Primary", "Secondary" or "First", "Second". It is free format and up to the Mission designer to choose. There are no rules behind this field.
|
||||
</li>
|
||||
<li><span class="parameter">MissionBriefing</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
is a string indicating the mission briefing to be shown when a player joins a <a href="../classes/CLIENT.html#">CLIENT</a>.
|
||||
</li>
|
||||
<li><span class="parameter">MissionCoalition</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
is a string indicating the coalition or party to which this mission belongs to. It is free format and can be chosen freely by the mission designer. Note that this field is not to be confused with the coalition concept of the ME. Examples of a Mission Coalition could be "NATO", "CCCP", "Intruders", "Terrorists"...
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/MISSION.html#">MISSION</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Declare a few missions.
|
||||
</span> <span class="keyword">local</span> Mission = MISSIONSCHEDULER.AddMission( <span class="string">'Russia Transport Troops SA-6'</span>, <span class="string">'Operational'</span>, <span class="string">'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.'</span>, <span class="string">'Russia'</span> )
|
||||
<span class="keyword">local</span> Mission = MISSIONSCHEDULER.AddMission( <span class="string">'Patriots'</span>, <span class="string">'Primary'</span>, <span class="string">'Our intelligence reports that 3 Patriot SAM defense batteries are located near Ruisi, Kvarhiti and Gori.'</span>, <span class="string">'Russia'</span> )
|
||||
<span class="keyword">local</span> Mission = MISSIONSCHEDULER.AddMission( <span class="string">'Package Delivery'</span>, <span class="string">'Operational'</span>, <span class="string">'In order to be in full control of the situation, we need you to deliver a very important package at a secret location. Fly undetected through the NATO defenses and deliver the secret package. The secret agent is located at waypoint 4.'</span>, <span class="string">'Russia'</span> )
|
||||
<span class="keyword">local</span> Mission = MISSIONSCHEDULER.AddMission( <span class="string">'Rescue General'</span>, <span class="string">'Tactical'</span>, <span class="string">'Our intelligence has received a remote signal behind Gori. We believe it is a very important Russian General that was captured by Georgia. Go out there and rescue him! Ensure you stay out of the battle zone, keep south. Waypoint 4 is the location of our Russian General.'</span>, <span class="string">'Russia'</span> )
|
||||
<span class="keyword">local</span> Mission = MISSIONSCHEDULER.AddMission( <span class="string">'NATO Transport Troops'</span>, <span class="string">'Operational'</span>, <span class="string">'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.'</span>, <span class="string">'NATO'</span> )
|
||||
<span class="keyword">local</span> Mission = MISSIONSCHEDULER.AddMission( <span class="string">'SA-6 SAMs'</span>, <span class="string">'Primary'</span>, <span class="string">'Our intelligence reports that 3 SA-6 SAM defense batteries are located near Didmukha, Khetagurov and Berula. Eliminate the Russian SAMs.'</span>, <span class="string">'NATO'</span> )
|
||||
<span class="keyword">local</span> Mission = MISSIONSCHEDULER.AddMission( <span class="string">'NATO Sling Load'</span>, <span class="string">'Operational'</span>, <span class="string">'Fly to the cargo pickup zone at Dzegvi or Kaspi, and sling the cargo to Soganlug airbase.'</span>, <span class="string">'NATO'</span> )
|
||||
<span class="keyword">local</span> Mission = MISSIONSCHEDULER.AddMission( <span class="string">'Rescue secret agent'</span>, <span class="string">'Tactical'</span>, <span class="string">'In order to be in full control of the situation, we need you to rescue a secret agent from the woods behind enemy lines. Avoid the Russian defenses and rescue the agent. Keep south until Khasuri, and keep your eyes open for any SAM presence. The agent is located at waypoint 4 on your kneeboard.'</span>, <span class="string">'NATO'</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:IsCompleted"></a>
|
||||
<strong>MISSION:IsCompleted ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns if a Mission has completed.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:Completed"></a>
|
||||
<strong>MISSION:Completed ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set a Mission to completed.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:IsOngoing"></a>
|
||||
<strong>MISSION:IsOngoing ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns if a Mission is ongoing.
|
||||
treturn bool
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:Ongoing"></a>
|
||||
<strong>MISSION:Ongoing ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set a Mission to ongoing.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:IsPending"></a>
|
||||
<strong>MISSION:IsPending ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns if a Mission is pending.
|
||||
treturn bool
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:Pending"></a>
|
||||
<strong>MISSION:Pending ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set a Mission to pending.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:IsFailed"></a>
|
||||
<strong>MISSION:IsFailed ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns if a Mission has failed.
|
||||
treturn bool
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:Failed"></a>
|
||||
<strong>MISSION:Failed ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set a Mission to failed.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:StatusToClients"></a>
|
||||
<strong>MISSION:StatusToClients ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Send the status of the MISSION to all Clients.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:ReportTrigger"></a>
|
||||
<strong>MISSION:ReportTrigger ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Handles the reporting. After certain time intervals, a MISSION report MESSAGE will be shown to All Players.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:ReportToAll"></a>
|
||||
<strong>MISSION:ReportToAll ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Report the status of all MISSIONs to all active Clients.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:AddGoalFunction"></a>
|
||||
<strong>MISSION:AddGoalFunction (GoalFunction)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Add a goal function to a MISSION. Goal functions are called when a <a href="../classes/TASK.html#">TASK</a> within a mission has been completed.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">GoalFunction</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
is the function defined by the mission designer to evaluate whether a certain goal has been reached after a <a href="../classes/TASK.html#">TASK</a> finishes within the <a href="../classes/MISSION.html#">MISSION</a>. A GoalFunction must accept 2 parameters: Mission, Client, which contains the current MISSION object and the current CLIENT object respectively.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
PatriotActivation = {
|
||||
{ <span class="string">"US SAM Patriot Zerti"</span>, <span class="keyword">false</span> },
|
||||
{ <span class="string">"US SAM Patriot Zegduleti"</span>, <span class="keyword">false</span> },
|
||||
{ <span class="string">"US SAM Patriot Gvleti"</span>, <span class="keyword">false</span> }
|
||||
}
|
||||
|
||||
<span class="keyword">function</span> DeployPatriotTroopsGoal( Mission, Client )
|
||||
|
||||
|
||||
<span class="comment">-- Check if the cargo is all deployed for mission success.
|
||||
</span> <span class="keyword">for</span> CargoID, CargoData <span class="keyword">in</span> <span class="global">pairs</span>( Mission._Cargos ) <span class="keyword">do</span>
|
||||
<span class="keyword">if</span> Group.getByName( CargoData.CargoGroupName ) <span class="keyword">then</span>
|
||||
CargoGroup = Group.getByName( CargoData.CargoGroupName )
|
||||
<span class="keyword">if</span> CargoGroup <span class="keyword">then</span>
|
||||
<span class="comment">-- Check if the cargo is ready to activate
|
||||
</span> CurrentLandingZoneID = routines.IsUnitInZones( CargoGroup:getUnits()[<span class="number">1</span>], Mission:GetTask( <span class="number">2</span> ).LandingZones ) <span class="comment">-- The second task is the Deploytask to measure mission success upon
|
||||
</span> <span class="keyword">if</span> CurrentLandingZoneID <span class="keyword">then</span>
|
||||
<span class="keyword">if</span> PatriotActivation[CurrentLandingZoneID][<span class="number">2</span>] == <span class="keyword">false</span> <span class="keyword">then</span>
|
||||
<span class="comment">-- Now check if this is a new Mission Task to be completed...
|
||||
</span> trigger.action.setGroupAIOn( Group.getByName( PatriotActivation[CurrentLandingZoneID][<span class="number">1</span>] ) )
|
||||
PatriotActivation[CurrentLandingZoneID][<span class="number">2</span>] = <span class="keyword">true</span>
|
||||
MessageToBlue( <span class="string">"Mission Command: Message to all airborne units! The "</span> .. PatriotActivation[CurrentLandingZoneID][<span class="number">1</span>] .. <span class="string">" is armed. Our air defenses are now stronger."</span>, <span class="number">60</span>, <span class="string">"BLUE/PatriotDefense"</span> )
|
||||
MessageToRed( <span class="string">"Mission Command: Our satellite systems are detecting additional NATO air defenses. To all airborne units: Take care!!!"</span>, <span class="number">60</span>, <span class="string">"RED/PatriotDefense"</span> )
|
||||
Mission:GetTask( <span class="number">2</span> ):AddGoalCompletion( <span class="string">"Patriots activated"</span>, PatriotActivation[CurrentLandingZoneID][<span class="number">1</span>], <span class="number">1</span> ) <span class="comment">-- Register Patriot activation as part of mission goal.
|
||||
</span> <span class="keyword">end</span>
|
||||
<span class="keyword">end</span>
|
||||
<span class="keyword">end</span>
|
||||
<span class="keyword">end</span>
|
||||
<span class="keyword">end</span>
|
||||
<span class="keyword">end</span>
|
||||
|
||||
<span class="keyword">local</span> Mission = MISSIONSCHEDULER.AddMission( <span class="string">'NATO Transport Troops'</span>, <span class="string">'Operational'</span>, <span class="string">'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.'</span>, <span class="string">'NATO'</span> )
|
||||
Mission:AddGoalFunction( DeployPatriotTroopsGoal )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:ShowBriefing"></a>
|
||||
<strong>MISSION:ShowBriefing (Client)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Show the briefing of the MISSION to the CLIENT.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">Client</span>
|
||||
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
||||
to show briefing to.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:AddClient"></a>
|
||||
<strong>MISSION:AddClient (Client)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a new <a href="../classes/CLIENT.html#">CLIENT</a> to participate within the mission.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">Client</span>
|
||||
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
||||
is the <a href="../classes/CLIENT.html#">CLIENT</a> object. The object must have been instantiated with <a href="../classes/CLIENT.html#CLIENT:New">CLIENT:New</a>.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
Add a number of Client objects to the Mission.
|
||||
Mission:AddClient( CLIENT:New( <span class="string">'US UH-1H*HOT-Deploy Troops 1'</span>, <span class="string">'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.'</span> ):Transport() )
|
||||
Mission:AddClient( CLIENT:New( <span class="string">'US UH-1H*RAMP-Deploy Troops 3'</span>, <span class="string">'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.'</span> ):Transport() )
|
||||
Mission:AddClient( CLIENT:New( <span class="string">'US UH-1H*HOT-Deploy Troops 2'</span>, <span class="string">'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.'</span> ):Transport() )
|
||||
Mission:AddClient( CLIENT:New( <span class="string">'US UH-1H*RAMP-Deploy Troops 4'</span>, <span class="string">'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.'</span> ):Transport() )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:FindClient"></a>
|
||||
<strong>MISSION:FindClient (ClientName)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Find a <a href="../classes/CLIENT.html#">CLIENT</a> object within the <a href="../classes/MISSION.html#">MISSION</a> by its ClientName.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">ClientName</span>
|
||||
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
||||
is a string defining the Client Group as defined within the ME.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Seach for Client "Bomber" within the Mission.
|
||||
</span> <span class="keyword">local</span> BomberClient = Mission:FindClient( <span class="string">"Bomber"</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:AddTask"></a>
|
||||
<strong>MISSION:AddTask (Task, TaskNumber)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a <a href="../classes/TASK.html#">TASK</a> to be completed within the <a href="../classes/MISSION.html#">MISSION</a>. Note that there can be multiple <a href="../classes/TASK.html#">TASK</a>s registered to be completed. Each TASK can be set a certain Goal. The MISSION will not be completed until all Goals are reached.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">Task</span>
|
||||
<span class="types"><a class="type" href="../classes/TASK.html#">TASK</a></span>
|
||||
is the <a href="../classes/TASK.html#">TASK</a> object. The object must have been instantiated with <a href="../classes/TASK.html#TASK:New">TASK:New</a> or any of its inherited <a href="../classes/TASK.html#">TASK</a>s.
|
||||
</li>
|
||||
<li><span class="parameter">TaskNumber</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is the sequence number of the TASK within the MISSION. This number does have to be chronological.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/TASK.html#">TASK</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Define a few tasks for the Mission.
|
||||
</span> PickupZones = { <span class="string">"NATO Gold Pickup Zone"</span>, <span class="string">"NATO Titan Pickup Zone"</span> }
|
||||
PickupSignalUnits = { <span class="string">"NATO Gold Coordination Center"</span>, <span class="string">"NATO Titan Coordination Center"</span> }
|
||||
|
||||
<span class="comment">-- Assign the Pickup Task
|
||||
</span> <span class="keyword">local</span> PickupTask = PICKUPTASK:New( PickupZones, CARGO_TYPE.ENGINEERS, CLIENT.ONBOARDSIDE.LEFT )
|
||||
PickupTask:AddSmokeBlue( PickupSignalUnits )
|
||||
PickupTask:SetGoalTotal( <span class="number">3</span> )
|
||||
Mission:AddTask( PickupTask, <span class="number">1</span> )
|
||||
|
||||
<span class="comment">-- Assign the Deploy Task
|
||||
</span> <span class="keyword">local</span> PatriotActivationZones = { <span class="string">"US Patriot Battery 1 Activation"</span>, <span class="string">"US Patriot Battery 2 Activation"</span>, <span class="string">"US Patriot Battery 3 Activation"</span> }
|
||||
<span class="keyword">local</span> PatriotActivationZonesSmokeUnits = { <span class="string">"US SAM Patriot - Battery 1 Control"</span>, <span class="string">"US SAM Patriot - Battery 2 Control"</span>, <span class="string">"US SAM Patriot - Battery 3 Control"</span> }
|
||||
<span class="keyword">local</span> DeployTask = DEPLOYTASK:New( PatriotActivationZones, CARGO_TYPE.ENGINEERS )
|
||||
<span class="comment">--DeployTask:SetCargoTargetZoneName( 'US Troops Attack ' .. math.random(2) )
|
||||
</span> DeployTask:AddSmokeBlue( PatriotActivationZonesSmokeUnits )
|
||||
DeployTask:SetGoalTotal( <span class="number">3</span> )
|
||||
DeployTask:SetGoalTotal( <span class="number">3</span>, <span class="string">"Patriots activated"</span> )
|
||||
Mission:AddTask( DeployTask, <span class="number">2</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:GetTask"></a>
|
||||
<strong>MISSION:GetTask (TaskNumber)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get the TASK idenified by the TaskNumber from the Mission. This function is useful in GoalFunctions.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">TaskNumber</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is the number of the <a href="../classes/TASK.html#">TASK</a> within the <a href="../classes/MISSION.html#">MISSION</a>.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/TASK.html#">TASK</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Get Task 2 from the Mission.
|
||||
</span> Task2 = Mission:GetTask( <span class="number">2</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSION:GetTasks"></a>
|
||||
<strong>MISSION:GetTasks ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get all the TASKs from the Mission. This function is useful in GoalFunctions.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/TASK.html#">{TASK,...}</a></span>
|
||||
Structure of TASKS with the <a href="../classes/TASK.html#">TASK</a> number as the key.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Get Tasks from the Mission.
|
||||
</span> Tasks = Mission:GetTasks()
|
||||
env.info( <span class="string">"Task 2 Completion = "</span> .. Tasks[<span class="number">2</span>]:GetGoalPercentage() .. <span class="string">"%"</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Class_MISSIONSCHEDULER"></a>Class MISSIONSCHEDULER </h2>
|
||||
|
||||
The MISSIONSCHEDULER is an OBJECT and is the main scheduler of ALL active MISSIONs registered within this scheduler. It's workings are considered internal and is automatically created when the Mission.lua file is included.
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "MISSIONSCHEDULER.Scheduler"></a>
|
||||
<strong>MISSIONSCHEDULER.Scheduler ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
This is the main MISSIONSCHEDULER Scheduler function. It is considered internal and is automatically created when the Mission.lua file is included.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSIONSCHEDULER.Start"></a>
|
||||
<strong>MISSIONSCHEDULER.Start ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Start the MISSIONSCHEDULER.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSIONSCHEDULER.Stop"></a>
|
||||
<strong>MISSIONSCHEDULER.Stop ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Stop the MISSIONSCHEDULER.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSIONSCHEDULER.AddMission"></a>
|
||||
<strong>MISSIONSCHEDULER.AddMission (Mission)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
This is the main MISSION declaration method. Each Mission is like the master or a Mission orchestration between, Clients, Tasks, Stages etc.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">Mission</span>
|
||||
is the MISSION object instantiated by <a href="../classes/MISSION.html#MISSION:New">MISSION:New</a>.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
MISSION
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Declare a mission.
|
||||
</span> Mission = MISSION:New( <span class="string">'Russia Transport Troops SA-6'</span>,
|
||||
<span class="string">'Operational'</span>,
|
||||
<span class="string">'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.'</span>,
|
||||
<span class="string">'Russia'</span> )
|
||||
MISSIONSCHEDULER:AddMission( Mission )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSIONSCHEDULER.RemoveMission"></a>
|
||||
<strong>MISSIONSCHEDULER.RemoveMission (MissionName)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Remove a MISSION from the MISSIONSCHEDULER.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">MissionName</span>
|
||||
is the name of the MISSION given at declaration using <a href="../classes/MISSION.html#MISSIONSCHEDULER.AddMission">AddMission</a>.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Declare a mission.
|
||||
</span> Mission = MISSION:New( <span class="string">'Russia Transport Troops SA-6'</span>,
|
||||
<span class="string">'Operational'</span>,
|
||||
<span class="string">'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.'</span>,
|
||||
<span class="string">'Russia'</span> )
|
||||
MISSIONSCHEDULER:AddMission( Mission )
|
||||
|
||||
<span class="comment">-- Now remove the Mission.
|
||||
</span> MISSIONSCHEDULER:RemoveMission( <span class="string">'Russia Transport Troops SA-6'</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSIONSCHEDULER.FindMission"></a>
|
||||
<strong>MISSIONSCHEDULER.FindMission (MissionName)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Find a MISSION within the MISSIONSCHEDULER.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">MissionName</span>
|
||||
is the name of the MISSION given at declaration using <a href="../classes/MISSION.html#MISSIONSCHEDULER.AddMission">AddMission</a>.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
MISSION
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Declare a mission.
|
||||
</span> Mission = MISSION:New( <span class="string">'Russia Transport Troops SA-6'</span>,
|
||||
<span class="string">'Operational'</span>,
|
||||
<span class="string">'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.'</span>,
|
||||
<span class="string">'Russia'</span> )
|
||||
MISSIONSCHEDULER:AddMission( Mission )
|
||||
|
||||
<span class="comment">-- Now find the Mission.
|
||||
</span> MissionFind = MISSIONSCHEDULER:FindMission( <span class="string">'Russia Transport Troops SA-6'</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSIONSCHEDULER.ReportMenu"></a>
|
||||
<strong>MISSIONSCHEDULER.ReportMenu ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Enables a MENU option in the communications menu under F10 to control the status of the active missions.
|
||||
This function should be called only once when starting the MISSIONSCHEDULER.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MISSIONSCHEDULER:TimeShow"></a>
|
||||
<strong>MISSIONSCHEDULER:TimeShow ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Show the remaining mission time.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
263
doc/classes/MOVEMENT.html
Normal file
263
doc/classes/MOVEMENT.html
Normal file
@ -0,0 +1,263 @@
|
||||
<!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><strong>MOVEMENT</strong></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>MOVEMENT</code></h1>
|
||||
<p>Limit the simultaneous movement of Groups within a running Mission.</p>
|
||||
<p> This module is defined to improve the performance in missions, and to bring additional realism for GROUND vehicles.
|
||||
Performance: If in a DCSRTE there are a lot of moving GROUND units, then in a multi player mission, this WILL create lag if
|
||||
the main DCS execution core of your CPU is fully utilized. So, this class will limit the amount of simultaneous moving GROUND units
|
||||
on defined intervals (currently every minute).</p>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MOVEMENT:New">MOVEMENT:New (MovePrefixes, MoveMaximum)</a></td>
|
||||
<td class="summary">Creates the main object which is handling the GROUND forces movement.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MOVEMENT:ScheduleStart">MOVEMENT:ScheduleStart ()</a></td>
|
||||
<td class="summary">Call this function to start the MOVEMENT scheduling.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MOVEMENT:ScheduleStop">MOVEMENT:ScheduleStop ()</a></td>
|
||||
<td class="summary">Call this function to stop the MOVEMENT scheduling.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MOVEMENT:OnBirth">MOVEMENT:OnBirth (event)</a></td>
|
||||
<td class="summary">Captures the birth events when new Units were spawned.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MOVEMENT:OnDeadOrCrash">MOVEMENT:OnDeadOrCrash (event)</a></td>
|
||||
<td class="summary">Captures the Dead or Crash events when Units crash or are destroyed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MOVEMENT:_Scheduler">MOVEMENT:_Scheduler ()</a></td>
|
||||
<td class="summary">This function is called automatically by the MOVEMENT scheduler.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "MOVEMENT:New"></a>
|
||||
<strong>MOVEMENT:New (MovePrefixes, MoveMaximum)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates the main object which is handling the GROUND forces movement.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">MovePrefixes</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>
|
||||
is a table of the Prefixes (names) of the GROUND Groups that need to be controlled by the MOVEMENT Object.
|
||||
</li>
|
||||
<li><span class="parameter">MoveMaximum</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is a number that defines the maximum amount of GROUND Units to be moving during one minute.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/MOVEMENT.html#">MOVEMENT</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- Limit the amount of simultaneous moving units on the ground to prevent lag.
|
||||
</span> Movement_US_Platoons = MOVEMENT:New( { <span class="string">'US Tank Platoon Left'</span>, <span class="string">'US Tank Platoon Middle'</span>, <span class="string">'US Tank Platoon Right'</span>, <span class="string">'US CH-47D Troops'</span> }, <span class="number">15</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MOVEMENT:ScheduleStart"></a>
|
||||
<strong>MOVEMENT:ScheduleStart ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Call this function to start the MOVEMENT scheduling.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MOVEMENT:ScheduleStop"></a>
|
||||
<strong>MOVEMENT:ScheduleStop ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Call this function to stop the MOVEMENT scheduling.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MOVEMENT:OnBirth"></a>
|
||||
<strong>MOVEMENT:OnBirth (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Captures the birth events when new Units were spawned.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MOVEMENT:OnDeadOrCrash"></a>
|
||||
<strong>MOVEMENT:OnDeadOrCrash (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Captures the Dead or Crash events when Units crash or are destroyed.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MOVEMENT:_Scheduler"></a>
|
||||
<strong>MOVEMENT:_Scheduler ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
This function is called automatically by the MOVEMENT scheduler. A new function is scheduled when MoveScheduled is true.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
163
doc/classes/NOTASK.html
Normal file
163
doc/classes/NOTASK.html
Normal file
@ -0,0 +1,163 @@
|
||||
<!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="#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><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><strong>NOTASK</strong></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>NOTASK</code></h1>
|
||||
<p>A NOTASK is a dummy activity...</p>
|
||||
<p> But it will show a Mission Briefing...</p>
|
||||
|
||||
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#NOTASK.NOTASK">NOTASK.NOTASK</a></td>
|
||||
<td class="summary">Modeling a sequence of STAGEs to do nothing, but wait for the mission goal.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#NOTASK:New">NOTASK:New ()</a></td>
|
||||
<td class="summary">Creates a new NOTASK.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "NOTASK.NOTASK"></a>
|
||||
<strong>NOTASK.NOTASK</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Modeling a sequence of STAGEs to do nothing, but wait for the mission goal.
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">ClassName</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "NOTASK:New"></a>
|
||||
<strong>NOTASK:New ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new NOTASK.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
146
doc/classes/PICKUPTASK.html
Normal file
146
doc/classes/PICKUPTASK.html
Normal file
@ -0,0 +1,146 @@
|
||||
<!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><strong>PICKUPTASK</strong></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>PICKUPTASK</code></h1>
|
||||
<p>A PICKUPTASK orchestrates the loading of CARGO at a specific landing zone.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#PICKUPTASK:New">PICKUPTASK:New (LandingZones, CargoType, OnBoardSide)</a></td>
|
||||
<td class="summary">Creates a new PICKUPTASK.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "PICKUPTASK:New"></a>
|
||||
<strong>PICKUPTASK:New (LandingZones, CargoType, OnBoardSide)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new PICKUPTASK.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">LandingZones</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>
|
||||
Table of Zone names where Cargo is to be loaded.
|
||||
</li>
|
||||
<li><span class="parameter">CargoType</span>
|
||||
<span class="types"><a class="type" href="../classes/CARGO.html#">CARGO_TYPE</a></span>
|
||||
Type of the Cargo. The type must be of the following Enumeration:..
|
||||
</li>
|
||||
<li><span class="parameter">OnBoardSide</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
Reflects from which side the cargo Group will be on-boarded on the Carrier.
|
||||
</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>
|
||||
189
doc/classes/ROUTETASK.html
Normal file
189
doc/classes/ROUTETASK.html
Normal file
@ -0,0 +1,189 @@
|
||||
<!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="#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><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><strong>ROUTETASK</strong></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>ROUTETASK</code></h1>
|
||||
<p>A ROUTETASK orchestrates the travel to a specific zone defined within the ME.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ROUTETASK.ROUTETASK">ROUTETASK.ROUTETASK</a></td>
|
||||
<td class="summary">Modeling a sequence of STAGEs to fly back to the home base specified by an Arrival Zone.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ROUTETASK:New">ROUTETASK:New (LandingZones, TaskBriefing)</a></td>
|
||||
<td class="summary">Creates a new ROUTETASK.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "ROUTETASK.ROUTETASK"></a>
|
||||
<strong>ROUTETASK.ROUTETASK</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Modeling a sequence of STAGEs to fly back to the home base specified by an Arrival Zone.
|
||||
|
||||
|
||||
<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 = "ROUTETASK:New"></a>
|
||||
<strong>ROUTETASK:New (LandingZones, TaskBriefing)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new ROUTETASK.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">LandingZones</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table{sring,...}</a> or <a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
Table of Zone Names where the target is located.
|
||||
</li>
|
||||
<li><span class="parameter">TaskBriefing</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
(optional) Defines a text describing the briefing of the task.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/ROUTETASK.html#">ROUTETASK</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
189
doc/classes/SEAD.html
Normal file
189
doc/classes/SEAD.html
Normal file
@ -0,0 +1,189 @@
|
||||
<!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><strong>SEAD</strong></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>SEAD</code></h1>
|
||||
<p>Provides defensive behaviour to a set of SAM sites within a running Mission.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<h3>Info:</h3>
|
||||
<ul>
|
||||
<li><strong>Author</strong>: to be searched on the forum,(co) Flightcontrol (Modified and enriched with functionality)</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SEAD:New">SEAD:New (SEADGroupPrefixes)</a></td>
|
||||
<td class="summary">Creates the main object which is handling defensive actions for SA sites or moving SA vehicles.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SEAD:EventShot">SEAD:EventShot (event)</a></td>
|
||||
<td class="summary">Detects if an SA site was shot with an anti radiation missile.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SEAD:New"></a>
|
||||
<strong>SEAD:New (SEADGroupPrefixes)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates the main object which is handling defensive actions for SA sites or moving SA vehicles.
|
||||
When an anti radiation missile is fired (KH-58, KH-31P, KH-31A, KH-25MPU, HARM missiles), the SA will shut down their radars and will take evasive actions...
|
||||
Chances are big that the missile will miss.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SEADGroupPrefixes</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 Prefixes of the SA Groups in the DCSRTE on which evasive actions need to be taken.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SEAD.html#">SEAD</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- CCCP SEAD Defenses
|
||||
</span> <span class="comment">-- Defends the Russian SA installations from SEAD attacks.
|
||||
</span> SEAD_RU_SAM_Defenses = SEAD:New( { <span class="string">'RU SA-6 Kub'</span>, <span class="string">'RU SA-6 Defenses'</span>, <span class="string">'RU MI-26 Troops'</span>, <span class="string">'RU Attack Gori'</span> } )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SEAD:EventShot"></a>
|
||||
<strong>SEAD: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/SEAD.html#">SEAD</a>
|
||||
</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>
|
||||
150
doc/classes/SLINGLOADHOOKTASK.html
Normal file
150
doc/classes/SLINGLOADHOOKTASK.html
Normal file
@ -0,0 +1,150 @@
|
||||
<!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><strong>SLINGLOADHOOKTASK</strong></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>SLINGLOADHOOKTASK</code></h1>
|
||||
<p>A SLINGLOADHOOKTASK will orchestrate the sling-load hook activity to slingload a CARGO from a specific landing zone(s).</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SLINGLOADHOOKTASK:New">SLINGLOADHOOKTASK:New (LandingZones, CargoPrefixes)</a></td>
|
||||
<td class="summary">Creates a new SLINGLOADHOOKTASK.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SLINGLOADHOOKTASK:New"></a>
|
||||
<strong>SLINGLOADHOOKTASK:New (LandingZones, CargoPrefixes)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new SLINGLOADHOOKTASK.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">LandingZones</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>
|
||||
Table or name of the zone(s) where Cargo is to be loaded.
|
||||
</li>
|
||||
<li><span class="parameter">CargoPrefixes</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>
|
||||
is the name or prefix of the name of the Cargo objects defined within the DCS ME.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SLINGLOADHOOKTASK.html#">SLINGLOADHOOKTASK</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
142
doc/classes/SLINGLOADUNHOOKTASK.html
Normal file
142
doc/classes/SLINGLOADUNHOOKTASK.html
Normal file
@ -0,0 +1,142 @@
|
||||
<!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><strong>SLINGLOADUNHOOKTASK</strong></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>SLINGLOADUNHOOKTASK</code></h1>
|
||||
<p>A SLINGLOADUNHOOKTASK will orchestrate the sling-load unhook activity to (sling)load a CARGO and deploy it in a specific landing zone(s).</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SLINGLOADUNHOOKTASK:New">SLINGLOADUNHOOKTASK:New (LandingZones, CargoPrefixes)</a></td>
|
||||
<td class="summary">Creates a new SLINGLOADUNHOOKTASK.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SLINGLOADUNHOOKTASK:New"></a>
|
||||
<strong>SLINGLOADUNHOOKTASK:New (LandingZones, CargoPrefixes)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new SLINGLOADUNHOOKTASK.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">LandingZones</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>
|
||||
Table or name of the zone(s) where Cargo is to be loaded.
|
||||
</li>
|
||||
<li><span class="parameter">CargoPrefixes</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>
|
||||
is the name or prefix of the name of the Cargo objects defined within the DCS ME.
|
||||
</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>
|
||||
995
doc/classes/SPAWN.html
Normal file
995
doc/classes/SPAWN.html
Normal file
@ -0,0 +1,995 @@
|
||||
<!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="#Private">Private </a></li>
|
||||
<li><a href="#Events">Events </a></li>
|
||||
<li><a href="#Scheduled">Scheduled </a></li>
|
||||
<li><a href="#Public">Public </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><strong>SPAWN</strong></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>SPAWN</code></h1>
|
||||
<p>Dynamic spawning of Groups and Units.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<h3>Info:</h3>
|
||||
<ul>
|
||||
<li><strong>Author</strong>: Flightcontrol</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Private">Private </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:_GetGroupCategoryID">SPAWN:_GetGroupCategoryID (SpawnPrefix)</a></td>
|
||||
<td class="summary">Gets the CategoryID of the Group with the given SpawnPrefix</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:_GetGroupCoalitionID">SPAWN:_GetGroupCoalitionID (SpawnPrefix)</a></td>
|
||||
<td class="summary">Gets the CoalitionID of the Group with the given SpawnPrefix</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:_GetGroupCountryID">SPAWN:_GetGroupCountryID (SpawnPrefix)</a></td>
|
||||
<td class="summary">Gets the CountryID of the Group with the given SpawnPrefix</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:_GetTemplate">SPAWN:_GetTemplate (SpawnPrefix)</a></td>
|
||||
<td class="summary">Gets the Group Template from the ME environment definition.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:_Prepare">SPAWN:_Prepare (SpawnIncrement)</a></td>
|
||||
<td class="summary">Prepares the new Group Template before Spawning.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:_RandomizeRoute">SPAWN:_RandomizeRoute (SpawnTemplate)</a></td>
|
||||
<td class="summary">Will randomize the route of the Group Template.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Events">Events </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:OnBirth">SPAWN:OnBirth (event)</a></td>
|
||||
<td class="summary">Obscolete</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:OnDeadOrCrash">SPAWN:OnDeadOrCrash (event)</a></td>
|
||||
<td class="summary">Obscolete</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:OnLand">SPAWN:OnLand (event)</a></td>
|
||||
<td class="summary">Will detect AIR Units landing...</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:OnTakeOff">SPAWN:OnTakeOff (event)</a></td>
|
||||
<td class="summary">Will detect AIR Units taking off...</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:OnEngineShutDown">SPAWN:OnEngineShutDown (event)</a></td>
|
||||
<td class="summary">Will detect AIR Units shutting down their engines ...</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Scheduled">Scheduled </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:_Scheduler">SPAWN:_Scheduler ()</a></td>
|
||||
<td class="summary">This function is called automatically by the Spawning scheduler.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Public">Public </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:New">SPAWN:New (SpawnPrefix)</a></td>
|
||||
<td class="summary">Creates the main object to spawn a Group defined in the DCS ME.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:RandomizeRoute">SPAWN:RandomizeRoute (SpawnStartPoint, SpawnEndPoint, SpawnRadius)</a></td>
|
||||
<td class="summary">Randomizes a defined route of the Template Group in the ME when the Group is Spawned.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:Schedule">SPAWN:Schedule (SpawnTime, SpawnTimeVariation)</a></td>
|
||||
<td class="summary">SPAWNs a new Group within varying time intervals.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:ScheduleStart">SPAWN:ScheduleStart ()</a></td>
|
||||
<td class="summary">Will start the SPAWNing timers.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:ScheduleStop">SPAWN:ScheduleStop ()</a></td>
|
||||
<td class="summary">Will stop the scheduled SPAWNing activity.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:Limit">SPAWN:Limit (SpawnMaxGroupsAlive, SpawnMaxGroups)</a></td>
|
||||
<td class="summary">Limits the Maximum amount of Units to be alive, and the maximum amount of Groups to be SPAWNed within the DCS World run-time environment.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:RandomizeTemplate">SPAWN:RandomizeTemplate (SpawnPrefixTable)</a></td>
|
||||
<td class="summary">This function is rather complicated to understand.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:Repeat">SPAWN:Repeat ()</a></td>
|
||||
<td class="summary">When a Group got SPAWNed, it has a life within the DCSRTE.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:RepeatOnLanding">SPAWN:RepeatOnLanding ()</a></td>
|
||||
<td class="summary">Same as the @{Repeat) method.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:RepeatOnEngineShutDown">SPAWN:RepeatOnEngineShutDown ()</a></td>
|
||||
<td class="summary">Same as the @{Repeat) method, but now the Group will respawn after its engines have shut down.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:Spawn">SPAWN:Spawn ()</a></td>
|
||||
<td class="summary">Will SPAWN a Group whenever you want to do this.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:ReSpawn">SPAWN:ReSpawn (SpawnGroupName)</a></td>
|
||||
<td class="summary">Will Re-SPAWN a Group based on a given GroupName.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:SpawnUncontrolled">SPAWN:SpawnUncontrolled ()</a></td>
|
||||
<td class="summary">Will SPAWN a Group whenever you want to do this, but for AIR Groups only to be applied, and will SPAWN the Group in Uncontrolled mode...</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:FromCarrier">SPAWN:FromCarrier (CarrierGroup, TargetZonePrefix, NewGroupName, LateActivate)</a></td>
|
||||
<td class="summary">Will SPAWN a Group from a Carrier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#SPAWN:InZone">SPAWN:InZone (ZonePrefix)</a></td>
|
||||
<td class="summary">Will SPAWN a Group within a given ZoneName.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Private"></a>Private </h2>
|
||||
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SPAWN:_GetGroupCategoryID"></a>
|
||||
<strong>SPAWN:_GetGroupCategoryID (SpawnPrefix)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the CategoryID of the Group with the given SpawnPrefix
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnPrefix</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:_GetGroupCoalitionID"></a>
|
||||
<strong>SPAWN:_GetGroupCoalitionID (SpawnPrefix)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the CoalitionID of the Group with the given SpawnPrefix
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnPrefix</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:_GetGroupCountryID"></a>
|
||||
<strong>SPAWN:_GetGroupCountryID (SpawnPrefix)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the CountryID of the Group with the given SpawnPrefix
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnPrefix</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:_GetTemplate"></a>
|
||||
<strong>SPAWN:_GetTemplate (SpawnPrefix)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the Group Template from the ME environment definition.
|
||||
This method used the <a href="../classes/DATABASE.html#">DATABASE</a> object, which contains ALL initial and new SPAWNed object in MOOSE.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnPrefix</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:_Prepare"></a>
|
||||
<strong>SPAWN:_Prepare (SpawnIncrement)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Prepares the new Group Template before Spawning.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnIncrement</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:_RandomizeRoute"></a>
|
||||
<strong>SPAWN:_RandomizeRoute (SpawnTemplate)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will randomize the route of the Group Template.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnTemplate</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Events"></a>Events </h2>
|
||||
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SPAWN:OnBirth"></a>
|
||||
<strong>SPAWN:OnBirth (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Obscolete
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:OnDeadOrCrash"></a>
|
||||
<strong>SPAWN:OnDeadOrCrash (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Obscolete
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:OnLand"></a>
|
||||
<strong>SPAWN:OnLand (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will detect AIR Units landing... When the event takes place, the SPAWNed Group is registered as landed.
|
||||
This is needed to ensure that Re-SPAWNing is only done for landed AIR Groups.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:OnTakeOff"></a>
|
||||
<strong>SPAWN:OnTakeOff (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will detect AIR Units taking off... When the event takes place, the SPAWNed Group is registered as airborne...
|
||||
This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:OnEngineShutDown"></a>
|
||||
<strong>SPAWN:OnEngineShutDown (event)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will detect AIR Units shutting down their engines ...
|
||||
When the event takes place, and the method <a href="../classes/SPAWN.html#SPAWN:RepeatOnEngineShutDown">RepeatOnEngineShutDown</a> was called, the SPAWNed Group will Re-SPAWN.
|
||||
But only when the Unit was registered to have landed.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h3>See also:</h3>
|
||||
<ul>
|
||||
<li><a href="../classes/SPAWN.html#SPAWN:OnTakeOff">OnTakeOff</a></li>
|
||||
<li><a href="../classes/SPAWN.html#SPAWN:OnLand">OnLand</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Scheduled"></a>Scheduled </h2>
|
||||
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SPAWN:_Scheduler"></a>
|
||||
<strong>SPAWN:_Scheduler ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
This function is called automatically by the Spawning scheduler.
|
||||
It is the internal worker method SPAWNing new Groups on the defined time intervals.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Public"></a>Public </h2>
|
||||
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SPAWN:New"></a>
|
||||
<strong>SPAWN:New (SpawnPrefix)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Creates the main object to spawn a Group defined in the DCS ME.
|
||||
Spawned Groups and Units will follow the following naming convention within the DCS World run-time environment:</p>
|
||||
<pre><code> Groups will have the name SpawnPrefix#ggg, where ggg is a counter from 0 to 999 for each new spawned Group.
|
||||
Units will have the name SpawnPrefix#ggg-uu, where uu is a counter from 0 to 99 for each new spawned Unit belonging to that Group.
|
||||
</code></pre>
|
||||
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnPrefix</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 Group in the ME that defines the Template. That Group must have the flag "Late Activation" set. Note that this SpawnPrefix name should not contain any # character.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SPAWN.html#">SPAWN</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- NATO helicopters engaging in the battle field.
|
||||
</span> Spawn_BE_KA50 = SPAWN:New( <span class="string">'BE KA-50@RAMP-Ground Defense'</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:RandomizeRoute"></a>
|
||||
<strong>SPAWN:RandomizeRoute (SpawnStartPoint, SpawnEndPoint, SpawnRadius)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Randomizes a defined route of the Template Group in the ME when the Group is Spawned. This is very useful to define extra variation in the DCS World run-time environment of the behaviour of Groups like Ground Units, Ships, Planes, Helicopters.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnStartPoint</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is the waypoint where the randomization begins. Note that the StartPoint = 0 equals the point where the Group is Spawned. This parameter is useful to avoid randomization to start from the first waypoint, but a bit further down the route...
|
||||
</li>
|
||||
<li><span class="parameter">SpawnEndPoint</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is the waypoint where the randomization ends. this parameter is useful to avoid randomization to end at a waypoint earlier than the last waypoint on the route.
|
||||
</li>
|
||||
<li><span class="parameter">SpawnRadius</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is the radius in meters, that defines the concentric circle in which the randomization of the new waypoint will take place, with the original waypoint located in the middle...
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SPAWN.html#">SPAWN</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- NATO helicopters engaging in the battle field.
|
||||
</span> <span class="comment">-- The KA-50 has waypoints SP, 1, 2, 3, 4, DP.
|
||||
</span> <span class="comment">-- Waypoints 2 and 3 will only be randomized. The others will remain on their original position with each new ${SPAWN} of the helicopter.
|
||||
</span> <span class="comment">-- The randomization of waypoint 2 and 3 will take place within a diameter of 4000 meters.
|
||||
</span> Spawn_BE_KA50 = SPAWN:New( <span class="string">'BE KA-50@RAMP-Ground Defense'</span> ):RandomizeRoute( <span class="number">2</span>, <span class="number">2</span>, <span class="number">2000</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:Schedule"></a>
|
||||
<strong>SPAWN:Schedule (SpawnTime, SpawnTimeVariation)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
SPAWNs a new Group within varying time intervals. This is useful if you want to have continuity within your missions of certain (AI) Groups to be present (alive) within your missions.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnTime</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is the time interval defined in seconds between each new SPAWN of new Groups.
|
||||
</li>
|
||||
<li><span class="parameter">SpawnTimeVariation</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is the variation to be applied on the defined time interval between each new SPAWN. The variation is defined as a value between 0 and 1, which expresses the %-tage of variation to be applied as the low and high time interval boundaries. Between these boundaries a new time interval will be applied. See usage.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SPAWN.html#">SPAWN</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- NATO helicopters engaging in the battle field.
|
||||
</span> <span class="comment">-- The time interval is set to SPAWN new helicopters between each 600 seconds, with a time variation of 50%.
|
||||
</span> <span class="comment">-- The time variation in this case will be between 450 seconds and 750 seconds.
|
||||
</span> <span class="comment">-- This is calculated as follows:
|
||||
</span> <span class="comment">-- Low limit: 600 * ( 1 - 0.5 / 2 ) = 450
|
||||
</span> <span class="comment">-- High limit: 600 * ( 1 + 0.5 / 2 ) = 750
|
||||
</span> <span class="comment">-- Between these two values, a random amount of seconds will be choosen for each new SPAWN of the helicopters.
|
||||
</span> Spawn_BE_KA50 = SPAWN:New( <span class="string">'BE KA-50@RAMP-Ground Defense'</span> ):Schedule( <span class="number">600</span>, <span class="number">0.5</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:ScheduleStart"></a>
|
||||
<strong>SPAWN:ScheduleStart ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will start the SPAWNing timers.
|
||||
This function is called automatically when <a href="../classes/SPAWN.html#SPAWN:Schedule">Schedule</a> is called.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:ScheduleStop"></a>
|
||||
<strong>SPAWN:ScheduleStop ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will stop the scheduled SPAWNing activity.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:Limit"></a>
|
||||
<strong>SPAWN:Limit (SpawnMaxGroupsAlive, SpawnMaxGroups)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Limits the Maximum amount of Units to be alive, and the maximum amount of Groups to be SPAWNed within the DCS World run-time environment.
|
||||
Note that this method is exceptionally important to balance the amount of Units alive within the DCSRTE and the performance of the mission. Depending on the machine etc, a mission can only process a maximum amount of units.
|
||||
If the time interval must be short, but there should not be more Units or Groups alive than a maximum amount of units, then this function should be used...
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnMaxGroupsAlive</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
is the Maximum amount of Units to be alive. When there are more Units alive in the DCSRTE of SpawnPrefix, then no new SPAWN will happen of the Group, until some of these Units will be destroyed.
|
||||
</li>
|
||||
<li><span class="parameter">SpawnMaxGroups</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
|
||||
<p> is the Maximum amount of Groups that can be SPAWNed from SpawnPrefix. When there are more Groups alive in the DCSRTE of SpawnPrefix, then no more SPAWNs will happen of the Group. This parameter is useful to define a maximum amount of airplanes, ground troops, helicopters, ships etc within a supply area. </p>
|
||||
<pre><code> This parameter accepts the value 0, which expresses no Group count limits.
|
||||
</code></pre>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SPAWN.html#">SPAWN</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- NATO helicopters engaging in the battle field.
|
||||
</span> <span class="comment">-- This helicopter group consists of one Unit. So, this group will SPAWN maximum 2 groups simultaneously within the DCSRTE.
|
||||
</span> <span class="comment">-- There will be maximum 24 groups SPAWNed during the whole mission lifetime.
|
||||
</span> Spawn_BE_KA50 = SPAWN:New( <span class="string">'BE KA-50@RAMP-Ground Defense'</span> ):Limit( <span class="number">2</span>, <span class="number">24</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:RandomizeTemplate"></a>
|
||||
<strong>SPAWN:RandomizeTemplate (SpawnPrefixTable)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
This function is rather complicated to understand. But I'll try to explain...
|
||||
This function becomes useful when you need to SPAWN random types of Groups defined within the ME, but they all need to follow the same Template route and have the same SpawnPrefix name, then this method becomes very useful.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnPrefixTable</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table{string,...}</a></span>
|
||||
is a table with the names of the Groups defined within the ME (with late activatio on), from which on a new SPAWN of SpawnPrefix (the main Group name), a NEW Group will be choosen as the Group to be SPAWNed.
|
||||
In other words, this method randomizes between a defined set of Groups the Group to be SPAWNed for each new SPAWN.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SPAWN.html#">SPAWN</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- NATO Tank Platoons invading Gori.
|
||||
</span> <span class="comment">-- Choose between 13 different 'US Tank Platoon' configurations for each new SPAWN the Group to be SPAWNed for the
|
||||
</span> <span class="comment">-- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SpawnPrefixes.
|
||||
</span> <span class="comment">-- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
|
||||
</span> <span class="comment">-- with a limit set of maximum 12 Units alive simulteneously and 150 Groups to be SPAWNed during the whole mission.
|
||||
</span> Spawn_US_Platoon = { <span class="string">'US Tank Platoon 1'</span>, <span class="string">'US Tank Platoon 2'</span>, <span class="string">'US Tank Platoon 3'</span>, <span class="string">'US Tank Platoon 4'</span>, <span class="string">'US Tank Platoon 5'</span>,
|
||||
<span class="string">'US Tank Platoon 6'</span>, <span class="string">'US Tank Platoon 7'</span>, <span class="string">'US Tank Platoon 8'</span>, <span class="string">'US Tank Platoon 9'</span>, <span class="string">'US Tank Platoon 10'</span>,
|
||||
<span class="string">'US Tank Platoon 11'</span>, <span class="string">'US Tank Platoon 12'</span>, <span class="string">'US Tank Platoon 13'</span> }
|
||||
Spawn_US_Platoon_Left = SPAWN:New( <span class="string">'US Tank Platoon Left'</span> ):Limit( <span class="number">12</span>, <span class="number">150</span> ):Schedule( <span class="number">200</span>, <span class="number">0.4</span> ):RandomizeTemplate( Spawn_US_Platoon ):RandomizeRoute( <span class="number">3</span>, <span class="number">3</span>, <span class="number">2000</span> )
|
||||
Spawn_US_Platoon_Middle = SPAWN:New( <span class="string">'US Tank Platoon Middle'</span> ):Limit( <span class="number">12</span>, <span class="number">150</span> ):Schedule( <span class="number">200</span>, <span class="number">0.4</span> ):RandomizeTemplate( Spawn_US_Platoon ):RandomizeRoute( <span class="number">3</span>, <span class="number">3</span>, <span class="number">2000</span> )
|
||||
Spawn_US_Platoon_Right = SPAWN:New( <span class="string">'US Tank Platoon Right'</span> ):Limit( <span class="number">12</span>, <span class="number">150</span> ):Schedule( <span class="number">200</span>, <span class="number">0.4</span> ):RandomizeTemplate( Spawn_US_Platoon ):RandomizeRoute( <span class="number">3</span>, <span class="number">3</span>, <span class="number">2000</span> )</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:Repeat"></a>
|
||||
<strong>SPAWN:Repeat ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
When a Group got SPAWNed, it has a life within the DCSRTE. For planes and helicopters, when these Units go home and land on their home airbases and farps, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the DCSRTE.
|
||||
This function is used to Re-Spawn automatically (so no extra call is needed anymore) the same Group after it landed. This will enable a SPAWNed group to be Re-SPAWNed after it lands, until it is destroyed...
|
||||
Note: When the Group is respawned, it will <a href="../classes/SPAWN.html#SPAWN:ReSpawn">ReSpawn</a> at the original airbase where it took off. So ensure that the paths for Groups that ReSpawn, always return to the orignal airbase.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SPAWN.html#">SPAWN</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">
|
||||
<span class="comment">-- RU Su-34 - AI Ship Attack
|
||||
</span> <span class="comment">-- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
|
||||
</span> SpawnRU_SU34 = SPAWN:New( <span class="string">'TF1 RU Su-34 Krymsk@AI - Attack Ships'</span> ):Schedule( <span class="number">2</span>, <span class="number">3</span>, <span class="number">1800</span>, <span class="number">0.4</span> ):SpawnUncontrolled():RandomizeRoute( <span class="number">1</span>, <span class="number">1</span>, <span class="number">3000</span> ):RepeatOnEngineShutDown()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:RepeatOnLanding"></a>
|
||||
<strong>SPAWN:RepeatOnLanding ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Same as the @{Repeat) method.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SPAWN.html#">SPAWN</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
<h3>See also:</h3>
|
||||
<ul>
|
||||
<a href="../classes/SPAWN.html#SPAWN:Repeat">Repeat</a>
|
||||
</ul>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:RepeatOnEngineShutDown"></a>
|
||||
<strong>SPAWN:RepeatOnEngineShutDown ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Same as the @{Repeat) method, but now the Group will respawn after its engines have shut down.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SPAWN.html#">SPAWN</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
<h3>See also:</h3>
|
||||
<ul>
|
||||
<a href="../classes/SPAWN.html#SPAWN:Repeat">Repeat</a>
|
||||
</ul>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:Spawn"></a>
|
||||
<strong>SPAWN:Spawn ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will SPAWN a Group whenever you want to do this.
|
||||
Note that the configuration with the above functions will apply when calling this method: Maxima, Randomization of routes, Scheduler, ...
|
||||
Uses <a href="../classes/DATABASE.html#">DATABASE</a> global object defined in MOOSE.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SPAWN.html#">SPAWN</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:ReSpawn"></a>
|
||||
<strong>SPAWN:ReSpawn (SpawnGroupName)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will Re-SPAWN a Group based on a given GroupName. The GroupName must be a group that is already alive within the DCSRTE and should have a Group Template defined in the ME (with Late Activation flag on).
|
||||
Note that the configuration with the above functions will apply when calling this method: Maxima, Randomization of routes, Scheduler, ...
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">SpawnGroupName</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SPAWN.html#">SPAWN</a></span>
|
||||
Uses _Database global object defined in MOOSE.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:SpawnUncontrolled"></a>
|
||||
<strong>SPAWN:SpawnUncontrolled ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will SPAWN a Group whenever you want to do this, but for AIR Groups only to be applied, and will SPAWN the Group in Uncontrolled mode... This will be similar to the Uncontrolled flag setting in the ME.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SPAWN.html#">SPAWN</a></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:FromCarrier"></a>
|
||||
<strong>SPAWN:FromCarrier (CarrierGroup, TargetZonePrefix, NewGroupName, LateActivate)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will SPAWN a Group from a Carrier. This function is mostly advisable to be used if you want to simulate SPAWNing from air units, like helicopters, which are dropping infantry into a defined Landing Zone.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">CarrierGroup</span>
|
||||
<span class="types"><span class="type">Group</span></span>
|
||||
is the Group of the AIR unit or GROUND unit dropping or unloading other units.
|
||||
</li>
|
||||
<li><span class="parameter">TargetZonePrefix</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
is the Prefix of the Zone defined in the ME where the Group should be moving to after drop.
|
||||
</li>
|
||||
<li><span class="parameter">NewGroupName</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
(forgot this).
|
||||
</li>
|
||||
<li><span class="parameter">LateActivate</span>
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
(optional) does the SPAWNing with Lateactivation on.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SPAWN:InZone"></a>
|
||||
<strong>SPAWN:InZone (ZonePrefix)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will SPAWN a Group within a given ZoneName.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">ZonePrefix</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 zone where the Group is to be SPAWNed.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">SpawnTemplate</span></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
104
doc/classes/STAGE.html
Normal file
104
doc/classes/STAGE.html
Normal file
@ -0,0 +1,104 @@
|
||||
<!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>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><strong>STAGE</strong></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>STAGE</code></h1>
|
||||
<p>Stages within a <a href="../classes/TASK.html#">TASK</a> within a <a href="../classes/MISSION.html#">MISSION</a>.</p>
|
||||
<p> All of the STAGE functionality is considered internally administered and not to be used by any Mission designer.</p>
|
||||
<h3>Info:</h3>
|
||||
<ul>
|
||||
<li><strong>Author</strong>: Flightcontrol</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
952
doc/classes/TASK.html
Normal file
952
doc/classes/TASK.html
Normal file
@ -0,0 +1,952 @@
|
||||
<!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>
|
||||
214
doc/index.html
Normal file
214
doc/index.html
Normal file
@ -0,0 +1,214 @@
|
||||
<!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>
|
||||
|
||||
|
||||
|
||||
|
||||
<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>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><a href="classes/TASK.html">TASK</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">
|
||||
|
||||
|
||||
<h2>Mission Object Oriented Scripting Environment</h2>
|
||||
<p>A Scripting Framework for DCS World, to script quickly missions.</p>
|
||||
|
||||
<h2>Modules</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/routines.html">routines</a></td>
|
||||
<td class="summary">Various routines</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/trace.html">trace</a></td>
|
||||
<td class="summary">Tracing functions...</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Scripts</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="scripts/eStatHandler.html">eStatHandler</a></td>
|
||||
<td class="summary">Provides a logging of statistics in a running DCS Mission.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Classes</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/BASE.html">BASE</a></td>
|
||||
<td class="summary">BASE The base class for all the classes defined within MOOSE.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/CARGO.html">CARGO</a></td>
|
||||
<td class="summary">CARGO</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/CLEANUP.html">CLEANUP</a></td>
|
||||
<td class="summary">CLEANUP Classes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/CLIENT.html">CLIENT</a></td>
|
||||
<td class="summary">CLIENT Classes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/DATABASE.html">DATABASE</a></td>
|
||||
<td class="summary">Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/DEPLOYTASK.html">DEPLOYTASK</a></td>
|
||||
<td class="summary">A DEPLOYTASK orchestrates the deployment of CARGO within a specific landing zone.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/DESTROYBASETASK.html">DESTROYBASETASK</a></td>
|
||||
<td class="summary">A DESTROYBASETASK will monitor the destruction of Groups and Units.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/DESTROYGROUPSTASK.html">DESTROYGROUPSTASK</a></td>
|
||||
<td class="summary">DESTROYGROUPSTASK</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/DESTROYRADARSTASK.html">DESTROYRADARSTASK</a></td>
|
||||
<td class="summary">Task class to destroy radar installations.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/DESTROYUNITTYPESTASK.html">DESTROYUNITTYPESTASK</a></td>
|
||||
<td class="summary">Set TASK to destroy certain unit types.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/GOHOMETASK.html">GOHOMETASK</a></td>
|
||||
<td class="summary">A GOHOMETASK orchestrates the travel back to the home base, which is a specific zone defined within the ME.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/MENU.html">MENU</a></td>
|
||||
<td class="summary">Encapsulation of DCS World Menu system in a set of MENU classes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/MESSAGE.html">MESSAGE</a></td>
|
||||
<td class="summary">Message System to display Messages for Clients and Coalitions or All.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/MISSION.html">MISSION</a></td>
|
||||
<td class="summary">A MISSION is the main owner of a Mission orchestration within MOOSE .</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/MOVEMENT.html">MOVEMENT</a></td>
|
||||
<td class="summary">Limit the simultaneous movement of Groups within a running Mission.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/NOTASK.html">NOTASK</a></td>
|
||||
<td class="summary">A NOTASK is a dummy activity...</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/PICKUPTASK.html">PICKUPTASK</a></td>
|
||||
<td class="summary">A PICKUPTASK orchestrates the loading of CARGO at a specific landing zone.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/ROUTETASK.html">ROUTETASK</a></td>
|
||||
<td class="summary">A ROUTETASK orchestrates the travel to a specific zone defined within the ME.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/SEAD.html">SEAD</a></td>
|
||||
<td class="summary">Provides defensive behaviour to a set of SAM sites within a running Mission.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/SLINGLOADHOOKTASK.html">SLINGLOADHOOKTASK</a></td>
|
||||
<td class="summary">A SLINGLOADHOOKTASK will orchestrate the sling-load hook activity to slingload a CARGO from a specific landing zone(s).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/SLINGLOADUNHOOKTASK.html">SLINGLOADUNHOOKTASK</a></td>
|
||||
<td class="summary">A SLINGLOADUNHOOKTASK will orchestrate the sling-load unhook activity to (sling)load a CARGO and deploy it in a specific landing zone(s).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/SPAWN.html">SPAWN</a></td>
|
||||
<td class="summary">Dynamic spawning of Groups and Units.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/STAGE.html">STAGE</a></td>
|
||||
<td class="summary">Stages within a <a href="classes/TASK.html#">TASK</a> within a <a href="classes/MISSION.html#">MISSION</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/TASK.html">TASK</a></td>
|
||||
<td class="summary">The TASK Classes define major end-to-end activities within a MISSION.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Topics</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="topics/manual.md.html">manual.md</a></td>
|
||||
<td class="summary"></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</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>
|
||||
307
doc/ldoc.css
Normal file
307
doc/ldoc.css
Normal file
@ -0,0 +1,307 @@
|
||||
/* BEGIN RESET
|
||||
|
||||
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
|
||||
Code licensed under the BSD License:
|
||||
http://developer.yahoo.com/yui/license.html
|
||||
version: 2.8.2r1
|
||||
*/
|
||||
html {
|
||||
color: #000;
|
||||
background: #FFF;
|
||||
}
|
||||
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
table {
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0;
|
||||
}
|
||||
fieldset,img {
|
||||
border: 0;
|
||||
}
|
||||
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
|
||||
font-style: inherit;
|
||||
font-weight: inherit;
|
||||
}
|
||||
del,ins {
|
||||
text-decoration: none;
|
||||
}
|
||||
li {
|
||||
list-style: disc;
|
||||
margin-left: 20px;
|
||||
}
|
||||
caption,th {
|
||||
text-align: left;
|
||||
}
|
||||
h1,h2,h3,h4,h5,h6 {
|
||||
font-size: 100%;
|
||||
font-weight: bold;
|
||||
}
|
||||
q:before,q:after {
|
||||
content: '';
|
||||
}
|
||||
abbr,acronym {
|
||||
border: 0;
|
||||
font-variant: normal;
|
||||
}
|
||||
sup {
|
||||
vertical-align: baseline;
|
||||
}
|
||||
sub {
|
||||
vertical-align: baseline;
|
||||
}
|
||||
legend {
|
||||
color: #000;
|
||||
}
|
||||
input,button,textarea,select,optgroup,option {
|
||||
font-family: inherit;
|
||||
font-size: inherit;
|
||||
font-style: inherit;
|
||||
font-weight: inherit;
|
||||
}
|
||||
input,button,textarea,select {*font-size:100%;
|
||||
}
|
||||
/* END RESET */
|
||||
|
||||
body {
|
||||
margin-left: 1em;
|
||||
margin-right: 1em;
|
||||
font-family: arial, helvetica, geneva, sans-serif;
|
||||
background-color: #ffffff; margin: 0px;
|
||||
}
|
||||
|
||||
code, tt { font-family: monospace; font-size: 1.1em; }
|
||||
span.parameter { font-family:monospace; }
|
||||
span.parameter:after { content:":"; }
|
||||
span.types:before { content:"("; }
|
||||
span.types:after { content:")"; }
|
||||
.type { font-weight: bold; font-style:italic }
|
||||
|
||||
body, p, td, th { font-size: .95em; line-height: 1.2em;}
|
||||
|
||||
p, ul { margin: 10px 0 0 0px;}
|
||||
|
||||
strong { font-weight: bold;}
|
||||
|
||||
em { font-style: italic;}
|
||||
|
||||
h1 {
|
||||
font-size: 1.5em;
|
||||
margin: 0 0 20px 0;
|
||||
}
|
||||
h2, h3, h4 { margin: 15px 0 10px 0; }
|
||||
h2 { font-size: 1.25em; }
|
||||
h3 { font-size: 1.15em; }
|
||||
h4 { font-size: 1.06em; }
|
||||
|
||||
a:link { font-weight: bold; color: #004080; text-decoration: none; }
|
||||
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
|
||||
a:link:hover { text-decoration: underline; }
|
||||
|
||||
hr {
|
||||
color:#cccccc;
|
||||
background: #00007f;
|
||||
height: 1px;
|
||||
}
|
||||
|
||||
blockquote { margin-left: 3em; }
|
||||
|
||||
ul { list-style-type: disc; }
|
||||
|
||||
p.name {
|
||||
font-family: "Andale Mono", monospace;
|
||||
padding-top: 1em;
|
||||
}
|
||||
|
||||
pre.example {
|
||||
background-color: rgb(245, 245, 245);
|
||||
border: 1px solid silver;
|
||||
padding: 10px;
|
||||
margin: 10px 0 10px 0;
|
||||
font-family: "Andale Mono", monospace;
|
||||
font-size: .85em;
|
||||
}
|
||||
|
||||
pre {
|
||||
background-color: rgb(245, 245, 245);
|
||||
border: 1px solid silver;
|
||||
padding: 10px;
|
||||
margin: 10px 0 10px 0;
|
||||
overflow: auto;
|
||||
font-family: "Andale Mono", monospace;
|
||||
}
|
||||
|
||||
|
||||
table.index { border: 1px #00007f; }
|
||||
table.index td { text-align: left; vertical-align: top; }
|
||||
|
||||
#container {
|
||||
margin-left: 1em;
|
||||
margin-right: 1em;
|
||||
background-color: #f0f0f0;
|
||||
}
|
||||
|
||||
#product {
|
||||
text-align: center;
|
||||
border-bottom: 1px solid #cccccc;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#product big {
|
||||
font-size: 2em;
|
||||
}
|
||||
|
||||
#main {
|
||||
background-color: #f0f0f0;
|
||||
border-left: 2px solid #cccccc;
|
||||
}
|
||||
|
||||
#navigation {
|
||||
float: left;
|
||||
width: 14em;
|
||||
vertical-align: top;
|
||||
background-color: #f0f0f0;
|
||||
overflow: visible;
|
||||
}
|
||||
|
||||
#navigation h2 {
|
||||
background-color:#e7e7e7;
|
||||
font-size:1.1em;
|
||||
color:#000000;
|
||||
text-align: left;
|
||||
padding:0.2em;
|
||||
border-top:1px solid #dddddd;
|
||||
border-bottom:1px solid #dddddd;
|
||||
}
|
||||
|
||||
#navigation ul
|
||||
{
|
||||
font-size:1em;
|
||||
list-style-type: none;
|
||||
margin: 1px 1px 10px 1px;
|
||||
}
|
||||
|
||||
#navigation li {
|
||||
text-indent: -1em;
|
||||
display: block;
|
||||
margin: 3px 0px 0px 22px;
|
||||
}
|
||||
|
||||
#navigation li li a {
|
||||
margin: 0px 3px 0px -1em;
|
||||
}
|
||||
|
||||
#content {
|
||||
margin-left: 14em;
|
||||
padding: 1em;
|
||||
width: 700px;
|
||||
border-left: 2px solid #cccccc;
|
||||
border-right: 2px solid #cccccc;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#about {
|
||||
clear: both;
|
||||
padding: 5px;
|
||||
border-top: 2px solid #cccccc;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
@media print {
|
||||
body {
|
||||
font: 12pt "Times New Roman", "TimeNR", Times, serif;
|
||||
}
|
||||
a { font-weight: bold; color: #004080; text-decoration: underline; }
|
||||
|
||||
#main {
|
||||
background-color: #ffffff;
|
||||
border-left: 0px;
|
||||
}
|
||||
|
||||
#container {
|
||||
margin-left: 2%;
|
||||
margin-right: 2%;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#content {
|
||||
padding: 1em;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#navigation {
|
||||
display: none;
|
||||
}
|
||||
pre.example {
|
||||
font-family: "Andale Mono", monospace;
|
||||
font-size: 10pt;
|
||||
page-break-inside: avoid;
|
||||
}
|
||||
}
|
||||
|
||||
table.module_list {
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.module_list td {
|
||||
border-width: 1px;
|
||||
padding: 3px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
}
|
||||
table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||
table.module_list td.summary { width: 100%; }
|
||||
|
||||
|
||||
table.function_list {
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.function_list td {
|
||||
border-width: 1px;
|
||||
padding: 3px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
}
|
||||
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||
table.function_list td.summary { width: 100%; }
|
||||
|
||||
ul.nowrap {
|
||||
overflow:auto;
|
||||
white-space:nowrap;
|
||||
}
|
||||
|
||||
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
|
||||
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
|
||||
dl.table h3, dl.function h3 {font-size: .95em;}
|
||||
|
||||
/* stop sublists from having initial vertical space */
|
||||
ul ul { margin-top: 0px; }
|
||||
ol ul { margin-top: 0px; }
|
||||
ol ol { margin-top: 0px; }
|
||||
ul ol { margin-top: 0px; }
|
||||
|
||||
/* make the target distinct; helps when we're navigating to a function */
|
||||
a:target + * {
|
||||
background-color: #FF9;
|
||||
}
|
||||
|
||||
/* styles for prettification of source */
|
||||
pre .comment { color: #558817; }
|
||||
pre .constant { color: #a8660d; }
|
||||
pre .escape { color: #844631; }
|
||||
pre .keyword { color: #aa5050; font-weight: bold; }
|
||||
pre .library { color: #0e7c6b; }
|
||||
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
|
||||
pre .string { color: #8080ff; }
|
||||
pre .number { color: #f8660d; }
|
||||
pre .operator { color: #2239a8; font-weight: bold; }
|
||||
pre .preprocessor, pre .prepro { color: #a33243; }
|
||||
pre .global { color: #800080; }
|
||||
pre .prompt { color: #558817; }
|
||||
pre .url { color: #272fc2; text-decoration: underline; }
|
||||
307
doc/modules/cleanup.html
Normal file
307
doc/modules/cleanup.html
Normal file
@ -0,0 +1,307 @@
|
||||
<!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="#Functions">Functions</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><strong>cleanup</strong></li>
|
||||
<li><a href="../modules/routines.html">routines</a></li>
|
||||
<li><a href="../modules/trace.html">trace</a></li>
|
||||
<li><a href="../modules/routines.html">routines</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../scripts/eStatHandler.html">eStatHandler</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/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>
|
||||
<li><a href="../classes/DATABASE.html">DATABASE</a></li>
|
||||
<li><a href="../classes/MESSAGE.html">MESSAGE</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>Module <code>cleanup</code></h1>
|
||||
<p>CLEANUP will keep (a) CleanUp Zone(s) clean.</p>
|
||||
<p> This class can be used to KEEP airbases or farps clean (note the word keep here, it cannot destroy units that are already dead).
|
||||
The CleanUp class works with 2 validation logic compontents:
|
||||
* EVENT validation: An event detection to intercept HIT events, upon which a validation of units CLEANUP CONDITIONS are applied. Once a unit is HIT, it is registered in a TIMED validation logic.
|
||||
* TIMED validation: Units registered in a TIMED validation, are repeatedly validated of certain CLEANUP CONDITIONS.
|
||||
If the CLEANUP CONDITIONS apply, the unit will be destroyed, and the group will be destroyed.
|
||||
* It does not clean the zone, it tries to keep it clean by destroying units or groups before they explode or crash into the ground.
|
||||
* For airplanes or helicopters, when in the CleanUpZone:
|
||||
** When the unit is airborne, and it is HIT ( by a weapon or a crash of another unit ), CLEANUP will destroy the unit or group when the health of the unit reaches an AIRBORNE HEALTH LIMIT. </p>
|
||||
|
||||
<pre>
|
||||
When the unit is HIT, it will register the unit <span class="keyword">for</span> further repeated health monitoring, <span class="keyword">until</span>:
|
||||
</pre>
|
||||
|
||||
<p> <strong>* the unit's health is beyond the an AIRBORNE HEALTH LIMIT
|
||||
*</strong> until the height of the unit is below the safety zone to prevent it from crashing.
|
||||
<em>* When the unit is not airborne, and it is HIT, it will be registered
|
||||
*</em> When the unit is </p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</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:_ExecuteDeadEvents">CLEANUP:_ExecuteDeadEvents (CleanUpUnit)</a></td>
|
||||
<td class="summary">This function is required, and used a non-documented feature.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLEANUP:_CheckLife">CLEANUP:_CheckLife (the)</a></td>
|
||||
<td class="summary">Measures the life of a Unit using the LifeLimit treshold.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CLEANUP:_CleanUnit">CLEANUP:_CleanUnit (CleanUpUnit)</a></td>
|
||||
<td class="summary">Cleans a Group from the DCSRTE.</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="Functions"></a>Functions</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"><span class="type">CLEANUP</span></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:_ExecuteDeadEvents"></a>
|
||||
<strong>CLEANUP:_ExecuteDeadEvents (CleanUpUnit)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
This function is required, and used a non-documented feature. The function world.onEvent will loop through all registered event handlers with the event structure given.
|
||||
This is required to be done because the method Group.destroy(Group) does not generate the S<em>EVENT</em>DEAD through all the registered event handlers.
|
||||
As such, the other classes using the S<em>EVENT</em>DEAD will get confused if this event is not catched properly...
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">CleanUpUnit</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLEANUP:_CheckLife"></a>
|
||||
<strong>CLEANUP:_CheckLife (the)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Measures the life of a Unit using the LifeLimit treshold. Returns true if Group has a life lower than the treshold, false if the life is still okay.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">the</span>
|
||||
<span class="types"><span class="type">Group</span></span>
|
||||
Group to be cleaned.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">bool</span></span>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CLEANUP:_CleanUnit"></a>
|
||||
<strong>CLEANUP:_CleanUnit (CleanUpUnit)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Cleans a Group from the DCSRTE.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">CleanUpUnit</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</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-02-11 11:12:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
210
doc/modules/routines.html
Normal file
210
doc/modules/routines.html
Normal file
@ -0,0 +1,210 @@
|
||||
<!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="#Functions">Functions</a></li>
|
||||
<li><a href="#Tables">Tables</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><strong>routines</strong></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>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><a href="../classes/TASK.html">TASK</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>Module <code>routines</code></h1>
|
||||
<p>Various routines</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<h3>Info:</h3>
|
||||
<ul>
|
||||
<li><strong>Author</strong>: Flightcontrol</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#do_scheduled_functions">do_scheduled_functions ()</a></td>
|
||||
<td class="summary">not intended for users to use this function.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ChooseInfantry">ChooseInfantry (TeleportPrefixTable, TeleportMax)</a></td>
|
||||
<td class="summary">Obsolete function, but kept to rework in framework.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#routines">routines</a></td>
|
||||
<td class="summary">Extract of MIST functions.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#utils">utils</a></td>
|
||||
<td class="summary">Utils- conversion, Lua utils, etc.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "do_scheduled_functions"></a>
|
||||
<strong>do_scheduled_functions ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
not intended for users to use this function.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ChooseInfantry"></a>
|
||||
<strong>ChooseInfantry (TeleportPrefixTable, TeleportMax)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Obsolete function, but kept to rework in framework.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">TeleportPrefixTable</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">TeleportMax</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "routines"></a>
|
||||
<strong>routines</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Extract of MIST functions.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "utils"></a>
|
||||
<strong>utils</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Utils- conversion, Lua utils, etc.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
106
doc/modules/trace.html
Normal file
106
doc/modules/trace.html
Normal file
@ -0,0 +1,106 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/routines.html">routines</a></li>
|
||||
<li><strong>trace</strong></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../scripts/eStatHandler.html">eStatHandler</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><a href="../classes/TASK.html">TASK</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>Module <code>trace</code></h1>
|
||||
<p>Tracing functions...</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<h3>Info:</h3>
|
||||
<ul>
|
||||
<li><strong>Author</strong>: Flightcontrol</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
102
doc/scripts/eStatHandler.html
Normal file
102
doc/scripts/eStatHandler.html
Normal file
@ -0,0 +1,102 @@
|
||||
<!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>Scripts</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><strong>eStatHandler</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>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><a href="../classes/TASK.html">TASK</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>Script <code>eStatHandler</code></h1>
|
||||
<p>Provides a logging of statistics in a running DCS Mission.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
178
doc/topics/manual.md.html
Normal file
178
doc/topics/manual.md.html
Normal file
@ -0,0 +1,178 @@
|
||||
<!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="#Context">Context </a></li>
|
||||
<li><a href="#Currently_supported_functions">Currently supported functions </a></li>
|
||||
<li><a href="#Installation">Installation </a></li>
|
||||
<li><a href="#What_has_changed_">What has changed? </a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Topics</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><strong>manual</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>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><a href="../classes/TASK.html">TASK</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
|
||||
<h1>MOOSE Framework for Eagle Dynamics <a href="https://www.digitalcombatsimulator.com">DCS World</a></h1>
|
||||
|
||||
<p><a name="Context"></a></p>
|
||||
<h2>Context</h2>
|
||||
<p><strong>MOOSE</strong> is a <strong>M</strong>ission <strong>O</strong>bject <strong>O</strong>riented <strong>S</strong>cripting <strong>E</strong>nvironment, and is meant for mission designers and mission hosters.
|
||||
It allows (will allow) to quickly setup complex missions using pre-scripted scenarios.
|
||||
In order to run missions using this framework, you will need to install the framework within your Eagle Dynamics program files folder.</p>
|
||||
|
||||
<p>The goal of MOOSE is to allow mission designers to enhance their scripting with mission orchestration objects, which can be instantiated from defined classes within the framework.
|
||||
This will allow to write mission scripts with minimal code embedded. Of course, the richness of the framework will determine the richness of the misson scenarios.
|
||||
We can expect that MOOSE will evolve over time, as more missions will be designed within the framework.</p>
|
||||
|
||||
<p><a name="Currently_supported_functions"></a></p>
|
||||
<h2>Currently supported functions</h2>
|
||||
<p>MOOSE contains currently the following mission design functions. The words in CAPITAL letters document the classes that can be used within MOOSE to accomplish these functions.</p>
|
||||
|
||||
<ol>
|
||||
<li><a href="../classes/SPAWN.html#">SPAWN</a> Dynamic spawning and respawning of Groups with related functions.</li>
|
||||
<li><a href="../classes/MOVEMENT.html#">MOVEMENT</a> Keeps control over the amount of units driving around the battlefield simultaneously.</li>
|
||||
<li><a href="../classes/CLEANUP.html#">CLEANUP</a> Clean-Up zones with air units that crashed. Can be used to prevent airports blocking air traffic and ground control operations due to crashed units near the airfield.</li>
|
||||
<li><a href="../classes/SEAD.html#">SEAD</a> Enables the defenses for SAM sites. Mobile SAMs will evade fired anti-radiation missiles by shutting down their radars (for a while). If they are mobile, they will also drive away.</li>
|
||||
<li><a href="../classes/MISSION.html#">MISSION</a> Create Taskforces or Missions within a DCS Mission. A mission will consist of <a href="../classes/TASK.html#">TASK</a>s, and <a href="../classes/CLIENT.html#">CLIENT</a>s.</li>
|
||||
<li><a href="../classes/TASK.html#">TASK</a> Add tasks for the mission. There are many different tasks that can be given, by using the classes derived from TASK.</li>
|
||||
<li><a href="../classes/DEPLOYTASK.html#">DEPLOYTASK</a> Deploy Cargo within a zone.</li>
|
||||
<li><a href="../classes/PICKUPTASK.html#">PICKUPTASK</a> Pick-Up Cargo from a zone.</li>
|
||||
<li><a href="../classes/GOHOMETASK.html#">GOHOMETASK</a> Fly back home.</li>
|
||||
<li><a href="../classes/DESTROYGROUPSTASK.html#">DESTROYGROUPSTASK</a> Destroy Groups.</li>
|
||||
<li><a href="../classes/DESTROYUNITTYPESTASK.html#">DESTROYUNITTYPESTASK</a> Destroy Units by measuring their UNIT Type.</li>
|
||||
<li><a href="../classes/DESTROYRADARSTASK.html#">DESTROYRADARSTASK</a> Destroy Radars of SAM Groups.</li>
|
||||
<li><a href="../classes/SLINGLOADHOOKTASK.html#">SLINGLOADHOOKTASK</a> Hook-Up Cargo within a zone and sling-load it outside of the zone.</li>
|
||||
<li><a href="../classes/SLINGLOADUNHOOKTASK.html#">SLINGLOADUNHOOKTASK</a> Sling-load Cargo to a zone and Un-Hook the Cargo within the zone.</li>
|
||||
<li><a href="../classes/CLIENT.html#">CLIENT</a> Registers a client within MOOSE.</li>
|
||||
<li><a href="../classes/MESSAGE.html#">MESSAGE</a> Send messages to <a href="../classes/CLIENT.html#">CLIENT</a>s.</li>
|
||||
<li><a href="../classes/MENU.html#">MENU</a> Menu System.</li>
|
||||
</ol>
|
||||
|
||||
<p><a name="Installation"></a></p>
|
||||
<h2>Installation</h2>
|
||||
<p>The installation of the MOOSE framework is straightforward.</p>
|
||||
|
||||
<ol>
|
||||
<li><p>Extract MOOSE.zip. You can do this quickly by right clicking the MOOSE.zip file, and select "Extract All".</p></li>
|
||||
<li><p>The extraction will add a directory within the Scripts directory of the Eagle Dynamics DCS world installation.
|
||||
Example, the Scripts directory of my DCS World installation folder is C:\Program Files\Eagle Dynamics\DCS World\Scripts</p></li>
|
||||
<li><p>Browse within the new MOOSE directory to the DCS_Script directory and run Install.bat as an administrator.
|
||||
This will make a backup of the missionScripting.lua file and replace this with a new one.</p></li>
|
||||
</ol>
|
||||
|
||||
<p>And you're done.</p>
|
||||
|
||||
<p><a name="What_has_changed_"></a></p>
|
||||
<h2>What has changed?</h2>
|
||||
|
||||
<p>Not much. The missionscripting.lua file has been enhanced with the following code:</p>
|
||||
|
||||
<hr/>
|
||||
|
||||
<pre>
|
||||
Include = {}
|
||||
|
||||
Include.LoadPath = <span class="string">'Scripts/MOOSE'</span>
|
||||
Include.Files = {}
|
||||
|
||||
Include.File = <span class="keyword">function</span>( IncludeFile )
|
||||
<span class="keyword">if</span> <span class="keyword">not</span> Include.Files[ IncludeFile ] <span class="keyword">then</span>
|
||||
Include.Files[IncludeFile] = IncludeFile
|
||||
<span class="global">dofile</span>( Include.LoadPath .. <span class="string">"/"</span> .. IncludeFile .. <span class="string">".lua"</span> )
|
||||
env.info( <span class="string">"Include:"</span> .. IncludeFile .. <span class="string">" loaded."</span> )
|
||||
<span class="keyword">end</span>
|
||||
<span class="keyword">end</span>
|
||||
|
||||
Include.File( <span class="string">"Database"</span> )
|
||||
Include.File( <span class="string">"StatHandler"</span> )
|
||||
</pre>
|
||||
|
||||
<hr/>
|
||||
|
||||
<p>This code allows for the inclusion of the MOOSE framework, and this now becomes part of your DCS World Simulation Engine.
|
||||
Missions designed with the MOOSE framework will now run.</p>
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
Loading…
x
Reference in New Issue
Block a user