From ab27a1bd2b34a498a635d6e6fb9047b8faa6f7cc Mon Sep 17 00:00:00 2001 From: FlightControl Date: Fri, 23 Jun 2017 07:40:38 +0200 Subject: [PATCH] Documentation --- docs/Documentation/AI_Patrol.html | 3 - docs/Documentation/Cargo.html | 1 - docs/Documentation/Detection.html | 1 + docs/Documentation/Fsm.html | 3 +- docs/Documentation/Point.html | 1 + docs/Documentation/Settings.html | 2 +- docs/Documentation/Spawn.html | 3 + docs/Documentation/Task_A2A_Dispatcher.html | 61 ++++++++++++++++++++- 8 files changed, 66 insertions(+), 9 deletions(-) diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index 43392b308..93a9f8ce6 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -926,9 +926,6 @@ Use the method AIPATROLZONE.M - -

This table contains the targets detected during patrol.

-
diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index e3fae231c..d774a472f 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -2934,7 +2934,6 @@ The range till cargo will board.

- CARGO_UNIT.CargoCarrier diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index 1d9cd5d70..141b7d951 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2393,6 +2393,7 @@ The index of the DetectedItem.

+ #number DETECTION_BASE.DetectedItemCount diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index 401b60084..5267af595 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -1604,7 +1604,7 @@ A string defining the start state.

- + #string FSM._StartState @@ -1903,7 +1903,6 @@ A string defining the start state.

- FSM.current diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index f204d56d9..74e7fcb9a 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -2799,6 +2799,7 @@ The y coordinate.

+ POINT_VEC2.z diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html index 4dce02244..7dca37cbf 100644 --- a/docs/Documentation/Settings.html +++ b/docs/Documentation/Settings.html @@ -1073,7 +1073,7 @@ true if metric.

- #boolean + SETTINGS.Metric diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 2540b5685..af544c865 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -2726,6 +2726,9 @@ when nothing was spawned.

+ +

Overwrite unit names by default with group name.

+
diff --git a/docs/Documentation/Task_A2A_Dispatcher.html b/docs/Documentation/Task_A2A_Dispatcher.html index f61d3f09e..df0f41733 100644 --- a/docs/Documentation/Task_A2A_Dispatcher.html +++ b/docs/Documentation/Task_A2A_Dispatcher.html @@ -109,6 +109,10 @@ +

Banner Image

+ +

The #TASKA2ADISPATCHER class implements the dynamic dispatching of tasks upon groups of detected units determined a Set of EWR installation groups.

+

Author: Sven Van de Velde (FlightControl)

@@ -197,6 +201,12 @@ TASK_A2A_DISPATCHER:ProcessDetected(Detection)

Assigns tasks in relation to the detected items to the Set#SET_GROUP.

+ + + + TASK_A2A_DISPATCHER:SetEngageRadius(EngageRadius) + +

Define the radius to when an ENGAGE task will be generated for any nearby by airborne friendlies, which are executing cap or returning from an intercept mission.

@@ -225,7 +235,7 @@

The EWR will detect units, will group them, and will dispatch Tasks to groups. Depending on the type of target detected, different tasks will be dispatched. Find a summary below describing for which situation a task type is created:

-

Banner Image

+

Banner Image

  • INTERCEPT Task: Is created when the target is known, is detected and within a danger zone, and there is no friendly airborne in range.
    • @@ -321,7 +331,7 @@ group being detected. This may result in additional GCI being started by the dis

    Define the radius to engage any target by airborne friendlies, which are executing cap or returning from an intercept mission.

    -

    Banner Image

    +

    Banner Image

    So, if there is a target area detected and reported, then any friendlies that are airborne near this target area, @@ -708,6 +718,53 @@ The detection created by the Detectio

    #boolean: Return true if you want the task assigning to continue... false will cancel the loop.

    + +
+
+
+ + +TASK_A2A_DISPATCHER:SetEngageRadius(EngageRadius) + +
+
+ +

Define the radius to when an ENGAGE task will be generated for any nearby by airborne friendlies, which are executing cap or returning from an intercept mission.

+ + +

So, if there is a target area detected and reported, +then any friendlies that are airborne near this target area, +will be commanded to (re-)engage that target when available (if no other tasks were commanded). +An ENGAGE task will be created for those pilots. +For example, if 100000 is given as a value, then any friendly that is airborne within 100km from the detected target, +will be considered to receive the command to engage that target area. +You need to evaluate the value of this parameter carefully. +If too small, more intercept missions may be triggered upon detected target areas. +If too large, any airborne cap may not be able to reach the detected target area in time, because it is too far.

+ +

Parameter

+
    +
  • + +

    #number EngageRadius : +(Optional, Default = 100000) The radius to report friendlies near the target.

    + +
    • +
+

Return value

+ +

#TASKA2ADISPATCHER:

+ + +

Usage:

+ 

+  -- Set 50km as the radius to engage any target by airborne friendlies.
+  TaskA2ADispatcher:SetEngageRadius( 50000 )
+  
+  -- Set 100km as the radius to engage any target by airborne friendlies.
+  TaskA2ADispatcher:SetEngageRadius() -- 100000 is the default value.
+
+