From d925b295d72009f14e8d544d1cf76d568716ffe5 Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Fri, 23 Apr 2021 09:08:51 +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 | 36 --- Documentation/AI.AI_Patrol.html | 12 - Documentation/Cargo.CargoGroup.html | 28 +++ Documentation/Cargo.CargoUnit.html | 44 ---- Documentation/Core.Fsm.html | 4 +- Documentation/Core.Point.html | 33 --- Documentation/Core.Settings.html | 30 +-- Documentation/Core.Spawn.html | 238 ++---------------- Documentation/Core.SpawnStatic.html | 84 ------- Documentation/Functional.Designate.html | 55 ---- Documentation/Functional.Detection.html | 66 ++--- Documentation/Functional.Rat.html | 69 ----- Documentation/Ops.Airboss.html | 19 +- Documentation/Tasking.Task.html | 22 -- .../Tasking.Task_A2G_Dispatcher.html | 20 +- Documentation/Tasking.Task_Cargo.html | 11 - .../Tasking.Task_Cargo_Dispatcher.html | 192 +------------- Documentation/Wrapper.Client.html | 14 +- Documentation/Wrapper.Group.html | 78 +++++- 21 files changed, 195 insertions(+), 894 deletions(-) diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 0b5c577da..973d7efba 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2358,17 +2358,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
@@ -3440,17 +3429,6 @@ 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 d9879c40f..a7ababdbf 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2592,9 +2592,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.

- @@ -4625,9 +4622,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.

- @@ -5240,9 +5234,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.

- @@ -6748,9 +6739,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 cf3a2d193..85e4d3d2e 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2549,9 +2549,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

- @@ -6569,9 +6536,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 82525ef52..1c0b4a34e 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -3057,9 +3057,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

- @@ -8694,9 +8685,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 5eeec9dd9..f28196628 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1740,6 +1740,20 @@ Controls a network of short range air/missile defense groups.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

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

Set cargo object.

-
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2344,17 +2322,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles - -
-
-
- - CARGO_UNIT.CargoInAir @@ -2373,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 d02e073c9..74f24f6b7 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5576,7 +5576,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -7180,7 +7180,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 04f2376f1..8cc7f014d 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -15245,17 +15245,6 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

-
- -
-
-
- - -POINT_VEC2.z - - -
@@ -16054,17 +16043,6 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

-
- -
-
-
- - -POINT_VEC2.z - - -
@@ -23027,17 +23005,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 f1fead737..7d8bda66b 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2635,7 +2635,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + SETTINGS.A2ASystem @@ -2690,22 +2690,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric -
- -
-
-
- - -SETTINGS.PlayerMenu - - -
@@ -4737,7 +4726,7 @@ It is advised to use this method at the start of the mission.

- #string + SETTINGS.A2ASystem @@ -4792,22 +4781,11 @@ 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 220904d25..fcdf10cfb 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2650,36 +2650,6 @@ 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.modulation

- - - - - -

SPAWN.skill

- - - - - -

SPAWN.uncontrolled

- - @@ -3406,17 +3376,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.SpawnGrouping - - -
@@ -3453,6 +3412,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
@@ -3486,17 +3456,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWN.SpawnInitFreq - - -
@@ -3552,20 +3511,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.

-
@@ -3587,7 +3532,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-SPAWN.SpawnInitModex +SPAWN.SpawnInitLivery @@ -3857,61 +3802,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.communication - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - - -
- -
-
-
- - -SPAWN.skill - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
@@ -8825,17 +8715,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

- - -
-
- - -SPAWN.SpawnInitFreq - - -
@@ -8971,20 +8850,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.

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

-SPAWN.SpawnInitModex +SPAWN.SpawnInitLivery @@ -9276,61 +9141,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.communication - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - - -
- -
-
-
- - -SPAWN.skill - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index ca8fc0898..4f128af2a 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1785,24 +1785,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

- - @@ -2716,39 +2698,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
- - -
-
- - -
-
-
@@ -3970,39 +3919,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
- - -
-
- - -
-
-
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 0f0cb816e..6a925a575 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3343,17 +3343,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
@@ -6522,17 +6511,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
@@ -7343,17 +7321,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
@@ -8134,17 +8101,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
@@ -9818,17 +9774,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 0e5c44b98..a9132fefd 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18696,6 +18696,17 @@ BASE:TraceOnOff( false ) + + + +
+
@@ -18850,17 +18861,6 @@ BASE:TraceOnOff( false ) - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -23409,6 +23409,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
@@ -23563,17 +23574,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -25178,6 +25178,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
@@ -25332,17 +25343,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index ede9478d7..3de006395 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3276,12 +3276,6 @@ manager:Stop(7200)

RAT.termtype

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

- - - -

RAT.type

- - @@ -4242,36 +4236,6 @@ 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.modulation

- - - - - -

RAT.skill

- - - - - -

RAT.uncontrolled

- - @@ -6643,17 +6607,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 - - -
@@ -14534,17 +14487,6 @@ Initializes the ratcraft array and group menu.

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

- - - -
-
- - -RAT.type - - -
@@ -20480,17 +20422,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 4255efc4e..5e9521695 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -38122,20 +38122,6 @@ BASE:TraceOnOff( false ) - -
-
- - -AIRBOSS.PlayerData.flag - - - - -

Also decrease flag for section members of flight.

- -
-
@@ -38269,9 +38255,6 @@ BASE:TraceOnOff( false ) - -

Make player section lead if he was not before.

-
@@ -38317,7 +38300,7 @@ BASE:TraceOnOff( false ) -

Set new time stamp.

+

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_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index f7d62cf15..e55a2218f 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -3004,11 +3004,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

+
@@ -3581,11 +3584,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

+
@@ -4768,11 +4774,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

+
@@ -6262,11 +6271,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 c2cc0aab3..71e388d33 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3038,17 +3038,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 c6417ea60..ccef9fa08 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3011,41 +3011,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -
-
- - -
-
- - -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -3060,17 +3027,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
@@ -4134,41 +4090,8 @@ This method can only be used once!

- -
-
- - -
-
- - -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -4183,17 +4106,6 @@ This method can only be used once!

-
- -
-
-
@@ -5036,41 +4948,8 @@ This method can only be used once!

- -
-
- - -
-
- - -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -5085,17 +4964,6 @@ This method can only be used once!

-
- -
-
-
@@ -6574,41 +6442,8 @@ This method can only be used once!

- -
-
- - -
-
- - -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -6623,17 +6458,6 @@ This method can only be used once!

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

Alive2.

+

Alive.

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

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 6b6b07a25..a0fe58537 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -4642,7 +4642,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ + +
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -8647,7 +8658,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu + +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -17130,7 +17152,18 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of + +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -20594,7 +20627,18 @@ Coordinates are dependent on the position of the maps origin.

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

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

+ +
+