| DATABASE.AlivePlayers |
@@ -299,76 +371,11 @@
-
-
- Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.
-
+
-Mission designers can use the DATABASE class to build sets of units belonging to certain:
-
-
- - Coalitions
- - Categories
- - Countries
- - Unit types
- - Starting with certain prefix strings.
-
-
- This list will grow over time. Planned developments are to include filters and iterators.
- Additional filters will be added around Zone#ZONEs, Radiuses, Active players, ...
- More iterators will be implemented in the near future ...
-
-DATABASE construction methods:
-Create a new DATABASE object with the DATABASE.New method:
-
-
-
-
-DATABASE filter criteria:
-You can set filter criteria to define the set of units within the database.
-Filter criteria are defined by:
-
-
-
-Once the filter criteria have been set for the DATABASE, you can start filtering using:
-
-
-
-Planned filter criteria within development are (so these are not yet available):
-
-
-
-
-DATABASE iterators:
-Once the filters have been defined and the DATABASE has been built, you can iterate the database with the available iterator methods.
-The iterator methods will walk the DATABASE set, and call for each element within the set a function that you provide.
-The following iterator methods are currently available within the DATABASE:
-
-
-
-Planned iterators methods in development are (so these are not yet available):
-
-
-
+
+
+DATABASE class
Field(s)
diff --git a/Documentation/Escort.html b/Documentation/Escort.html
index e5305361f..d38a27767 100644
--- a/Documentation/Escort.html
+++ b/Documentation/Escort.html
@@ -21,7 +21,6 @@
CARGO
CleanUp
Client
- DATABASE
DCSAirbase
DCSCoalitionObject
DCSCommand
@@ -38,6 +37,7 @@
DESTROYGROUPSTASK
DESTROYRADARSTASK
DESTROYUNITTYPESTASK
+ Database
Escort
Event
GOHOMETASK
@@ -68,15 +68,19 @@
Taking the lead of AI escorting your flight.
-The ESCORT class allows you to interact with escorting AI on your flight and take the lead.
+
+
+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).
The radio commands will vary according the category of the group. The richest set of commands are with Helicopters and AirPlanes.
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:
-1. Navigation ...: Escort group navigation functions:
+Navigation ...:
+Escort group navigation functions:
- "Join-Up and Follow at x meters": The escort group fill follow you at about x meters, and they will follow you.
@@ -84,14 +88,16 @@ Ships and Ground troops will have a more limited set, but they can provide suppo
- "Smoke": Provides menu commands to let the escort group smoke the air in a color. Note that smoking is only available for ground and naval troops.
-2. Hold position ...: Escort group navigation functions:
+Hold position ...:
+Escort group navigation functions:
- "At current location": Stops the escort group and they will hover 30 meters above the ground at the position they stopped.
- "At client location": Stops the escort group and they will hover 30 meters above the ground at the position they stopped.
-3. Report targets ...: Report targets will make the escort group to report any target that it identifies within a 8km range. Any detected target can be attacked using the 4. Attack nearby targets function. (see below).
+Report targets ...:
+Report targets will make the escort group to report any target that it identifies within a 8km range. Any detected target can be attacked using the 4. Attack nearby targets function. (see below).
- "Report now": Will report the current detected targets.
@@ -99,21 +105,25 @@ Ships and Ground troops will have a more limited set, but they can provide suppo
- "Report targets off": Will stop detecting targets.
-4. Scan targets ...: Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or defined task.
+Scan targets ...:
+Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or defined task.
- "Scan targets 30 seconds": Scan 30 seconds for targets.
- "Scan targets 60 seconds": Scan 60 seconds for targets.
-5. Attack targets ...: This menu item will list all detected targets within a 15km range. Depending on the level of detection (known/unknown) and visuality, the targets type will also be listed.
+Attack targets ...:
+This menu item will list all detected targets within a 15km range. Depending on the level of detection (known/unknown) and visuality, the targets type will also be listed.
-6. Request assistance from ...: This menu item will list all detected targets within a 15km range, as with the menu item Attack Targets.
+ Request assistance from ...:
+This menu item will list all detected targets within a 15km range, as with the menu item Attack Targets.
This menu item allows to request attack support from other escorts supporting the current client group.
eg. the function allows a player to request support from the Ship escort to attack a target identified by the Plane escort with its Tomahawk missiles.
eg. the function allows a player to request support from other Planes escorting to bomb the unit with illumination missiles or bombs, so that the main plane escort can attack the area.
-7. ROE ...: Defines the Rules of Engagement of the escort group when in flight.
+ROE ...:
+Sets the Rules of Engagement (ROE) of the escort group when in flight.
- "Hold Fire": The escort group will hold fire.
@@ -122,7 +132,8 @@ eg. the function allows a player to request support from other Planes escorting
- "Weapon Free": The escort group will engage with any target.
-8. Evasion ...: Will define the evasion techniques that the escort group will perform during flight or combat.
+Evasion ...:
+Will define the evasion techniques that the escort group will perform during flight or combat.
- "Fight until death": The escort group will have no reaction to threats.
@@ -131,27 +142,31 @@ eg. the function allows a player to request support from other Planes escorting
- "Go below radar and evade fire": The escort group will perform evasive vertical manoeuvres.
-9. Resume Mission ...: Escort groups can have their own mission. This menu item will allow the escort group to resume their Mission from a given waypoint.
+ Resume Mission ...:
+Escort groups can have their own mission. This menu item will allow the escort group to resume their Mission from a given waypoint.
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.
-10. Abort Current Task: Cancel the current task and rejoin formation.
+ESCORT construction methods.
+Create a new SPAWN object with the ESCORT.New method:
-
- ESCORT object 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 object initialization methods.
- The following menus can be setup: ESCORT.MenuFollowAt: Creates a menu to make the escort follow the client. ESCORT.MenuHoldAtEscortPosition: Creates a menu to hold the escort at its current position. ESCORT.MenuHoldAtLeaderPosition: Creates a menu to hold the escort at the client position. ESCORT.MenuScanForTargets: Creates a menu so that the escort scans targets. ESCORT.MenuFlare: Creates a menu to disperse flares. ESCORT.MenuSmoke: Creates a menu to disparse smoke. ESCORT.MenuReportTargets: Creates a menu so that the escort reports targets. ESCORT.MenuReportPosition: Creates a menu so that the escort reports its current position from bullseye. ESCORT.MenuAssistedAttack: Creates a menu structure so that the escort can resume from a waypoint.
+
+
+ESCORT initialization methods.
+The following menus are created within the RADIO MENU of an active unit hosted by a player:
+
+
Global(s)
@@ -720,10 +735,7 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
-
-ESCORT class
-
- Field(s)
+ Field(s)
-
@@ -1835,6 +1847,7 @@ self
-
+
ESCORT.ReportTargetsScheduler
diff --git a/Documentation/Event.html b/Documentation/Event.html
index 50ed86fc5..eaa58b863 100644
--- a/Documentation/Event.html
+++ b/Documentation/Event.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/GOHOMETASK.html b/Documentation/GOHOMETASK.html
index dc2a4b028..b1ebecdcd 100644
--- a/Documentation/GOHOMETASK.html
+++ b/Documentation/GOHOMETASK.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/Group.html b/Documentation/Group.html
index c260ae21d..3298e9321 100644
--- a/Documentation/Group.html
+++ b/Documentation/Group.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/MISSION.html b/Documentation/MISSION.html
index f320ff531..81752775f 100644
--- a/Documentation/MISSION.html
+++ b/Documentation/MISSION.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/MOVEMENT.html b/Documentation/MOVEMENT.html
index bf2539324..1fd0bfce1 100644
--- a/Documentation/MOVEMENT.html
+++ b/Documentation/MOVEMENT.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/Menu.html b/Documentation/Menu.html
index 744da29a2..a82742975 100644
--- a/Documentation/Menu.html
+++ b/Documentation/Menu.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/Message.html b/Documentation/Message.html
index 2141cc4dc..66c9d6c91 100644
--- a/Documentation/Message.html
+++ b/Documentation/Message.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/NOTASK.html b/Documentation/NOTASK.html
index 44017a343..4fa604429 100644
--- a/Documentation/NOTASK.html
+++ b/Documentation/NOTASK.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/PICKUPTASK.html b/Documentation/PICKUPTASK.html
index 0a5e99486..e9fcbf698 100644
--- a/Documentation/PICKUPTASK.html
+++ b/Documentation/PICKUPTASK.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/ROUTETASK.html b/Documentation/ROUTETASK.html
index 6d7554c75..87dc106be 100644
--- a/Documentation/ROUTETASK.html
+++ b/Documentation/ROUTETASK.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/STAGE.html b/Documentation/STAGE.html
index 2e49e72dd..bc38980e4 100644
--- a/Documentation/STAGE.html
+++ b/Documentation/STAGE.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/Scoring.html b/Documentation/Scoring.html
index 4e4180ae7..b70b673fb 100644
--- a/Documentation/Scoring.html
+++ b/Documentation/Scoring.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/Sead.html b/Documentation/Sead.html
index 84d17c60e..95c47ee9e 100644
--- a/Documentation/Sead.html
+++ b/Documentation/Sead.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/Spawn.html b/Documentation/Spawn.html
index 770a35c22..cef33f470 100644
--- a/Documentation/Spawn.html
+++ b/Documentation/Spawn.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
@@ -68,7 +68,9 @@
Dynamic spawning of groups (and units).
-The SPAWN class allows to spawn dynamically new groups, based on pre-defined initialization settings, modifying the behaviour when groups are spawned.
+
+
+The #SPAWN class allows to spawn dynamically new groups, based on pre-defined initialization settings, modifying the behaviour when groups are spawned.
For each group to be spawned, within the mission editor, a group has to be created with the "late activation flag" set. We call this group the "Spawn Template" of the SPAWN object.
A reference to this Spawn Template needs to be provided when constructing the SPAWN object, by indicating the name of the group within the mission editor in the constructor methods.
@@ -142,6 +144,7 @@ In such a case, when the inactive group is cleaned, a new group will Re-spawned
This models AI that has succesfully returned to their airbase, to restart their combat activities.
Check the SPAWN.CleanUp for further info.
+
Global(s)
diff --git a/Documentation/StaticObject.html b/Documentation/StaticObject.html
index aa4f9fe4e..9f6847026 100644
--- a/Documentation/StaticObject.html
+++ b/Documentation/StaticObject.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/TASK.html b/Documentation/TASK.html
index a8215456d..bc244726c 100644
--- a/Documentation/TASK.html
+++ b/Documentation/TASK.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/Unit.html b/Documentation/Unit.html
index ed1a6112c..985e6a1e7 100644
--- a/Documentation/Unit.html
+++ b/Documentation/Unit.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/Zone.html b/Documentation/Zone.html
index 15939e2e1..1b9c3cb4b 100644
--- a/Documentation/Zone.html
+++ b/Documentation/Zone.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/env.html b/Documentation/env.html
index ddd05da06..959ef7350 100644
--- a/Documentation/env.html
+++ b/Documentation/env.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/index.html b/Documentation/index.html
index d6bdc643a..0464d0694 100644
--- a/Documentation/index.html
+++ b/Documentation/index.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
@@ -68,7 +68,7 @@
| Base |
- The BASE class for all the classes defined within MOOSE.
+BASE classes.
|
@@ -87,12 +87,6 @@
| Client |
The CLIENT models client units in multi player missions.
- |
-
-
- | DATABASE |
-
-
|
@@ -189,6 +183,12 @@
| DESTROYUNITTYPESTASK |
Set TASK to destroy certain unit types.
+ |
+
+
+ | Database |
+
+ Manage sets of units and groups.
|
diff --git a/Documentation/land.html b/Documentation/land.html
index 091a8e0ae..5399503ee 100644
--- a/Documentation/land.html
+++ b/Documentation/land.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Documentation/routines.html b/Documentation/routines.html
index 0318b5608..d33caf801 100644
--- a/Documentation/routines.html
+++ b/Documentation/routines.html
@@ -21,7 +21,6 @@
- CARGO
- CleanUp
- Client
- - DATABASE
- DCSAirbase
- DCSCoalitionObject
- DCSCommand
@@ -38,6 +37,7 @@
- DESTROYGROUPSTASK
- DESTROYRADARSTASK
- DESTROYUNITTYPESTASK
+ - Database
- Escort
- Event
- GOHOMETASK
diff --git a/Moose/Base.lua b/Moose/Base.lua
index fe6affc98..3eb5acd45 100644
--- a/Moose/Base.lua
+++ b/Moose/Base.lua
@@ -1,4 +1,55 @@
---- The BASE class for all the classes defined within MOOSE.
+--- BASE classes.
+--
+-- @{#BASE} class
+-- ==============
+-- The @{#BASE} class is the super class for most of the classes defined within MOOSE.
+--
+-- It handles:
+--
+-- * The construction and inheritance of child classes.
+-- * The tracing of objects during mission execution within the DCS.log file (under saved games folder).
+--
+-- Note: Normally you would not use the BASE class unless you are extending the MOOSE framework with new classes.
+--
+-- BASE Trace functionality
+-- ========================
+-- The BASE class contains trace methods to trace progress within a mission execution of a certain object.
+-- Note that these trace methods are inherited by each MOOSE class interiting BASE.
+-- As such, each object created from derived class from BASE can use the tracing functions to trace its execution.
+--
+-- Trace a function call
+-- ---------------------
+-- There are basically 3 types of tracing methods available within BASE:
+--
+-- * @{#BASE.F}: Trace the beginning of a function and its given parameters.
+-- * @{#BASE.T}: Trace further logic within a function giving optional variables or parameters.
+-- * @{#BASE.E}: Trace an execption within a function giving optional variables or parameters. An exception will always be traced.
+--
+-- Tracing levels
+-- --------------
+-- There are 3 tracing levels within MOOSE.
+-- These tracing levels were defined to avoid bulks of tracing to be generated by lots of objects.
+--
+-- As such, the F and T methods have additional variants to trace level 2 and 3 respectively:
+--
+-- * @{#BASE.F2}: Trace the beginning of a function and its given parameters with tracing level 2.
+-- * @{#BASE.F3}: Trace the beginning of a function and its given parameters with tracing level 3.
+-- * @{#BASE.T2}: Trace further logic within a function giving optional variables or parameters with tracing level 2.
+-- * @{#BASE.T3}: Trace further logic within a function giving optional variables or parameters with tracing level 3.
+--
+-- BASE Inheritance support
+-- ========================
+-- The following methods are available to support inheritance:
+--
+-- * @{#BASE.Inherit}: Inherits from a class.
+-- * @{#BASE.Inherited}: Returns the parent class from the class.
+--
+-- Future
+-- ======
+-- Further methods may be added to BASE whenever there is a need to make "overall" functions available within MOOSE.
+--
+-- ====
+--
-- @module Base
-- @author FlightControl
diff --git a/Moose/Database.lua b/Moose/Database.lua
index 109566d2f..a0c915eda 100644
--- a/Moose/Database.lua
+++ b/Moose/Database.lua
@@ -1,15 +1,7 @@
----
--- @module DATABASE
--- @author FlightControl
-
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Menu" )
-Include.File( "Group" )
-Include.File( "Event" )
-
----
--- Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.
+--- Manage sets of units and groups.
+--
+-- @{#Database} class
+-- ==================
-- Mission designers can use the DATABASE class to build sets of units belonging to certain:
--
-- * Coalitions
@@ -18,9 +10,11 @@ Include.File( "Event" )
-- * Unit types
-- * Starting with certain prefix strings.
--
--- This list will grow over time. Planned developments are to include filters and iterators.
--- Additional filters will be added around @{Zone#ZONEs}, Radiuses, Active players, ...
--- More iterators will be implemented in the near future ...
+-- This list will grow over time. Planned developments are to include filters and iterators.
+-- Additional filters will be added around @{Zone#ZONEs}, Radiuses, Active players, ...
+-- More iterators will be implemented in the near future ...
+--
+-- Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.
--
-- DATABASE construction methods:
-- =================================
@@ -64,6 +58,17 @@ Include.File( "Event" )
-- * @{#DATABASE.ForEachGroup}: Calls a function for each group contained within the DATABASE.
-- * @{#DATABASE.ForEachUnitInZone}: Calls a function for each unit within a certain zone contained within the DATABASE.
--
+-- ====
+-- @module Database
+-- @author FlightControl
+
+Include.File( "Routines" )
+Include.File( "Base" )
+Include.File( "Menu" )
+Include.File( "Group" )
+Include.File( "Event" )
+
+--- DATABASE class
-- @type DATABASE
-- @extends Base#BASE
DATABASE = {
diff --git a/Moose/Escort.lua b/Moose/Escort.lua
index 2e654db49..e45a3c876 100644
--- a/Moose/Escort.lua
+++ b/Moose/Escort.lua
@@ -1,69 +1,90 @@
--- Taking the lead of AI escorting your flight.
--- The ESCORT class allows you to interact with escorting AI on your flight and take the lead.
+--
+-- @{#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).
--
-- The radio commands will vary according the category of the group. The richest set of commands are with Helicopters and AirPlanes.
-- 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:
--
--- **1. Navigation ...:** Escort group navigation functions:
+-- Navigation ...:
+-- ---------------
+-- Escort group navigation functions:
--
--- * **"Join-Up and Follow at x meters":** The escort group fill follow you at about x meters, and they will follow you.
--- * **"Flare":** Provides menu commands to let the escort group shoot a flare in the air in a color.
--- * **"Smoke":** Provides menu commands to let the escort group smoke the air in a color. Note that smoking is only available for ground and naval troops.
+-- * **"Join-Up and Follow at x meters":** The escort group fill follow you at about x meters, and they will follow you.
+-- * **"Flare":** Provides menu commands to let the escort group shoot a flare in the air in a color.
+-- * **"Smoke":** Provides menu commands to let the escort group smoke the air in a color. Note that smoking is only available for ground and naval troops.
--
--- **2. Hold position ...:** Escort group navigation functions:
+-- Hold position ...:
+-- ------------------
+-- Escort group navigation functions:
--
--- * **"At current location":** Stops the escort group and they will hover 30 meters above the ground at the position they stopped.
--- * **"At client location":** Stops the escort group and they will hover 30 meters above the ground at the position they stopped.
+-- * **"At current location":** Stops the escort group and they will hover 30 meters above the ground at the position they stopped.
+-- * **"At client location":** Stops the escort group and they will hover 30 meters above the ground at the position they stopped.
--
--- **3. Report targets ...:** Report targets will make the escort group to report any target that it identifies within a 8km range. Any detected target can be attacked using the 4. Attack nearby targets function. (see below).
+-- Report targets ...:
+-- -------------------
+-- Report targets will make the escort group to report any target that it identifies within a 8km range. Any detected target can be attacked using the 4. Attack nearby targets function. (see below).
--
--- * **"Report now":** Will report the current detected targets.
--- * **"Report targets on":** Will make the escort group to report detected targets and will fill the "Attack nearby targets" menu list.
--- * **"Report targets off":** Will stop detecting targets.
+-- * **"Report now":** Will report the current detected targets.
+-- * **"Report targets on":** Will make the escort group to report detected targets and will fill the "Attack nearby targets" menu list.
+-- * **"Report targets off":** Will stop detecting targets.
--
--- **4. Scan targets ...:** Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or defined task.
+-- Scan targets ...:
+-- -----------------
+-- Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or defined task.
--
--- * **"Scan targets 30 seconds":** Scan 30 seconds for targets.
--- * **"Scan targets 60 seconds":** Scan 60 seconds for targets.
+-- * **"Scan targets 30 seconds":** Scan 30 seconds for targets.
+-- * **"Scan targets 60 seconds":** Scan 60 seconds for targets.
--
--- **5. Attack targets ...:** This menu item will list all detected targets within a 15km range. Depending on the level of detection (known/unknown) and visuality, the targets type will also be listed.
+-- Attack targets ...:
+-- -------------------
+-- This menu item will list all detected targets within a 15km range. Depending on the level of detection (known/unknown) and visuality, the targets type will also be listed.
--
--- **6. Request assistance from ...:** This menu item will list all detected targets within a 15km range, as with the menu item **Attack Targets**.
+-- Request assistance from ...:
+-- ----------------------------
+-- This menu item will list all detected targets within a 15km range, as with the menu item **Attack Targets**.
-- This menu item allows to request attack support from other escorts supporting the current client group.
-- eg. the function allows a player to request support from the Ship escort to attack a target identified by the Plane escort with its Tomahawk missiles.
-- eg. the function allows a player to request support from other Planes escorting to bomb the unit with illumination missiles or bombs, so that the main plane escort can attack the area.
--
--- **7. ROE ...:** Defines the Rules of Engagement of the escort group when in flight.
+-- ROE ...:
+-- --------
+-- Sets the Rules of Engagement (ROE) of the escort group when in flight.
--
--- * **"Hold Fire":** The escort group will hold fire.
--- * **"Return Fire":** The escort group will return fire.
--- * **"Open Fire":** The escort group will open fire on designated targets.
--- * **"Weapon Free":** The escort group will engage with any target.
+-- * **"Hold Fire":** The escort group will hold fire.
+-- * **"Return Fire":** The escort group will return fire.
+-- * **"Open Fire":** The escort group will open fire on designated targets.
+-- * **"Weapon Free":** The escort group will engage with any target.
--
--- **8. Evasion ...:** Will define the evasion techniques that the escort group will perform during flight or combat.
+-- Evasion ...:
+-- ------------
+-- Will define the evasion techniques that the escort group will perform during flight or combat.
--
--- * **"Fight until death":** The escort group will have no reaction to threats.
--- * **"Use flares, chaff and jammers":** The escort group will use passive defense using flares and jammers. No evasive manoeuvres are executed.
--- * **"Evade enemy fire":** The rescort group will evade enemy fire before firing.
--- * **"Go below radar and evade fire":** The escort group will perform evasive vertical manoeuvres.
+-- * **"Fight until death":** The escort group will have no reaction to threats.
+-- * **"Use flares, chaff and jammers":** The escort group will use passive defense using flares and jammers. No evasive manoeuvres are executed.
+-- * **"Evade enemy fire":** The rescort group will evade enemy fire before firing.
+-- * **"Go below radar and evade fire":** The escort group will perform evasive vertical manoeuvres.
--
--- **9. Resume Mission ...:** Escort groups can have their own mission. This menu item will allow the escort group to resume their Mission from a given waypoint.
+-- Resume Mission ...:
+-- -------------------
+-- Escort groups can have their own mission. This menu item will allow the escort group to resume their Mission from a given waypoint.
-- 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.
--
--- **10. Abort Current Task:** Cancel the current task and rejoin formation.
---
--- 1. ESCORT object construction methods.
--- --------------------------------------
+-- 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.
--
--- 2. ESCORT object initialization methods.
--- ----------------------------------------
--- The following menus can be setup:
+-- ESCORT initialization methods.
+-- ==============================
+-- The following menus are created within the RADIO MENU of an active unit hosted by a player:
--
-- * @{#ESCORT.MenuFollowAt}: Creates a menu to make the escort follow the client.
-- * @{#ESCORT.MenuHoldAtEscortPosition}: Creates a menu to hold the escort at its current position.
@@ -77,7 +98,7 @@
-- * @{#ESCORT.MenuROE: Creates a menu structure to set the rules of engagement of the escort.
-- * @{#ESCORT.MenuEvasion: Creates a menu structure to set the evasion techniques when the escort is under threat.
-- * @{#ESCORT.MenuResumeMission}: Creates a menu structure so that the escort can resume from a waypoint.
---
+--
-- @module Escort
-- @author FlightControl
@@ -87,8 +108,7 @@ Include.File( "Database" )
Include.File( "Group" )
Include.File( "Zone" )
-
---- ESCORT class
+---
-- @type ESCORT
-- @extends Base#BASE
-- @field Client#CLIENT EscortClient
diff --git a/Moose/Spawn.lua b/Moose/Spawn.lua
index be92d9ea0..3e1f9d3f3 100644
--- a/Moose/Spawn.lua
+++ b/Moose/Spawn.lua
@@ -1,5 +1,8 @@
--- Dynamic spawning of groups (and units).
--- The SPAWN class allows to spawn dynamically new groups, based on pre-defined initialization settings, modifying the behaviour when groups are spawned.
+--
+-- @{#SPAWN} class
+-- ===============
+-- The @{#SPAWN} class allows to spawn dynamically new groups, based on pre-defined initialization settings, modifying the behaviour when groups are spawned.
-- For each group to be spawned, within the mission editor, a group has to be created with the "late activation flag" set. We call this group the *"Spawn Template"* of the SPAWN object.
-- A reference to this Spawn Template needs to be provided when constructing the SPAWN object, by indicating the name of the group within the mission editor in the constructor methods.
--
@@ -67,6 +70,7 @@
-- This models AI that has succesfully returned to their airbase, to restart their combat activities.
-- Check the @{#SPAWN.CleanUp} for further info.
--
+-- ====
-- @module Spawn
-- @author FlightControl
|