From 706aea01cade521c63ffd9b661227145f0ab240d Mon Sep 17 00:00:00 2001 From: FlightControl_Master Date: Tue, 20 Mar 2018 10:34:53 +0100 Subject: [PATCH] Cleanup of documentation of AI --- Moose Development/Moose/AI/AI_A2A.lua | 12 +++---- Moose Development/Moose/AI/AI_A2A_Cap.lua | 26 +++----------- .../Moose/AI/AI_A2A_Dispatcher.lua | 18 +++++----- Moose Development/Moose/AI/AI_A2A_Gci.lua | 20 +++-------- Moose Development/Moose/AI/AI_A2A_Patrol.lua | 36 +++---------------- Moose Development/Moose/AI/AI_BAI.lua | 33 +++++------------ Moose Development/Moose/AI/AI_Balancer.lua | 28 ++++++--------- Moose Development/Moose/AI/AI_CAP.lua | 33 +++++------------ Moose Development/Moose/AI/AI_CAS.lua | 34 +++++------------- Moose Development/Moose/AI/AI_Formation.lua | 27 ++++++-------- Moose Development/Moose/AI/AI_Patrol.lua | 26 ++++++-------- Moose Development/Moose/Core/Base.lua | 4 +-- Moose Development/Moose/Core/Cargo.lua | 10 +++--- Moose Development/Moose/Core/Database.lua | 6 ++-- Moose Development/Moose/Core/Event.lua | 4 +-- Moose Development/Moose/Core/Fsm.lua | 6 ++-- Moose Development/Moose/Core/Goal.lua | 8 ++--- Moose Development/Moose/Core/Menu.lua | 4 +-- Moose Development/Moose/Core/Message.lua | 6 ++-- Moose Development/Moose/Core/Point.lua | 4 +-- Moose Development/Moose/Core/Scheduler.lua | 4 +-- Moose Development/Moose/Core/Set.lua | 6 ++-- Moose Development/Moose/Core/Settings.lua | 2 +- Moose Development/Moose/Core/Spawn.lua | 32 +++++------------ Moose Development/Moose/Core/SpawnStatic.lua | 12 +++---- Moose Development/Moose/Core/Spot.lua | 12 +++---- Moose Development/Moose/Core/UserFlag.lua | 8 ++--- Moose Development/Moose/Core/UserSound.lua | 8 ++--- Moose Development/Moose/Core/Velocity.lua | 4 +-- Moose Development/Moose/Core/Zone.lua | 8 ++--- .../Moose/Functional/CleanUp.lua | 4 +-- .../Moose/Functional/Detection.lua | 6 ++-- Moose Development/Moose/Functional/Escort.lua | 10 +++--- .../Moose/Functional/MissileTrainer.lua | 4 +-- .../Moose/Functional/Movement.lua | 2 +- .../Moose/Functional/Protect.lua | 4 +-- Moose Development/Moose/Functional/RAT.lua | 14 ++++---- Moose Development/Moose/Functional/Range.lua | 12 ++++--- .../Moose/Functional/Scoring.lua | 7 ++-- Moose Development/Moose/Functional/Sead.lua | 2 +- .../Moose/Functional/ZoneCaptureCoalition.lua | 20 ++++++++--- .../Moose/Functional/ZoneGoal.lua | 8 ++--- .../Moose/Functional/ZoneGoalCargo.lua | 8 ++--- .../Moose/Functional/ZoneGoalCoalition.lua | 8 ++--- .../Moose/Tasking/CommandCenter.lua | 4 +-- .../Moose/Tasking/DetectionManager.lua | 4 +-- Moose Development/Moose/Tasking/Mission.lua | 4 +-- Moose Development/Moose/Tasking/Task.lua | 6 ++-- Moose Development/Moose/Tasking/TaskInfo.lua | 6 ++-- .../Moose/Tasking/TaskZoneCapture.lua | 6 ++-- Moose Development/Moose/Tasking/Task_A2A.lua | 6 ++-- .../Moose/Tasking/Task_A2A_Dispatcher.lua | 6 ++-- Moose Development/Moose/Tasking/Task_A2G.lua | 6 ++-- .../Moose/Tasking/Task_A2G_Dispatcher.lua | 6 ++-- .../Moose/Tasking/Task_CARGO.lua | 8 ++--- .../Moose/Tasking/Task_Pickup.lua | 2 +- Moose Development/Moose/Wrapper/Airbase.lua | 4 +-- Moose Development/Moose/Wrapper/Client.lua | 4 +-- .../Moose/Wrapper/Controllable.lua | 4 +-- Moose Development/Moose/Wrapper/Group.lua | 6 ++-- .../Moose/Wrapper/Identifiable.lua | 6 ++-- Moose Development/Moose/Wrapper/Object.lua | 4 +-- .../Moose/Wrapper/Positionable.lua | 6 ++-- Moose Development/Moose/Wrapper/Scenery.lua | 6 ++-- Moose Development/Moose/Wrapper/Static.lua | 6 ++-- Moose Development/Moose/Wrapper/Unit.lua | 6 ++-- 66 files changed, 271 insertions(+), 395 deletions(-) diff --git a/Moose Development/Moose/AI/AI_A2A.lua b/Moose Development/Moose/AI/AI_A2A.lua index aee68be5c..1309b52bc 100644 --- a/Moose Development/Moose/AI/AI_A2A.lua +++ b/Moose Development/Moose/AI/AI_A2A.lua @@ -1,14 +1,12 @@ ---- **AI** -- **AI A2A Air Patrolling or Staging.** +--- **AI** -- (R2.2) - Models the process of air operations for airplanes. -- --- ==== +-- This is a class used in the @{AI_A2A_Dispatcher}. -- --- ### Author: **Sven Van de Velde (FlightControl)** --- ### Contributions: +-- === -- --- * **[Dutch_Baron](https://forums.eagle.ru/member.php?u=112075)**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-) --- * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Testing and API concept review. +-- ### Author: **FlightControl** -- --- ==== +-- === -- -- @module AI_A2A diff --git a/Moose Development/Moose/AI/AI_A2A_Cap.lua b/Moose Development/Moose/AI/AI_A2A_Cap.lua index a38ac5b58..9b90b489e 100644 --- a/Moose Development/Moose/AI/AI_A2A_Cap.lua +++ b/Moose Development/Moose/AI/AI_A2A_Cap.lua @@ -1,28 +1,12 @@ ---- **AI** -- **Execute Combat Air Patrol (CAP).** +--- **AI** -- (R2.2) - Models the process of Combat Air Patrol (CAP) for airplanes. +-- +-- This is a class used in the @{AI_A2A_Dispatcher}. -- --- ![Banner Image](..\Presentations\AI_CAP\Dia1.JPG) --- -- === -- --- AI CAP classes makes AI Groups execute a Combat Air Patrol. +-- ### Author: **FlightControl** -- --- There are the following types of CAP classes defined: --- --- * @{#AI_A2A_CAP}: Perform a CAP in a zone. --- --- ==== --- --- ### Author: **Sven Van de Velde (FlightControl)** --- --- ### Contributions: --- --- * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing. --- * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing. --- * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision. --- * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing. --- * **[Delta99](https://forums.eagle.ru/member.php?u=125166): Testing. --- --- ==== +-- === -- -- @module AI_A2A_Cap diff --git a/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua b/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua index f5875f571..39e81634a 100644 --- a/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua +++ b/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua @@ -1,8 +1,10 @@ ---- **AI** - The AI_A2A_DISPATCHER creates an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI. +--- **AI** - (R2.2) - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI. +-- +-- === -- -- ![Banner Image](..\Presentations\AI_A2A_DISPATCHER\Dia1.JPG) -- --- ==== +-- === -- -- # QUICK START GUIDE -- @@ -150,7 +152,7 @@ -- -- === -- --- ### Authors: **Sven Van de Velde (FlightControl)** rework of GCICAP + introduction of new concepts (squadrons). +-- ### Authors: **FlightControl** rework of GCICAP + introduction of new concepts (squadrons). -- ### Authors: **Stonehouse**, **SNAFU** in terms of the advice, documentation, and the original GCICAP script. -- -- @module AI_A2A_Dispatcher @@ -169,13 +171,13 @@ do -- AI_A2A_DISPATCHER -- -- The @{#AI_A2A_DISPATCHER} class is designed to create an automatic air defence system for a coalition. -- - -- ==== + -- === -- -- # Demo Missions -- -- ### [AI\_A2A\_DISPATCHER Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching) -- - -- ==== + -- === -- -- # YouTube Channel -- @@ -3178,7 +3180,7 @@ do -- The AI_A2A_GCICAP class is designed to create an automatic air defence system for a coalition setting up GCI and CAP air defenses. -- The class derives from @{AI#AI_A2A_DISPATCHER} and thus, all the methods that are defined in the @{AI#AI_A2A_DISPATCHER} class, can be used also in AI\_A2A\_GCICAP. -- - -- ==== + -- === -- -- # Demo Missions -- @@ -3188,7 +3190,7 @@ do -- -- ### [AI\_A2A\_GCICAP for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching) -- - -- ==== + -- === -- -- # YouTube Channel -- @@ -3218,7 +3220,7 @@ do -- -- In short it is a plug in very flexible and configurable air defence module for DCS World. -- - -- ==== + -- === -- -- # The following actions need to be followed when using AI\_A2A\_GCICAP in your mission: -- diff --git a/Moose Development/Moose/AI/AI_A2A_Gci.lua b/Moose Development/Moose/AI/AI_A2A_Gci.lua index ac868630f..e714fcfe6 100644 --- a/Moose Development/Moose/AI/AI_A2A_Gci.lua +++ b/Moose Development/Moose/AI/AI_A2A_Gci.lua @@ -1,28 +1,16 @@ ---- **AI** -- **Execute Ground Controlled Interception (GCI).** +--- **AI** -- (R2.2) - Models the process of Ground Controlled Interception (GCI) for airplanes. -- --- ![Banner Image](..\Presentations\AI_GCI\Dia1.JPG) +-- This is a class used in the @{AI_A2A_Dispatcher}. -- -- === -- --- AI A2A_INTEREPT class makes AI Groups execute an Intercept. +-- ### Author: **FlightControl** -- --- There are the following types of GCI classes defined: --- --- * @{#AI_A2A_GCI}: Perform a GCI in a zone. --- --- ==== --- --- ### Author: **Sven Van de Velde (FlightControl)** --- --- ### Contributions: --- --- ==== +-- === -- -- @module AI_A2A_GCI ---BASE:TraceClass("AI_A2A_GCI") - --- @type AI_A2A_GCI -- @extends AI.AI_A2A#AI_A2A diff --git a/Moose Development/Moose/AI/AI_A2A_Patrol.lua b/Moose Development/Moose/AI/AI_A2A_Patrol.lua index a6620b68b..927c5fd32 100644 --- a/Moose Development/Moose/AI/AI_A2A_Patrol.lua +++ b/Moose Development/Moose/AI/AI_A2A_Patrol.lua @@ -1,40 +1,12 @@ ---- **AI** -- **Air Patrolling or Staging.** +--- **AI** -- (R2.2) - Models the process of air patrol of airplanes. -- --- ![Banner Image](..\Presentations\AI_PATROL\Dia1.JPG) +-- This is a class used in the @{AI_A2A_Dispatcher}. -- -- === -- --- AI PATROL classes makes AI Groups execute an Patrol. +-- ### Author: **FlightControl** -- --- There are the following types of PATROL classes defined: --- --- * @{#AI_A2A_PATROL}: Perform a PATROL in a zone. --- --- ==== --- --- # Demo Missions --- --- ### [AI_PATROL Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/PAT%20-%20Patrolling) --- --- ### [AI_PATROL Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/PAT%20-%20Patrolling) --- --- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) --- --- ==== --- --- # YouTube Channel --- --- ### [AI_PATROL YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl35HvYZKA6G22WMt7iI3zky) --- --- ==== --- --- ### Author: **Sven Van de Velde (FlightControl)** --- ### Contributions: --- --- * **[Dutch_Baron](https://forums.eagle.ru/member.php?u=112075)**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-) --- * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Testing and API concept review. --- --- ==== +-- === -- -- @module AI_A2A_Patrol diff --git a/Moose Development/Moose/AI/AI_BAI.lua b/Moose Development/Moose/AI/AI_BAI.lua index 426bfea04..ccb0603bc 100644 --- a/Moose Development/Moose/AI/AI_BAI.lua +++ b/Moose Development/Moose/AI/AI_BAI.lua @@ -1,40 +1,25 @@ ---- **AI** -- **Provide Battlefield Air Interdiction (bombing).** +--- **AI** -- (R2.1) - Manages the independent process of Battlefield Air Interdiction (bombing) for airplanes. +-- +-- === -- -- ![Banner Image](..\Presentations\AI_BAI\Dia1.JPG) -- -- === -- --- AI_BAI classes makes AI Controllables execute bombing tasks. +-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/BAI%20-%20Battlefield%20Air%20Interdiction) -- --- There are the following types of BAI classes defined: +-- === -- --- * @{#AI_BAI_ZONE}: Perform a BAI in a zone. --- --- ==== +-- ### [YouTube Playlist]() -- --- # Demo Missions --- --- ### [AI_BAI Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/BOMB%20-%20Close%20Air%20Support) --- --- ### [AI_BAI Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/BOMB%20-%20Close%20Air%20Support) --- --- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) --- --- ==== --- --- # YouTube Channel --- --- ### [AI_BAI YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl3JBO1WDqqpyYRRmIkR2ir2) --- --- ==== --- --- ### Author: **Sven Van de Velde (FlightControl)** +-- === -- +-- ### Author: **FlightControl** -- ### Contributions: -- -- * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision. -- --- ==== +-- === -- -- @module AI_Bai diff --git a/Moose Development/Moose/AI/AI_Balancer.lua b/Moose Development/Moose/AI/AI_Balancer.lua index b20f3d32a..cb784e571 100644 --- a/Moose Development/Moose/AI/AI_Balancer.lua +++ b/Moose Development/Moose/AI/AI_Balancer.lua @@ -1,33 +1,25 @@ ---- **AI** -- **AI Balancing will replace in multi player missions --- non-occupied human slots with AI groups, in order to provide an engaging simulation environment, --- even when there are hardly any players in the mission.** +--- **AI** -- (2.1) - Balance player slots with AI to create an engaging simulation environment, independent of the amount of players. +-- +-- === -- -- ![Banner Image](..\Presentations\AI_Balancer\Dia1.JPG) --- --- ==== -- --- # Demo Missions +-- === -- --- ### [AI_BALANCER Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/AIB%20-%20AI%20Balancing) +-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/AIB%20-%20AI%20Balancing) -- --- ### [AI_BALANCER Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AIB%20-%20AI%20Balancing) --- --- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) +-- === -- --- ==== +-- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl2CJVIrL1TdAumuVS8n64B7) -- --- # YouTube Channel +-- === -- --- ### [AI_BALANCER YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl2CJVIrL1TdAumuVS8n64B7) --- --- ==== --- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- -- * **[Dutch_Baron](https://forums.eagle.ru/member.php?u=112075)**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-) -- --- ==== +-- === -- -- @module AI_Balancer diff --git a/Moose Development/Moose/AI/AI_CAP.lua b/Moose Development/Moose/AI/AI_CAP.lua index 58b8e3191..8dc70fd40 100644 --- a/Moose Development/Moose/AI/AI_CAP.lua +++ b/Moose Development/Moose/AI/AI_CAP.lua @@ -1,35 +1,20 @@ ---- **AI** -- **Execute Combat Air Patrol (CAP).** +--- **AI** -- (R2.1) - Manages the independent process of Combat Air Patrol (CAP) for airplanes. +-- +-- === -- -- ![Banner Image](..\Presentations\AI_CAP\Dia1.JPG) -- -- === -- --- AI CAP classes makes AI Controllables execute a Combat Air Patrol. +-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAP%20-%20Combat%20Air%20Patrol) -- --- There are the following types of CAP classes defined: +-- === -- --- * @{#AI_CAP_ZONE}: Perform a CAP in a zone. --- --- ==== +-- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl1YCyPxJgoZn-CfhwyeW65L) -- --- # Demo Missions --- --- ### [AI_CAP Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAP%20-%20Combat%20Air%20Patrol) --- --- ### [AI_CAP Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAP%20-%20Combat%20Air%20Patrol) --- --- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) --- --- ==== --- --- # YouTube Channel --- --- ### [AI_CAP YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl1YCyPxJgoZn-CfhwyeW65L) --- --- ==== --- --- ### Author: **Sven Van de Velde (FlightControl)** +-- === -- +-- ### Author: **FlightControl** -- ### Contributions: -- -- * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing. @@ -38,7 +23,7 @@ -- * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing. -- * **[Delta99](https://forums.eagle.ru/member.php?u=125166): Testing. -- --- ==== +-- === -- -- @module AI_Cap diff --git a/Moose Development/Moose/AI/AI_CAS.lua b/Moose Development/Moose/AI/AI_CAS.lua index 3f3a88a19..2450d02ff 100644 --- a/Moose Development/Moose/AI/AI_CAS.lua +++ b/Moose Development/Moose/AI/AI_CAS.lua @@ -1,43 +1,27 @@ ---- **AI** -- **Provide Close Air Support to friendly ground troops.** +--- **AI** -- (R2.1) - Manages the independent process of Close Air Support for airplanes. +-- +-- === -- -- ![Banner Image](..\Presentations\AI_CAS\Dia1.JPG) -- -- === -- --- AI CAS classes makes AI Controllables execute a Close Air Support. +-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAS%20-%20Close%20Air%20Support) -- --- There are the following types of CAS classes defined: +-- === -- --- * @{#AI_CAS_ZONE}: Perform a CAS in a zone. --- --- ==== +-- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl3JBO1WDqqpyYRRmIkR2ir2) -- --- # Demo Missions --- --- ### [AI_CAS Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAS%20-%20Close%20Air%20Support) --- --- ### [AI_CAS Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAS%20-%20Close%20Air%20Support) --- --- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) --- --- ==== --- --- # YouTube Channel --- --- ### [AI_CAS YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl3JBO1WDqqpyYRRmIkR2ir2) --- --- ==== --- --- --- ### Author: **Sven Van de Velde (FlightControl)** +-- === -- +-- ### Author: **FlightControl** -- ### Contributions: -- -- * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing. -- * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing. -- * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision. -- --- ==== +-- === -- -- @module AI_Cas diff --git a/Moose Development/Moose/AI/AI_Formation.lua b/Moose Development/Moose/AI/AI_Formation.lua index 3b2012710..d5801927d 100644 --- a/Moose Development/Moose/AI/AI_Formation.lua +++ b/Moose Development/Moose/AI/AI_Formation.lua @@ -1,4 +1,6 @@ ---- **AI** -- Build large **formations** of AI @{Group}s flying together. +--- **AI** -- (R2.2) - Build large airborne formations of aircraft. +-- +-- === -- -- ![Banner Image](..\Presentations\AI_FORMATION\Dia1.JPG) -- @@ -28,29 +30,20 @@ -- -- * @{#AI_FORMATION}: Create a formation from several @{GROUP}s. -- --- ==== +-- === -- --- # Demo Missions --- --- ### [AI_FORMATION Demo Missions source code]() --- --- ### [AI_FORMATION Demo Missions, only for beta testers]() --- --- ### [ALL Demo Missions pack of the last release]() --- --- ==== --- --- # YouTube Channel --- ---- ### [AI_FORMATION YouTube Channel]() +-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/FOR%20-%20Formation) -- -- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl0bFIJ9jIdYM22uaWmIN4oz) -- +-- === +-- +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module AI_Formation diff --git a/Moose Development/Moose/AI/AI_Patrol.lua b/Moose Development/Moose/AI/AI_Patrol.lua index fe3474b0d..4cc6e7d6e 100644 --- a/Moose Development/Moose/AI/AI_Patrol.lua +++ b/Moose Development/Moose/AI/AI_Patrol.lua @@ -1,4 +1,6 @@ ---- **AI** -- **Air Patrolling or Staging.** +--- **AI** -- (R2.1) - Manages the independent process of Air Patrol for airplanes. +-- +-- === -- -- ![Banner Image](..\Presentations\AI_PATROL\Dia1.JPG) -- @@ -10,31 +12,23 @@ -- -- * @{#AI_PATROL_ZONE}: Perform a PATROL in a zone. -- --- ==== +-- === -- --- # Demo Missions +-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/PAT%20-%20Patrolling) -- --- ### [AI_PATROL Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/PAT%20-%20Patrolling) +-- === -- --- ### [AI_PATROL Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/PAT%20-%20Patrolling) --- --- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) +-- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl35HvYZKA6G22WMt7iI3zky) -- --- ==== +-- === -- --- # YouTube Channel --- --- ### [AI_PATROL YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl35HvYZKA6G22WMt7iI3zky) --- --- ==== --- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- -- * **[Dutch_Baron](https://forums.eagle.ru/member.php?u=112075)**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-) -- * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Testing and API concept review. -- --- ==== +-- === -- -- @module AI_Patrol diff --git a/Moose Development/Moose/Core/Base.lua b/Moose Development/Moose/Core/Base.lua index 00b2dabc4..7c7647c0b 100644 --- a/Moose Development/Moose/Core/Base.lua +++ b/Moose Development/Moose/Core/Base.lua @@ -4,10 +4,10 @@ -- -- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module Base diff --git a/Moose Development/Moose/Core/Cargo.lua b/Moose Development/Moose/Core/Cargo.lua index de62c73e2..991669931 100644 --- a/Moose Development/Moose/Core/Cargo.lua +++ b/Moose Development/Moose/Core/Cargo.lua @@ -11,7 +11,7 @@ -- -- This module is still under construction, but is described above works already, and will keep working ... -- --- ==== +-- === -- -- # Demo Missions -- @@ -21,18 +21,18 @@ -- -- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) -- --- ==== +-- === -- -- # YouTube Channel -- -- ### [CARGO YouTube Channel](https://www.youtube.com/watch?v=tM00lTlkpYs&list=PL7ZUrU4zZUl2zUTuKrLW5RsO9zLMqUtbf) -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module Cargo diff --git a/Moose Development/Moose/Core/Database.lua b/Moose Development/Moose/Core/Database.lua index f99726349..d90e01284 100644 --- a/Moose Development/Moose/Core/Database.lua +++ b/Moose Development/Moose/Core/Database.lua @@ -1,11 +1,11 @@ --- **Core** -- DATABASE manages the database of mission objects. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module Database diff --git a/Moose Development/Moose/Core/Event.lua b/Moose Development/Moose/Core/Event.lua index 3e55977da..1907c3a4c 100644 --- a/Moose Development/Moose/Core/Event.lua +++ b/Moose Development/Moose/Core/Event.lua @@ -159,10 +159,10 @@ -- -- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module Event diff --git a/Moose Development/Moose/Core/Fsm.lua b/Moose Development/Moose/Core/Fsm.lua index d107fc903..0c49c79e3 100644 --- a/Moose Development/Moose/Core/Fsm.lua +++ b/Moose Development/Moose/Core/Fsm.lua @@ -56,13 +56,13 @@ -- * @{#FSM_SET}: Models Finite State Machines for @{Set}s. Note that these FSMs control multiple objects!!! So State concerns here -- for multiple objects or the position of the state machine in the process. -- --- ==== +-- === -- -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module Fsm diff --git a/Moose Development/Moose/Core/Goal.lua b/Moose Development/Moose/Core/Goal.lua index 6b2a98b3c..ff6976877 100644 --- a/Moose Development/Moose/Core/Goal.lua +++ b/Moose Development/Moose/Core/Goal.lua @@ -1,14 +1,14 @@ --- **Core (WIP)** -- Base class to allow the modeling of processes to achieve Goals. -- --- ==== +-- === -- -- GOAL models processes that have an objective with a defined achievement. Derived classes implement the ways how the achievements can be realized. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- --- ==== +-- === -- -- @module Goal diff --git a/Moose Development/Moose/Core/Menu.lua b/Moose Development/Moose/Core/Menu.lua index 87439acb4..9bb30be21 100644 --- a/Moose Development/Moose/Core/Menu.lua +++ b/Moose Development/Moose/Core/Menu.lua @@ -25,10 +25,10 @@ -- -- === --- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module Menu diff --git a/Moose Development/Moose/Core/Message.lua b/Moose Development/Moose/Core/Message.lua index 5d3450616..11a1e19dc 100644 --- a/Moose Development/Moose/Core/Message.lua +++ b/Moose Development/Moose/Core/Message.lua @@ -39,12 +39,12 @@ -- * To all players using @{Message#MESSAGE.ToAllIf}(). -- * To a coalition using @{Message#MESSAGE.ToCoalitionIf}(). -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @field #MESSAGE MESSAGE = { diff --git a/Moose Development/Moose/Core/Point.lua b/Moose Development/Moose/Core/Point.lua index 3fdfea1c5..e56ff64aa 100644 --- a/Moose Development/Moose/Core/Point.lua +++ b/Moose Development/Moose/Core/Point.lua @@ -2,7 +2,7 @@ -- -- ![Banner Image](..\Presentations\POINT\Dia1.JPG) -- --- ==== +-- === -- -- # Demo Missions -- @@ -12,7 +12,7 @@ -- -- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) -- --- ==== +-- === -- -- # YouTube Channel -- diff --git a/Moose Development/Moose/Core/Scheduler.lua b/Moose Development/Moose/Core/Scheduler.lua index 4b712d215..e576aa2aa 100644 --- a/Moose Development/Moose/Core/Scheduler.lua +++ b/Moose Development/Moose/Core/Scheduler.lua @@ -21,13 +21,13 @@ -- -- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) -- --- ==== +-- === -- -- # YouTube Channel -- -- ### [SCHEDULER YouTube Channel (none)]() -- --- ==== +-- === -- -- ### Contributions: -- diff --git a/Moose Development/Moose/Core/Set.lua b/Moose Development/Moose/Core/Set.lua index b4e7a95a4..a3988b558 100644 --- a/Moose Development/Moose/Core/Set.lua +++ b/Moose Development/Moose/Core/Set.lua @@ -23,12 +23,12 @@ -- * Validate the presence of objects in the SET. -- * Trigger events when objects in the SET change a zone presence. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module Set diff --git a/Moose Development/Moose/Core/Settings.lua b/Moose Development/Moose/Core/Settings.lua index 85498104d..8b8a2c601 100644 --- a/Moose Development/Moose/Core/Settings.lua +++ b/Moose Development/Moose/Core/Settings.lua @@ -2,7 +2,7 @@ -- -- ![Banner Image](..\Presentations\SETTINGS\Dia1.JPG) -- --- ==== +-- === -- -- The documentation of the SETTINGS class can be found further in this document. -- diff --git a/Moose Development/Moose/Core/Spawn.lua b/Moose Development/Moose/Core/Spawn.lua index eef24926a..5342a6e92 100644 --- a/Moose Development/Moose/Core/Spawn.lua +++ b/Moose Development/Moose/Core/Spawn.lua @@ -2,43 +2,27 @@ -- -- ![Banner Image](..\Presentations\SPAWN\SPAWN.JPG) -- --- ==== +-- === -- -- The documentation of the SPAWN class can be found further in this document. -- --- ==== +-- === -- --- # Demo Missions --- --- ### [SPAWN Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/SPA%20-%20Spawning) --- --- ### [SPAWN Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SPA%20-%20Spawning) --- --- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) --- --- ==== --- --- # YouTube Channel --- --- ### [SPAWN YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl1jirWIo4t4YxqN-HxjqRkL) +-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/SPA%20-%20Spawning) -- -- === -- --- # **AUTHORS and CONTRIBUTIONS** +-- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl1jirWIo4t4YxqN-HxjqRkL) -- --- ### Contributions: +-- === -- --- * **Aaron**: Posed the idea for Group position randomization at SpawnInZone and make the Unit randomization separate from the Group randomization. --- * [**Entropy**](https://forums.eagle.ru/member.php?u=111471), **Afinegan**: Came up with the requirement for AIOnOff(). +-- ### Author: **FlightControl** +-- ### Contributions: A lot of people within this community! -- --- ### Authors: --- --- * **FlightControl**: Design & Programming +-- === -- -- @module Spawn -----BASE:TraceClass("SPAWN") - --- SPAWN Class -- @type SPAWN diff --git a/Moose Development/Moose/Core/SpawnStatic.lua b/Moose Development/Moose/Core/SpawnStatic.lua index 533c51e1f..92a816257 100644 --- a/Moose Development/Moose/Core/SpawnStatic.lua +++ b/Moose Development/Moose/Core/SpawnStatic.lua @@ -2,11 +2,11 @@ -- -- ![Banner Image](..\Presentations\SPAWNSTATIC\Dia1.JPG) -- --- ==== +-- === -- -- SPAWNSTATIC spawns static structures in your missions dynamically. See below the SPAWNSTATIC class documentation. -- --- ==== +-- === -- -- # Demo Missions -- @@ -16,18 +16,18 @@ -- -- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) -- --- ==== +-- === -- -- # YouTube Channel -- -- ### [SPAWNSTATIC YouTube Channel]() -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module SpawnStatic diff --git a/Moose Development/Moose/Core/Spot.lua b/Moose Development/Moose/Core/Spot.lua index 38ed1d583..10edb6cee 100644 --- a/Moose Development/Moose/Core/Spot.lua +++ b/Moose Development/Moose/Core/Spot.lua @@ -2,7 +2,7 @@ -- -- ![Banner Image](..\Presentations\SPOT\Dia1.JPG) -- --- ==== +-- === -- -- SPOT implements the DCS Spot class functionality, but adds additional luxury to be able to: -- @@ -11,7 +11,7 @@ -- * Provide a @{Unit} as a target, instead of a point. -- * Implement a status machine, LaseOn, LaseOff. -- --- ==== +-- === -- -- # Demo Missions -- @@ -21,22 +21,22 @@ -- -- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) -- --- ==== +-- === -- -- # YouTube Channel -- -- ### [SPOT YouTube Channel]() -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- -- * [**Ciribob**](https://forums.eagle.ru/member.php?u=112175): Showing the way how to lase targets + how laser codes work!!! Explained the autolase script. -- * [**EasyEB**](https://forums.eagle.ru/member.php?u=112055): Ideas and Beta Testing -- * [**Wingthor**](https://forums.eagle.ru/member.php?u=123698): Beta Testing -- --- ==== +-- === -- -- @module Spot diff --git a/Moose Development/Moose/Core/UserFlag.lua b/Moose Development/Moose/Core/UserFlag.lua index 3c11718da..05fc7b29e 100644 --- a/Moose Development/Moose/Core/UserFlag.lua +++ b/Moose Development/Moose/Core/UserFlag.lua @@ -1,14 +1,14 @@ --- **Core (WIP)** -- Manage user flags. -- --- ==== +-- === -- -- Management of DCS User Flags. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- --- ==== +-- === -- -- @module UserFlag diff --git a/Moose Development/Moose/Core/UserSound.lua b/Moose Development/Moose/Core/UserSound.lua index ff1c316c8..808b78a5f 100644 --- a/Moose Development/Moose/Core/UserSound.lua +++ b/Moose Development/Moose/Core/UserSound.lua @@ -1,14 +1,14 @@ --- **Core (WIP)** -- Manage user sound. -- --- ==== +-- === -- -- Management of DCS User Sound. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- --- ==== +-- === -- -- @module UserSound diff --git a/Moose Development/Moose/Core/Velocity.lua b/Moose Development/Moose/Core/Velocity.lua index 964d67577..88d047126 100644 --- a/Moose Development/Moose/Core/Velocity.lua +++ b/Moose Development/Moose/Core/Velocity.lua @@ -2,10 +2,10 @@ -- -- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module Velocity diff --git a/Moose Development/Moose/Core/Zone.lua b/Moose Development/Moose/Core/Zone.lua index 618d49ec5..72317d2ba 100644 --- a/Moose Development/Moose/Core/Zone.lua +++ b/Moose Development/Moose/Core/Zone.lua @@ -2,7 +2,7 @@ -- -- ![Banner Image](..\Presentations\ZONE\Dia1.JPG) -- --- ==== +-- === -- -- There are essentially two core functions that zones accomodate: -- @@ -27,12 +27,12 @@ -- * @{#ZONE_GROUP}: The ZONE_GROUP class defines by a zone around a @{Group#GROUP} with a radius. -- * @{#ZONE_POLYGON}: The ZONE_POLYGON class defines by a sequence of @{Group#GROUP} waypoints within the Mission Editor, forming a polygon. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module Zone diff --git a/Moose Development/Moose/Functional/CleanUp.lua b/Moose Development/Moose/Functional/CleanUp.lua index 50c3851f1..016bb10ef 100644 --- a/Moose Development/Moose/Functional/CleanUp.lua +++ b/Moose Development/Moose/Functional/CleanUp.lua @@ -2,10 +2,10 @@ -- -- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: -- --- ==== +-- === -- -- @module CleanUp diff --git a/Moose Development/Moose/Functional/Detection.lua b/Moose Development/Moose/Functional/Detection.lua index bc738e2f7..7484bbd98 100644 --- a/Moose Development/Moose/Functional/Detection.lua +++ b/Moose Development/Moose/Functional/Detection.lua @@ -9,7 +9,7 @@ -- -- Find the DETECTION classes documentation further in this document in the globals section. -- --- ==== +-- === -- -- # Demo Missions -- @@ -19,13 +19,13 @@ -- -- ### [ALL Demo Missions pack of the Latest Release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) -- --- ==== +-- === -- -- # YouTube Channel -- -- ### [DETECTION YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl3Cf5jpI6BS0sBOVWK__tji) -- --- ==== +-- === -- -- ### Contributions: -- diff --git a/Moose Development/Moose/Functional/Escort.lua b/Moose Development/Moose/Functional/Escort.lua index c9b150a92..6fcddbe7c 100644 --- a/Moose Development/Moose/Functional/Escort.lua +++ b/Moose Development/Moose/Functional/Escort.lua @@ -1,9 +1,9 @@ --- **Functional** -- Taking the lead of AI escorting your flight. -- --- ==== +-- === -- -- @{#ESCORT} class --- ================ +-- === -- The @{#ESCORT} class allows you to interact with escorting AI on your flight and take the lead. -- Each escorting group can be commanded with a whole set of radio commands (radio menu in your flight, and then F10). -- @@ -11,7 +11,7 @@ -- Ships and Ground troops will have a more limited set, but they can provide support through the bombing of targets designated by the other escorts. -- -- RADIO MENUs that can be created: --- ================================ +-- === -- Find a summary below of the current available commands: -- -- Navigation ...: @@ -79,13 +79,13 @@ -- Note that this is really fantastic, as you now have the dynamic of taking control of the escort groups, and allowing them to resume their path or mission. -- -- ESCORT construction methods. --- ============================ +-- === -- Create a new SPAWN object with the @{#ESCORT.New} method: -- -- * @{#ESCORT.New}: Creates a new ESCORT object from a @{Group#GROUP} for a @{Client#CLIENT}, with an optional briefing text. -- -- ESCORT initialization methods. --- ============================== +-- === -- The following menus are created within the RADIO MENU (F10) of an active unit hosted by a player: -- -- * @{#ESCORT.MenuFollowAt}: Creates a menu to make the escort follow the client. diff --git a/Moose Development/Moose/Functional/MissileTrainer.lua b/Moose Development/Moose/Functional/MissileTrainer.lua index fd3357855..7659b3c8a 100644 --- a/Moose Development/Moose/Functional/MissileTrainer.lua +++ b/Moose Development/Moose/Functional/MissileTrainer.lua @@ -3,7 +3,7 @@ -- === -- -- 1) @{MissileTrainer#MISSILETRAINER} class, extends @{Base#BASE} --- =============================================================== +-- === -- The @{#MISSILETRAINER} class uses the DCS world messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft, -- the class will destroy the missile within a certain range, to avoid damage to your aircraft. -- It suports the following functionality: @@ -71,7 +71,7 @@ -- === -- -- CREDITS --- ======= +-- === -- **Stuka (Danny)** Who you can search on the Eagle Dynamics Forums. -- Working together with Danny has resulted in the MISSILETRAINER class. -- Danny has shared his ideas and together we made a design. diff --git a/Moose Development/Moose/Functional/Movement.lua b/Moose Development/Moose/Functional/Movement.lua index 69317c9e5..a5d4d7058 100644 --- a/Moose Development/Moose/Functional/Movement.lua +++ b/Moose Development/Moose/Functional/Movement.lua @@ -1,6 +1,6 @@ --- **Functional** -- Limit the MOVEMENT of simulaneous moving ground vehicles. -- --- ==== +-- === -- -- Limit the simultaneous movement of Groups within a running Mission. -- This module is defined to improve the performance in missions, and to bring additional realism for GROUND vehicles. diff --git a/Moose Development/Moose/Functional/Protect.lua b/Moose Development/Moose/Functional/Protect.lua index 6fe73e54a..f0f2ef260 100644 --- a/Moose Development/Moose/Functional/Protect.lua +++ b/Moose Development/Moose/Functional/Protect.lua @@ -2,10 +2,10 @@ -- -- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- ### Contributions: **MillerTime** -- --- ==== +-- === -- -- @module Protect diff --git a/Moose Development/Moose/Functional/RAT.lua b/Moose Development/Moose/Functional/RAT.lua index b73c53820..04da94f98 100644 --- a/Moose Development/Moose/Functional/RAT.lua +++ b/Moose Development/Moose/Functional/RAT.lua @@ -1,9 +1,11 @@ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ---- **Functional** - Create random airtraffic in your missions. --- +--- **Functional** - (R2.2) - Create random airtraffic in your missions. +-- +-- === +-- -- ![Banner Image](..\Presentations\RAT\RAT.png) -- --- ==== +-- === -- -- The aim of the RAT class is to fill the empty DCS world with randomized air traffic and bring more life to your airports. -- @@ -36,14 +38,14 @@ -- -- More of the documentation include some simple examples can be found further down this page. -- --- ==== +-- === -- -- # Demo Missions -- -- ### [RAT Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/Release/RAT%20-%20Random%20Air%20Traffic) -- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) -- --- ==== +-- === -- -- # YouTube Channel -- @@ -56,7 +58,7 @@ -- -- ### Contributions: **Sven van de Velde ([FlightControl](https://forums.eagle.ru/member.php?u=89536))** -- --- ==== +-- === -- @module Rat ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- diff --git a/Moose Development/Moose/Functional/Range.lua b/Moose Development/Moose/Functional/Range.lua index e167bd7c9..5108d13e8 100644 --- a/Moose Development/Moose/Functional/Range.lua +++ b/Moose Development/Moose/Functional/Range.lua @@ -1,9 +1,11 @@ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ---- **Functional** - Range Practice. +--- **Functional** - (R2.3) - Range Practice. -- +-- === +-- -- ![Banner Image](..\Presentations\RANGE\RANGE_Main.png) -- --- ==== +-- === -- -- The RANGE class enables easy set up of bombing and strafing ranges within DCS World. -- @@ -24,13 +26,13 @@ -- -- More information and examples can be found below. -- --- ==== +-- === -- -- # Demo Missions -- -- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) -- --- ==== +-- === -- -- # YouTube Channel -- @@ -42,7 +44,7 @@ -- -- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536), [Ciribob](https://forums.eagle.ru/member.php?u=112175) -- --- ==== +-- === -- @module Range ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- diff --git a/Moose Development/Moose/Functional/Scoring.lua b/Moose Development/Moose/Functional/Scoring.lua index ed233a409..cab7839ae 100644 --- a/Moose Development/Moose/Functional/Scoring.lua +++ b/Moose Development/Moose/Functional/Scoring.lua @@ -1,5 +1,6 @@ ---- **Functional** -- **Administer the SCORING of player achievements, --- and create a CSV file logging the scoring events for use at team or squadron websites.** +--- **Functional** -- (R2.0) - Administer the scoring of player achievements, and create a CSV file logging the scoring events for use at team or squadron websites. +-- +-- === -- -- ![Banner Image](..\Presentations\SCORING\Dia1.JPG) -- @@ -178,7 +179,7 @@ -- * @{#SCORING.SetMessagesToCoalition}(): Configure to send messages to only those players within the same coalition as the player. -- -- --- ==== +-- === -- -- # **API CHANGE HISTORY** -- diff --git a/Moose Development/Moose/Functional/Sead.lua b/Moose Development/Moose/Functional/Sead.lua index cd176650f..f1a18b8df 100644 --- a/Moose Development/Moose/Functional/Sead.lua +++ b/Moose Development/Moose/Functional/Sead.lua @@ -1,6 +1,6 @@ --- **Functional** -- Provides defensive behaviour to a set of SAM sites within a running Mission. -- --- ==== +-- === -- -- @module Sead diff --git a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua index b2954d575..b0d6d6912 100644 --- a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua +++ b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua @@ -1,15 +1,25 @@ ---- **Functional** -- (WIP R2.3) Models the process to capture a Zone for a Coalition, which is guarded by another Coalition. +--- **Functional** -- (R2.3) Models the process to zone guarding and capturing. -- --- ==== +-- === -- -- ![Banner Image](..\Presentations\ZONE_CAPTURE_COALITION\Dia1.JPG) -- -- === -- --- ### Contributions: **Millertime**: Concept --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAZ%20-%20Capture Zones) -- --- ==== +-- - CAZ-000 - Capture Zone: Demonstrates the basic concept of capturing a zone. +-- +-- === +-- +-- ### [YouTube Playlist](https://www.youtube.com/watch?v=0m6K6Yxa-os&list=PL7ZUrU4zZUl0qqJsfa8DPvZWDY-OyDumE) +-- +-- === +-- +-- ### Author: **FlightControl** +-- ### Contributions: **Millertime** - Concept +-- +-- === -- -- @module ZoneCaptureCoalition diff --git a/Moose Development/Moose/Functional/ZoneGoal.lua b/Moose Development/Moose/Functional/ZoneGoal.lua index 436b00db8..5bca12a4e 100644 --- a/Moose Development/Moose/Functional/ZoneGoal.lua +++ b/Moose Development/Moose/Functional/ZoneGoal.lua @@ -1,15 +1,15 @@ --- **Functional (WIP)** -- Base class that models processes to achieve goals involving a Zone. -- --- ==== +-- === -- -- ZONE_GOAL models processes that have a Goal with a defined achievement involving a Zone. -- Derived classes implement the ways how the achievements can be realized. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- --- ==== +-- === -- -- @module ZoneGoal diff --git a/Moose Development/Moose/Functional/ZoneGoalCargo.lua b/Moose Development/Moose/Functional/ZoneGoalCargo.lua index 3fc0d5e8b..e5ea44310 100644 --- a/Moose Development/Moose/Functional/ZoneGoalCargo.lua +++ b/Moose Development/Moose/Functional/ZoneGoalCargo.lua @@ -1,15 +1,15 @@ --- **Functional (WIP)** -- Base class that models processes to achieve goals involving a Zone and Cargo. -- --- ==== +-- === -- -- ZONE_GOAL_CARGO models processes that have a Goal with a defined achievement involving a Zone and Cargo. -- Derived classes implement the ways how the achievements can be realized. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- --- ==== +-- === -- -- @module ZoneGoalCargo diff --git a/Moose Development/Moose/Functional/ZoneGoalCoalition.lua b/Moose Development/Moose/Functional/ZoneGoalCoalition.lua index 0b31b8494..91c7df0dc 100644 --- a/Moose Development/Moose/Functional/ZoneGoalCoalition.lua +++ b/Moose Development/Moose/Functional/ZoneGoalCoalition.lua @@ -1,15 +1,15 @@ --- **Functional (WIP)** -- Base class that models processes to achieve goals involving a Zone for a Coalition. -- --- ==== +-- === -- -- ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition. -- Derived classes implement the ways how the achievements can be realized. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- --- ==== +-- === -- -- @module ZoneGoalCoalition diff --git a/Moose Development/Moose/Tasking/CommandCenter.lua b/Moose Development/Moose/Tasking/CommandCenter.lua index d949f4763..2aa6317a6 100644 --- a/Moose Development/Moose/Tasking/CommandCenter.lua +++ b/Moose Development/Moose/Tasking/CommandCenter.lua @@ -3,11 +3,11 @@ -- -- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module CommandCenter diff --git a/Moose Development/Moose/Tasking/DetectionManager.lua b/Moose Development/Moose/Tasking/DetectionManager.lua index e2816dbba..6252dc0a4 100644 --- a/Moose Development/Moose/Tasking/DetectionManager.lua +++ b/Moose Development/Moose/Tasking/DetectionManager.lua @@ -3,7 +3,7 @@ -- === -- -- 1) @{DetectionManager#DETECTION_MANAGER} class, extends @{Fsm#FSM} --- ==================================================================== +-- === -- The @{DetectionManager#DETECTION_MANAGER} class defines the core functions to report detected objects to groups. -- Reportings can be done in several manners, and it is up to the derived classes if DETECTION_MANAGER to model the reporting behaviour. -- @@ -27,7 +27,7 @@ -- === -- -- 2) @{DetectionManager#DETECTION_REPORTING} class, extends @{DetectionManager#DETECTION_MANAGER} --- ========================================================================================= +-- === -- The @{DetectionManager#DETECTION_REPORTING} class implements detected units reporting. Reporting can be controlled using the reporting methods available in the @{DetectionManager#DETECTION_MANAGER} class. -- -- 2.1) DETECTION_REPORTING constructor: diff --git a/Moose Development/Moose/Tasking/Mission.lua b/Moose Development/Moose/Tasking/Mission.lua index 897180d16..6b2fe4df5 100644 --- a/Moose Development/Moose/Tasking/Mission.lua +++ b/Moose Development/Moose/Tasking/Mission.lua @@ -1,8 +1,8 @@ --- **Tasking** -- A MISSION is the main owner of a Mission orchestration within MOOSE. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- diff --git a/Moose Development/Moose/Tasking/Task.lua b/Moose Development/Moose/Tasking/Task.lua index 22a02fe82..7f8841095 100644 --- a/Moose Development/Moose/Tasking/Task.lua +++ b/Moose Development/Moose/Tasking/Task.lua @@ -1,12 +1,12 @@ --- **Tasking** -- This module contains the TASK class, the main engine to run human taskings. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module Task diff --git a/Moose Development/Moose/Tasking/TaskInfo.lua b/Moose Development/Moose/Tasking/TaskInfo.lua index df0160747..bf75bcf5a 100644 --- a/Moose Development/Moose/Tasking/TaskInfo.lua +++ b/Moose Development/Moose/Tasking/TaskInfo.lua @@ -1,12 +1,12 @@ --- **Tasking** -- Controls the information of a Task. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module TaskInfo diff --git a/Moose Development/Moose/Tasking/TaskZoneCapture.lua b/Moose Development/Moose/Tasking/TaskZoneCapture.lua index e897e0e2e..fd5934dfd 100644 --- a/Moose Development/Moose/Tasking/TaskZoneCapture.lua +++ b/Moose Development/Moose/Tasking/TaskZoneCapture.lua @@ -1,12 +1,12 @@ --- **Tasking** - The TASK_Protect models tasks for players to protect or capture specific zones. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: MillerTime -- --- ==== +-- === -- -- @module TaskZoneCapture diff --git a/Moose Development/Moose/Tasking/Task_A2A.lua b/Moose Development/Moose/Tasking/Task_A2A.lua index cd6f74022..4db992c40 100644 --- a/Moose Development/Moose/Tasking/Task_A2A.lua +++ b/Moose Development/Moose/Tasking/Task_A2A.lua @@ -1,12 +1,12 @@ --- **Tasking** - The TASK_A2A models tasks for players in Air to Air engagements. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module Task_A2A diff --git a/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua b/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua index ce227ce24..18d48e9e4 100644 --- a/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua +++ b/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua @@ -2,13 +2,13 @@ -- -- The @{#TASK_A2A_DISPATCHER} classes implement the dynamic dispatching of tasks upon groups of detected units determined a @{Set} of EWR installation groups. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module Task_A2A_Dispatcher diff --git a/Moose Development/Moose/Tasking/Task_A2G.lua b/Moose Development/Moose/Tasking/Task_A2G.lua index c9737759a..6ecb4ce78 100644 --- a/Moose Development/Moose/Tasking/Task_A2G.lua +++ b/Moose Development/Moose/Tasking/Task_A2G.lua @@ -1,12 +1,12 @@ --- **Tasking** - The TASK_A2G models tasks for players in Air to Ground engagements. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module Task_A2G diff --git a/Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua b/Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua index 9b435c10e..d47aa8b95 100644 --- a/Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua +++ b/Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua @@ -1,12 +1,12 @@ --- **Tasking** - The TASK\_A2G\_DISPATCHER dispatches A2G Tasks to Players based on enemy location detection. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module Task_A2G_Dispatcher diff --git a/Moose Development/Moose/Tasking/Task_CARGO.lua b/Moose Development/Moose/Tasking/Task_CARGO.lua index a138e2a0f..7d11cae8d 100644 --- a/Moose Development/Moose/Tasking/Task_CARGO.lua +++ b/Moose Development/Moose/Tasking/Task_CARGO.lua @@ -2,7 +2,7 @@ -- -- ![Banner Image](..\Presentations\TASK_CARGO\Dia1.JPG) -- --- ==== +-- === -- -- The Moose framework provides various CARGO classes that allow DCS phisical or logical objects to be transported or sling loaded by Carriers. -- The CARGO_ classes, as part of the moose core, are able to Board, Load, UnBoard and UnLoad cargo between Carrier units. @@ -14,13 +14,13 @@ -- -- * @{#TASK_CARGO_TRANSPORT}: Defines a task for a human player to transport a set of cargo between various zones. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module Task_Cargo diff --git a/Moose Development/Moose/Tasking/Task_Pickup.lua b/Moose Development/Moose/Tasking/Task_Pickup.lua index 0e1b103c5..459f9f4a2 100644 --- a/Moose Development/Moose/Tasking/Task_Pickup.lua +++ b/Moose Development/Moose/Tasking/Task_Pickup.lua @@ -1,7 +1,7 @@ --- This module contains the TASK_PICKUP classes. -- -- 1) @{#TASK_PICKUP} class, extends @{Task#TASK} --- =================================================== +-- === -- The @{#TASK_PICKUP} class defines a pickup task of a @{Set} of @{CARGO} objects defined within the mission. -- based on the tasking capabilities defined in @{Task#TASK}. -- The TASK_PICKUP is implemented using a @{Statemachine#FSM_TASK}, and has the following statuses: diff --git a/Moose Development/Moose/Wrapper/Airbase.lua b/Moose Development/Moose/Wrapper/Airbase.lua index 13ee83ab1..e6db9284c 100644 --- a/Moose Development/Moose/Wrapper/Airbase.lua +++ b/Moose Development/Moose/Wrapper/Airbase.lua @@ -1,8 +1,8 @@ --- **Wrapper** -- AIRBASE is a wrapper class to handle the DCS Airbase objects. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- diff --git a/Moose Development/Moose/Wrapper/Client.lua b/Moose Development/Moose/Wrapper/Client.lua index 3b20fb754..71e2066cb 100644 --- a/Moose Development/Moose/Wrapper/Client.lua +++ b/Moose Development/Moose/Wrapper/Client.lua @@ -1,8 +1,8 @@ --- **Wrapper** -- CLIENT wraps DCS Unit objects acting as a __Client__ or __Player__ within a mission. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- diff --git a/Moose Development/Moose/Wrapper/Controllable.lua b/Moose Development/Moose/Wrapper/Controllable.lua index 90e11151d..fe3d1378d 100644 --- a/Moose Development/Moose/Wrapper/Controllable.lua +++ b/Moose Development/Moose/Wrapper/Controllable.lua @@ -1,8 +1,8 @@ --- **Wrapper** -- CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers". -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- diff --git a/Moose Development/Moose/Wrapper/Group.lua b/Moose Development/Moose/Wrapper/Group.lua index 5c9e48b87..f46c2701b 100644 --- a/Moose Development/Moose/Wrapper/Group.lua +++ b/Moose Development/Moose/Wrapper/Group.lua @@ -13,15 +13,15 @@ -- -- See the detailed documentation on the GROUP class. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- -- * [**Entropy**](https://forums.eagle.ru/member.php?u=111471), **Afinegan**: Came up with the requirement for AIOnOff(). -- --- ==== +-- === -- -- @module Group diff --git a/Moose Development/Moose/Wrapper/Identifiable.lua b/Moose Development/Moose/Wrapper/Identifiable.lua index fe14a8b9d..baa83eedb 100644 --- a/Moose Development/Moose/Wrapper/Identifiable.lua +++ b/Moose Development/Moose/Wrapper/Identifiable.lua @@ -1,12 +1,12 @@ --- **Wrapper** -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module Identifiable diff --git a/Moose Development/Moose/Wrapper/Object.lua b/Moose Development/Moose/Wrapper/Object.lua index a8fcdfe0c..fc3c11126 100644 --- a/Moose Development/Moose/Wrapper/Object.lua +++ b/Moose Development/Moose/Wrapper/Object.lua @@ -1,8 +1,8 @@ --- **Wrapper** -- OBJECT wraps the DCS Object derived objects. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- diff --git a/Moose Development/Moose/Wrapper/Positionable.lua b/Moose Development/Moose/Wrapper/Positionable.lua index f901be0e2..5a7f064c4 100644 --- a/Moose Development/Moose/Wrapper/Positionable.lua +++ b/Moose Development/Moose/Wrapper/Positionable.lua @@ -1,12 +1,12 @@ --- **Wrapper** -- POSITIONABLE wraps DCS classes that are "positionable". -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module Positionable diff --git a/Moose Development/Moose/Wrapper/Scenery.lua b/Moose Development/Moose/Wrapper/Scenery.lua index d0d5215dd..e999917b1 100644 --- a/Moose Development/Moose/Wrapper/Scenery.lua +++ b/Moose Development/Moose/Wrapper/Scenery.lua @@ -1,12 +1,12 @@ --- **Wrapper** -- SCENERY models scenery within the DCS simulator. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module Scenery diff --git a/Moose Development/Moose/Wrapper/Static.lua b/Moose Development/Moose/Wrapper/Static.lua index 1a76a869a..28e7c364b 100644 --- a/Moose Development/Moose/Wrapper/Static.lua +++ b/Moose Development/Moose/Wrapper/Static.lua @@ -1,12 +1,12 @@ --- **Wrapper** -- STATIC wraps the DCS StaticObject class. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module Static diff --git a/Moose Development/Moose/Wrapper/Unit.lua b/Moose Development/Moose/Wrapper/Unit.lua index 76f4567ab..26d30ed91 100644 --- a/Moose Development/Moose/Wrapper/Unit.lua +++ b/Moose Development/Moose/Wrapper/Unit.lua @@ -9,13 +9,13 @@ -- * Handle local Unit Controller. -- * Manage the "state" of the DCS Unit. -- --- ==== +-- === -- --- ### Author: **Sven Van de Velde (FlightControl)** +-- ### Author: **FlightControl** -- -- ### Contributions: -- --- ==== +-- === -- -- @module Unit