FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

ESCORT Updated

Browse Source
This commit is contained in:
FlightControl
2016-06-14 15:04:08 +02:00
parent 29652a0edb
commit 8de64bc95a
77 changed files with 2002 additions and 330 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
Moose Training/Documentation/Escort.html
View File

@@ -17,6 +17,7 @@
<a href="index.html">index</a>
</li></ul>
<ul>
<li><a href="AIBalancer.html">AIBalancer</a></li>
<li><a href="Airbase.html">Airbase</a></li>
<li><a href="Base.html">Base</a></li>
<li><a href="CARGO.html">CARGO</a></li>
@@ -175,6 +176,20 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
</ul>
<h2>Usage:</h2>
<pre class="example"><code>-- Declare a new EscortPlanes object as follows:
-- First find the GROUP object and the CLIENT object.
local EscortClient = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.
-- Now use these 2 objects to construct the new EscortPlanes object.
EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )
</code></pre>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
@@ -430,12 +445,18 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortName">ESCORT.EscortName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ESCORT).FollowDistance">ESCORT.FollowDistance</a></td>
<td class="summary">
<p>The current follow distance.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ESCORT).FollowScheduler">ESCORT.FollowScheduler</a></td>
<td class="summary">
<p>The id of the _FollowScheduler function.</p>
<p>The instance of the SCHEDULER class.</p>
</td>
</tr>
<tr>
@@ -589,7 +610,7 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._FollowScheduler">ESCORT:_FollowScheduler(FollowDistance)</a></td>
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._FollowScheduler">ESCORT:_FollowScheduler()</a></td>
<td class="summary">
</td>
@@ -1322,13 +1343,27 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
<dt>
<em>#number</em>
<a id="#(ESCORT).FollowDistance" >
<strong>ESCORT.FollowDistance</strong>
</a>
</dt>
<dd>
<p>The current follow distance.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Scheduler.html##(SCHEDULER)">Scheduler#SCHEDULER</a></em>
<a id="#(ESCORT).FollowScheduler" >
<strong>ESCORT.FollowScheduler</strong>
</a>
</dt>
<dd>
<p>The id of the _FollowScheduler function.</p>
<p>The instance of the SCHEDULER class.</p>
</dd>
</dl>
@@ -1788,6 +1823,16 @@ Name of the escort.</p>
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em>
self</p>
<h3>Usage:</h3>
<pre class="example"><code>-- Declare a new EscortPlanes object as follows:
-- First find the GROUP object and the CLIENT object.
local EscortClient = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.
-- Now use these 2 objects to construct the new EscortPlanes object.
EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )</code></pre>
</dd>
</dl>
<dl class="function">
@@ -1962,21 +2007,13 @@ self</p>
<dt>
<a id="#(ESCORT)._FollowScheduler" >
<strong>ESCORT:_FollowScheduler(FollowDistance)</strong>
<strong>ESCORT:_FollowScheduler()</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> FollowDistance </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">