From 9e634d58d367a4a15b976166426e186caf295b50 Mon Sep 17 00:00:00 2001
From: Applevangelist
Date: Wed, 20 Apr 2022 17:30:31 +0000
Subject: [PATCH] MOOSE generated documentation [skip ci]
---
Documentation/AI.AI_AIR_Dispatcher.html | 44 ----
Documentation/AI.AI_Air_Squadron.html | 22 ++
Documentation/AI.AI_Cargo_Airplane.html | 56 +++++
Documentation/AI.AI_Cargo_Helicopter.html | 40 +---
Documentation/AI.AI_Patrol.html | 12 +
Documentation/Cargo.CargoGroup.html | 6 +
Documentation/Cargo.CargoUnit.html | 22 --
Documentation/Core.Point.html | 33 +++
Documentation/Core.Settings.html | 4 +-
Documentation/Core.Spawn.html | 132 ++++++-----
Documentation/Functional.Designate.html | 110 ++++++++++
Documentation/Functional.Detection.html | 99 +++++++++
Documentation/Functional.Range.html | 12 +-
Documentation/Functional.Scoring.html | 4 +-
Documentation/Ops.Airboss.html | 5 +-
Documentation/Ops.CSAR.html | 207 +++++-------------
Documentation/Ops.CTLD.html | 154 ++-----------
.../Tasking.Task_A2A_Dispatcher.html | 8 +-
Documentation/Tasking.Task_Cargo.html | 6 +-
.../Tasking.Task_Cargo_Dispatcher.html | 52 +----
Documentation/Utils.html | 113 ++++++++++
Documentation/Wrapper.Positionable.html | 44 ----
22 files changed, 629 insertions(+), 556 deletions(-)
diff --git a/Documentation/AI.AI_AIR_Dispatcher.html b/Documentation/AI.AI_AIR_Dispatcher.html
index b2641ffc8..30bb524cf 100644
--- a/Documentation/AI.AI_AIR_Dispatcher.html
+++ b/Documentation/AI.AI_AIR_Dispatcher.html
@@ -4437,17 +4437,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
The Defender Default Settings over all Squadrons.
-
-
-
-
@@ -9745,17 +9734,6 @@ multiplied by the Overhead and rounded up to the smallest integer.
The Defender Default Settings over all Squadrons.
-
-
-
-
@@ -11073,17 +11051,6 @@ multiplied by the Overhead and rounded up to the smallest integer.
The Defender Default Settings over all Squadrons.
-
-
-
-
@@ -12707,17 +12674,6 @@ 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_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html
index e8756f1aa..61dde2240 100644
--- a/Documentation/AI.AI_Cargo_Airplane.html
+++ b/Documentation/AI.AI_Cargo_Airplane.html
@@ -2620,6 +2620,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
@@ -4393,6 +4407,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
@@ -5008,6 +5036,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
@@ -6515,6 +6557,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
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 8732f72f8..7e42cf341 100644
--- a/Documentation/AI.AI_Patrol.html
+++ b/Documentation/AI.AI_Patrol.html
@@ -3136,6 +3136,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
This table contains the targets detected during patrol.
+
@@ -6383,6 +6386,9 @@ Note that this method is required, as triggers the next route when patrolling fo
+
+
This table contains the targets detected during patrol.
+
@@ -7127,6 +7133,9 @@ Note that this method is required, as triggers the next route when patrolling fo
+
+
This table contains the targets detected during patrol.
+
@@ -8763,6 +8772,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.CargoGroup.html b/Documentation/Cargo.CargoGroup.html
index 21a6a6d92..f82ea5469 100644
--- a/Documentation/Cargo.CargoGroup.html
+++ b/Documentation/Cargo.CargoGroup.html
@@ -1824,6 +1824,9 @@ Controls a network of short range air/missile defense groups.
+
+ Then we register the new group in the database
+
@@ -3142,6 +3145,9 @@ This works for ground only groups.
+
+ Then we register the new group in the database
+
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html
index db8be2868..49aa6ed95 100644
--- a/Documentation/Cargo.CargoUnit.html
+++ b/Documentation/Cargo.CargoUnit.html
@@ -1698,17 +1698,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-
-
-
-
-
-
CARGO_UNIT.CargoInAir
@@ -2424,17 +2413,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-
-
-
-
-
-
CARGO_UNIT.CargoInAir
diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html
index fe0701eed..6cce6b2ec 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 c8bef4e07..a0e7c5b68 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
@@ -4830,7 +4830,7 @@ It is advised to use this method at the start of the mission.
-
+ #string
SETTINGS.A2GSystem
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html
index e1fff503e..85820e75e 100644
--- a/Documentation/Core.Spawn.html
+++ b/Documentation/Core.Spawn.html
@@ -3286,14 +3286,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean
+
SPAWN.AIOnOff
-
-
The AI is on by default when spawning a group.
-
@@ -3366,9 +3363,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.
-
@@ -3424,20 +3418,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
-
-
- #number
-
SPAWN.SpawnCount
-
-
-
-
-
The internal counter of the amount of spawning the has happened since SpawnStart.
-
@@ -3460,6 +3440,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3496,6 +3487,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3529,6 +3531,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3591,21 +3604,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean
-
SPAWN.SpawnInitLimit
+
+
SPAWN.SpawnInitModex
@@ -3834,7 +3844,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.
+
When the first Spawn executes, all the Groups need to be made visible before start.
@@ -8662,14 +8672,11 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
- #boolean
+
SPAWN.AIOnOff
-
-
The AI is on by default when spawning a group.
-
@@ -8742,9 +8749,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups. Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.
-
@@ -8800,20 +8804,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
-
-
- #number
-
SPAWN.SpawnCount
-
-
-
-
-
The internal counter of the amount of spawning the has happened since SpawnStart.
-
@@ -8836,6 +8826,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -8872,6 +8873,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -8905,6 +8917,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -8967,21 +8990,18 @@ 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.
-
- #boolean
-
SPAWN.SpawnInitLimit
+
+
SPAWN.SpawnInitModex
@@ -9210,7 +9230,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups. Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.
+
When the first Spawn executes, all the Groups need to be made visible before start.
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html
index 6f4a09cd6..f0b0bac3b 100644
--- a/Documentation/Functional.Designate.html
+++ b/Documentation/Functional.Designate.html
@@ -3422,6 +3422,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3433,6 +3444,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -6579,6 +6601,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
@@ -6590,6 +6623,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
@@ -7378,6 +7422,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
@@ -7389,6 +7444,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
@@ -8147,6 +8213,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
@@ -8158,6 +8235,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
@@ -9808,6 +9896,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
@@ -9819,6 +9918,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html
index 7b6d1f800..6005faded 100644
--- a/Documentation/Functional.Detection.html
+++ b/Documentation/Functional.Detection.html
@@ -18890,6 +18890,28 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
+
+
+
@@ -19033,6 +19055,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
+
+
@@ -23581,6 +23614,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual
+
+
+
+
+
@@ -23724,6 +23779,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual
+
+
+
+
@@ -25327,6 +25393,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual
+
+
+
+
+
@@ -25470,6 +25558,17 @@ 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 afdc24e7c..206b7e6f4 100644
--- a/Documentation/Functional.Range.html
+++ b/Documentation/Functional.Range.html
@@ -15687,13 +15687,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
@@ -15701,13 +15701,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
@@ -15715,13 +15715,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 3f8b98b05..b85964403 100644
--- a/Documentation/Functional.Scoring.html
+++ b/Documentation/Functional.Scoring.html
@@ -2983,7 +2983,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean
+
SCORING.penaltyonfratricide
@@ -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 e846e3c54..5b59ff3d1 100644
--- a/Documentation/Ops.Airboss.html
+++ b/Documentation/Ops.Airboss.html
@@ -38980,9 +38980,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-
-
Set Stable Hover
-
@@ -39017,7 +39014,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 0755533b6..9faed9d2a 100644
--- a/Documentation/Ops.CSAR.html
+++ b/Documentation/Ops.CSAR.html
@@ -2292,6 +2292,12 @@ Create a late-activated single infantry unit as template in the mission editor a
CSAR.inTransitGroups |
+ |
+
+
+ CSAR.index |
+
+
|
@@ -3586,7 +3592,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
CSAR.FreeVHFFrequencies
@@ -3689,14 +3695,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -3902,14 +3905,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -3930,25 +3930,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
@@ -4047,6 +4033,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
contain a table for each SAR with all units he has with the original names
+
+
+
+
@@ -4244,20 +4241,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
@@ -4283,20 +4266,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
-
-
-
@@ -8429,7 +8398,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
CSAR.FreeVHFFrequencies
@@ -8532,14 +8501,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -8745,14 +8711,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -8773,25 +8736,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
@@ -8890,6 +8839,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
contain a table for each SAR with all units he has with the original names
+
+
+
+
@@ -9087,20 +9047,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
@@ -9126,20 +9072,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
-
-
-
@@ -10765,7 +10697,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
CSAR.FreeVHFFrequencies
@@ -10868,14 +10800,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -11081,14 +11010,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -11109,25 +11035,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
@@ -11226,6 +11138,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
contain a table for each SAR with all units he has with the original names
+
+
+
+
@@ -11423,20 +11346,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
@@ -11462,20 +11371,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 2ac61a26f..fb64f1392 100644
--- a/Documentation/Ops.CTLD.html
+++ b/Documentation/Ops.CTLD.html
@@ -6917,17 +6917,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Name of the class.
-
-
-
-
@@ -6981,7 +6970,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.DroppedTroops
@@ -7020,11 +7009,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -7056,7 +7048,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeFMFrequencies
@@ -7067,7 +7059,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeUHFFrequencies
@@ -7296,17 +7288,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -7451,17 +7432,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#1570
-
-
-
-
@@ -14488,17 +14458,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Name of the class.
-
-
-
-
@@ -14552,7 +14511,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.DroppedTroops
@@ -14591,11 +14550,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -14627,7 +14589,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeFMFrequencies
@@ -14638,7 +14600,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeUHFFrequencies
@@ -14867,17 +14829,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -15022,17 +14973,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#1570
-
-
-
-
@@ -16900,17 +16840,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Name of the class.
-
-
-
-
@@ -16964,7 +16893,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.DroppedTroops
@@ -17003,11 +16932,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -17039,7 +16971,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeFMFrequencies
@@ -17050,7 +16982,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeUHFFrequencies
@@ -17279,17 +17211,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -17434,17 +17355,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#1570
-
-
-
-
@@ -29379,17 +29289,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
template for a group of 10 paratroopers
-
-
-
-
@@ -30626,17 +30525,6 @@ Expected template names are the ones in the rounded brackets.
template for a group of 10 paratroopers
-
-
-
-
diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html
index 0a4ca9a12..a4ec41421 100644
--- a/Documentation/Tasking.Task_A2A_Dispatcher.html
+++ b/Documentation/Tasking.Task_A2A_Dispatcher.html
@@ -2813,7 +2813,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+ UTILS.BearingToCardinal(Heading) |
+
+ Heading Degrees (0-360) to Cardinal
|
@@ -3886,6 +3892,12 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
UTILS.ToRadian(angle) |
+ |
+
+
+ UTILS.ToStringBRAANATO(FromGrp, ToGrp) |
+
+ Create a BRAA NATO call string BRAA between two GROUP objects
|
@@ -12336,6 +12348,50 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
+
+
+
+
+
+
Heading Degrees (0-360) to Cardinal
+
+
+
+
Defined in:
+
+
Parameter:
+
+
+
+ #number
+ Heading
+
+
+
+
+
Return value:
+
+
+
+
+
Cardinal, e.g. "NORTH"
+
+
+
+
+
@@ -16190,6 +16246,63 @@ The data will be a simple comma separated list of name and state etc, with one h
+
+
+
+
+
+
+
+
Create a BRAA NATO call string BRAA between two GROUP objects
+
+
+
+
Defined in:
+
+
Parameters:
+
+
+
Return value:
+
+
+
+
+
Formatted BRAA NATO call
+
+
+
+
+
diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html
index f3544e87e..a83daeb86 100644
--- a/Documentation/Wrapper.Positionable.html
+++ b/Documentation/Wrapper.Positionable.html
@@ -3515,17 +3515,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -7088,17 +7077,6 @@ Coordinates are dependent on the position of the maps origin.
-
-
-
-
@@ -7676,17 +7654,6 @@ If the Identifiable is alive, true is returned.
-
-
-
-
@@ -7870,17 +7837,6 @@ If the Identifiable is alive, true is returned.
-
-
-
-