Documentation

This commit is contained in:
FlightControl_Master 2018-03-18 08:16:02 +01:00
parent af7a87e5a0
commit 7b5136eabf

View File

@ -47,11 +47,34 @@ do -- TASK_A2G_DISPATCHER
-- This chapters provides some insights in the tactical situations when certain Task Types are created.
-- The Task Types are depending on the enemy positions that were detected, and the current location of friendly units.
--
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia3.JPG)
--
-- In the demonstration mission [TAD-A2G-000 - AREAS - Detection test],
-- the tactical situation is a demonstration how the A2G detection works.
-- This example will be taken further in the explanation in the following chapters.
--
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia4.JPG)
--
-- The red coalition are the players, the blue coalition is the enemy.
--
-- Red reconnaissance vehicles and airborne units are detecting the targets.
-- We call this the RecceSet as explained above, which is a Set of Groups that
-- have a group name starting with `Recce` (configured in the mission script).
--
-- Red attack units are responsible for executing the mission for the command center.
-- We call this the AttackSet, which is a Set of Groups with a group name starting with `Attack` (configured in the mission script).
-- These units are setup in this demonstration mission to be ground vehicles and airplanes.
-- For demonstration purposes, the attack airplane is stationed on the ground to explain
-- the messages and the menus properly.
-- Further test missions demonstrate the A2G task dispatcher from within air.
--
-- Depending upon the detection results, the A2G dispatcher will create different tasks.
--
-- # 0.1. SEAD Task
--
-- A SEAD Task is dispatched when there are ground based Radar Emitters detected within an area.
--
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia11.JPG)
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia9.JPG)
--
-- - Once all Radar Emitting Units have been destroyed, the Task will convert into a BAI or CAS task!
-- - A CAS and BAI task may be converted into a SEAD task, once a radar has been detected within the area!
@ -60,7 +83,7 @@ do -- TASK_A2G_DISPATCHER
--
-- A CAS Task is dispatched when there are no ground based Radar Emitters within the area, but there are friendly ground Units within 6 km from the enemy.
--
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia12.JPG)
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia10.JPG)
--
-- - After the detection of the CAS task, if the friendly Units are destroyed, the CAS task will convert into a BAI task!
-- - Only ground Units are taken into account. Airborne units are ships are not considered friendlies that require Close Air Support.
@ -69,7 +92,7 @@ do -- TASK_A2G_DISPATCHER
--
-- A BAI Task is dispatched when there are no ground based Radar Emitters within the area, and there aren't friendly ground Units within 6 km from the enemy.
--
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia13.JPG)
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia11.JPG)
--
-- - A BAI task may be converted into a CAS task if friendly Ground Units approach within 6 km range!
--
@ -83,16 +106,15 @@ do -- TASK_A2G_DISPATCHER
--
-- Radio MENU Structure (F10. Other)
--
-- F1. Command Center |Gori|
-- F1. Mission "Alpha"
-- F2. Mission "Beta"
-- F3. Mission "Gamma"
-- F1. Command Center |Lima|
-- F1. Mission "Overlord"
-- F2. Mission "Desert Storm"
-- F1. Command Center [Gori]
-- F1. Mission "Alpha (Primary)"
-- F2. Mission "Beta (Secondary)"
-- F3. Mission "Gamma (Tactical)"
-- F1. Command Center [Lima]
-- F1. Mission "Overlord (High)"
--
-- CC |Gori| is controlling Mission "Alpha", "Beta", "Gamma".
-- CC |Lima| is controlling Missions "Overlord" and "Desert Storm".
-- Command Center [Gori] is controlling Mission "Alpha", "Beta", "Gamma". Alpha is the Primary mission, Beta the Secondary and there is a Tacical mission Gamma.
-- Command Center [Lima] is controlling Missions "Overlord", which needs to be executed with High priority.
--
-- ## 1.1. Mission Menu (Under the Command Center Menu)
--
@ -103,20 +125,18 @@ do -- TASK_A2G_DISPATCHER
-- - **Create Task Reports**: A menu to create various reports of the current tasks dispatched by the A2G dispatcher.
-- - **Create Mission Reports**: A menu to create various reports on the current mission.
--
-- For CC |Lima|, Mission "Overlord", the menu structure could look like this:
-- For CC [Lima], Mission "Overlord", the menu structure could look like this:
--
-- Radio MENU Structure (F10. Other)
--
-- F1. Command Center |Lima|
-- F1. Command Center [Lima]
-- F1. Mission "Overlord"
-- F1. Mission Briefing
-- F2. Mark Task Locations on Map
-- F3. Task Reports
-- F4. Mission Reports
--
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia6.JPG)
--
--
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia5.JPG)
--
-- ### 1.1.1. Mission Briefing Menu
--
@ -144,11 +164,11 @@ do -- TASK_A2G_DISPATCHER
--
-- The information shown of the tasks will vary according the underlying task type, but are self explanatory.
--
-- For CC |Gori|, Mission "Alpha", the Task Reports menu structure could look like this:
-- For CC [Gori], Mission "Alpha", the Task Reports menu structure could look like this:
--
-- Radio MENU Structure (F10. Other)
--
-- F1. Command Center |Gori|
-- F1. Command Center [Gori]
-- F1. Mission "Alpha"
-- F1. Mission Briefing
-- F2. Mark Task Locations on Map
@ -174,7 +194,7 @@ do -- TASK_A2G_DISPATCHER
--
-- Radio MENU Structure (F10. Other)
--
-- F1. Command Center |Gori|
-- F1. Command Center [Gori]
-- F1. Mission "Alpha"
-- F1. Mission Briefing
-- F2. Mark Task Locations on Map
@ -201,7 +221,7 @@ do -- TASK_A2G_DISPATCHER
--
-- Radio MENU Structure (F10. Other)
--
-- F1. Command Center |Gori|
-- F1. Command Center [Gori]
-- F1. Mission "Alpha"
-- F1. Mission Briefing
-- F2. Mark Task Locations on Map
@ -225,7 +245,7 @@ do -- TASK_A2G_DISPATCHER
--
-- Radio MENU Structure (F10. Other)
--
-- F1. Command Center |Gori|
-- F1. Command Center [Gori]
-- F1. Mission "Alpha"
-- F1. Mission Briefing
-- F2. Mark Task Locations on Map
@ -241,7 +261,7 @@ do -- TASK_A2G_DISPATCHER
-- The Join Planned Task Menu contains the different Planned A2G Tasks **in a structured Menu Hierarchy**.
-- The Menu Hierarchy is structuring the Tasks per **Task Type**, and then by **Task Name (ID)**.
--
-- For example, for CC |Gori|, Mission "Alpha",
-- For example, for CC [Gori], Mission "Alpha",
-- if a Mission "ALpha" contains 5 Planned Tasks, which would be:
--
-- - 2 CAS Tasks
@ -252,34 +272,29 @@ do -- TASK_A2G_DISPATCHER
--
-- Radio MENU Structure (F10. Other)
--
-- F1. Command Center |Gori|
-- F1. Command Center [Gori]
-- F1. Mission "Alpha"
-- F1. Mission Briefing
-- F2. Mark Task Locations on Map
-- F3. Task Reports
-- F4. Mission Reports
-- F5. Join Planned Task
-- F1. CAS
-- F1. CAS.001
-- F2. CAS.002
-- F2. BAI
-- F1. BAI.001
-- F1. CAS
-- F1. CAS.002
-- F3. SEAD
-- F1. SEAD.001
-- F2. SEAD.002
-- F1. SEAD.003
-- F2. SEAD.004
-- F3. SEAD.005
--
-- An example from within a running simulation:
--
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia7.JPG)
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia6.JPG)
--
-- Each Task Type Menu would have a list of the Task Menus underneath.
-- Each Task Menu (eg. `CAS.001`) has a **detailed Task Menu structure to control the specific task**!
--
-- An example from within a running simulation:
--
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia8.JPG)
--
--
-- ### 1.3.1. Planned Task Menu
--
-- Each Planned Task Menu will allow for the following actions:
@ -307,10 +322,6 @@ do -- TASK_A2G_DISPATCHER
--
-- **The Join Task is THE menu option to let a Player join the Task, and to engage within the Mission.**
--
-- An example from within a running simulation:
--
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia9.JPG)
--
--
-- ## 1.4. Assigned Task Menu
--
@ -338,13 +349,29 @@ do -- TASK_A2G_DISPATCHER
-- Task abortion will result in the Task to be Cancelled, and the Task **may** be **Replanned**.
-- However, this will depend on the setup of each Mission.
--
-- ## 1.5. Messages
--
-- During game play, different messages are displayed.
-- These messages provide an update of the achievements made, and the state wherein the task is.
--
-- # 1. TASK_A2G_DISPATCHER constructor
-- The various reports can be used also to retrieve the current status of the mission and its tasks.
--
-- ![](..\Presentations\TASK_A2G_DISPATCHER\Dia7.JPG)
--
-- The @{Settings} menu provides additional options to control the timing of the messages.
-- There are:
--
-- - Status messages, which are quick status updates. The settings menu allows to switch off these messages.
-- - Information messages, which are shown a bit longer, as they contain important information.
-- - Summary reports, which are quick reports showing a high level summary.
-- - Overview reports, which are providing the essential information. It provides an overview of a greater thing, and may take a bit of time to read.
-- - Detailed reports, which provide with very detailed information. It takes a bit longer to read those reports, so the display of those could be a bit longer.
--
-- # 2. TASK_A2G_DISPATCHER constructor
--
-- The @{#TASK_A2G_DISPATCHER.New}() method creates a new TASK_A2G_DISPATCHER instance.
--
-- # 2. Usage
-- # 3. Usage
--
-- To use the TASK\_A2G\_DISPATCHER class, you need:
--