From 0ec4b9fc7df96f1794642672077e29239422d420 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Tue, 12 Jan 2021 16:45:58 +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 | 36 ++++ Documentation/AI.AI_Patrol.html | 12 ++ Documentation/Cargo.CargoCrate.html | 22 ++ Documentation/Cargo.CargoGroup.html | 6 + Documentation/Core.Fsm.html | 4 +- Documentation/Core.Point.html | 39 ---- Documentation/Core.Settings.html | 26 ++- Documentation/Core.Spawn.html | 132 +++++++----- Documentation/Core.SpawnStatic.html | 84 -------- Documentation/Functional.Designate.html | 55 ----- Documentation/Functional.Mantis.html | 11 + Documentation/Functional.Movement.html | 28 +++ Documentation/Functional.Rat.html | 47 +++- Documentation/Ops.Airboss.html | 17 -- .../Tasking.Task_A2G_Dispatcher.html | 20 +- Documentation/Tasking.Task_Cargo.html | 17 +- .../Tasking.Task_Cargo_Dispatcher.html | 200 ++---------------- Documentation/Wrapper.Client.html | 14 +- 21 files changed, 346 insertions(+), 502 deletions(-) diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 2b79b82fd..debf46e03 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4519,6 +4519,17 @@ 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 + + +
@@ -12862,6 +12873,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -15803,6 +15836,17 @@ 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 37c7768aa..93e1bddc5 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2312,17 +2312,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
@@ -3394,17 +3383,6 @@ 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 feb7a0eab..a4670c96e 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -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.

- @@ -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.

- @@ -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.

- @@ -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 3d38c7b06..24c0d4dbf 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2503,6 +2503,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

+ @@ -8639,6 +8648,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 64926c924..76ad2703e 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1653,6 +1653,17 @@ Controls a network of SAM sites.

Field(s)

+
+
+ + +CARGO_CRATE.CargoCarrier + + + +
+ +
@@ -2321,6 +2332,17 @@ Controls a network of SAM sites.

Field(s)

+
+
+ + +CARGO_CRATE.CargoCarrier + + + +
+ +
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 3466f6b43..0ef22b6b2 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1742,6 +1742,9 @@ Controls a network of SAM sites.

+ +

Then we register the new group in the database

+
@@ -3074,6 +3077,9 @@ This works for ground only groups.

+ +

Then we register the new group in the database

+
diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 6ea3c3f37..8139b9dd3 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 04e730e67..e7810d454 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -4831,9 +4831,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Coordinates.

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

Coordinates.

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

the y coordinate in meters.

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

the y coordinate in meters.

- - - -
-
- - -POINT_VEC2.z - - -
@@ -22187,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 0311a1c3c..82d405bc0 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 a804031f3..8caff66b5 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2637,7 +2637,7 @@ and any spaces before and after the resulting name are removed.

-

SPAWN.communication

+

SPAWN.frequency

@@ -2652,6 +2652,12 @@ and any spaces before and after the resulting name are removed.

SPAWN.modulation

+ + + +

SPAWN.skill

+ + @@ -3315,20 +3321,6 @@ 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.

-
@@ -3351,6 +3343,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnGrouping + + +
@@ -3497,6 +3500,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnInitModex + + +
@@ -3699,17 +3713,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -3722,7 +3725,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.

@@ -3781,7 +3784,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-SPAWN.communication +SPAWN.frequency @@ -3807,6 +3810,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + +SPAWN.skill + + +
@@ -8692,20 +8706,6 @@ 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.

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

+ + +
+
+ + +SPAWN.SpawnGrouping + + +
@@ -8874,6 +8885,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.SpawnInitModex + + +
@@ -9076,17 +9098,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -9099,7 +9110,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.

@@ -9158,7 +9169,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

-SPAWN.communication +SPAWN.frequency @@ -9184,6 +9195,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.skill + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index e337a619b..a1e01596e 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1769,24 +1769,6 @@ 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

