From 2b6fecbe4d272fdb5b877314415a5f37075e23f7 Mon Sep 17 00:00:00 2001 From: FlightControl Date: Tue, 13 Jun 2017 13:38:52 +0200 Subject: [PATCH] Documentation --- .../bin/TreeHierarchy.csv | 4 ++-- docs/Documentation/AI_A2A_Dispatcher.html | 20 +++++++++---------- docs/Documentation/Cargo.html | 2 ++ docs/Documentation/Detection.html | 4 +++- docs/Documentation/Point.html | 1 - docs/Documentation/Settings.html | 2 +- docs/Documentation/Spawn.html | 5 +---- docs/Documentation/Task_Cargo.html | 2 +- 8 files changed, 20 insertions(+), 20 deletions(-) diff --git a/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv b/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv index a01e3881f..723c4e708 100644 --- a/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv +++ b/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv @@ -39,5 +39,5 @@ @K=function, @M=Designate, @N=OnAfterStatus, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=15822, @K=function, @M=Designate, @N=Status, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=16043, @K=function, @M=Designate, @N=__Status, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=16166, -@K=function, @M=AI_A2A_Dispatcher, @N=onafterHome, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\AI\AI_A2A_Dispatcher.lua, @C=65243, -@K=function, @M=AI_A2A_Dispatcher, @N=onafterHome, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\AI\AI_A2A_Dispatcher.lua, @C=69452, +@K=function, @M=AI_A2A_Dispatcher, @N=onafterHome, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\AI\AI_A2A_Dispatcher.lua, @C=65259, +@K=function, @M=AI_A2A_Dispatcher, @N=onafterHome, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\AI\AI_A2A_Dispatcher.lua, @C=69468, diff --git a/docs/Documentation/AI_A2A_Dispatcher.html b/docs/Documentation/AI_A2A_Dispatcher.html index 5b1bfc49f..efdca725b 100644 --- a/docs/Documentation/AI_A2A_Dispatcher.html +++ b/docs/Documentation/AI_A2A_Dispatcher.html @@ -126,9 +126,9 @@ AI_A2A_DISPATCHER -

AIA2ADISPATCHER class, extends Tasking#DETECTION_MANAGER

+

AI_A2A_DISPATCHER class, extends Tasking#DETECTION_MANAGER

-

The #AIA2ADISPATCHER class is designed to create an automatic air defence system for a coalition.

+

The #AI class is designed to create an automatic air defence system for a coalition.

@@ -597,9 +597,9 @@
-

AIA2ADISPATCHER class, extends Tasking#DETECTION_MANAGER

+

AI_A2A_DISPATCHER class, extends Tasking#DETECTION_MANAGER

-

The #AIA2ADISPATCHER class is designed to create an automatic air defence system for a coalition.

+

The #AI class is designed to create an automatic air defence system for a coalition.

It includes automatic spawning of Combat Air Patrol aircraft (CAP) and Ground Controlled Intercept aircraft (GCI) in response to enemy air movements that are detected by a ground based radar network. @@ -608,12 +608,12 @@ If all CAP flights are engaged or RTB then additional GCI interceptors will scra With a little time and with a little work it provides the mission designer with a convincing and completely automatic air defence system. In short it is a plug in very flexible and configurable air defence module for DCS World.

-

Note that in order to create a two way A2A defense system, two AIA2ADISPATCHER defense system may need to be created, for each coalition one. +

Note that in order to create a two way A2A defense system, two AI_A2A_DISPATCHER defense system may need to be created, for each coalition one. This is a good implementation, because maybe in the future, more coalitions may become available in DCS world.

-

1. AIA2ADISPATCHER constructor:

+

1. AI_A2A_DISPATCHER constructor:

-

The AIA2ADISPATCHER.New() method creates a new AIA2ADISPATCHER instance. +

The AIA2ADISPATCHER.New() method creates a new AI_A2A_DISPATCHER instance. There are two parameters required, a Set#SET_GROUP that defines the Groups of the EWR network, and a radius in meters, that will be used to group the detected targets.

The AIA2ADISPATCHER.New() method is used to setup the EWR network and to define the grouping.

@@ -632,7 +632,7 @@ Having the radars further back will mean a slower escalation because fewer targe therefore less CAP and GCI flights will spawn and this will tend to make just the border area active rather than a melee over the whole map. It all depends on what the desired effect is.

-

EWR networks are dynamically constructed, that is, they form part of the Set#SET_GROUP object that is given as the input parameter of the AIA2ADISPATCHER class. +

EWR networks are dynamically constructed, that is, they form part of the Set#SET_GROUP object that is given as the input parameter of the AI_A2A_DISPATCHER class. By defining in a smart way the names or name prefixes of the groups of EWR capable units, these units will be automatically added or deleted from the EWR network, increasing or decreasing the radar coverage of the Early Warning System.

@@ -686,7 +686,7 @@ If a hot war is chosen then no borders actually need to be defi

4. Squadrons:

-

The AIA2ADISPATCHER works with Squadrons, that need to be defined using the different methods available.

+

The AI_A2A_DISPATCHER works with Squadrons, that need to be defined using the different methods available.

Use the method AIA2ADISPATCHER.SetSquadron() to setup a new squadron active at an airfield, while defining which plane types are being used by the squadron and how many resources are available.

@@ -700,7 +700,7 @@ while defining which plane types are being used by the squadron and how many res
  • Have a limited set of resources.
    • -

    The name of the squadron given acts as the squadron key in the AIA2ADISPATCHER:Squadron...() methods.

    +

    The name of the squadron given acts as the squadron key in the AI_A2A_DISPATCHER:Squadron...() methods.

    Additionally, squadrons have specific configuration options to:

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

    + CARGO_UNIT.CargoCarrier @@ -3059,6 +3060,7 @@ The range till cargo will board.

    + #number CARGO_UNIT.RunCount diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index 4893802ee..49f3c5879 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2387,6 +2387,7 @@ The index of the DetectedItem.

    + #number DETECTION_BASE.DetectedItemCount @@ -2400,6 +2401,7 @@ The index of the DetectedItem.

    + #number DETECTION_BASE.DetectedItemMax @@ -2557,7 +2559,7 @@ The index of the DetectedItem.

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

    - POINT_VEC2.z diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html index 7dca37cbf..4dce02244 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 2aa5a01d8..89a987529 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -2732,9 +2732,6 @@ when nothing was spawned.

    - -

    Overwrite unit names by default with group name.

    -
    @@ -3153,7 +3150,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 ) -

    Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

    +

    When the first Spawn executes, all the Groups need to be made visible before start.

    diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 34472761b..a49a3383f 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -510,7 +510,7 @@ based on the tasking capabilities defined in Task#TA
    - + Core.Cargo#CARGO_GROUP FSM_PROCESS.Cargo