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

Documentation

Browse Source
This commit is contained in:
FlightControl_Master 2017-08-05 15:14:11 +02:00
parent b88c84fc3b
commit 53845448b0
10 changed files with 134 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/Documentation/AI_A2A.html
View File

@ -661,7 +661,6 @@
<dl class="function">
<dt>
<em>#number</em>
<a id="#(AI_A2A).IdleCount" >
<strong>AI_A2A.IdleCount</strong>
</a>

111
docs/Documentation/AI_A2A_Dispatcher.html
View File

@ -698,6 +698,12 @@ Per one, two, three, four?</p>
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).SetDefaultTakeoffInAir">AI_A2A_DISPATCHER:SetDefaultTakeoffInAir()</a></td>
<td class="summary">
<p>Sets flights to default take-off in the air, as part of the defense system.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).SetDefaultTakeoffInAirAltitude">AI_A2A_DISPATCHER:SetDefaultTakeoffInAirAltitude(TakeoffAltitude)</a></td>
<td class="summary">
<p>Defines the default altitude where airplanes will spawn in the air and take-off as part of the defense system, when the take-off in the air method has been selected.</p>
</td>
</tr>
<tr>
@ -833,9 +839,15 @@ Per one, two, three, four?</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).SetSquadronTakeoffInAir">AI_A2A_DISPATCHER:SetSquadronTakeoffInAir(SquadronName)</a></td>
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).SetSquadronTakeoffInAir">AI_A2A_DISPATCHER:SetSquadronTakeoffInAir(SquadronName, TakeoffAltitude)</a></td>
<td class="summary">
<p>Sets flights to take-off in the air, as part of the defense system.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).SetSquadronTakeoffInAirAltitude">AI_A2A_DISPATCHER:SetSquadronTakeoffInAirAltitude(SquadronName, TakeoffAltitude)</a></td>
<td class="summary">
<p>Defines the default altitude where airplanes will spawn in the air and take-off as part of the defense system, when the take-off in the air method has been selected.</p>
</td>
</tr>
<tr>
@ -1217,6 +1229,15 @@ And for a couple of squadrons overrides this default method.</p>
</code></pre>
<h4>6.1.1. Takeoff Altitude when spawning new aircraft in the air.</h4>
<p>In the case of the <a href="##(AI_A2A_DISPATCHER).SetSquadronTakeoffInAir">AI<em>A2A</em>DISPATCHER.SetSquadronTakeoffInAir</a>() there is also an other parameter that can be applied.
That is modifying or setting the <strong>altitude</strong> from where planes spawn in the air.
Use the method <a href="##(AI_A2A_DISPATCHER).SetSquadronTakeoffInAirAltitude">AI<em>A2A</em>DISPATCHER.SetSquadronTakeoffInAirAltitude</a>() to set the altitude for a specific squadron.
The default takeoff altitude can be modified or set using the method <a href="##(AI_A2A_DISPATCHER).SetSquadronTakeoffInAirAltitude">AI<em>A2A</em>DISPATCHER.SetSquadronTakeoffInAirAltitude</a>().
As part of the method <a href="##(AI_A2A_DISPATCHER).SetSquadronTakeoffInAir">AI<em>A2A</em>DISPATCHER.SetSquadronTakeoffInAir</a>() a parameter can be specified to set the takeoff altitude.
If this parameter is not specified, then the default altitude will be used for the squadron.</p>
<h3>6.2. Set squadron landing methods</h3>
<p>In analogy with takeoff, the landing methods are to control how squadrons land at the airfield:</p>
@ -3773,6 +3794,42 @@ From the airbase hot, from the airbase cold, in the air, from the runway.</p>
<dl class="function">
<dt>
<a id="#(AI_A2A_DISPATCHER).SetDefaultTakeoffInAirAltitude" >
<strong>AI_A2A_DISPATCHER:SetDefaultTakeoffInAirAltitude(TakeoffAltitude)</strong>
</a>
</dt>
<dd>
<p>Defines the default altitude where airplanes will spawn in the air and take-off as part of the defense system, when the take-off in the air method has been selected.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number TakeoffAltitude </em></code>:
The altitude in meters above the ground.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(AI_A2A_DISPATCHER)">#AI<em>A2A</em>DISPATCHER</a>:</em></p>
<h3>Usage:</h3>
<pre class="example"><code>
local A2ADispatcher = AI_A2A_DISPATCHER:New( ... )
-- Set the default takeoff altitude when taking off in the air.
A2ADispatcher:SetDefaultTakeoffInAirAltitude( 2000 ) -- This makes planes start at 2000 meters above the ground.
</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(AI_A2A_DISPATCHER).SetDefaultTanker" >
<strong>AI_A2A_DISPATCHER:SetDefaultTanker(TankerName)</strong>
</a>
@ -4808,20 +4865,26 @@ The name of the squadron.</p>
<dt>
<a id="#(AI_A2A_DISPATCHER).SetSquadronTakeoffInAir" >
<strong>AI_A2A_DISPATCHER:SetSquadronTakeoffInAir(SquadronName)</strong>
<strong>AI_A2A_DISPATCHER:SetSquadronTakeoffInAir(SquadronName, TakeoffAltitude)</strong>
</a>
</dt>
<dd>
<p>Sets flights to take-off in the air, as part of the defense system.</p>
<h3>Parameter</h3>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string SquadronName </em></code>:
The name of the squadron.</p>
</li>
<li>
<p><code><em>#number TakeoffAltitude </em></code>:
(optional) The altitude in meters above the ground. If not given, the default takeoff altitude will be used.</p>
</li>
</ul>
<h3>Return value</h3>
@ -4843,6 +4906,48 @@ The name of the squadron.</p>
<dl class="function">
<dt>
<a id="#(AI_A2A_DISPATCHER).SetSquadronTakeoffInAirAltitude" >
<strong>AI_A2A_DISPATCHER:SetSquadronTakeoffInAirAltitude(SquadronName, TakeoffAltitude)</strong>
</a>
</dt>
<dd>
<p>Defines the default altitude where airplanes will spawn in the air and take-off as part of the defense system, when the take-off in the air method has been selected.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string SquadronName </em></code>:
The name of the squadron.</p>
</li>
<li>
<p><code><em>#number TakeoffAltitude </em></code>:
The altitude in meters above the ground.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(AI_A2A_DISPATCHER)">#AI<em>A2A</em>DISPATCHER</a>:</em></p>
<h3>Usage:</h3>
<pre class="example"><code>
local A2ADispatcher = AI_A2A_DISPATCHER:New( ... )
-- Set the default takeoff altitude when taking off in the air.
A2ADispatcher:SetSquadronTakeoffInAirAltitude( "SquadronName", 2000 ) -- This makes planes start at 2000 meters above the ground.
</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(AI_A2A_DISPATCHER).SetSquadronTanker" >
<strong>AI_A2A_DISPATCHER:SetSquadronTanker(SquadronName, TankerName)</strong>
</a>