- - @@ -2670,39 +2652,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWNSTATIC.heliport_callsign_id - - - -
- -
-
-
- - -SPAWNSTATIC.heliport_frequency - - - -
- -
-
-
- - -SPAWNSTATIC.heliport_modulation - - -
@@ -3924,39 +3873,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWNSTATIC.heliport_callsign_id - - - -
- -
-
-
- - -SPAWNSTATIC.heliport_frequency - - - -
- -
-
-
- - -SPAWNSTATIC.heliport_modulation - - -
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 424cf4d63..5267e3811 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3308,17 +3308,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -6476,17 +6465,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -7286,17 +7264,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -8066,17 +8033,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -9739,17 +9695,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 0f7b6d1e1..8015c46c8 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -1993,6 +1993,17 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75% + + + +
+
+ + +MANTIS.AWACS_Prefix + + +
diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index f10f1cd20..115c2dc63 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -2022,6 +2022,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + #number +MOVEMENT.AliveUnits + + + + +

Contains the counter how many units are currently alive

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

Field(s)

+
+
+ + #number +MOVEMENT.AliveUnits + + + + +

Contains the counter how many units are currently alive

+ +
+ +
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index 860e5126c..671595728 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3260,6 +3260,12 @@ manager:Stop(7200)

RAT.termtype

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

+ + + +

RAT.type

+ + @@ -4223,7 +4229,7 @@ and any spaces before and after the resulting name are removed.

-

RAT.communication

+

RAT.frequency

@@ -4238,6 +4244,12 @@ and any spaces before and after the resulting name are removed.

RAT.modulation

+ + + +

RAT.skill

+ + @@ -6555,6 +6567,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.

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

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

+
+ +
+
+
+ + +RAT.type + + +
@@ -20370,6 +20404,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.

+ + + +
+
+ + +RAT.type + + +
diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 5d17e2b33..e04b5c975 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -37786,20 +37786,6 @@ BASE:TraceOnOff( false ) - -
-
- - -AIRBOSS.PlayerData.flag - - - - -

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

- -
-
@@ -37933,9 +37919,6 @@ BASE:TraceOnOff( false ) - -

Set section lead of player flight.

-
diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index 95ca6bc4a..a29feade8 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -2958,11 +2958,14 @@ 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

+
@@ -3535,11 +3538,14 @@ 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

+
@@ -4722,11 +4728,14 @@ 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

+
@@ -6216,11 +6225,14 @@ 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 d276ee96b..667744a35 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3022,17 +3022,6 @@ based on the tasking capabilities defined in - - -
-
- - -FSM_PROCESS.DeployZone - - -
@@ -3065,7 +3054,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -4487,7 +4476,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -9019,7 +9008,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 daf0b862c..6d742b5ec 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2965,8 +2965,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -TASK_CARGO_DISPATCHER.CSARBriefing + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -2976,55 +2976,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
- - @@ -4088,8 +4044,8 @@ This method can only be used once!

- -TASK_CARGO_DISPATCHER.CSARBriefing + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -4099,55 +4055,11 @@ This method can only be used once!

- -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
- - @@ -4990,8 +4902,8 @@ This method can only be used once!

- -TASK_CARGO_DISPATCHER.CSARBriefing + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -5001,55 +4913,11 @@ This method can only be used once!

- -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
- - @@ -6528,8 +6396,8 @@ This method can only be used once!

- -TASK_CARGO_DISPATCHER.CSARBriefing + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -6539,55 +6407,11 @@ This method can only be used once!

- -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
- - diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index fc5aee63e..cfc21581a 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -4076,7 +4076,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive2.

+

Alive.

@@ -5190,7 +5190,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive2.

+

Alive.

@@ -7330,7 +7330,7 @@ If the Unit is alive but not active, false is returned.

-

Alive2.

+

Alive.

@@ -15785,7 +15785,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of -

Alive2.

+

Alive.

@@ -19269,7 +19269,7 @@ Coordinates are dependent on the position of the maps origin.

-

Alive2.

+

Alive.

@@ -19943,7 +19943,7 @@ If the Identifiable is alive, true is returned.

-

Alive2.

+

Alive.

@@ -20223,7 +20223,7 @@ If the Identifiable is alive, true is returned.

-

Alive2.

+

Alive.