From e5ee36596498a6f1de9e28805688658c11b773b6 Mon Sep 17 00:00:00 2001
From: FlightControl-User
Date: Mon, 21 Dec 2020 14:17:23 +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 | 12 --
Documentation/Cargo.CargoCrate.html | 22 --
Documentation/Cargo.CargoGroup.html | 56 ++---
Documentation/Cargo.CargoUnit.html | 44 ----
Documentation/Core.Fsm.html | 4 +-
Documentation/Core.Point.html | 33 ---
Documentation/Core.Settings.html | 8 +-
Documentation/Core.Spawn.html | 170 +++++++++-------
Documentation/Core.Spot.html | 132 ++++++++++++
Documentation/Functional.Designate.html | 55 +++++
Documentation/Functional.Detection.html | 33 ---
Documentation/Functional.Mantis.html | 77 ++++++-
Documentation/Functional.Rat.html | 6 -
Documentation/Functional.Sead.html | 56 ++++-
Documentation/Ops.Airboss.html | 28 ---
.../Tasking.Task_A2G_Dispatcher.html | 20 +-
Documentation/Tasking.Task_Cargo.html | 6 +-
.../Tasking.Task_Cargo_Dispatcher.html | 192 +++++++++++++++++-
20 files changed, 707 insertions(+), 313 deletions(-)
diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html
index 116eb7392..e96388dca 100644
--- a/Documentation/AI.AI_Air.html
+++ b/Documentation/AI.AI_Air.html
@@ -2769,6 +2769,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -5513,6 +5524,17 @@ Once the time is finished, the old AI will return to the base.
+
+
+
+
@@ -6238,6 +6260,17 @@ Once the time is finished, the old AI will return to the base.
+
+
+
+
@@ -7856,6 +7889,17 @@ 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 310a76016..a957f08a2 100644
--- a/Documentation/AI.AI_Air_Squadron.html
+++ b/Documentation/AI.AI_Air_Squadron.html
@@ -2272,6 +2272,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3343,6 +3354,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 a61a279e3..e3442aeb3 100644
--- a/Documentation/AI.AI_Cargo_Airplane.html
+++ b/Documentation/AI.AI_Cargo_Airplane.html
@@ -2485,9 +2485,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- Aircraft is on a depoly mission.
-
@@ -4264,9 +4261,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- Aircraft is on a depoly mission.
-
@@ -4885,9 +4879,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- Aircraft is on a depoly mission.
-
@@ -6399,9 +6390,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/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html
index 5375a99d6..4348cfca4 100644
--- a/Documentation/Cargo.CargoCrate.html
+++ b/Documentation/Cargo.CargoCrate.html
@@ -1625,17 +1625,6 @@ Controls a network of SAM sites.
Field(s)
-
@@ -2304,17 +2293,6 @@ Controls a network of SAM sites.
Field(s)
-
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html
index 4107edba0..77fff914a 100644
--- a/Documentation/Cargo.CargoGroup.html
+++ b/Documentation/Cargo.CargoGroup.html
@@ -1696,20 +1696,6 @@ Controls a network of SAM sites.
-
-
-
+
@@ -3025,20 +3025,6 @@ This works for ground only groups.
-
-
-
+
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html
index 0e72caf19..5fbf32388 100644
--- a/Documentation/Cargo.CargoUnit.html
+++ b/Documentation/Cargo.CargoUnit.html
@@ -1574,17 +1574,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-
-
-
-
-
-
CARGO_UNIT.CargoInAir
@@ -1600,17 +1589,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-
-
-
-
@@ -2297,17 +2275,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-
-
-
-
-
-
CARGO_UNIT.CargoInAir
@@ -2323,17 +2290,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-
-
-
-
diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html
index 35c75edda..5d4fa323a 100644
--- a/Documentation/Core.Fsm.html
+++ b/Documentation/Core.Fsm.html
@@ -5364,7 +5364,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #string
FSM._StartState
@@ -6968,7 +6968,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 6259e63ed..23b36d011 100644
--- a/Documentation/Core.Point.html
+++ b/Documentation/Core.Point.html
@@ -14566,17 +14566,6 @@ BASE:TraceOnOff( false )
the y coordinate in meters.
-
-
-
-
@@ -15375,17 +15364,6 @@ BASE:TraceOnOff( false )
the y coordinate in meters.
-
-
-
-
@@ -22059,17 +22037,6 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t
the y coordinate in meters.
-
-
-
-
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html
index c219301fb..cb4994423 100644
--- a/Documentation/Core.Settings.html
+++ b/Documentation/Core.Settings.html
@@ -2549,7 +2549,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #string
SETTINGS.A2ASystem
@@ -2604,7 +2604,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #boolean
SETTINGS.Metric
@@ -4651,7 +4651,7 @@ It is advised to use this method at the start of the mission.
-
+ #string
SETTINGS.A2ASystem
@@ -4706,7 +4706,7 @@ It is advised to use this method at the start of the mission.
-
+ #boolean
SETTINGS.Metric
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html
index 7af7b914d..bdb5737ba 100644
--- a/Documentation/Core.Spawn.html
+++ b/Documentation/Core.Spawn.html
@@ -2606,12 +2606,6 @@ and any spaces before and after the resulting name are removed.
SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) |
- |
-
-
- SPAWN.uncontrolled |
-
-
|
@@ -3202,6 +3196,9 @@ 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.
+
@@ -3257,6 +3254,20 @@ 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.
+
@@ -3279,17 +3290,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3436,6 +3436,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3447,16 +3461,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
-
@@ -3465,7 +3471,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
SPAWN.SpawnInitModu
+
SPAWN.SpawnInitLivery
@@ -3511,7 +3517,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #number
SPAWN.SpawnMaxGroups
@@ -3525,7 +3531,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #number
SPAWN.SpawnMaxUnitsAlive
@@ -3671,6 +3677,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3683,7 +3700,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.
@@ -3735,17 +3752,6 @@ 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.
-
-
-
-
@@ -8565,6 +8571,9 @@ 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.
+
@@ -8620,6 +8629,20 @@ 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.
+
@@ -8642,17 +8665,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
@@ -8799,6 +8811,20 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -8810,16 +8836,8 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
-
@@ -8828,7 +8846,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
SPAWN.SpawnInitModu
+
SPAWN.SpawnInitLivery
@@ -8874,7 +8892,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
+ #number
SPAWN.SpawnMaxGroups
@@ -8888,7 +8906,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
+ #number
SPAWN.SpawnMaxUnitsAlive
@@ -9034,6 +9052,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -9046,7 +9075,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.
@@ -9098,17 +9127,6 @@ 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 8596de0b9..72d18a580 100644
--- a/Documentation/Core.Spot.html
+++ b/Documentation/Core.Spot.html
@@ -2504,6 +2504,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
+
@@ -3717,6 +3761,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
+
@@ -5222,6 +5310,50 @@ 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 8b9a6237a..324adefd8 100644
--- a/Documentation/Functional.Designate.html
+++ b/Documentation/Functional.Designate.html
@@ -3257,6 +3257,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -6414,6 +6425,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
@@ -7213,6 +7235,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
@@ -7982,6 +8015,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
@@ -9644,6 +9688,17 @@ Designate:SetFlashStatusMenu( false )
+
+
+
+
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html
index 48b80bef7..9a1e3405a 100644
--- a/Documentation/Functional.Detection.html
+++ b/Documentation/Functional.Detection.html
@@ -18389,17 +18389,6 @@ BASE:TraceOnOff( false )
-
-
-
-
@@ -23091,17 +23080,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual
-
-
-
-
@@ -24849,17 +24827,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 0aade74c9..f1c5b5eb1 100644
--- a/Documentation/Functional.Mantis.html
+++ b/Documentation/Functional.Mantis.html
@@ -1429,20 +1429,39 @@ Leverage attack range setup added by DCS in 11/20.
Set up your EWR system in the mission editor. Name the groups with common prefix like "Red EWR". Can be e.g. AWACS or a combination of AWACS and Search Radars like e.g. EWR 1L13 etc.
[optional] Set up your HQ. Can be any group, e.g. a command vehicle.
-Start up your MANTIS
+1. Start up your MANTIS
myredmantis = MANTIS:New("myredmantis","Red SAM","Red EWR",nil,"red",false)
-[optional] Use
- * MANTIS:SetEWRGrouping(radius)
- * MANTIS:SetEWRRange(radius)
- * MANTIS:SetSAMRadius(radius)
- * MANTIS:SetDetectInterval(interval)
- * MANTIS:SetAutoRelocate(hq, ewr)
-to fine-tune your setup.
+[optional] Use
+
+
+ MANTIS:SetEWRGrouping(radius)
+ MANTIS:SetEWRRange(radius)
+ MANTIS:SetSAMRadius(radius)
+ MANTIS:SetDetectInterval(interval)
+ MANTIS:SetAutoRelocate(hq, ewr)
+
+
+to fine-tune your setup.
myredmantis:Start()
+2. Default settings
+
+By default, the following settings are active:
+
+
+ - checkradius = 25000 (meters) - SAMs will engage enemy flights, if they are within a 25km around each SAM site -
MANTIS:SetSAMRadius(radius)
+ - grouping = 5000 (meters) - Detection (EWR) will group enemy flights to areas of 5km for tracking -
MANTIS:SetEWRGrouping(radius)
+ - acceptrange = 80000 (meters) - Detection (EWR) will on consider flights inside a 80km radius -
MANTIS:SetEWRRange(radius)
+ - detectinterval = 30 (seconds) - MANTIS will decide every 30 seconds which SAM to activate -
MANTIS:SetDetectInterval(interval)
+ - engagerange = 75 (percent) - SAMs will only fire if flights are inside of a 75% radius of their max firerange -
MANTIS:SetSAMRange(range)
+ - dynamic = false - Group filtering is set to once, i.e. newly added groups will not be part of the setup by default -
MANTIS:New(name,samprefix,ewrprefix,hq,coaltion,dynamic)
+ - autorelocate = false - HQ and (mobile) EWR system will not relocate in random intervals between 30mins and 1 hour -
MANTIS:SetAutoRelocate(hq, ewr)
+ - debug = false - Debugging reports on screen are set to off -
MANTIS:Debug(onoff)
+
+
@@ -1613,6 +1632,12 @@ to fine-tune your setup.
MANTIS:SetSAMRadius(radius) |
Function to set switch-on/off zone for the SAM sites in meters
+ |
+
+
+ MANTIS:SetSAMRange(range) |
+
+ Function to set SAM firing engage range, 0-100 percent, e.g.
|
@@ -2426,6 +2451,42 @@ to fine-tune your setup.
+
+
+
+
+
+
+
+
Function to set SAM firing engage range, 0-100 percent, e.g.
+
+
+
75
+
+
+
+
Defined in:
+
+
Parameter:
+
+
+
+
+
Percent of the max fire range
+
+
+
+
+
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html
index 050c08c82..c17ccb17e 100644
--- a/Documentation/Functional.Rat.html
+++ b/Documentation/Functional.Rat.html
@@ -4192,12 +4192,6 @@ and any spaces before and after the resulting name are removed.
RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) |
- |
-
-
- RAT.uncontrolled |
-
-
|
diff --git a/Documentation/Functional.Sead.html b/Documentation/Functional.Sead.html
index 8cf9eb9ce..ea0c1f883 100644
--- a/Documentation/Functional.Sead.html
+++ b/Documentation/Functional.Sead.html
@@ -1388,7 +1388,9 @@ Controls a network of SAM sites.
-Authors: FlightControl
+Authors: FlightControl, applevangelist
+
+Last Update: Dec 2020
@@ -1462,6 +1464,12 @@ Controls a network of SAM sites.
SEAD:SetEngagementRange(range) |
Sets the engagement range of the SAMs.
+ |
+
+
+ SEAD:UpdateSet(SEADGroupPrefixes) |
+
+ Update the active SEAD Set
|
@@ -2007,7 +2015,7 @@ Chances are big that the missile will miss.
-
string,...}|string SEADGroupPrefixes which is a table of Prefixes of the SA Groups in the DCSRTE on which evasive actions need to be taken.
+
string,...}|string SEADGroupPrefixes which is a table of Prefixes of the SA Groups in the DCS mission editor on which evasive actions need to be taken.
@@ -2138,6 +2146,50 @@ SEAD_RU_SAM_Defenses = SEAD:New( { 'RU SA-6 Kub', 'RU SA-6 Defenses', 'RU MI-26
+
+
+
+
+
+
+
+
Update the active SEAD Set
+
+
+
+
Defined in:
+
+
Parameter:
+
+
+
+ #table
+ SEADGroupPrefixes
+
+
+
+
+
The prefixes to add, note: can also be a single #string
+
+
+
+
Return value:
+
+
+
diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html
index b9721de1a..fd04a33d1 100644
--- a/Documentation/Ops.Airboss.html
+++ b/Documentation/Ops.Airboss.html
@@ -37676,20 +37676,6 @@ BASE:TraceOnOff( false )
-
-
@@ -37699,17 +37685,6 @@ BASE:TraceOnOff( false )
Data table at each position in the groove. Elements are of type AIRBOSS.GrooveData.
-
-
-
-
@@ -37834,9 +37809,6 @@ BASE:TraceOnOff( false )
-
- Make player section lead if he was not before.
-
diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html
index 08a5d1520..53149b97c 100644
--- a/Documentation/Tasking.Task_A2G_Dispatcher.html
+++ b/Documentation/Tasking.Task_A2G_Dispatcher.html
@@ -2918,11 +2918,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -3495,11 +3498,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -4682,11 +4688,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -6176,11 +6185,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html
index 806dada3a..28c26bdd5 100644
--- a/Documentation/Tasking.Task_Cargo.html
+++ b/Documentation/Tasking.Task_Cargo.html
@@ -3037,7 +3037,7 @@ based on the tasking capabilities defined in