From e10d69c0f573f703974a589d611331d065b36332 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Wed, 10 Feb 2021 21:01:25 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2G_Dispatcher.html | 44 --- Documentation/AI.AI_AIR_Dispatcher.html | 44 +++ Documentation/AI.AI_Air.html | 44 --- Documentation/AI.AI_Cargo.html | 20 +- Documentation/AI.AI_Cargo_Airplane.html | 12 - Documentation/AI.AI_Patrol.html | 12 - Documentation/Cargo.CargoGroup.html | 28 -- Documentation/Cargo.CargoUnit.html | 22 ++ Documentation/Core.Spawn.html | 252 ++++++------------ Documentation/Core.Spot.html | 33 +++ Documentation/Functional.Designate.html | 55 ++++ Documentation/Functional.Detection.html | 72 ++++- Documentation/Functional.Mantis.html | 11 - Documentation/Functional.Rat.html | 69 ++--- Documentation/Ops.Airboss.html | 20 +- Documentation/Tasking.Task.html | 22 ++ Documentation/Tasking.Task_Cargo.html | 17 +- .../Tasking.Task_Cargo_Dispatcher.html | 44 --- Documentation/Wrapper.Client.html | 14 +- Documentation/Wrapper.Group.html | 78 +----- 20 files changed, 411 insertions(+), 502 deletions(-) diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 793be37f4..ef141afef 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4519,17 +4519,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

- - - -
-
@@ -15836,17 +15803,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_Dispatcher.html b/Documentation/AI.AI_AIR_Dispatcher.html index 33c093afc..3d8aa8bd5 100644 --- a/Documentation/AI.AI_AIR_Dispatcher.html +++ b/Documentation/AI.AI_AIR_Dispatcher.html @@ -4315,6 +4315,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

+ + + +
+
@@ -12553,6 +12586,17 @@ 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_Cargo.html b/Documentation/AI.AI_Cargo.html index 9ec582515..feb7a0eab 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,6 +2546,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.

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

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

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

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

- @@ -6523,9 +6514,6 @@ 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 5f1ca73a4..2b8e241d0 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1724,20 +1724,6 @@ Controls a network of SAM sites.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- - -
-
- - CARGO_GROUP.CargoGroup @@ -3042,20 +3028,6 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index d96706807..9da2b7ce7 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1602,6 +1602,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles + +
+
+
+ + CARGO_UNIT.CargoInAir @@ -2317,6 +2328,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles + +
+
+
+ + CARGO_UNIT.CargoInAir diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index d10bd8229..3d7b1cd25 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2634,36 +2634,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.frequency

- - - - - -

SPAWN.livery_id

- - - - - -

SPAWN.modulation

- - - - - -

SPAWN.skill

- - - - - -

SPAWN.uncontrolled

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

+
@@ -3379,6 +3363,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
@@ -3412,6 +3407,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -3492,20 +3498,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

By default, no InitLimit

- - - - -
-
@@ -3537,7 +3529,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3551,7 +3543,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3720,7 +3712,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.

@@ -3772,61 +3764,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.frequency - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - - -
- -
-
-
- - -SPAWN.skill - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
@@ -8701,6 +8638,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.

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

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

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

By default, no InitLimit

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

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

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

@@ -9152,61 +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.frequency - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - - -
- -
-
-
- - -SPAWN.skill - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 9f392b19a..c84e8a257 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2577,6 +2577,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.Target + + +
@@ -3823,6 +3834,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.Target + + +
@@ -5361,6 +5383,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.Target + + +
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 5267e3811..e0ad4d90f 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3297,6 +3297,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
@@ -6454,6 +6465,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -7253,6 +7275,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -8022,6 +8055,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -9684,6 +9728,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 297a6ba4f..920b166b9 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18392,6 +18392,28 @@ BASE:TraceOnOff( false ) + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -18552,7 +18574,7 @@ BASE:TraceOnOff( false )
- + #number DETECTION_BASE.RefreshTimeInterval @@ -23094,6 +23116,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -23254,7 +23298,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval @@ -24852,6 +24896,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -25012,7 +25078,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 8def0d2e9..8a298ccd4 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -1999,17 +1999,6 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75% -
- -
-
-
- - -MANTIS.AWACS_Prefix - - -
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index a0e40f154..ea08379ea 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

+ + @@ -4220,36 +4226,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

RAT.frequency

- - - - - -

RAT.livery_id

- - - - - -

RAT.modulation

- - - - - -

RAT.skill

- - - - - -

RAT.uncontrolled

- - @@ -6561,6 +6537,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 + + +
@@ -14441,6 +14428,17 @@ Initializes the ratcraft array and group menu.

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

+ + + +
+
+ + +RAT.type + + +
@@ -20376,6 +20374,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 269ca971b..8e51541c1 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -37727,7 +37727,7 @@ BASE:TraceOnOff( false ) -

Set case to that of lead.

+

Set case of f

@@ -37796,7 +37796,7 @@ BASE:TraceOnOff( false ) -

Set stack flag.

+

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

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

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

+ + + +
+
+ + #boolean +AIRBOSS.PlayerData.holding + + +
@@ -37934,7 +37945,7 @@ BASE:TraceOnOff( false ) -

Make player section lead if he was not before.

+

Set section lead of player flight.

@@ -37980,6 +37991,9 @@ BASE:TraceOnOff( false ) + +

Set time stamp.

+ diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index 8191a194c..8322edaea 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2724,6 +2724,17 @@ but can separately be modified later in your mission using the + + + +
+
@@ -7360,6 +7371,17 @@ If the Unit is part of the Task, true is returned.

+ + + +
+
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 5d3cd03ad..d7754b30b 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3022,17 +3022,6 @@ based on the tasking capabilities defined in - - -
-
@@ -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 d3ee1b315..e1156b172 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2970,17 +2970,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
@@ -4049,17 +4038,6 @@ This method can only be used once!

-
- -
-
-
@@ -4907,17 +4885,6 @@ This method can only be used once!

- - - -
-
@@ -6401,17 +6368,6 @@ This method can only be used once!

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

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

- -
-