1
docs/Documentation/Cargo.html
View File

@ -3417,7 +3417,6 @@ The range till cargo will board.</p>
<dl class="function">
<dt>
<em></em>
<a id="#(CARGO_UNIT).CargoCarrier" >
<strong>CARGO_UNIT.CargoCarrier</strong>
</a>

2
docs/Documentation/Detection.html
View File

@ -2464,6 +2464,7 @@ The index of the DetectedItem.</p>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(DETECTION_BASE).DetectedItemCount" >
<strong>DETECTION_BASE.DetectedItemCount</strong>
</a>
@ -2477,6 +2478,7 @@ The index of the DetectedItem.</p>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(DETECTION_BASE).DetectedItemMax" >
<strong>DETECTION_BASE.DetectedItemMax</strong>
</a>

3
docs/Documentation/Fsm.html
View File

@ -1598,7 +1598,7 @@ A string defining the start state.</p>
<dl class="function">
<dt>
<em></em>
<em>#string</em>
<a id="#(FSM)._StartState" >
<strong>FSM._StartState</strong>
</a>
@ -1897,7 +1897,6 @@ A string defining the start state.</p>
<dl class="function">
<dt>
<em></em>
<a id="#(FSM).current" >
<strong>FSM.current</strong>
</a>

1
docs/Documentation/Positionable.html
View File

@ -1838,7 +1838,6 @@ self</p>
<dl class="function">
<dt>
<em><a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a></em>
<a id="#(POSITIONABLE).Spot" >
<strong>POSITIONABLE.Spot</strong>
</a>

2
docs/Documentation/Settings.html
View File

@ -1142,7 +1142,7 @@ true if metric.</p>
<dl class="function">
<dt>
<em>#boolean</em>
<em></em>
<a id="#(SETTINGS).Metric" >
<strong>SETTINGS.Metric</strong>
</a>

44
docs/Documentation/Spawn.html
View File

@ -423,7 +423,7 @@ and any spaces before and after the resulting name are removed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPAWN).SpawnAtAirbase">SPAWN:SpawnAtAirbase(Airbase, Takeoff)</a></td>
<td class="name" nowrap="nowrap"><a href="##(SPAWN).SpawnAtAirbase">SPAWN:SpawnAtAirbase(Airbase, Takeoff, TakeoffAltitude)</a></td>
<td class="summary">
<p>Will spawn a group at an airbase.</p>
</td>
@ -822,12 +822,6 @@ and any spaces before and after the resulting name are removed.</p>
<td class="name" nowrap="nowrap"><a href="##(SPAWN)._TranslateRotate">SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPAWN).uncontrolled">SPAWN.uncontrolled</a></td>
<td class="summary">
</td>
</tr>
</table>
@ -2269,7 +2263,7 @@ The group that was spawned. You can use this group for further actions.</p>
<dt>
<a id="#(SPAWN).SpawnAtAirbase" >
<strong>SPAWN:SpawnAtAirbase(Airbase, Takeoff)</strong>
<strong>SPAWN:SpawnAtAirbase(Airbase, Takeoff, TakeoffAltitude)</strong>
</a>
</dt>
<dd>
@ -2294,6 +2288,12 @@ The <a href="Airbase.html">Airbase</a> where to spawn the group.</p>
<p><code><em><a href="##(SPAWN.Takeoff)">#SPAWN.Takeoff</a> Takeoff </em></code>:
(optional) The location and takeoff method. Default is Hot.</p>
</li>
<li>
<p><code><em>#number TakeoffAltitude </em></code>:
(optional) The altitude above the ground.</p>
</li>
</ul>
<h3>Return values</h3>
@ -2732,6 +2732,9 @@ when nothing was spawned.</p>
<p> Overwrite unit names by default with group name.</p>
</dd>
</dl>
<dl class="function">
@ -2746,6 +2749,9 @@ when nothing was spawned.</p>
<p> By default, no InitLimit</p>
</dd>
</dl>
<dl class="function">
@ -2781,7 +2787,7 @@ when nothing was spawned.</p>
<dl class="function">
<dt>
<em></em>
<em>#number</em>
<a id="#(SPAWN).SpawnMaxGroups" >
<strong>SPAWN.SpawnMaxGroups</strong>
</a>
@ -2798,7 +2804,7 @@ when nothing was spawned.</p>
<dl class="function">
<dt>
<em></em>
<em>#number</em>
<a id="#(SPAWN).SpawnMaxUnitsAlive" >
<strong>SPAWN.SpawnMaxUnitsAlive</strong>
</a>
@ -3126,7 +3132,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
<dl class="function">
<dt>
<em></em>
<em>#boolean</em>
<a id="#(SPAWN).SpawnUnControlled" >
<strong>SPAWN.SpawnUnControlled</strong>
</a>
@ -3150,7 +3156,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
</dd>
</dl>
@ -3730,20 +3736,6 @@ True = Continue Scheduler</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(SPAWN).uncontrolled" >
<strong>SPAWN.uncontrolled</strong>
</a>
</dt>
<dd>
</dd>
</dl>

4
docs/Documentation/Spot.html
View File

@ -765,6 +765,7 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).ScheduleID" >
<strong>SPOT.ScheduleID</strong>
</a>
@ -778,6 +779,7 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).SpotIR" >
<strong>SPOT.SpotIR</strong>
</a>
@ -791,6 +793,7 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).SpotLaser" >
<strong>SPOT.SpotLaser</strong>
</a>
@ -804,6 +807,7 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).Target" >
<strong>SPOT.Target</strong>
</a>

1
docs/Documentation/Task_Cargo.html
View File

@ -566,7 +566,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<dl class="function">
<dt>
<em></em>
<a id="#(FSM_PROCESS).DeployZone" >
<strong>FSM_PROCESS.DeployZone</strong>
</a>