From 0da13de5b9779ce5b4d28bfc3027a5931e7e77b2 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Sat, 16 Jan 2021 14:17:25 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2G_Dispatcher.html | 2 +- Documentation/AI.AI_Cargo.html | 20 +- Documentation/Cargo.CargoGroup.html | 62 ----- Documentation/Cargo.CargoUnit.html | 22 -- Documentation/Core.Point.html | 33 +++ Documentation/Core.Settings.html | 22 ++ Documentation/Core.Spawn.html | 110 ++++++++- Documentation/Core.SpawnStatic.html | 84 +++++++ Documentation/Functional.Designate.html | 55 ----- Documentation/Functional.Detection.html | 33 +++ Documentation/Functional.Mantis.html | 22 -- Documentation/Functional.Movement.html | 28 +++ Documentation/Functional.Rat.html | 18 ++ Documentation/Ops.Airboss.html | 7 +- .../Tasking.Task_A2A_Dispatcher.html | 8 +- Documentation/Tasking.Task_Cargo.html | 11 - .../Tasking.Task_Cargo_Dispatcher.html | 220 ++++++++++++++---- Documentation/Wrapper.Client.html | 14 +- Documentation/Wrapper.Group.html | 78 ++++++- Documentation/Wrapper.Marker.html | 72 +++++- 20 files changed, 664 insertions(+), 257 deletions(-) diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index debf46e03..793be37f4 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -1861,7 +1861,7 @@ Note that the defense radius applies to all defense coordinates

2.2. The Defense Reactivity.

-

There are 5 levels that can be configured to tweak the defense reactivity. As explained above, the threat to a defense coordinate is +

There are three levels that can be configured to tweak the defense reactivity. As explained above, the threat to a defense coordinate is also determined by the distance of the enemy ground target to the defense coordinate. If you want to have a low defense reactivity, that is, the probability that an A2G defense will engage to the enemy ground target, then use the AI_A2G_DISPATCHER.SetDefenseReactivityLow() method. For medium and high reactivity, use the methods 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/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 0ef22b6b2..2b8e241d0 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1724,27 +1724,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

-
@@ -1756,20 +1739,6 @@ Controls a network of SAM sites.

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

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

-
@@ -3059,27 +3028,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

-
@@ -3091,20 +3043,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 8358ee597..68f2738d4 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1602,17 +1602,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- - -
-
- - CARGO_UNIT.CargoInAir @@ -2317,17 +2306,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index e7810d454..3ed965ee8 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -14688,6 +14688,17 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

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

the y coordinate in meters.

+
+ + +
+
+ + +POINT_VEC2.z + + +
@@ -22159,6 +22181,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 56c18b8c7..50f75660f 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2649,6 +2649,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SETTINGS.PlayerMenu + + +
@@ -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 e3851e2d3..a30b9a9f8 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2634,6 +2634,24 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

SPAWN.communication

+ + + + + +

SPAWN.livery_id

+ + + + + +

SPAWN.skill

+ + @@ -3722,6 +3740,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -3734,7 +3763,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

+

When the first Spawn executes, all the Groups need to be made visible before start.

@@ -3786,6 +3815,39 @@ 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.communication + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.skill + + +
@@ -9096,6 +9158,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -9108,7 +9181,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

+

When the first Spawn executes, all the Groups need to be made visible before start.

@@ -9160,6 +9233,39 @@ 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.communication + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.skill + + +
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 + + + +
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
@@ -3873,6 +3924,39 @@ 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 e0ad4d90f..5267e3811 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3297,17 +3297,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -6465,17 +6454,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -7275,17 +7253,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -8055,17 +8022,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -9728,17 +9684,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - -DESIGNATE.LaseDuration - - -
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index d6f918354..ad9241e65 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18392,6 +18392,17 @@ BASE:TraceOnOff( false ) + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + +
@@ -23105,6 +23116,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + +
@@ -24874,6 +24896,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + +
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 2f96df924..ffdc6ad12 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -1999,28 +1999,6 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75% - - - -
-
- - -MANTIS.AWACS_Prefix - - - -
- -
-
-
- - -MANTIS.Adv_EWR_Group - - -
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 72250f94f..3e9a87022 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -4220,6 +4220,24 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

RAT.communication

+ + + + + +

RAT.livery_id

+ + + + + +

RAT.skill

+ + diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 439e87220..49188b82f 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -37792,6 +37792,9 @@ BASE:TraceOnOff( false ) + +

Set case to that of lead.

+
@@ -37859,7 +37862,7 @@ BASE:TraceOnOff( false ) -

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

+

Set stack flag.

@@ -38041,7 +38044,7 @@ BASE:TraceOnOff( false ) -

Set time stamp.

+

Set new time stamp.

diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index 188f446a3..47b0b6c07 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -2688,7 +2688,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -3413,7 +3413,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -4589,7 +4589,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -6072,7 +6072,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 4ef0a3001..bd240f249 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3022,17 +3022,6 @@ based on the tasking capabilities defined in - -
- diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index b49487562..dc70dcd04 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2962,6 +2962,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

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

Field(s)

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

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

Field(s)

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

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

Field(s)

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

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

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

-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 94490f0f5..61fa3f4de 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2773,6 +2773,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -2857,7 +2879,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.toall +MARKER.togroup @@ -4857,6 +4879,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -4941,7 +4985,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.toall +MARKER.togroup @@ -6450,6 +6494,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -6534,7 +6600,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.toall +MARKER.togroup