From d0d5268307bf74bfeca26d1d3dd04d020dea6465 Mon Sep 17 00:00:00 2001
From: Applevangelist
Date: Fri, 4 Feb 2022 08:01:04 +0000
Subject: [PATCH] MOOSE generated documentation [skip ci]
---
Documentation/AI.AI_A2G_Dispatcher.html | 44 +++++
Documentation/AI.AI_Air_Squadron.html | 22 +++
Documentation/AI.AI_Cargo.html | 20 ++-
Documentation/AI.AI_Cargo_Airplane.html | 56 ++----
Documentation/AI.AI_Cargo_Helicopter.html | 40 +----
Documentation/AI.AI_Patrol.html | 12 --
Documentation/Cargo.CargoGroup.html | 56 +++---
Documentation/Cargo.CargoUnit.html | 22 +++
Documentation/Core.Fsm.html | 4 +-
Documentation/Core.Point.html | 33 ++++
Documentation/Core.Settings.html | 26 ++-
Documentation/Core.Spawn.html | 48 +++++-
Documentation/Core.Spot.html | 99 +++++++++++
Documentation/Functional.Detection.html | 161 ++++++++++++++----
Documentation/Functional.Range.html | 12 +-
Documentation/Functional.Scoring.html | 8 +-
Documentation/Ops.Airboss.html | 33 +++-
Documentation/Ops.CSAR.html | 129 +++-----------
Documentation/Ops.CTLD.html | 67 ++++++--
.../Tasking.Task_A2A_Dispatcher.html | 8 +-
Documentation/Tasking.Task_Cargo.html | 19 +--
.../Tasking.Task_Cargo_Dispatcher.html | 8 +-
Documentation/Wrapper.Marker.html | 72 +++++++-
23 files changed, 677 insertions(+), 322 deletions(-)
diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html
index 959d4ed2b..2bf247784 100644
--- a/Documentation/AI.AI_A2G_Dispatcher.html
+++ b/Documentation/AI.AI_A2G_Dispatcher.html
@@ -4659,6 +4659,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
The Defender Default Settings over all Squadrons.
+
+
+
+
@@ -13093,6 +13104,17 @@ multiplied by the Overhead and rounded up to the smallest integer.
The Defender Default Settings over all Squadrons.
+
+
+
+
@@ -14410,6 +14432,17 @@ multiplied by the Overhead and rounded up to the smallest integer.
The Defender Default Settings over all Squadrons.
+
+
+
+
@@ -16033,6 +16066,17 @@ multiplied by the Overhead and rounded up to the smallest integer.
The Defender Default Settings over all Squadrons.
+
+
+
+
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html
index 0d4013861..fc1f0f648 100644
--- a/Documentation/AI.AI_Air_Squadron.html
+++ b/Documentation/AI.AI_Air_Squadron.html
@@ -2437,6 +2437,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3508,6 +3519,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html
index 56717b67f..3802dd9c7 100644
--- a/Documentation/AI.AI_Cargo.html
+++ b/Documentation/AI.AI_Cargo.html
@@ -2633,7 +2633,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
Wrapper.Group#GROUP
+
AI_CARGO.CargoCarrier
@@ -2671,6 +2671,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
No loading happened, so we need to pickup something else.
+
@@ -4663,7 +4666,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
Wrapper.Group#GROUP
+
AI_CARGO.CargoCarrier
@@ -4701,6 +4704,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
No loading happened, so we need to pickup something else.
+
@@ -5275,7 +5281,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
Wrapper.Group#GROUP
+
AI_CARGO.CargoCarrier
@@ -5313,6 +5319,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
No loading happened, so we need to pickup something else.
+
@@ -6779,7 +6788,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
Wrapper.Group#GROUP
+
AI_CARGO.CargoCarrier
@@ -6817,6 +6826,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
No loading happened, so we need to pickup something else.
+
diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html
index d5c13b2bd..42f867d10 100644
--- a/Documentation/AI.AI_Cargo_Airplane.html
+++ b/Documentation/AI.AI_Cargo_Airplane.html
@@ -2620,17 +2620,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -2686,6 +2675,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Aircraft is on a pickup mission.
+
@@ -4404,17 +4396,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -4470,6 +4451,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Aircraft is on a pickup mission.
+
@@ -5030,17 +5014,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -5096,6 +5069,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Aircraft is on a pickup mission.
+
@@ -6548,17 +6524,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -6614,6 +6579,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Aircraft is on a pickup mission.
+
diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html
index 3396809a3..bd0d3f1c7 100644
--- a/Documentation/AI.AI_Cargo_Helicopter.html
+++ b/Documentation/AI.AI_Cargo_Helicopter.html
@@ -2785,28 +2785,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -4709,28 +4703,22 @@ Adjust if necessary.
@@ -5385,28 +5373,22 @@ Adjust if necessary.
@@ -6953,28 +6935,22 @@ Adjust if necessary.
diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html
index 7e42cf341..8732f72f8 100644
--- a/Documentation/AI.AI_Patrol.html
+++ b/Documentation/AI.AI_Patrol.html
@@ -3136,9 +3136,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- This table contains the targets detected during patrol.
-
@@ -6386,9 +6383,6 @@ Note that this method is required, as triggers the next route when patrolling fo
-
- This table contains the targets detected during patrol.
-
@@ -7133,9 +7127,6 @@ Note that this method is required, as triggers the next route when patrolling fo
-
- This table contains the targets detected during patrol.
-
@@ -8772,9 +8763,6 @@ Note that this method is required, as triggers the next route when patrolling fo
-
- This table contains the targets detected during patrol.
-
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html
index 3e9bd798b..f82ea5469 100644
--- a/Documentation/Cargo.CargoGroup.html
+++ b/Documentation/Cargo.CargoGroup.html
@@ -1820,20 +1820,6 @@ Controls a network of short range air/missile defense groups.
-
-
-
-
-
-
CARGO_GROUP.CargoGroup
@@ -1852,6 +1838,20 @@ Controls a network of short range air/missile defense groups.
+
+
+
+
@@ -3141,20 +3141,6 @@ This works for ground only groups.
-
-
-
+
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html
index b3c66a4d4..db8be2868 100644
--- a/Documentation/Cargo.CargoUnit.html
+++ b/Documentation/Cargo.CargoUnit.html
@@ -1727,6 +1727,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
Set cargo object.
+
+
+
+
@@ -2442,6 +2453,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
Set cargo object.
+
+
+
+
diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html
index 3e303283d..789151b7f 100644
--- a/Documentation/Core.Fsm.html
+++ b/Documentation/Core.Fsm.html
@@ -5651,7 +5651,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string
+
FSM._StartState
@@ -7254,7 +7254,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string
+
FSM._StartState
diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html
index a8e97dfba..eee73c591 100644
--- a/Documentation/Core.Point.html
+++ b/Documentation/Core.Point.html
@@ -17091,6 +17091,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
the y coordinate in meters.
+
+
+
+
@@ -17889,6 +17900,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
the y coordinate in meters.
+
+
+
+
@@ -26015,6 +26037,17 @@ Creates a line on the F10 map from one point to another.
the y coordinate in meters.
+
+
+
+
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html
index d1c66c9f5..2b8856ff5 100644
--- a/Documentation/Core.Settings.html
+++ b/Documentation/Core.Settings.html
@@ -2725,7 +2725,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string
+
SETTINGS.A2GSystem
@@ -2774,6 +2774,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -4819,7 +4830,7 @@ It is advised to use this method at the start of the mission.
- #string
+
SETTINGS.A2GSystem
@@ -4868,6 +4879,17 @@ It is advised to use this method at the start of the mission.
+
+
+
+
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html
index 948ad1c8c..2e4cee68f 100644
--- a/Documentation/Core.Spawn.html
+++ b/Documentation/Core.Spawn.html
@@ -3454,6 +3454,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3606,6 +3617,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
By default, no InitLimit
+
+
+
+
@@ -3820,7 +3842,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- When the first Spawn executes, all the Groups need to be made visible before start.
+ Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.
@@ -8811,6 +8833,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -8963,6 +8996,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups. By default, no InitLimit
+
+
+
+
@@ -9177,7 +9221,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups. When the first Spawn executes, all the Groups need to be made visible before start.
+ Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html
index a09822339..41988fee0 100644
--- a/Documentation/Core.Spot.html
+++ b/Documentation/Core.Spot.html
@@ -2669,6 +2669,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
@@ -3882,6 +3915,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
@@ -5386,6 +5452,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html
index 82114b1fe..903a03706 100644
--- a/Documentation/Functional.Detection.html
+++ b/Documentation/Functional.Detection.html
@@ -1565,13 +1565,13 @@ It uses the in-built detection capabilities of DCS World, but adds new functiona
## 4.1) Retrieve the Detected Unit Sets and Detected Zones
The methods to manage the DetectedItems[].Set(s) are implemented in Functional.Detection#DETECTION_BASE and
- the methods to manage the DetectedItems[].Zone(s) is implemented in Functional.Detection#DETECTION_AREAS.
+ the methods to manage the DetectedItems[].Zone(s) are implemented in Functional.Detection#DETECTION_AREAS.
Retrieve the DetectedItems[].Set with the method Functional.Detection#DETECTION_BASE.GetDetectedSet(). A Core.Set#SET_UNIT object will be returned.
- Retrieve the formed Zones as a result of the grouping the detected units within the DetectionZoneRange, use the method Functional.Detection#DETECTION_BASE.GetDetectionZones().
- To understand the amount of zones created, use the method Functional.Detection#DETECTION_BASE.GetDetectionZoneCount().
- If you want to obtain a specific zone from the DetectedZones, use the method Functional.Detection#DETECTION_BASE.GetDetectionZone() with a given index.
+ Retrieve the formed Zones as a result of the grouping the detected units within the DetectionZoneRange, use the method Functional.Detection#DETECTION_AREAS.GetDetectionZones().
+ To understand the amount of zones created, use the method Functional.Detection#DETECTION_AREAS.GetDetectionZoneCount().
+ If you want to obtain a specific zone from the DetectedZones, use the method Functional.Detection#DETECTION_AREAS.GetDetectionZoneByID() with a given index.
## 4.4) Flare or Smoke detected units
@@ -1979,6 +1979,24 @@ Beware that when the amount of units detected is large, the DetectedItems list w
DETECTION_AREAS:GetChangeText(DetectedItem) |
Make text documenting the changes of the detected zone.
+ |
+
+
+ DETECTION_AREAS:GetDetectionZoneByID(ID) |
+
+ Retrieve a specific zone by its ID (number)
+ |
+
+
+ DETECTION_AREAS:GetDetectionZoneCount() |
+
+ Retrieve number of detected zones.
+ |
+
+
+ DETECTION_AREAS:GetDetectionZones() |
+
+ Retrieve set of detected zones.
|
@@ -9201,6 +9219,108 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
+
+
Retrieve a specific zone by its ID (number)
+
+
+
+
Defined in:
+
+
Parameter:
+
+
Return value:
+
+
+
+
+
The zone or nil if it does not exist
+
+
+
+
+
+
+
+
+
+
+
+
+
Retrieve number of detected zones.
+
+
+
+
Defined in:
+
+
Return value:
+
+
+
+
+
The number of zones.
+
+
+
+
+
+
+
+
+
+
+
+
+
Retrieve set of detected zones.
+
+
+
+
Defined in:
+
+
Return value:
+
+
+
+
+
The Set of ZONE_UNIT objects detected.
+
+
+
+
+
@@ -18913,17 +19033,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-
-
-
-
@@ -23615,17 +23724,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual
-
-
-
-
@@ -25372,17 +25470,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual
-
-
-
-
diff --git a/Documentation/Functional.Range.html b/Documentation/Functional.Range.html
index 5c100056d..6086c2553 100644
--- a/Documentation/Functional.Range.html
+++ b/Documentation/Functional.Range.html
@@ -15692,13 +15692,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
@@ -15706,13 +15706,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
@@ -15720,13 +15720,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html
index 6c6c41ba6..3f8b98b05 100644
--- a/Documentation/Functional.Scoring.html
+++ b/Documentation/Functional.Scoring.html
@@ -2972,7 +2972,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #boolean
SCORING.penaltyoncoalitionchange
@@ -2983,7 +2983,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #boolean
SCORING.penaltyonfratricide
@@ -5492,7 +5492,7 @@ The scale magnifies the scores given to the players.
-
+ #boolean
SCORING.penaltyoncoalitionchange
@@ -5503,7 +5503,7 @@ The scale magnifies the scores given to the players.
-
+ #boolean
SCORING.penaltyonfratricide
diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html
index 80fc72dc2..79cdbb2fa 100644
--- a/Documentation/Ops.Airboss.html
+++ b/Documentation/Ops.Airboss.html
@@ -38806,6 +38806,20 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
@@ -38815,6 +38829,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
Data table at each position in the groove. Elements are of type AIRBOSS.GrooveData.
+
+
+
+
@@ -38950,6 +38975,9 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
Make player section lead if he was not before.
+
@@ -38972,9 +39000,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-
-
Set Stable Hover
-
@@ -39009,7 +39034,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
-
Set time stamp.
+
Set new time stamp.
diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html
index e7deb6069..69c24bef9 100644
--- a/Documentation/Ops.CSAR.html
+++ b/Documentation/Ops.CSAR.html
@@ -3635,14 +3635,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -3848,11 +3845,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -3873,11 +3873,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -4184,20 +4187,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
@@ -4223,20 +4212,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
- #number
-
CSAR.rescues
-
-
-
-
-
counter for successful rescue landings at FARP/AFB/MASH
-
-
-
@@ -8421,14 +8396,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -8634,11 +8606,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -8659,11 +8634,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -8970,20 +8948,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
@@ -9009,20 +8973,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
- #number
-
CSAR.rescues
-
-
-
-
-
counter for successful rescue landings at FARP/AFB/MASH
-
-
-
@@ -10726,14 +10676,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -10939,11 +10886,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -10964,11 +10914,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -11275,20 +11228,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
@@ -11314,20 +11253,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
- #number
-
CSAR.rescues
-
-
-
-
-
counter for successful rescue landings at FARP/AFB/MASH
-
-
-
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html
index cd7bdb120..5fc35007c 100644
--- a/Documentation/Ops.CTLD.html
+++ b/Documentation/Ops.CTLD.html
@@ -7000,7 +7000,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau