From 22e9cfac487398ab6549dd484589f397a0821562 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Mon, 22 Mar 2021 11:22:32 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_AIR_Dispatcher.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.Fsm.html | 4 +- Documentation/Core.Point.html | 6 - Documentation/Core.Settings.html | 34 ++++- Documentation/Core.Spawn.html | 92 +++++++----- Documentation/Core.Spot.html | 132 ++++++++++++++++++ Documentation/Functional.Detection.html | 66 +++++++++ Documentation/Functional.Mantis.html | 22 --- Documentation/Functional.Rat.html | 39 ++++++ Documentation/Ops.Airboss.html | 6 +- Documentation/Tasking.Task.html | 22 --- Documentation/Tasking.Task_Cargo.html | 13 +- .../Tasking.Task_Cargo_Dispatcher.html | 52 ++++++- Documentation/Utils.html | 66 +++++++++ Documentation/Wrapper.Client.html | 14 +- Documentation/Wrapper.Marker.html | 132 +++++++++--------- Documentation/Wrapper.Positionable.html | 44 ------ 22 files changed, 572 insertions(+), 310 deletions(-) diff --git a/Documentation/AI.AI_AIR_Dispatcher.html b/Documentation/AI.AI_AIR_Dispatcher.html index 16c75e243..0e621b659 100644 --- a/Documentation/AI.AI_AIR_Dispatcher.html +++ b/Documentation/AI.AI_AIR_Dispatcher.html @@ -4331,6 +4331,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

+ + + +
+
@@ -12569,6 +12602,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_Cargo.html b/Documentation/AI.AI_Cargo.html index 6098edfa7..a31c95bc5 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2524,7 +2524,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -2562,9 +2562,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.

-
@@ -4557,7 +4554,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -4595,9 +4592,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.

-
@@ -5172,7 +5166,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -5210,9 +5204,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.

-
@@ -6680,7 +6671,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -6718,9 +6709,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 5b5241cfc..e55cffddf 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2566,9 +2566,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

- @@ -6471,9 +6462,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 2233c471d..d6e99e200 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -3027,6 +3027,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

+ @@ -8655,6 +8664,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.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 3fee6f0a2..792c3af7d 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1740,20 +1740,6 @@ Controls a network of short range air/missile defense groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- - -
-
- - CARGO_GROUP.CargoGroup @@ -3061,20 +3047,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 78c4cc492..ef20a2709 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1636,17 +1636,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

-
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2351,17 +2340,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

-
- - -
-
- - #number -CARGO_UNIT.RunCount - - -
diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 727a39f0e..03d80fbbb 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5456,7 +5456,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState @@ -7060,7 +7060,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 658dff607..55d77c40a 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -4847,9 +4847,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Coordinates.

-
@@ -11589,9 +11586,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 aa7185253..77870aead 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2605,7 +2605,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2ASystem @@ -2616,7 +2616,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2GSystem @@ -2660,11 +2660,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -4696,7 +4707,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem @@ -4707,7 +4718,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2GSystem @@ -4751,11 +4762,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 654584e39..e73e49b9d 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -3258,6 +3258,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.

+
@@ -3335,6 +3338,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.SpawnGrouping + + +
@@ -3415,6 +3429,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -3470,20 +3495,6 @@ 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.

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

By default, no InitLimit

- @@ -3562,7 +3570,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3576,7 +3584,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -8616,6 +8624,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.

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

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

+ +
+
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -8828,20 +8861,6 @@ 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.

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

By default, no InitLimit

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

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

- #number + SPAWN.SpawnMaxUnitsAlive diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index a2b7c3324..0559e7e66 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2560,6 +2560,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + + +
+ +
+
+
+ + +SPOT.Target + + +
@@ -3773,6 +3817,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + + +
+ +
+
+
+ + +SPOT.Target + + +
@@ -5278,6 +5366,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + + +
+ +
+
+
+ + +SPOT.Target + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index af7375a4f..64faca7a6 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18408,6 +18408,17 @@ BASE:TraceOnOff( false ) + + + +
+
@@ -18568,7 +18579,18 @@ BASE:TraceOnOff( false )
+ #boolean +DETECTION_BASE.Locking + + +
+ +
+
+
+ + #number DETECTION_BASE.RefreshTimeInterval @@ -23110,6 +23132,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
@@ -23270,7 +23303,18 @@ zones that reflect cloudy areas where detected units may not be so easily visual
+ #boolean +DETECTION_BASE.Locking + + +
+ +
+
+
+ + #number DETECTION_BASE.RefreshTimeInterval @@ -24868,6 +24912,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
@@ -25028,7 +25083,18 @@ zones that reflect cloudy areas where detected units may not be so easily visual
+ #boolean +DETECTION_BASE.Locking + + +
+ +
+
+
+ + #number DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 92fe309fb..801732f7b 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -2571,17 +2571,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The #DETECTION_AREAS object for AWACS

-
- -
-
-
- - -MANTIS.AWACS_Prefix - - -
@@ -4107,17 +4096,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

The #DETECTION_AREAS object for AWACS

- - - -
-
- - -MANTIS.AWACS_Prefix - - -
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index f4adc0c7f..e98c00155 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3276,6 +3276,12 @@ manager:Stop(7200)

RAT.termtype

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

+ + + +

RAT.type

+ + @@ -6553,6 +6559,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 + + +
@@ -14433,6 +14450,17 @@ Initializes the ratcraft array and group menu.

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

+ + + +
+
+ + +RAT.type + + +
@@ -20368,6 +20396,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 0c98cb3b7..01509f8ac 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -38057,9 +38057,6 @@ BASE:TraceOnOff( false ) - -

Set section lead of player flight.

- @@ -38104,6 +38101,9 @@ BASE:TraceOnOff( false ) + +

Set time stamp.

+ diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index ed5ecff1d..e416485d0 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2740,17 +2740,6 @@ but can separately be modified later in your mission using the - - - -
-
@@ -7387,17 +7376,6 @@ 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 c2cc0aab3..022399576 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3033,22 +3033,11 @@ based on the tasking capabilities defined in
- Cargo.Cargo#CARGO + FSM_PROCESS.Cargo -
- - -
-
diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index e410127b9..054d8f96f 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2981,7 +2981,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4049,7 +4060,18 @@ This method can only be used once!

- #table + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4896,7 +4918,18 @@ This method can only be used once!

- #table + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -6379,7 +6412,18 @@ This method can only be used once!

- #table + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Utils.html b/Documentation/Utils.html index 9b74a762c..40325e784 100644 --- a/Documentation/Utils.html +++ b/Documentation/Utils.html @@ -2028,6 +2028,12 @@ Controls a network of short range air/missile defense groups.

UTILS.KmphToMps(kmph)

+ + + +

UTILS.KnotsToAltKIAS(knots, altitude)

+ +

Convert knots to alitude corrected KIAS, e.g.

@@ -4198,6 +4204,66 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
+
+
+ +
+ + + +

Convert knots to alitude corrected KIAS, e.g.

+ + +

for tankers.

+ +
+
+

Defined in:

+
+

UTILS

+
+

Parameters:

+
+
+

+ #number + knots +

+
+
+ +

Speed in knots.

+ +
+
+
+
+

+ #number + altitude +

+
+
+ +

Altitude in feet

+ +
+
+

Return value:

+
+
+

#number:

+
+
+ +

Corrected KIAS

+ +
+
+
+
diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index 950e0be1b..ff59778a1 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -4092,7 +4092,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive2.

+

Alive.

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

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 7fac21090..56cdd5b65 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2789,28 +2789,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

- - - -
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -2888,6 +2866,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Text displayed in the mark panel.

+ + + +
+
+ + #boolean +MARKER.toall + + + +
+ +
+
+
+ + #boolean +MARKER.tocoaliton + + +
@@ -4895,28 +4895,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

- - - -
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -4994,6 +4972,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Text displayed in the mark panel.

+ + + +
+
+ + #boolean +MARKER.toall + + + +
+ +
+
+
+ + #boolean +MARKER.tocoaliton + + +
@@ -6510,28 +6510,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

- - - -
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -6609,6 +6587,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Text displayed in the mark panel.

+ + + +
+
+ + #boolean +MARKER.toall + + + +
+ +
+
+
+ + #boolean +MARKER.tocoaliton + + +
diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 387aa1dc5..9db074f75 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3371,17 +3371,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
@@ -6769,17 +6758,6 @@ Coordinates are dependent on the position of the maps origin.

- - - -
-
@@ -7357,17 +7335,6 @@ If the Identifiable is alive, true is returned.

- - - -
-
@@ -7551,17 +7518,6 @@ If the Identifiable is alive, true is returned.

- - - -
-