From 408d075bac097357f62cf00a2c87338535068124 Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Thu, 7 Oct 2021 16:23:23 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_Cargo_Airplane.html | 68 ++----- Documentation/Cargo.CargoGroup.html | 28 +++ Documentation/Cargo.CargoUnit.html | 22 +++ Documentation/Core.Fsm.html | 4 +- Documentation/Core.Settings.html | 4 +- Documentation/Core.Spawn.html | 166 +++++++++++++++--- Documentation/Functional.Designate.html | 55 ------ Documentation/Functional.Mantis.html | 22 +++ Documentation/Functional.Rat.html | 6 + Documentation/Ops.Airboss.html | 73 +------- Documentation/Ops.CSAR.html | 108 +++++++----- Documentation/Ops.CTLD.html | 38 +--- Documentation/Tasking.Task.html | 22 --- .../Tasking.Task_A2A_Dispatcher.html | 8 +- Documentation/Tasking.Task_Cargo.html | 19 +- .../Tasking.Task_Cargo_Dispatcher.html | 88 ++++++++++ Documentation/Wrapper.Client.html | 14 +- Documentation/Wrapper.Group.html | 78 +++++++- Documentation/Wrapper.Marker.html | 72 +++++++- 19 files changed, 564 insertions(+), 331 deletions(-) diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 845ff3d09..987668f47 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2621,20 +2621,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.

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

Aircraft is on a pickup mission.

+
@@ -4408,20 +4397,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.

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

Aircraft is on a pickup mission.

+
@@ -5037,20 +5015,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.

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

Aircraft is on a pickup mission.

+
@@ -6558,20 +6525,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.

- -
- -
@@ -6627,6 +6580,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.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index f7d452eea..dc83f1524 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1838,6 +1838,20 @@ Controls a network of short range air/missile defense groups.

+ + + +
+
+ + +CARGO_GROUP.CargoObject + + + + +

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

+
@@ -3145,6 +3159,20 @@ 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 820f688bb..c1b1d60de 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1727,6 +1727,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

+ + + +
+
+ + #number +CARGO_UNIT.RunCount + + +
@@ -2442,6 +2453,17 @@ 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 7e8aa11bd..85d4686f5 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5656,7 +5656,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -7259,7 +7259,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 035e55cfd..113864f7c 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2715,7 +2715,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2ASystem @@ -4809,7 +4809,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 2fee74195..06af9afce 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2754,6 +2754,12 @@ and any spaces before and after the resulting name are removed.

SPAWN.modulation

+ + + +

SPAWN.skill

+ + @@ -3513,6 +3519,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
@@ -3546,6 +3563,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -3601,6 +3629,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.

+
@@ -3612,6 +3654,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
@@ -3623,6 +3676,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnInitModu + + +
@@ -3825,17 +3889,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -3944,6 +3997,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.skill + + +
@@ -8890,6 +8954,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

+ + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -8978,6 +9064,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.

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

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

+ + +
+
+ + +SPAWN.SpawnInitModu + + +
@@ -9202,17 +9324,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -9321,6 +9432,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.skill + + +
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index f9c0193b2..5e51b7402 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3423,17 +3423,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
@@ -6602,17 +6591,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
@@ -7423,17 +7401,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
@@ -8214,17 +8181,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
@@ -9897,17 +9853,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 73b5315f6..e7e5e8040 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -2832,6 +2832,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The #DETECTION_AREAS object for AWACS

+ + + +
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -5907,6 +5918,17 @@ 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 f2b3bea5f..73672ba28 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -4348,6 +4348,12 @@ and any spaces before and after the resulting name are removed.

RAT.modulation

+ + + +

RAT.skill

+ + diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index f590d5ceb..655ec5e55 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -9175,17 +9175,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

- - - -
-
- - -AIRBOSS.RQLid - - -
@@ -9197,17 +9186,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -28367,17 +28345,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

- - - -
-
- - -AIRBOSS.RQLid - - -
@@ -28389,17 +28356,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -31370,17 +31326,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

- - - -
-
- - -AIRBOSS.RQLid - - -
@@ -31392,17 +31337,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -38690,7 +38624,7 @@ BASE:TraceOnOff( false ) -

Set current case.

+

Set case to that of lead.

@@ -38759,7 +38693,7 @@ BASE:TraceOnOff( false ) -

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

+

Set stack flag.

@@ -38943,9 +38877,6 @@ BASE:TraceOnOff( false ) - -

Set time stamp.

- diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index 93d5a4300..40133b1e9 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -2218,12 +2218,6 @@ Create a late-activated single infantry unit as template in the mission editor a

CSAR.inTransitGroups

- - - -

CSAR.index

- - @@ -3472,7 +3466,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.FreeVHFFrequencies @@ -3724,22 +3718,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.csarUnits + +

table of CSAR unit names

+
- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -3838,17 +3849,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

contain a table for each SAR with all units he has with the original names

-
- -
-
-
- - -CSAR.index - - -
@@ -7923,7 +7923,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.FreeVHFFrequencies @@ -8175,22 +8175,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.csarUnits + +

table of CSAR unit names

+
- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -8289,17 +8306,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

contain a table for each SAR with all units he has with the original names

-
- -
-
-
- - -CSAR.index - - -
@@ -10153,7 +10159,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.FreeVHFFrequencies @@ -10405,22 +10411,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.csarUnits + +

table of CSAR unit names

+
- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -10519,17 +10542,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

contain a table for each SAR with all units he has with the original names

-
- -
-
-
- - -CSAR.index - - -
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index 78a071663..e83a8ec2a 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -5682,7 +5682,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -5823,14 +5823,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.PilotGroups - -

tables

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

time to repair a unit/group

+

noob catch

@@ -12680,7 +12677,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -12821,14 +12818,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.PilotGroups - -

tables

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

time to repair a unit/group

+

noob catch

@@ -14926,7 +14920,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -15067,14 +15061,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.PilotGroups - -

tables

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

time to repair a unit/group

+

noob catch

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

Can transport crate.

-
- -
-
-
- - #number -CTLD.UnitCapabilities.length - - -
diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index 9995cb896..29350e6d5 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2820,17 +2820,6 @@ but can separately be modified later in your mission using the -
- - -
-
@@ -7467,17 +7456,6 @@ If the Unit is part of the Task, true is returned.

- - - -
-
diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index d9dfd7c14..32df93725 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -2814,7 +2814,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -3539,7 +3539,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -4715,7 +4715,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -6197,7 +6197,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 a0f6a6048..7a540f2ee 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3113,11 +3113,22 @@ based on the tasking capabilities defined in + +
+
+
@@ -3150,7 +3161,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -4572,7 +4583,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -9104,7 +9115,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 4005fb540..1393083d2 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3091,11 +3091,33 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ +
+ + @@ -4159,11 +4181,33 @@ This method can only be used once!

+ +
+ + @@ -5006,11 +5050,33 @@ This method can only be used once!

+ +
+ + @@ -6488,11 +6554,33 @@ This method can only be used once!

+ +
+ + diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index 8ea4f41ff..82ace3b68 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -4232,7 +4232,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive2.

+

Alive.

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

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 4ca249d3a..f409e8b06 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -4752,7 +4752,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -8891,7 +8902,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu + +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -17432,7 +17454,18 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of + +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -20926,7 +20959,18 @@ Coordinates are dependent on the position of the maps origin.

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

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

+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 0ced76afd..0f701b3c3 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2899,6 +2899,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -2983,7 +3005,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.toall +MARKER.togroup @@ -4983,6 +5005,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -5067,7 +5111,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.toall +MARKER.togroup @@ -6575,6 +6619,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -6659,7 +6725,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau