From de4502bfa673899c4714264d510f1954cd7d277c Mon Sep 17 00:00:00 2001
From: Applevangelist
Date: Fri, 21 May 2021 10:40:40 +0000
Subject: [PATCH] MOOSE generated documentation [skip ci]
---
Documentation/AI.AI_Air.html | 44 -----
Documentation/AI.AI_Air_Squadron.html | 22 ---
Documentation/AI.AI_Cargo_Airplane.html | 68 -------
Documentation/AI.AI_Patrol.html | 12 ++
Documentation/Cargo.CargoCrate.html | 22 +++
Documentation/Cargo.CargoGroup.html | 34 ++++
Documentation/Cargo.CargoUnit.html | 22 ---
Documentation/Core.Settings.html | 30 +--
Documentation/Core.Spawn.html | 76 +++++---
Documentation/Core.SpawnStatic.html | 84 ---------
Documentation/Functional.Designate.html | 110 -----------
Documentation/Functional.Detection.html | 33 ----
Documentation/Functional.Mantis.html | 22 ---
Documentation/Functional.Movement.html | 28 ---
Documentation/Ops.Airboss.html | 27 ++-
.../Tasking.Task_A2A_Dispatcher.html | 8 +-
.../Tasking.Task_A2G_Dispatcher.html | 20 +-
Documentation/Tasking.Task_Cargo.html | 19 +-
.../Tasking.Task_Cargo_Dispatcher.html | 176 ++++++++++++++++++
Documentation/Wrapper.Client.html | 11 +-
Documentation/Wrapper.Controllable.html | 16 +-
Documentation/Wrapper.Group.html | 11 +-
Documentation/Wrapper.Marker.html | 132 ++++++-------
Documentation/Wrapper.Positionable.html | 44 +++++
Documentation/Wrapper.Unit.html | 11 +-
25 files changed, 475 insertions(+), 607 deletions(-)
diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html
index 94b054fca..d48961c52 100644
--- a/Documentation/AI.AI_Air.html
+++ b/Documentation/AI.AI_Air.html
@@ -2869,17 +2869,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -5624,17 +5613,6 @@ Once the time is finished, the old AI will return to the base.
-
-
-
-
@@ -6360,17 +6338,6 @@ Once the time is finished, the old AI will return to the base.
-
-
-
-
@@ -7988,17 +7955,6 @@ Once the time is finished, the old AI will return to the base.
-
-
-
-
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html
index c2310f6fa..4f8351e74 100644
--- a/Documentation/AI.AI_Air_Squadron.html
+++ b/Documentation/AI.AI_Air_Squadron.html
@@ -2372,17 +2372,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3454,17 +3443,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html
index af7a68e10..71a1ec9c3 100644
--- a/Documentation/AI.AI_Cargo_Airplane.html
+++ b/Documentation/AI.AI_Cargo_Airplane.html
@@ -2555,20 +2555,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -2599,9 +2585,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
Aircraft is on a depoly mission.
-
@@ -4348,20 +4331,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -4392,9 +4361,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
Aircraft is on a depoly mission.
-
@@ -4983,20 +4949,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -5027,9 +4979,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
Aircraft is on a depoly mission.
-
@@ -6510,20 +6459,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -6554,9 +6489,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
Aircraft is on a depoly mission.
-
diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html
index 435ab2ca9..0e05bcab7 100644
--- a/Documentation/AI.AI_Patrol.html
+++ b/Documentation/AI.AI_Patrol.html
@@ -3071,6 +3071,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+ This table contains the targets detected during patrol.
+
@@ -6318,6 +6321,9 @@ Note that this method is required, as triggers the next route when patrolling fo
+
+ This table contains the targets detected during patrol.
+
@@ -7062,6 +7068,9 @@ Note that this method is required, as triggers the next route when patrolling fo
+
+ This table contains the targets detected during patrol.
+
@@ -8698,6 +8707,9 @@ 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.CargoCrate.html b/Documentation/Cargo.CargoCrate.html
index 81e6f0ebd..43db3b6a8 100644
--- a/Documentation/Cargo.CargoCrate.html
+++ b/Documentation/Cargo.CargoCrate.html
@@ -1683,6 +1683,17 @@ Controls a network of short range air/missile defense groups.
Field(s)
+
@@ -2351,6 +2362,17 @@ Controls a network of short range air/missile defense groups.
Field(s)
+
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html
index def570c80..dfd6f4ec7 100644
--- a/Documentation/Cargo.CargoGroup.html
+++ b/Documentation/Cargo.CargoGroup.html
@@ -1772,6 +1772,9 @@ Controls a network of short range air/missile defense groups.
+
+
Then we register the new group in the database
+
@@ -1783,6 +1786,20 @@ Controls a network of short range air/missile defense groups.
+
+
+
+
@@ -3090,6 +3107,9 @@ This works for ground only groups.
+
+ Then we register the new group in the database
+
@@ -3101,6 +3121,20 @@ This works for ground only groups.
+
+
+
+
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html
index e4adfe127..b346f9fd0 100644
--- a/Documentation/Cargo.CargoUnit.html
+++ b/Documentation/Cargo.CargoUnit.html
@@ -1632,17 +1632,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-
-
-
-
-
-
CARGO_UNIT.CargoInAir
@@ -2358,17 +2347,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-
-
-
-
-
-
CARGO_UNIT.CargoInAir
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html
index d9c8bc6e6..124e70631 100644
--- a/Documentation/Core.Settings.html
+++ b/Documentation/Core.Settings.html
@@ -2649,7 +2649,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string
+
SETTINGS.A2ASystem
@@ -2660,7 +2660,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #string
SETTINGS.A2GSystem
@@ -2709,17 +2709,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -4751,7 +4740,7 @@ It is advised to use this method at the start of the mission.
- #string
+
SETTINGS.A2ASystem
@@ -4762,7 +4751,7 @@ It is advised to use this method at the start of the mission.
-
+ #string
SETTINGS.A2GSystem
@@ -4811,17 +4800,6 @@ 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 ad67016c2..977908e96 100644
--- a/Documentation/Core.Spawn.html
+++ b/Documentation/Core.Spawn.html
@@ -3420,6 +3420,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3456,6 +3467,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3551,27 +3573,21 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -3603,7 +3619,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number
+
SPAWN.SpawnMaxGroups
@@ -3617,7 +3633,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number
+
SPAWN.SpawnMaxUnitsAlive
@@ -8806,6 +8822,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -8842,6 +8869,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -8937,27 +8975,21 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
#boolean
-
SPAWN.SpawnInitKeepUnitNames
+
SPAWN.SpawnInitLimit
-
-
Overwrite unit names by default with group name.
-
@@ -8989,7 +9021,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
- #number
+
SPAWN.SpawnMaxGroups
@@ -9003,7 +9035,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
-
-
@@ -3984,39 +3933,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
-
-
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html
index 86b25025a..96cd3cac3 100644
--- a/Documentation/Functional.Designate.html
+++ b/Documentation/Functional.Designate.html
@@ -3357,17 +3357,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3379,17 +3368,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -6536,17 +6514,6 @@ Designate:SetFlashStatusMenu( false )
-
-
-
-
@@ -6558,17 +6525,6 @@ Designate:SetFlashStatusMenu( false )
-
-
-
-
@@ -7357,17 +7313,6 @@ Designate:SetFlashStatusMenu( false )
-
-
-
-
@@ -7379,17 +7324,6 @@ Designate:SetFlashStatusMenu( false )
-
-
-
-
@@ -8148,17 +8082,6 @@ Designate:SetFlashStatusMenu( false )
-
-
-
-
@@ -8170,17 +8093,6 @@ Designate:SetFlashStatusMenu( false )
-
-
-
-
@@ -9831,17 +9743,6 @@ Designate:SetFlashStatusMenu( false )
-
-
-
-
@@ -9853,17 +9754,6 @@ Designate:SetFlashStatusMenu( false )
-
-
-
-
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html
index d24b039de..73032e47e 100644
--- a/Documentation/Functional.Detection.html
+++ b/Documentation/Functional.Detection.html
@@ -18709,17 +18709,6 @@ BASE:TraceOnOff( false )
-
-
-
-
@@ -23422,17 +23411,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual
-
-
-
-
@@ -25190,17 +25168,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual
-
-
-
-
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html
index 9316f1e3c..dcd0ae9fe 100644
--- a/Documentation/Functional.Mantis.html
+++ b/Documentation/Functional.Mantis.html
@@ -2627,17 +2627,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
The #DETECTION_AREAS object for AWACS
-
-
-
-
@@ -4220,17 +4209,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
The #DETECTION_AREAS object for AWACS
-
-
-
-
diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html
index b780bcc21..03dc28cc9 100644
--- a/Documentation/Functional.Movement.html
+++ b/Documentation/Functional.Movement.html
@@ -2082,20 +2082,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
-
-
- #number
-
MOVEMENT.AliveUnits
-
-
-
-
-
Contains the counter how many units are currently alive
-
-
-
-
-
Any positive number: AI will disperse, but only for the specified time before continuing their route. 0: AI will not disperse.
+
Any positive number: AI will disperse, but only for the specified time before continuing their route. 0: AI will not disperse.
@@ -15381,7 +15381,8 @@ The unit / controllable will also protect that controllable from threats of spec
The killer is player-controlled allied CAS-aircraft that is in contact with the FAC.
-If the task is assigned to the controllable lead unit will be a FAC.
+If the task is assigned to the controllable lead unit will be a FAC.
+It's important to note that depending on the type of unit that is being assigned the task (AIR or GROUND), you must choose the correct type of callsign enumerator. For airborne controllables use CALLSIGN.Aircraft and for ground based use CALLSIGN.JTAC enumerators.
@@ -15477,7 +15478,7 @@ If the task is assigned to the controllable lead unit will be a FAC.
-
Callsign enumerator name of the FAC.
+
Callsign enumerator name of the FAC. (CALLSIGN.Aircraft.{name} for airborne controllables, CALLSIGN.JTACS.{name} for ground units)
@@ -15599,7 +15600,7 @@ If the task is assigned to the controllable lead unit will be a FAC.
-
Altitude is above mean sea level. Default is above ground level.
+
Altitude is above mean sea level. Default is above ground level.
diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html
index befa07f22..85ae379cd 100644
--- a/Documentation/Wrapper.Marker.html
+++ b/Documentation/Wrapper.Marker.html
@@ -2833,6 +2833,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Coordinate of the mark.
+
+
+
+
+
@@ -2910,28 +2932,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Text displayed in the mark panel.
-
-
-
-
-
@@ -4939,6 +4939,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Coordinate of the mark.
+
+
+
+
+
@@ -5016,28 +5038,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Text displayed in the mark panel.
-
-
-
-
-
@@ -6553,6 +6553,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Coordinate of the mark.
+
+
+
+
+
@@ -6630,28 +6652,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Text displayed in the mark panel.
-
-
-
-
-
diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html
index 90ca3e806..428477e07 100644
--- a/Documentation/Wrapper.Positionable.html
+++ b/Documentation/Wrapper.Positionable.html
@@ -3445,6 +3445,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -6832,6 +6843,17 @@ Coordinates are dependent on the position of the maps origin.
+
+
+
+
@@ -7409,6 +7431,17 @@ If the Identifiable is alive, true is returned.
+
+
+
+
@@ -7592,6 +7625,17 @@ If the Identifiable is alive, true is returned.
+
+
+
+
diff --git a/Documentation/Wrapper.Unit.html b/Documentation/Wrapper.Unit.html
index e5288ce4a..039a7aa78 100644
--- a/Documentation/Wrapper.Unit.html
+++ b/Documentation/Wrapper.Unit.html
@@ -8818,7 +8818,7 @@ If at least one detection method is specified, only the methods
-
Defines the range
+
Defines the range
@@ -8991,7 +8991,7 @@ If at least one detection method is specified, only the methods
-
Any positive number: AI will disperse, but only for the specified time before continuing their route. 0: AI will not disperse.
+
Any positive number: AI will disperse, but only for the specified time before continuing their route. 0: AI will not disperse.
@@ -12704,7 +12704,8 @@ The unit / controllable will also protect that controllable from threats of spec
The killer is player-controlled allied CAS-aircraft that is in contact with the FAC.
-If the task is assigned to the controllable lead unit will be a FAC.
+If the task is assigned to the controllable lead unit will be a FAC.
+It's important to note that depending on the type of unit that is being assigned the task (AIR or GROUND), you must choose the correct type of callsign enumerator. For airborne controllables use CALLSIGN.Aircraft and for ground based use CALLSIGN.JTAC enumerators.
@@ -12800,7 +12801,7 @@ If the task is assigned to the controllable lead unit will be a FAC.
-
Callsign enumerator name of the FAC.
+
Callsign enumerator name of the FAC. (CALLSIGN.Aircraft.{name} for airborne controllables, CALLSIGN.JTACS.{name} for ground units)
@@ -12922,7 +12923,7 @@ If the task is assigned to the controllable lead unit will be a FAC.
-
Altitude is above mean sea level. Default is above ground level.
+
Altitude is above mean sea level. Default is above ground level.