From f8aa4721fc73f33f63e09cd2758c0b44eea50dc8 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Thu, 11 Jun 2020 21:49:00 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2G_Dispatcher.html | 44 ---- Documentation/AI.AI_Air_Squadron.html | 22 ++ Documentation/AI.AI_Cargo.html | 12 + Documentation/AI.AI_Cargo_Airplane.html | 12 - Documentation/Cargo.CargoGroup.html | 28 --- Documentation/Core.Fsm.html | 22 ++ Documentation/Core.Point.html | 6 - Documentation/Core.Settings.html | 26 +- Documentation/Core.Spawn.html | 230 +++++++----------- Documentation/Core.SpawnStatic.html | 107 ++++++++ Documentation/Core.Spot.html | 99 ++++++++ Documentation/Functional.Detection.html | 66 ++--- Documentation/Functional.Rat.html | 63 ----- Documentation/Ops.Airboss.html | 83 ++++++- Documentation/Tasking.Task_Cargo.html | 19 +- .../Tasking.Task_Cargo_Dispatcher.html | 32 +-- Documentation/Wrapper.Positionable.html | 44 ++++ 17 files changed, 549 insertions(+), 366 deletions(-) diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index bf1e7c576..181389364 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4424,17 +4424,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -12778,17 +12767,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -14106,17 +14084,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -15486,17 +15453,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 0d5b2966a..d1fc7631b 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2223,6 +2223,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +AI_AIR_SQUADRON.ResourceCount + + +
@@ -3294,6 +3305,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +AI_AIR_SQUADRON.ResourceCount + + +
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index 61ce34e14..21d0e795a 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2451,6 +2451,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.

+ @@ -4488,6 +4491,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.

+ @@ -5100,6 +5106,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.

+ @@ -6350,6 +6359,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 d87db048b..76ed12dc5 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2444,9 +2444,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

- @@ -4234,9 +4231,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

- @@ -4866,9 +4860,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

- @@ -6136,9 +6127,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.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 84e4af5b4..5f604db35 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1647,20 +1647,6 @@
-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- - -
-
- - CARGO_GROUP.CargoGroup @@ -2990,20 +2976,6 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 11b55d589..0a1d75a42 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5296,6 +5296,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +FSM.current + + +
@@ -6612,6 +6623,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + +FSM.current + + +
diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index e2bcf0d27..01b269bd0 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -4686,9 +4686,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Coordinates.

- @@ -11205,9 +11202,6 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t - -

Coordinates.

- diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 0bd4252a7..0cf320603 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2555,11 +2555,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -4646,11 +4657,22 @@ It is advised to use this method at the start of the mission.

- + #boolean SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index e652bc633..982f80b61 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2557,30 +2557,6 @@ and any spaces before and after the resulting name are removed.

SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

- - - -

SPAWN.communication

- - - - - -

SPAWN.frequency

- - - - - -

SPAWN.livery_id

- - - - - -

SPAWN.modulation

- - @@ -3232,6 +3208,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.

+
@@ -3345,6 +3335,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -3400,6 +3401,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #boolean +SPAWN.SpawnInitKeepUnitNames + + + + +

Overwrite unit names by default with group name.

+
@@ -3411,6 +3426,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

By default, no InitLimit

+ @@ -3422,17 +3440,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWN.SpawnInitModex - - -
@@ -3475,7 +3482,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxGroups @@ -3489,7 +3496,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxUnitsAlive @@ -3658,7 +3665,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.

@@ -3710,50 +3717,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.

-
- -
-
-
- - -SPAWN.communication - - - -
- -
-
-
- - -SPAWN.frequency - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - -
@@ -8639,6 +8602,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.

+
@@ -8752,6 +8729,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -8807,6 +8795,20 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + #boolean +SPAWN.SpawnInitKeepUnitNames + + + + +

Overwrite unit names by default with group name.

+
@@ -8818,6 +8820,9 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

+ @@ -8829,17 +8834,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - -SPAWN.SpawnInitModex - - -
@@ -8882,7 +8876,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- + #number SPAWN.SpawnMaxGroups @@ -8896,7 +8890,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- + #number SPAWN.SpawnMaxUnitsAlive @@ -9065,7 +9059,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.

@@ -9117,50 +9111,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.

-
- - -
-
- - -SPAWN.communication - - - -
- -
-
-
- - -SPAWN.frequency - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 4e7756bf8..a26837f71 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1464,6 +1464,18 @@ such as position and heading.

SPAWNSTATIC.CountryID

Country ID.

+ + + +

SPAWNSTATIC.InitCargo

+ +

If true, static can act as cargo.

+ + + +

SPAWNSTATIC.InitCargoMass

+ +

Mass of cargo in kg.

@@ -2156,6 +2168,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SPAWNSTATIC.TemplateData.alt

+ + + +

SPAWNSTATIC.TemplateData.canCargo

+ +

Static can be a cargo.

@@ -2180,6 +2198,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SPAWNSTATIC.TemplateData.heading

Heading in rad.

+ + + +

SPAWNSTATIC.TemplateData.isCargo

+ + @@ -2198,6 +2222,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SPAWNSTATIC.TemplateData.livery_id

Livery name.

+ + + +

SPAWNSTATIC.TemplateData.mass

+ +

Cargo mass in kg.

@@ -2289,6 +2319,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
+
+ + #boolean +SPAWNSTATIC.InitCargo + +

If true, static can act as cargo.

+ +
+ +
+
+
+ + #number +SPAWNSTATIC.InitCargoMass + +

Mass of cargo in kg.

+ +
+
@@ -3407,6 +3459,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+ + #boolean +SPAWNSTATIC.InitCargo + +

If true, static can act as cargo.

+ +
+ +
+
+
+ + #number +SPAWNSTATIC.InitCargoMass + +

Mass of cargo in kg.

+ +
+
@@ -6584,6 +6658,17 @@ BASE:TraceOnOff( false ) +
+ +
+
+
+ + #boolean +SPAWNSTATIC.TemplateData.canCargo + +

Static can be a cargo.

+
@@ -6628,6 +6713,17 @@ BASE:TraceOnOff( false )

Heading in rad.

+ + + +
+
+ + +SPAWNSTATIC.TemplateData.isCargo + + +
@@ -6663,6 +6759,17 @@ BASE:TraceOnOff( false ) + +
+
+ + #number +SPAWNSTATIC.TemplateData.mass + +

Cargo mass in kg.

+ +
+
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 47ef74a88..c403031a9 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2449,6 +2449,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
@@ -3662,6 +3695,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
@@ -4912,6 +4978,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index e55eaddbc..4e2c0710f 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -17914,6 +17914,17 @@ BASE:TraceOnOff( false ) + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -18057,17 +18068,6 @@ BASE:TraceOnOff( false ) - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -22616,6 +22616,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -22759,17 +22770,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -24119,6 +24119,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -24262,17 +24273,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index 859c2702e..fd82d0f8e 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3183,12 +3183,6 @@ manager:Stop(7200)

RAT.termtype

Type of terminal to be used when spawning at an airbase.

- - - -

RAT.type

- - @@ -4149,30 +4143,6 @@ and any spaces before and after the resulting name are removed.

RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

- - - -

RAT.communication

- - - - - -

RAT.frequency

- - - - - -

RAT.livery_id

- - - - - -

RAT.modulation

- - @@ -6466,17 +6436,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.

- - - -
-
- - -RAT.type - - -
@@ -14357,17 +14316,6 @@ Initializes the ratcraft array and group menu.

Type of terminal to be used when spawning at an airbase.

- - - -
-
- - -RAT.type - - -
@@ -20303,17 +20251,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.

- - - -
-
- - -RAT.type - - -
diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index f433f3f90..dbda11b7d 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -8781,6 +8781,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

+ + + +
+
+ + +AIRBOSS.RQLid + + +
@@ -8792,6 +8803,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of marshal.

+ + + +
+
+ + +AIRBOSS.RQMid + + +
@@ -27699,6 +27721,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

+ + + +
+
+ + +AIRBOSS.RQLid + + +
@@ -27710,6 +27743,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

+ + + +
+
+ + +AIRBOSS.RQMid + + +
@@ -30368,6 +30412,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

+ + + +
+
+ + +AIRBOSS.RQLid + + +
@@ -30379,6 +30434,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

+ + + +
+
+ + +AIRBOSS.RQMid + + +
@@ -37278,7 +37344,7 @@ BASE:TraceOnOff( false ) -

Set case of f

+

Set case to that of lead.

@@ -37341,10 +37407,13 @@ BASE:TraceOnOff( false )
- #AIRBOSS.GroovePos -AIRBOSS.PlayerData.groove -

Data table at each position in the groove. Elements are of type AIRBOSS.GrooveData.

+AIRBOSS.PlayerData.flag + + + + +

Set stack flag.

@@ -37352,10 +37421,10 @@ BASE:TraceOnOff( false )
- #boolean -AIRBOSS.PlayerData.holding + #AIRBOSS.GroovePos +AIRBOSS.PlayerData.groove - +

Data table at each position in the groove. Elements are of type AIRBOSS.GrooveData.

diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 583c36900..53fe67952 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2940,22 +2940,11 @@ based on the tasking capabilities defined in
- Cargo.Cargo#CARGO + FSM_PROCESS.Cargo -
- -
-
-
- - -FSM_PROCESS.DeployZone - - -
@@ -2988,7 +2977,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -4410,7 +4399,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -8942,7 +8931,7 @@ If the Unit is part of the Task, true is returned.

- + #number TASK_CARGO.CargoLimit diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 52330407f..eba468fb0 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2870,8 +2870,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number -TASK_CARGO_DISPATCHER.CountCSAR + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -2881,8 +2881,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.MaxCSAR @@ -3949,8 +3949,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -3960,8 +3960,8 @@ This method can only be used once!

- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.MaxCSAR @@ -4807,8 +4807,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4818,8 +4818,8 @@ This method can only be used once!

- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.MaxCSAR @@ -6046,8 +6046,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -6057,8 +6057,8 @@ This method can only be used once!

- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.MaxCSAR diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index e15458923..c04dacc55 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3230,6 +3230,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+ @@ -6557,6 +6568,17 @@ Coordinates are dependent on the position of the maps origin.

+
+ +
+ @@ -7112,6 +7134,17 @@ If the Identifiable is alive, true is returned.

+
+ +
+ @@ -7273,6 +7306,17 @@ If the Identifiable is alive, true is returned.

+
+ +
+