This commit is contained in:
FlightControl
2017-02-14 08:49:59 +01:00
parent a47195198e
commit 62b668029b
115 changed files with 28580 additions and 2880 deletions

View File

@@ -39,11 +39,11 @@
<li><a href="Fsm.html">Fsm</a></li>
<li><a href="Group.html">Group</a></li>
<li><a href="Identifiable.html">Identifiable</a></li>
<li>MOVEMENT</li>
<li><a href="Menu.html">Menu</a></li>
<li><a href="Message.html">Message</a></li>
<li><a href="MissileTrainer.html">MissileTrainer</a></li>
<li><a href="Mission.html">Mission</a></li>
<li>Movement</li>
<li><a href="Object.html">Object</a></li>
<li><a href="Point.html">Point</a></li>
<li><a href="Positionable.html">Positionable</a></li>
@@ -69,7 +69,7 @@
</ul>
</div>
<div id="content">
<h1>Module <code>MOVEMENT</code></h1>
<h1>Module <code>Movement</code></h1>
<p>Limit the simultaneous movement of Groups within a running Mission.</p>
@@ -88,30 +88,60 @@ on defined intervals (currently every minute).</p>
</td>
</tr>
</table>
<h2><a id="#(MOVEMENT)" >Type <code>MOVEMENT</code></a></h2>
<table class="function_list">
<h2><a id="#(MOVEMENT)">Type <code>MOVEMENT</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(MOVEMENT).AliveUnits">MOVEMENT.AliveUnits</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MOVEMENT).ClassName">MOVEMENT.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MOVEMENT).MoveCount">MOVEMENT.MoveCount</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MOVEMENT).MoveMaximum">MOVEMENT.MoveMaximum</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MOVEMENT).MovePrefixes">MOVEMENT.MovePrefixes</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MOVEMENT).MoveUnits">MOVEMENT.MoveUnits</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MOVEMENT).New">MOVEMENT:New(MovePrefixes, MoveMaximum)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MOVEMENT).OnBirth">MOVEMENT:OnBirth(Event)</a></td>
<td class="summary">
<p>Captures the birth events when new Units were spawned.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MOVEMENT).OnDeadOrCrash">MOVEMENT:OnDeadOrCrash(Event)</a></td>
<td class="summary">
<p>Captures the Dead or Crash events when Units crash or are destroyed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MOVEMENT).OnEventBirth">MOVEMENT:OnEventBirth(self, EventData)</a></td>
<td class="summary">
<p>Captures the birth events when new Units were spawned.</p>
</td>
</tr>
<tr>
@@ -149,8 +179,30 @@ on defined intervals (currently every minute).</p>
</dd>
</dl>
<h2><a id="#(MOVEMENT)" >Type <code>MOVEMENT</code></a></h2>
<h3>Field(s)</h3>
<h2><a id="#(Movement)" >Type <code>Movement</code></a></h2>
<h2><a id="#(MOVEMENT)" >Type <code>MOVEMENT</code></a></h2>
<p>the MOVEMENT class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MOVEMENT).AliveUnits" >
<strong>MOVEMENT.AliveUnits</strong>
</a>
</dt>
<dd>
<p> Contains the counter how many units are currently alive</p>
</dd>
</dl>
<dl class="function">
<dt>
@@ -163,6 +215,71 @@ on defined intervals (currently every minute).</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MOVEMENT).MoveCount" >
<strong>MOVEMENT.MoveCount</strong>
</a>
</dt>
<dd>
<p> The internal counter of the amount of Moveing the has happened since MoveStart.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(MOVEMENT).MoveMaximum" >
<strong>MOVEMENT.MoveMaximum</strong>
</a>
</dt>
<dd>
<p> Contains the Maximum amount of units that are allowed to move...</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(MOVEMENT).MovePrefixes" >
<strong>MOVEMENT.MovePrefixes</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(MOVEMENT).MoveUnits" >
<strong>MOVEMENT.MoveUnits</strong>
</a>
</dt>
<dd>
<p> Reflects if the Moving for this MovePrefixes is going to be scheduled or not.</p>
</dd>
</dl>
<dl class="function">
@@ -194,13 +311,13 @@ on defined intervals (currently every minute).</p>
<dl class="function">
<dt>
<a id="#(MOVEMENT).OnBirth" >
<strong>MOVEMENT:OnBirth(Event)</strong>
<a id="#(MOVEMENT).OnDeadOrCrash" >
<strong>MOVEMENT:OnDeadOrCrash(Event)</strong>
</a>
</dt>
<dd>
<p>Captures the birth events when new Units were spawned.</p>
<p>Captures the Dead or Crash events when Units crash or are destroyed.</p>
<h3>Parameter</h3>
<ul>
@@ -215,19 +332,24 @@ on defined intervals (currently every minute).</p>
<dl class="function">
<dt>
<a id="#(MOVEMENT).OnDeadOrCrash" >
<strong>MOVEMENT:OnDeadOrCrash(Event)</strong>
<a id="#(MOVEMENT).OnEventBirth" >
<strong>MOVEMENT:OnEventBirth(self, EventData)</strong>
</a>
</dt>
<dd>
<p>Captures the Dead or Crash events when Units crash or are destroyed.</p>
<p>Captures the birth events when new Units were spawned.</p>
<h3>Parameter</h3>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> Event </em></code>: </p>
<p><code><em><a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a> self </em></code>: </p>
</li>
<li>
<p><code><em> EventData </em></code>: </p>
</li>
</ul>