From cfa2c026db01a43451d5f222b8a242a5da0afbcc Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Sun, 20 Dec 2020 22:52:34 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_Air_Squadron.html | 22 ++ Documentation/AI.AI_Cargo.html | 12 -- Documentation/AI.AI_Cargo_Airplane.html | 68 ++----- Documentation/Cargo.CargoCrate.html | 22 ++ Documentation/Cargo.CargoGroup.html | 62 ------ Documentation/Cargo.CargoUnit.html | 22 -- Documentation/Core.Point.html | 33 +++ Documentation/Core.Settings.html | 4 +- Documentation/Core.Spawn.html | 188 +++++++++--------- Documentation/Core.Spot.html | 132 ++++++++++++ Documentation/Functional.Designate.html | 30 +-- Documentation/Functional.Detection.html | 99 +++++++++ Documentation/Functional.Rat.html | 45 ----- Documentation/Ops.Airboss.html | 17 +- .../Tasking.Task_A2A_Dispatcher.html | 8 +- Documentation/Tasking.Task_Cargo.html | 11 + .../Tasking.Task_Cargo_Dispatcher.html | 8 +- Documentation/Wrapper.Group.html | 78 +++++++- Documentation/Wrapper.Marker.html | 66 ++++++ 19 files changed, 604 insertions(+), 323 deletions(-) diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 310a76016..a957f08a2 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2272,6 +2272,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
@@ -3343,6 +3354,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 d2d2d8f62..bf8af7f0f 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2506,9 +2506,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.

- @@ -4546,9 +4543,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.

- @@ -5161,9 +5155,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.

- @@ -6669,9 +6660,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 947fcf4d3..e3442aeb3 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2455,20 +2455,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.

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

Aircraft is on a pickup mission.

+
@@ -4242,20 +4231,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.

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

Aircraft is on a pickup mission.

+
@@ -4871,20 +4849,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.

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

Aircraft is on a pickup mission.

+
@@ -6393,20 +6360,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.

- -
- -
@@ -6462,6 +6415,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/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index 4348cfca4..5375a99d6 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1625,6 +1625,17 @@ Controls a network of SAM sites.

Field(s)

+
+ + +
@@ -2293,6 +2304,17 @@ Controls a network of SAM sites.

Field(s)

+
+ + +
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 6e50fba1b..e7b9b71a2 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1696,27 +1696,10 @@ Controls a network of SAM sites.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup - -

Then we register the new group in the database

-
@@ -1728,20 +1711,6 @@ Controls a network of SAM sites.

-
- -
-
-
- - -CARGO_GROUP.CargoObject - - - - -

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

-
@@ -3042,27 +3011,10 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup - -

Then we register the new group in the database

-
@@ -3074,20 +3026,6 @@ This works for ground only groups.

- - - -
-
- - -CARGO_GROUP.CargoObject - - - - -

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

-
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 0e72caf19..8c878ab5f 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1574,17 +1574,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- - -
-
- - CARGO_UNIT.CargoInAir @@ -2297,17 +2286,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles - -
-
-
- - CARGO_UNIT.CargoInAir diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 23b36d011..6259e63ed 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -14566,6 +14566,17 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

+
+ +
+
+
+ + +POINT_VEC2.z + + +
@@ -15364,6 +15375,17 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

+
+ + +
+
+ + +POINT_VEC2.z + + +
@@ -22037,6 +22059,17 @@ 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 b74e66f87..2307a637e 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2604,7 +2604,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric @@ -4695,7 +4695,7 @@ It is advised to use this method at the start of the mission.

- #boolean + SETTINGS.Metric diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index efbf30cd4..76fe5280f 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2606,12 +2606,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.uncontrolled

- - @@ -3202,9 +3196,6 @@ 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.

-
@@ -3260,20 +3251,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.

-
@@ -3296,17 +3273,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWN.SpawnGrouping - - -
@@ -3387,6 +3353,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -3442,6 +3419,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.

+
@@ -3453,8 +3444,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ -

By default, no InitLimit

+SPAWN.SpawnInitLivery + + + +
+ +
+
+ @@ -3498,7 +3508,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3512,7 +3522,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3681,7 +3691,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.

@@ -3733,17 +3743,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.uncontrolled - - -
@@ -8563,9 +8562,6 @@ 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.

-
@@ -8621,20 +8617,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.

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

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

+ + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -8803,6 +8785,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.

+
@@ -8814,8 +8810,27 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ -

By default, no InitLimit

+SPAWN.SpawnInitLivery + + + +
+ +
+
+ @@ -8859,7 +8874,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

@@ -9094,17 +9109,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.uncontrolled - - -
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 8596de0b9..72d18a580 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2504,6 +2504,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + + +
+ +
+
+
+ + +SPOT.Target + + +
@@ -3717,6 +3761,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + + +
+ +
+
+
+ + +SPOT.Target + + +
@@ -5222,6 +5310,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.Designate.html b/Documentation/Functional.Designate.html index d20e22bc3..324adefd8 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3264,7 +3264,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-DESIGNATE.LaseStart +DESIGNATE.LaseDuration @@ -3274,8 +3274,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table -DESIGNATE.LaserCodes + +DESIGNATE.LaseStart @@ -6432,7 +6432,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseStart +DESIGNATE.LaseDuration @@ -6442,8 +6442,8 @@ Designate:SetFlashStatusMenu( false )
- #table -DESIGNATE.LaserCodes + +DESIGNATE.LaseStart @@ -7242,7 +7242,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseStart +DESIGNATE.LaseDuration @@ -7252,8 +7252,8 @@ Designate:SetFlashStatusMenu( false )
- #table -DESIGNATE.LaserCodes + +DESIGNATE.LaseStart @@ -8022,7 +8022,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseStart +DESIGNATE.LaseDuration @@ -8032,8 +8032,8 @@ Designate:SetFlashStatusMenu( false )
- #table -DESIGNATE.LaserCodes + +DESIGNATE.LaseStart @@ -9695,7 +9695,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseStart +DESIGNATE.LaseDuration @@ -9705,8 +9705,8 @@ Designate:SetFlashStatusMenu( false )
- #table -DESIGNATE.LaserCodes + +DESIGNATE.LaseStart diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 9a1e3405a..a8e212445 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18246,6 +18246,28 @@ BASE:TraceOnOff( false ) +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -18395,7 +18417,18 @@ BASE:TraceOnOff( false )
+ #boolean +DETECTION_BASE.Locking + + +
+ +
+
+
+ + #number DETECTION_BASE.RefreshTimeInterval @@ -22937,6 +22970,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -23086,7 +23141,18 @@ zones that reflect cloudy areas where detected units may not be so easily visual
+ #boolean +DETECTION_BASE.Locking + + +
+ +
+
+
+ + #number DETECTION_BASE.RefreshTimeInterval @@ -24684,6 +24750,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -24833,7 +24921,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.Rat.html b/Documentation/Functional.Rat.html index 81ab22b8e..c17ccb17e 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3232,12 +3232,6 @@ manager:Stop(7200)

RAT.termtype

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

- - - -

RAT.type

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

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

- - - -

RAT.uncontrolled

- - @@ -6491,17 +6479,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 - - -
@@ -14382,17 +14359,6 @@ Initializes the ratcraft array and group menu.

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

-
- -
-
-
- - -RAT.type - - -
@@ -20328,17 +20294,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 b638c0055..28981d82e 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -37751,6 +37751,17 @@ BASE:TraceOnOff( false )

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

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

Set section lead of player flight.

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

Set new time stamp.

-
diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index a41a78a5c..810aa9e2c 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -2648,7 +2648,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -3373,7 +3373,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -4549,7 +4549,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -6032,7 +6032,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 5358bb05a..28c26bdd5 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2994,6 +2994,17 @@ based on the tasking capabilities defined in + +
+ diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 2030e56d0..fb3ac4b42 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2925,7 +2925,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4004,7 +4004,7 @@ This method can only be used once!

- + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4862,7 +4862,7 @@ This method can only be used once!

- + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -6356,7 +6356,7 @@ This method can only be used once!

- + #table TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index e9e55382a..e988bc31d 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -4550,7 +4550,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -8524,7 +8535,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu + +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -16959,7 +16981,18 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of + +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -20423,7 +20456,18 @@ Coordinates are dependent on the position of the maps origin.

+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -21077,7 +21121,18 @@ If the Identifiable is alive, true is returned.

+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -21337,7 +21392,18 @@ If the Identifiable is alive, true is returned.

+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index d7d2e7aa9..7a8ddeea7 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2821,6 +2821,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +MARKER.tocoaliton + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +
@@ -4905,6 +4927,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +MARKER.tocoaliton + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +
@@ -6498,6 +6542,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +MARKER.tocoaliton + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +