From e56f7edc1765e9a6a5121ee070e84d5d500318c7 Mon Sep 17 00:00:00 2001
From: Applevangelist
Date: Wed, 12 Oct 2022 14:36:35 +0000
Subject: [PATCH] MOOSE generated documentation [skip ci]
---
Documentation/AI.AI_A2G_Dispatcher.html | 20 +-
Documentation/AI.AI_AIR_Dispatcher.html | 44 ----
Documentation/AI.AI_Air.html | 44 ----
Documentation/AI.AI_Air_Squadron.html | 22 --
Documentation/AI.AI_Cargo_Airplane.html | 44 ----
Documentation/AI.AI_Cargo_Helicopter.html | 40 ++-
Documentation/AI.AI_Patrol.html | 12 +
Documentation/Cargo.CargoCrate.html | 22 --
Documentation/Cargo.CargoGroup.html | 28 --
Documentation/Cargo.CargoUnit.html | 44 ++--
Documentation/Core.Point.html | 33 ---
Documentation/Core.Spawn.html | 246 +++++++++++++++---
Documentation/Core.Spot.html | 33 +++
Documentation/Functional.Designate.html | 110 ++++++++
Documentation/Functional.Mantis.html | 156 +++++------
Documentation/Functional.Rat.html | 63 ++---
Documentation/Ops.Airboss.html | 22 +-
Documentation/Ops.CSAR.html | 21 +-
Documentation/Ops.CTLD.html | 168 ++++++++++--
Documentation/Tasking.Task_Cargo.html | 19 +-
.../Tasking.Task_Cargo_Dispatcher.html | 52 +++-
Documentation/Utils.FiFo.html | 22 --
Documentation/Wrapper.Group.html | 78 +-----
Documentation/Wrapper.Scenery.html | 6 +-
24 files changed, 751 insertions(+), 598 deletions(-)
diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html
index 5c5f9a436..3952481a1 100644
--- a/Documentation/AI.AI_A2G_Dispatcher.html
+++ b/Documentation/AI.AI_A2G_Dispatcher.html
@@ -4883,14 +4883,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -13364,14 +13361,11 @@ multiplied by the Overhead and rounded up to the smallest integer.
@@ -14695,14 +14689,11 @@ multiplied by the Overhead and rounded up to the smallest integer.
@@ -16328,14 +16319,11 @@ multiplied by the Overhead and rounded up to the smallest integer.
diff --git a/Documentation/AI.AI_AIR_Dispatcher.html b/Documentation/AI.AI_AIR_Dispatcher.html
index c3872a47b..5636ecc32 100644
--- a/Documentation/AI.AI_AIR_Dispatcher.html
+++ b/Documentation/AI.AI_AIR_Dispatcher.html
@@ -4527,17 +4527,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
The Defender Default Settings over all Squadrons.
-
-
-
-
@@ -9835,17 +9824,6 @@ multiplied by the Overhead and rounded up to the smallest integer.
The Defender Default Settings over all Squadrons.
-
-
-
-
@@ -11163,17 +11141,6 @@ multiplied by the Overhead and rounded up to the smallest integer.
The Defender Default Settings over all Squadrons.
-
-
-
-
@@ -12793,17 +12760,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.html b/Documentation/AI.AI_Air.html
index aa0b79b17..daf0f9903 100644
--- a/Documentation/AI.AI_Air.html
+++ b/Documentation/AI.AI_Air.html
@@ -3042,17 +3042,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -5859,17 +5848,6 @@ A random value in this bracket is then applied in the waypoint routing generatio
-
-
-
-
@@ -6595,17 +6573,6 @@ A random value in this bracket is then applied in the waypoint routing generatio
-
-
-
-
@@ -8219,17 +8186,6 @@ A random value in this bracket is then applied in the waypoint routing generatio
-
-
-
-
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html
index cccdcae38..c50525da6 100644
--- a/Documentation/AI.AI_Air_Squadron.html
+++ b/Documentation/AI.AI_Air_Squadron.html
@@ -2527,17 +2527,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3609,17 +3598,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 880e6e8d8..3695d9b75 100644
--- a/Documentation/AI.AI_Cargo_Airplane.html
+++ b/Documentation/AI.AI_Cargo_Airplane.html
@@ -2710,17 +2710,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -4497,17 +4486,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -5126,17 +5104,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -6643,17 +6610,6 @@ 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 21b5da8b1..1c4c459c4 100644
--- a/Documentation/AI.AI_Cargo_Helicopter.html
+++ b/Documentation/AI.AI_Cargo_Helicopter.html
@@ -2875,22 +2875,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -4793,22 +4799,28 @@ Adjust if necessary.
@@ -5463,22 +5475,28 @@ Adjust if necessary.
@@ -7021,22 +7039,28 @@ Adjust if necessary.
diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html
index af18e58ec..d55f0f146 100644
--- a/Documentation/AI.AI_Patrol.html
+++ b/Documentation/AI.AI_Patrol.html
@@ -3226,6 +3226,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
This table contains the targets detected during patrol.
+
@@ -6473,6 +6476,9 @@ Note that this method is required, as triggers the next route when patrolling fo
+
+
This table contains the targets detected during patrol.
+
@@ -7217,6 +7223,9 @@ Note that this method is required, as triggers the next route when patrolling fo
+
+
This table contains the targets detected during patrol.
+
@@ -8849,6 +8858,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 212f38705..a8be423c5 100644
--- a/Documentation/Cargo.CargoCrate.html
+++ b/Documentation/Cargo.CargoCrate.html
@@ -1831,17 +1831,6 @@ Controls a network of short range air/missile defense groups.
Field(s)
-
@@ -2510,17 +2499,6 @@ 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 da1a9b195..9b1483c5d 100644
--- a/Documentation/Cargo.CargoGroup.html
+++ b/Documentation/Cargo.CargoGroup.html
@@ -1917,20 +1917,6 @@ Controls a network of short range air/missile defense groups.
-
-
-
-
@@ -3235,20 +3221,6 @@ This works for ground only groups.
-
-
-
-
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html
index 5f682ff0c..52bb45786 100644
--- a/Documentation/Cargo.CargoUnit.html
+++ b/Documentation/Cargo.CargoUnit.html
@@ -1780,17 +1780,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-
-
-
-
-
-
CARGO_UNIT.CargoInAir
@@ -1809,6 +1798,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
Set cargo object.
+
+
+
+
@@ -2495,17 +2495,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-
-
-
-
-
-
CARGO_UNIT.CargoInAir
@@ -2524,6 +2513,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
Set cargo object.
+
+
+
+
diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html
index 578265a69..3700ee6dd 100644
--- a/Documentation/Core.Point.html
+++ b/Documentation/Core.Point.html
@@ -17551,17 +17551,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
the y coordinate in meters.
-
-
-
-
@@ -18360,17 +18349,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
the y coordinate in meters.
-
-
-
-
@@ -26712,17 +26690,6 @@ Creates a line on the F10 map from one point to another.
the y coordinate in meters.
-
-
-
-
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html
index 225687010..cb71c210a 100644
--- a/Documentation/Core.Spawn.html
+++ b/Documentation/Core.Spawn.html
@@ -2817,6 +2817,30 @@ and any spaces before and after the resulting name are removed.
SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) |
+ |
+
+
+ SPAWN.frequency |
+
+
+ |
+
+
+ SPAWN.livery_id |
+
+
+ |
+
+
+ SPAWN.modulation |
+
+
+ |
+
+
+ SPAWN.skill |
+
+
|
@@ -3382,14 +3406,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.
-
@@ -3553,6 +3574,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3589,6 +3621,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3677,20 +3720,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3708,8 +3737,30 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
SPAWN.SpawnInitModu
@@ -3968,6 +4019,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.
+
+
+
+
+
+
+
@@ -8717,14 +8812,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.
-
@@ -8888,6 +8980,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -8924,6 +9027,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -9012,20 +9126,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
@@ -9043,8 +9143,30 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
+
+
+
+
+
SPAWN.SpawnInitModu
@@ -9303,6 +9425,50 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups. When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.
+
+
+
+
+
+
+
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html
index a7c09ff87..eac4f9bfe 100644
--- a/Documentation/Core.Spot.html
+++ b/Documentation/Core.Spot.html
@@ -2804,6 +2804,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -4098,6 +4109,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -5631,6 +5653,17 @@ 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 1d13c4953..735ccb987 100644
--- a/Documentation/Functional.Designate.html
+++ b/Documentation/Functional.Designate.html
@@ -3512,6 +3512,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3523,6 +3534,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -6676,6 +6698,17 @@ Using the menu system, the player can "forget" a designation, so that gradually
+
+
+
+
@@ -6687,6 +6720,17 @@ Using the menu system, the player can "forget" a designation, so that gradually
+
+
+
+
@@ -7475,6 +7519,17 @@ Using the menu system, the player can "forget" a designation, so that gradually
+
+
+
+
@@ -7486,6 +7541,17 @@ Using the menu system, the player can "forget" a designation, so that gradually
+
+
+
+
@@ -8244,6 +8310,17 @@ Using the menu system, the player can "forget" a designation, so that gradually
+
+
+
+
@@ -8255,6 +8332,17 @@ Using the menu system, the player can "forget" a designation, so that gradually
+
+
+
+
@@ -9901,6 +9989,17 @@ Using the menu system, the player can "forget" a designation, so that gradually
+
+
+
+
@@ -9912,6 +10011,17 @@ Using the menu system, the player can "forget" a designation, so that gradually
+
+
+
+
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html
index 5298ed7b4..80cbadb00 100644
--- a/Documentation/Functional.Mantis.html
+++ b/Documentation/Functional.Mantis.html
@@ -1964,6 +1964,12 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
MANTIS:GetCommandCenter() |
Function to get the HQ object for further use
+ |
+
+
+ MANTIS.Groupset |
+
+
|
@@ -3578,6 +3584,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
The #DETECTION_AREAS object for AWACS
+
+
+
+
@@ -3688,6 +3705,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Prefix to build the #SET_GROUP for EWR group
+
+
+
+
@@ -3749,7 +3777,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
MANTIS.SAM_Table_Long
@@ -3760,7 +3788,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
MANTIS.SAM_Table_Medium
@@ -3771,7 +3799,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
MANTIS.SAM_Table_Short
@@ -4123,50 +4151,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Prefix for logging
-
-
-
-
-
-
-
@@ -4225,6 +4209,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
switch alarm state RED
+
@@ -8079,6 +8066,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
The #DETECTION_AREAS object for AWACS
+
+
+
+
@@ -8189,6 +8187,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
Prefix to build the #SET_GROUP for EWR group
+
+
+
+
@@ -8250,7 +8259,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- #table
+
MANTIS.SAM_Table_Long
@@ -8261,7 +8270,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- #table
+
MANTIS.SAM_Table_Medium
@@ -8272,7 +8281,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- #table
+
MANTIS.SAM_Table_Short
@@ -8624,50 +8633,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
Prefix for logging
-
-
-
-
-
-
-
@@ -8726,6 +8691,9 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
+
+
switch alarm state RED
+
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html
index ba1f12440..03d648370 100644
--- a/Documentation/Functional.Rat.html
+++ b/Documentation/Functional.Rat.html
@@ -3440,12 +3440,6 @@ manager:Stop(7200)
RAT.termtype |
Type of terminal to be used when spawning at an airbase.
- |
-
-
- RAT.type |
-
-
|
@@ -4413,6 +4407,30 @@ and any spaces before and after the resulting name are removed.
RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) |
+ |
+
+
+ RAT.frequency |
+
+
+ |
+
+
+ RAT.livery_id |
+
+
+ |
+
+
+ RAT.modulation |
+
+
+ |
+
+
+ RAT.skill |
+
+
|
@@ -6804,17 +6822,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Type of terminal to be used when spawning at an airbase.
-
-
-
-
@@ -14695,17 +14702,6 @@ Initializes the ratcraft array and group menu.
Type of terminal to be used when spawning at an airbase.
-
-
-
-
@@ -20640,17 +20636,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.Type of terminal to be used when spawning at an airbase.
-
-
-
-
diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html
index d2f940763..8f0e914b3 100644
--- a/Documentation/Ops.Airboss.html
+++ b/Documentation/Ops.Airboss.html
@@ -39583,9 +39583,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-
- Set current case.
-
@@ -39648,6 +39645,20 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
+
+
+
+
AIRBOSS.PlayerData.grade
@@ -39802,7 +39813,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
-
Set section lead of player flight.
+
Make player section lead if he was not before.
@@ -39859,6 +39870,9 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
Set new time stamp.
+
diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html
index dce37be9c..609a28368 100644
--- a/Documentation/Ops.CSAR.html
+++ b/Documentation/Ops.CSAR.html
@@ -3764,7 +3764,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
CSAR.FreeVHFFrequencies
@@ -4141,14 +4141,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -8876,7 +8873,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
CSAR.FreeVHFFrequencies
@@ -9253,14 +9250,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -11291,7 +11285,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table
+
CSAR.FreeVHFFrequencies
@@ -11668,14 +11662,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html
index 68386b3c1..d0078b460 100644
--- a/Documentation/Ops.CTLD.html
+++ b/Documentation/Ops.CTLD.html
@@ -7040,6 +7040,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
@@ -7106,6 +7117,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Name of the class.
+
+
+
+
@@ -7180,6 +7202,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
@@ -7220,7 +7256,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeFMFrequencies
@@ -7375,14 +7411,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -7610,6 +7643,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#1570
+
+
+
+
@@ -7893,7 +7937,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number
+
CTLD.troopdropzoneradius
@@ -14609,6 +14653,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
@@ -14675,6 +14730,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Name of the class.
+
+
+
+
@@ -14749,6 +14815,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
@@ -14789,7 +14869,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeFMFrequencies
@@ -14944,14 +15024,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -15179,6 +15256,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#1570
+
+
+
+
@@ -15462,7 +15550,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number
+
CTLD.troopdropzoneradius
@@ -16973,6 +17061,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
@@ -17039,6 +17138,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Name of the class.
+
+
+
+
@@ -17113,6 +17223,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
@@ -17153,7 +17277,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeFMFrequencies
@@ -17308,14 +17432,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -17543,6 +17664,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#1570
+
+
+
+
@@ -17826,7 +17958,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
GROUP.InitRespawnRandomizePositionOuter
+
GROUP.InitRespawnRandomizePositionZone
diff --git a/Documentation/Wrapper.Scenery.html b/Documentation/Wrapper.Scenery.html
index 5a41e0d90..93e8db089 100644
--- a/Documentation/Wrapper.Scenery.html
+++ b/Documentation/Wrapper.Scenery.html
@@ -1638,7 +1638,7 @@ Controls a network of short range air/missile defense groups.
SCENERY:FindByName(name) |
- Find a SCENERY object by it's name/id.
+ Create a SCENERY object from it's name/id.
|
@@ -2938,7 +2938,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Find a SCENERY object by it's name/id.
+ Create a SCENERY object from it's name/id.
@@ -2967,7 +2967,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
Scenery Object or nil if not found.
+
Scenery Object - Note this might not point to anything useful. Check with myscenery:IsAlive() if it is valid.