From 27c5b22f1a558629908f71b7e07faf519763e980 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Thu, 28 Jan 2021 09:09:56 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_AIR_Dispatcher.html | 44 ---- Documentation/AI.AI_Air.html | 44 ---- Documentation/AI.AI_Air_Squadron.html | 22 ++ Documentation/AI.AI_Cargo.html | 20 +- Documentation/AI.AI_Cargo_Airplane.html | 68 +----- Documentation/AI.AI_Patrol.html | 12 - Documentation/Cargo.CargoGroup.html | 28 +++ Documentation/Core.Fsm.html | 4 +- Documentation/Core.Point.html | 33 --- Documentation/Core.Settings.html | 26 ++- Documentation/Core.Spawn.html | 186 +++++++-------- Documentation/Core.SpawnStatic.html | 84 +++++++ Documentation/Functional.Mantis.html | 11 + Documentation/Ops.Airboss.html | 18 +- .../Tasking.Task_A2G_Dispatcher.html | 20 +- Documentation/Tasking.Task_Cargo.html | 17 +- .../Tasking.Task_Cargo_Dispatcher.html | 220 ------------------ Documentation/Wrapper.Group.html | 78 +------ Documentation/Wrapper.Marker.html | 66 ------ Documentation/Wrapper.Positionable.html | 44 ++++ 20 files changed, 345 insertions(+), 700 deletions(-) diff --git a/Documentation/AI.AI_AIR_Dispatcher.html b/Documentation/AI.AI_AIR_Dispatcher.html index 3d8aa8bd5..33c093afc 100644 --- a/Documentation/AI.AI_AIR_Dispatcher.html +++ b/Documentation/AI.AI_AIR_Dispatcher.html @@ -4315,17 +4315,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

- - - -
-
@@ -9623,17 +9612,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
@@ -10951,17 +10929,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
@@ -12586,17 +12553,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 d2d803f9d..b069736a5 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -2809,17 +2809,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -5564,17 +5553,6 @@ Once the time is finished, the old AI will return to the base.

- - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -6300,17 +6278,6 @@ Once the time is finished, the old AI will return to the base.

- - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -7929,17 +7896,6 @@ Once the time is finished, the old AI will return to the base.

- - - -
-
- - #number -AI_AIR.IdleCount - - -
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 93e1bddc5..37c7768aa 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2312,6 +2312,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
@@ -3383,6 +3394,17 @@ 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 feb7a0eab..9ec582515 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2508,7 +2508,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -2546,9 +2546,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

-
@@ -4541,7 +4538,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -4579,9 +4576,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

-
@@ -5156,7 +5150,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -5194,9 +5188,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

-
@@ -6664,7 +6655,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -6702,9 +6693,6 @@ 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 8199a1739..0d9f5c119 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2495,20 +2495,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

+
@@ -4285,20 +4274,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

+
@@ -4917,20 +4895,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

+
@@ -6442,20 +6409,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

- -
- -
@@ -6514,6 +6467,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_Patrol.html b/Documentation/AI.AI_Patrol.html index 10b1e301e..56e18aac1 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -3011,9 +3011,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

This table contains the targets detected during patrol.

- @@ -6261,9 +6258,6 @@ Note that this method is required, as triggers the next route when patrolling fo - -

This table contains the targets detected during patrol.

- @@ -7008,9 +7002,6 @@ Note that this method is required, as triggers the next route when patrolling fo - -

This table contains the targets detected during patrol.

- @@ -8648,9 +8639,6 @@ 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 937494cdd..0ef22b6b2 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1756,6 +1756,20 @@ Controls a network of SAM sites.

+ + + +
+
+ + +CARGO_GROUP.CargoObject + + + + +

Now we spawn the new group based on the template created.

+
@@ -3077,6 +3091,20 @@ This works for ground only groups.

+ + + +
+
+ + +CARGO_GROUP.CargoObject + + + + +

Now we spawn the new group based on the template created.

+
diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 8139b9dd3..6ea3c3f37 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5440,7 +5440,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState @@ -7044,7 +7044,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 3ed965ee8..e7810d454 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -14688,17 +14688,6 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

-
- -
-
-
- - -POINT_VEC2.z - - -
@@ -15497,17 +15486,6 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

-
- -
-
-
- - -POINT_VEC2.z - - -
@@ -22181,17 +22159,6 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t

the y coordinate in meters.

- - - -
-
- - -POINT_VEC2.z - - -
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index e40c6584b..209d328dc 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2589,7 +2589,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2ASystem @@ -2649,6 +2649,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -4680,7 +4691,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem @@ -4740,6 +4751,17 @@ It is advised to use this method at the start of the mission.

+
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index abaa6347f..0f8343cfe 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -3236,6 +3236,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.

+ @@ -3291,6 +3294,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.

+
@@ -3448,6 +3465,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.

+
@@ -3459,53 +3490,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

By default, no InitLimit

- - - - -
-
- - -SPAWN.SpawnInitLivery - - - -
- -
-
-
- - -SPAWN.SpawnInitModex - - - -
- -
-
-
- - -SPAWN.SpawnInitModu - - - -
- -
-
-
- - #string -SPAWN.SpawnInitSkill - - -
@@ -3537,7 +3521,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3551,7 +3535,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3697,6 +3681,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -8580,6 +8575,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.

+
@@ -8635,6 +8633,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.

+
@@ -8792,6 +8804,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.

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

By default, no InitLimit

- - - - -
-
- - -SPAWN.SpawnInitLivery - - - -
- -
-
-
- - -SPAWN.SpawnInitModex - - - -
- -
-
-
- - -SPAWN.SpawnInitModu - - - -
- -
-
-
- - #string -SPAWN.SpawnInitSkill - - -
@@ -8881,7 +8860,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

- #number + SPAWN.SpawnMaxUnitsAlive @@ -9041,6 +9020,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index a1e01596e..e337a619b 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1769,6 +1769,24 @@ such as position and heading.

SPAWNSTATIC:_SpawnStatic(Template, CountryID)

Spawns a new static using a given template.

+ + + +

SPAWNSTATIC.heliport_callsign_id

+ + + + + +

SPAWNSTATIC.heliport_frequency

+ + + + + +

SPAWNSTATIC.heliport_modulation

+ + @@ -2652,6 +2670,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+ + +
+
+ + +
+
+
@@ -3873,6 +3924,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+ + +
+
+ + +
+
+
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 5ca359c23..8def0d2e9 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -2010,6 +2010,17 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75% + + + +
+
diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 0dc7bf592..485674291 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -37796,7 +37796,7 @@ BASE:TraceOnOff( false ) -

Decrease stack/flag. Human player needs to take care himself.

+

Also decrease flag for section members of flight.

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

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

- - - -
-
- - #boolean -AIRBOSS.PlayerData.holding - - -
@@ -37944,9 +37933,6 @@ BASE:TraceOnOff( false ) - -

Set section lead of player flight.

- @@ -37992,7 +37978,7 @@ BASE:TraceOnOff( false ) -

Set time stamp.

+

Set new time stamp.

diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index a29feade8..95ca6bc4a 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -2958,14 +2958,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + TASK_A2G_DISPATCHER.FlashNewTask - -

set to false to suppress flash messages

-
@@ -3538,14 +3535,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + TASK_A2G_DISPATCHER.FlashNewTask - -

set to false to suppress flash messages

-
@@ -4728,14 +4722,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + TASK_A2G_DISPATCHER.FlashNewTask - -

set to false to suppress flash messages

-
@@ -6225,14 +6216,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + TASK_A2G_DISPATCHER.FlashNewTask - -

set to false to suppress flash messages

-
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 667744a35..d276ee96b 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3022,6 +3022,17 @@ based on the tasking capabilities defined in + + +
+
@@ -3054,7 +3065,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4476,7 +4487,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -9008,7 +9019,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 c89c3b0c3..327191460 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2962,50 +2962,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -3014,17 +2970,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
- @@ -4085,50 +4030,6 @@ This method can only be used once!

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -4137,17 +4038,6 @@ This method can only be used once!

-
- -
- @@ -4987,50 +4877,6 @@ This method can only be used once!

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -5039,17 +4885,6 @@ This method can only be used once!

-
- -
- @@ -6525,50 +6360,6 @@ This method can only be used once!

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -6577,17 +6368,6 @@ This method can only be used once!

-
- -
- diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 28aa77dff..51030a6f1 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -4590,18 +4590,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -8575,18 +8564,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu - -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -17021,18 +16999,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of - -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -20496,18 +20463,7 @@ Coordinates are dependent on the position of the maps origin.

- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -21161,18 +21117,7 @@ If the Identifiable is alive, true is returned.

- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -21432,18 +21377,7 @@ If the Identifiable is alive, true is returned.

- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 418dc383d..94490f0f5 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2861,28 +2861,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -MARKER.tocoaliton - - - -
- -
-
-
- - #boolean -MARKER.togroup - - -
@@ -4967,28 +4945,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -MARKER.tocoaliton - - - -
- -
-
-
- - #boolean -MARKER.togroup - - -
@@ -6582,28 +6538,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -MARKER.tocoaliton - - - -
- -
-
-
- - #boolean -MARKER.togroup - - -
diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index b80cabe35..4475c4391 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3355,6 +3355,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
@@ -6742,6 +6753,17 @@ Coordinates are dependent on the position of the maps origin.

+
+ +
+
+
@@ -7319,6 +7341,17 @@ If the Identifiable is alive, true is returned.

+ + + +
+
@@ -7502,6 +7535,17 @@ If the Identifiable is alive, true is returned.

+ + + +
+