mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
264 lines
7.4 KiB
HTML
264 lines
7.4 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
<head>
|
|
<title>MOOSE</title>
|
|
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
|
</head>
|
|
<body>
|
|
|
|
<div id="container">
|
|
|
|
<div id="product">
|
|
<div id="product_logo"></div>
|
|
<div id="product_name"><big><b></b></big></div>
|
|
<div id="product_description"></div>
|
|
</div> <!-- id="product" -->
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
<!-- Menu -->
|
|
|
|
<div id="navigation">
|
|
<br/>
|
|
<h1>MOOSE</h1>
|
|
|
|
<ul>
|
|
<li><a href="../index.html">Index</a></li>
|
|
</ul>
|
|
|
|
<h2>Contents</h2>
|
|
<ul>
|
|
<li><a href="#Methods">Methods</a></li>
|
|
</ul>
|
|
|
|
|
|
<h2>Classes</h2>
|
|
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
|
<li><a href="../classes/BASE.html">BASE</a></li>
|
|
<li><a href="../classes/CARGO.html">CARGO</a></li>
|
|
<li><a href="../classes/CLEANUP.html">CLEANUP</a></li>
|
|
<li><a href="../classes/CLIENT.html">CLIENT</a></li>
|
|
<li><a href="../classes/DATABASE.html">DATABASE</a></li>
|
|
<li><a href="../classes/DEPLOYTASK.html">DEPLOYTASK</a></li>
|
|
<li><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>
|