From 1a4c045d593384f7fb90737b2f89ac524aac812d Mon Sep 17 00:00:00 2001
From: Applevangelist
Date: Wed, 18 Aug 2021 07:42:23 +0000
Subject: [PATCH] MOOSE generated documentation [skip ci]
---
Documentation/AI.AI_Air_Squadron.html | 22 --
Documentation/AI.AI_Cargo.html | 12 +
Documentation/AI.AI_Cargo_Airplane.html | 56 +----
Documentation/AI.AI_Cargo_Helicopter.html | 40 +---
Documentation/Cargo.CargoCrate.html | 22 ++
Documentation/Cargo.CargoGroup.html | 56 ++---
Documentation/Cargo.CargoUnit.html | 22 ++
Documentation/Core.Fsm.html | 4 +-
Documentation/Core.Settings.html | 26 ++-
Documentation/Core.Spawn.html | 212 ++++++++++++------
Documentation/Core.Spot.html | 99 ++++++++
Documentation/Functional.Detection.html | 39 +++-
Documentation/Functional.Mantis.html | 28 ---
Documentation/Functional.Rat.html | 65 +++++-
Documentation/Ops.Airboss.html | 23 +-
Documentation/Ops.CSAR.html | 207 +++++++++++++++--
Documentation/Ops.CTLD.html | 180 +++++++++++++--
Documentation/Tasking.Task_Cargo.html | 6 +-
.../Tasking.Task_Cargo_Dispatcher.html | 24 +-
Documentation/Wrapper.Client.html | 14 +-
Documentation/Wrapper.Positionable.html | 44 ----
21 files changed, 857 insertions(+), 344 deletions(-)
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html
index da6cda728..dc98ca3b5 100644
--- a/Documentation/AI.AI_Air_Squadron.html
+++ b/Documentation/AI.AI_Air_Squadron.html
@@ -2438,17 +2438,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3520,17 +3509,6 @@ 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 92d1a1679..2020f568b 100644
--- a/Documentation/AI.AI_Cargo.html
+++ b/Documentation/AI.AI_Cargo.html
@@ -2672,6 +2672,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.
+
@@ -4702,6 +4705,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.
+
@@ -5314,6 +5320,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.
+
@@ -6818,6 +6827,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 3524ce555..fc6268d69 100644
--- a/Documentation/AI.AI_Cargo_Airplane.html
+++ b/Documentation/AI.AI_Cargo_Airplane.html
@@ -2621,17 +2621,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -2690,6 +2679,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Aircraft is on a pickup mission.
+
@@ -4408,17 +4400,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -4477,6 +4458,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Aircraft is on a pickup mission.
+
@@ -5037,17 +5021,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -5106,6 +5079,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Aircraft is on a pickup mission.
+
@@ -6558,17 +6534,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
@@ -6627,6 +6592,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 f4adecf17..a56dddeeb 100644
--- a/Documentation/AI.AI_Cargo_Helicopter.html
+++ b/Documentation/AI.AI_Cargo_Helicopter.html
@@ -2786,28 +2786,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -4710,28 +4704,22 @@ Adjust if necessary.
@@ -5386,28 +5374,22 @@ Adjust if necessary.
@@ -6954,28 +6936,22 @@ Adjust if necessary.
diff --git a/Documentation/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html
index 4774a7526..1a92434e6 100644
--- a/Documentation/Cargo.CargoCrate.html
+++ b/Documentation/Cargo.CargoCrate.html
@@ -1749,6 +1749,17 @@ Controls a network of short range air/missile defense groups.
Field(s)
+
@@ -2417,6 +2428,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 c0005729c..8cf26ce7e 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
@@ -1849,6 +1835,20 @@ Controls a network of short range air/missile defense groups.
+
+
+
+
@@ -3138,20 +3138,6 @@ This works for ground only groups.
-
-
-
+
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html
index 820f688bb..c1b1d60de 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 85d4686f5..7e8aa11bd 100644
--- a/Documentation/Core.Fsm.html
+++ b/Documentation/Core.Fsm.html
@@ -5656,7 +5656,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string
+
FSM._StartState
@@ -7259,7 +7259,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string
+
FSM._StartState
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html
index 113864f7c..7e54118ff 100644
--- a/Documentation/Core.Settings.html
+++ b/Documentation/Core.Settings.html
@@ -2726,7 +2726,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string
+
SETTINGS.A2GSystem
@@ -2775,6 +2775,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -4820,7 +4831,7 @@ It is advised to use this method at the start of the mission.
- #string
+
SETTINGS.A2GSystem
@@ -4869,6 +4880,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 7f0c22df2..7f2673ef9 100644
--- a/Documentation/Core.Spawn.html
+++ b/Documentation/Core.Spawn.html
@@ -2733,7 +2733,31 @@ and any spaces before and after the resulting name are removed.
- SPAWN.uncontrolled |
+ SPAWN.communication |
+
+
+ |
+
+
+ SPAWN.frequency |
+
+
+ |
+
+
+ SPAWN.livery_id |
+
+
+ |
+
+
+ SPAWN.modulation |
+
+
+ |
+
+
+ SPAWN.skill |
|
@@ -3423,6 +3447,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.
+
@@ -3536,17 +3574,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3624,17 +3651,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3646,17 +3662,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3919,7 +3924,51 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
+
+
+
+
SPAWN.skill
@@ -8797,6 +8846,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.
+
@@ -8910,17 +8973,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
@@ -8998,17 +9050,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
@@ -9020,17 +9061,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
@@ -9293,7 +9323,51 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-SPAWN.uncontrolled
+SPAWN.communication
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SPAWN.skill
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html
index 0b858fece..b0b52b35e 100644
--- a/Documentation/Core.Spot.html
+++ b/Documentation/Core.Spot.html
@@ -2670,6 +2670,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
@@ -3883,6 +3916,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
@@ -5387,6 +5453,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 b6eb5ef46..42d3e84aa 100644
--- a/Documentation/Functional.Detection.html
+++ b/Documentation/Functional.Detection.html
@@ -18775,6 +18775,17 @@ BASE:TraceOnOff( false )
+
+
+
+
@@ -18935,7 +18946,7 @@ BASE:TraceOnOff( false )
+
@@ -23637,7 +23659,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
+
@@ -25394,7 +25427,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
-
+ #number
DETECTION_BASE.RefreshTimeInterval
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html
index 003da61f1..11a80f5fe 100644
--- a/Documentation/Functional.Mantis.html
+++ b/Documentation/Functional.Mantis.html
@@ -2802,17 +2802,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
The #DETECTION_AREAS object for AWACS
-
-
-
-
@@ -3215,9 +3204,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- switch alarm state RED
-
@@ -5787,17 +5773,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
The #DETECTION_AREAS object for AWACS
-
-
-
-
@@ -6200,9 +6175,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
-
- switch alarm state RED
-
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html
index ccab606d8..73672ba28 100644
--- a/Documentation/Functional.Rat.html
+++ b/Documentation/Functional.Rat.html
@@ -3358,6 +3358,12 @@ manager:Stop(7200)
RAT.termtype |
Type of terminal to be used when spawning at an airbase.
+ |
+
+
+ RAT.type |
+
+
|
@@ -4321,7 +4327,31 @@ and any spaces before and after the resulting name are removed.
- RAT.uncontrolled |
+ RAT.communication |
+
+
+ |
+
+
+ RAT.frequency |
+
+
+ |
+
+
+ RAT.livery_id |
+
+
+ |
+
+
+ RAT.modulation |
+
+
+ |
+
+
+ RAT.skill |
|
@@ -6695,6 +6725,17 @@ 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.
+
+
+
+
@@ -14575,6 +14616,17 @@ Initializes the ratcraft array and group menu.
Type of terminal to be used when spawning at an airbase.
+
+
+
+
@@ -20510,6 +20562,17 @@ 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 56f332feb..5c8b02bd8 100644
--- a/Documentation/Ops.Airboss.html
+++ b/Documentation/Ops.Airboss.html
@@ -38511,7 +38511,7 @@ BASE:TraceOnOff( false )
- Set case of f
+ Set case to that of lead.
@@ -38574,10 +38574,13 @@ BASE:TraceOnOff( false )
@@ -38585,10 +38588,10 @@ BASE:TraceOnOff( false )
@@ -38714,9 +38717,6 @@ BASE:TraceOnOff( false )
-
-
Make player section lead if he was not before.
-
@@ -38761,9 +38761,6 @@ BASE:TraceOnOff( false )
-
- Set time stamp.
-
diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html
index b7725df8e..f35106638 100644
--- a/Documentation/Ops.CSAR.html
+++ b/Documentation/Ops.CSAR.html
@@ -1588,6 +1588,7 @@ Create a late-activated single infantry unit as template in the mission editor a
self.allowDownedPilotCAcontrol = false -- Set to false if you don\'t want to allow control by Combined Arms.
self.allowFARPRescue = true -- allows pilots to be rescued by landing at a FARP or Airbase. Else MASH only!
+ self.FARPRescueDistance = 1000 -- you need to be this close to a FARP or Airport for the pilot to be rescued.
self.autosmoke = false -- automatically smoke a downed pilot\'s location when a heli is near.
self.autosmokedistance = 1000 -- distance for autosmoke
self.coordtype = 1 -- Use Lat/Long DDM (0), Lat/Long DMS (1), MGRS (2), Bullseye imperial (3) or Bullseye metric (4) for coordinates.
@@ -1722,6 +1723,12 @@ Create a late-activated single infantry unit as template in the mission editor a
CSAR.ClassName |
Name of the class.
+ |
+
+
+ CSAR.FARPRescueDistance |
+
+
|
@@ -2025,7 +2032,7 @@ Create a late-activated single infantry unit as template in the mission editor a
- CSAR:_ScheduledSARFlight(heliname, groupname) |
+ CSAR:_ScheduledSARFlight(heliname, groupname, isairport) |
(Internal) Monitor in-flight returning groups.
|
@@ -2325,7 +2332,7 @@ Create a late-activated single infantry unit as template in the mission editor a
- CSAR:onbeforeReturning(From, Event, To, Heliname, Woundedgroupname) |
+ CSAR:onbeforeReturning(From, Event, To, Heliname, Woundedgroupname, IsAirport, IsAirPort) |
(Internal) Function called before Returning() event.
|
@@ -3426,6 +3433,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+ #number
+
CSAR.FARPRescueDistance
+
+
+
+
+
you need to be this close to a FARP or Airport for the pilot to be rescued.
+
+
+
@@ -3679,25 +3700,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -4004,6 +4025,34 @@ 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
+
+
+
@@ -6669,7 +6718,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
(Internal) Monitor in-flight returning groups.
@@ -6705,6 +6754,19 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Group name
+
+
+
+
+
+ #boolean
+ isairport
+
+
+
+
+
If true, EVENT.Landing took place at an airport or FARP
+
@@ -7614,7 +7676,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
(Internal) Function called before Returning() event.
@@ -7691,6 +7753,29 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+ #boolean
+ IsAirport
+
+
+
+
+
True if heli has landed on an AFB (from event land).
+
+
+
+
@@ -7779,6 +7864,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+ #number
+
CSAR.FARPRescueDistance
+
+
+
+
+
you need to be this close to a FARP or Airport for the pilot to be rescued.
+
+
+
@@ -8032,25 +8131,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -8357,6 +8456,34 @@ 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
+
+
+
@@ -9942,6 +10069,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+ #number
+
CSAR.FARPRescueDistance
+
+
+
+
+
you need to be this close to a FARP or Airport for the pilot to be rescued.
+
+
+
@@ -10195,25 +10336,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -10520,6 +10661,34 @@ 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 0116045fc..a3a1ec668 100644
--- a/Documentation/Ops.CTLD.html
+++ b/Documentation/Ops.CTLD.html
@@ -4855,6 +4855,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
@@ -4910,6 +4921,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Name of the class.
+
+
+
+
@@ -4941,7 +4963,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.CtldUnits
@@ -4963,7 +4985,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.DroppedTroops
@@ -4988,7 +5010,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeFMFrequencies
@@ -5015,6 +5037,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Beacons
+
@@ -5140,11 +5165,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -5170,6 +5198,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
radio beacons
+
+
+
+
@@ -5192,6 +5231,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -5411,7 +5461,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
noob catch
+
time to repair a unit/group
@@ -10242,6 +10292,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
@@ -10297,6 +10358,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Name of the class.
+
+
+
+
@@ -10328,7 +10400,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.CtldUnits
@@ -10350,7 +10422,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.DroppedTroops
@@ -10375,7 +10447,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeFMFrequencies
@@ -10402,6 +10474,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Beacons
+
@@ -10527,11 +10602,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -10557,6 +10635,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
radio beacons
+
+
+
+
@@ -10579,6 +10668,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -10798,7 +10898,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
noob catch
+
time to repair a unit/group
@@ -12324,6 +12424,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
@@ -12379,6 +12490,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Name of the class.
+
+
+
+
@@ -12410,7 +12532,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.CtldUnits
@@ -12432,7 +12554,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.DroppedTroops
@@ -12457,7 +12579,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #table
CTLD.FreeFMFrequencies
@@ -12484,6 +12606,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Beacons
+
@@ -12609,11 +12734,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
@@ -12639,6 +12767,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
radio beacons
+
+
+
+
@@ -12661,6 +12800,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -12880,7 +13030,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- noob catch
+ time to repair a unit/group
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html
index ff52e0a12..a0f6a6048 100644
--- a/Documentation/Tasking.Task_Cargo.html
+++ b/Documentation/Tasking.Task_Cargo.html
@@ -3150,7 +3150,7 @@ based on the tasking capabilities defined in