Added GCI engage range.

This commit is contained in:
FlightControl
2017-06-22 09:58:05 +02:00
parent 44f60169cb
commit bdfd169d39
10 changed files with 170 additions and 52 deletions

View File

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

View File

@@ -258,6 +258,12 @@
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).GCI">AI_A2A_DISPATCHER:GCI()</a></td>
<td class="summary">
<p>GCI Trigger for AI<em>A2A</em>DISPATCHER</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).GciRadius">AI_A2A_DISPATCHER.GciRadius</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -441,9 +447,15 @@
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).SetEngageRadius">AI_A2A_DISPATCHER:SetEngageRadius(FriendliesRadius)</a></td>
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).SetEngageRadius">AI_A2A_DISPATCHER:SetEngageRadius(EngageRadius)</a></td>
<td class="summary">
<p>Define the radius to engage any target by airborne friendlies, which are executing cap or returning from an intercept mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).SetGciRadius">AI_A2A_DISPATCHER:SetGciRadius(GciRadius)</a></td>
<td class="summary">
<p>Define the radius to check if a target can be engaged by an ground controlled intercept.</p>
</td>
</tr>
<tr>
@@ -1640,6 +1652,19 @@ If there are no targets to be set.</p>
<p>GCI Trigger for AI<em>A2A</em>DISPATCHER</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(AI_A2A_DISPATCHER).GciRadius" >
<strong>AI_A2A_DISPATCHER.GciRadius</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
@@ -2516,7 +2541,7 @@ An object derived from ZONE_BASE, that defines a zone between</p>
<dt>
<a id="#(AI_A2A_DISPATCHER).SetEngageRadius" >
<strong>AI_A2A_DISPATCHER:SetEngageRadius(FriendliesRadius)</strong>
<strong>AI_A2A_DISPATCHER:SetEngageRadius(EngageRadius)</strong>
</a>
</dt>
<dd>
@@ -2537,8 +2562,8 @@ If too large, any airborne cap may not be able to reach the detected target area
<ul>
<li>
<p><code><em>#number FriendliesRadius </em></code>:
The radius to report friendlies near the target.</p>
<p><code><em>#number EngageRadius </em></code>:
(Optional, Default = 100000) The radius to report friendlies near the target.</p>
</li>
</ul>
@@ -2549,8 +2574,57 @@ The radius to report friendlies near the target.</p>
<h3>Usage:</h3>
<pre class="example"><code>
-- Set 50km as the radius to engage any target by airborne friendlies.
Dispatcher:SetEngageRadius( 50000 )
-- Set 100km as the radius to engage any target by airborne friendlies.
Dispatcher:InitDetectionFriendiesRadius( 100000 )
Dispatcher:SetEngageRadius() -- 100000 is the default value.
</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(AI_A2A_DISPATCHER).SetGciRadius" >
<strong>AI_A2A_DISPATCHER:SetGciRadius(GciRadius)</strong>
</a>
</dt>
<dd>
<p>Define the radius to check if a target can be engaged by an ground controlled intercept.</p>
<p>So, if there is a target area detected and reported,
and a GCI is to be executed,
then it will be check if the target is within the GCI from the nearest airbase.
For example, if 150000 is given as a value, then any airbase within 150km from the detected target,
will be considered to receive the command to GCI.
You need to evaluate the value of this parameter carefully.
If too small, intercept missions may be triggered too late.
If too large, intercept missions may be triggered when the detected target is too far.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number GciRadius </em></code>:
(Optional, Default = 200000) The radius to ground control intercept detected targets from the nearest airbase.</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>
-- Set 100km as the radius to ground control intercept detected targets from the nearest airbase.
Dispatcher:SetGciRadius( 100000 )
-- Set 200km as the radius to ground control intercept.
Dispatcher:SetGciRadius() -- 200000 is the default value.
</code></pre>
</dd>

View File

@@ -926,9 +926,6 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI<em>PATROL</em>ZONE.M
<p> This table contains the targets detected during patrol.</p>
</dd>
</dl>
<dl class="function">

View File

@@ -900,7 +900,6 @@ function below will use the range 1-7 just in case</p>
<dl class="function">
<dt>
<em></em>
<a id="#(DESIGNATE).LaserCodes" >
<strong>DESIGNATE.LaserCodes</strong>
</a>

View File

@@ -607,6 +607,12 @@ The different values of Unit.Category can be:</p>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).GetDetectionSetGroup">DETECTION_BASE:GetDetectionSetGroup()</a></td>
<td class="summary">
<p>Get the detection Groups.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).GetFriendliesDistance">DETECTION_BASE:GetFriendliesDistance(DetectedItem)</a></td>
<td class="summary">
<p>Returns friendly units nearby the FAC units sorted per distance ...</p>
</td>
</tr>
<tr>
@@ -2971,6 +2977,32 @@ DetectedSet</p>
<p><em><a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_BASE).GetFriendliesDistance" >
<strong>DETECTION_BASE:GetFriendliesDistance(DetectedItem)</strong>
</a>
</dt>
<dd>
<p>Returns friendly units nearby the FAC units sorted per distance ...</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> DetectedItem </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(map)">#map</a>:</em></p>
<h1>number,Wrapper.Unit#UNIT> The map of Friendly UNITs.</h1>
</dd>
</dl>
<dl class="function">

View File

@@ -1604,7 +1604,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>
@@ -1903,7 +1903,6 @@ A string defining the start state.</p>
<dl class="function">
<dt>
<em></em>
<a id="#(FSM).current" >
<strong>FSM.current</strong>
</a>

View File

@@ -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>
@@ -2200,9 +2194,6 @@ The group that was spawned. You can use this group for further actions.</p>
<p> Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.</p>
</dd>
</dl>
<dl class="function">
@@ -2735,9 +2726,6 @@ when nothing was spawned.</p>
<p> Overwrite unit names by default with group name.</p>
</dd>
</dl>
<dl class="function">
@@ -3736,20 +3724,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>

View File

@@ -436,7 +436,6 @@ ptional) The name of the new static.</p>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(SPAWNSTATIC).SpawnIndex" >
<strong>SPAWNSTATIC.SpawnIndex</strong>
</a>

View File

@@ -510,7 +510,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<dl class="function">
<dt>
<em><a href="Core.Cargo.html##(CARGO)">Core.Cargo#CARGO</a></em>
<em><a href="Core.Cargo.html##(CARGO_GROUP)">Core.Cargo#CARGO_GROUP</a></em>
<a id="#(FSM_PROCESS).Cargo" >
<strong>FSM_PROCESS.Cargo</strong>
</a>
@@ -524,6 +524,7 @@ 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>