From 946a76d242d1e4b075f389d981f90f36c6a0c9cb Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Thu, 26 Nov 2020 16:25:32 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2G_Dispatcher.html | 44 ---- Documentation/AI.AI_Air.html | 44 ---- Documentation/AI.AI_Air_Squadron.html | 22 -- Documentation/AI.AI_Cargo_Airplane.html | 68 +----- Documentation/AI.AI_Patrol.html | 12 - Documentation/Cargo.CargoCrate.html | 22 -- Documentation/Cargo.CargoGroup.html | 28 +++ Documentation/Cargo.CargoUnit.html | 44 ++-- Documentation/Core.Fsm.html | 4 +- Documentation/Core.Spawn.html | 168 ++++--------- Documentation/Functional.Designate.html | 55 ----- Documentation/Functional.Detection.html | 6 +- Documentation/Functional.Movement.html | 28 --- Documentation/Functional.Rat.html | 59 +++-- Documentation/Ops.Airboss.html | 16 +- Documentation/Tasking.Task.html | 22 ++ .../Tasking.Task_A2A_Dispatcher.html | 47 +++- .../Tasking.Task_A2G_Dispatcher.html | 89 +++++++ Documentation/Tasking.Task_Cargo.html | 13 +- .../Tasking.Task_Cargo_Dispatcher.html | 228 ++++-------------- Documentation/Wrapper.Marker.html | 66 +++++ Documentation/Wrapper.Positionable.html | 44 ++++ 22 files changed, 468 insertions(+), 661 deletions(-) diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 53c6e4365..71b9fe89a 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4463,17 +4463,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

- - - -
-
diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 5e90a9350..a779e02d0 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -2753,17 +2753,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -5508,17 +5497,6 @@ Once the time is finished, the old AI will return to the base.

- - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -6244,17 +6222,6 @@ Once the time is finished, the old AI will return to the base.

- - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -7873,17 +7840,6 @@ Once the time is finished, the old AI will return to the base.

- - - -
-
- - #number -AI_AIR.IdleCount - - -
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 0c01d449b..84bc1d307 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2256,17 +2256,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
@@ -3338,17 +3327,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 8aff18476..791fde891 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2439,20 +2439,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.

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

Aircraft is on a pickup mission.

+
@@ -4226,20 +4215,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.

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

Aircraft is on a pickup mission.

+
@@ -4855,20 +4833,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.

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

Aircraft is on a pickup mission.

+
@@ -6377,20 +6344,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.

- -
- -
@@ -6446,6 +6399,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/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index c348aaa53..a27ba1560 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -2955,9 +2955,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

- @@ -8592,9 +8583,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.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index 72c71e454..3017bfc4b 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1609,17 +1609,6 @@

Field(s)

-
- - -
@@ -2288,17 +2277,6 @@

Field(s)

-
- - -
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index a9750edc1..a842008f5 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1712,6 +1712,20 @@ +
+ +
+
+
+ + +CARGO_GROUP.CargoObject + + + + +

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

+
@@ -3044,6 +3058,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 677501298..dcbb04c6c 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1558,6 +1558,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ + +
+
+ + CARGO_UNIT.CargoInAir @@ -1573,17 +1584,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles -
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2270,6 +2270,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ + +
+
+ + CARGO_UNIT.CargoInAir @@ -2285,17 +2296,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles -
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index f41ab3ff5..91eee6bc5 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5348,7 +5348,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState @@ -6952,7 +6952,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index fa9039b75..00f4dd3e5 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2593,25 +2593,7 @@ and any spaces before and after the resulting name are removed.

-

SPAWN.communication

- - - - - -

SPAWN.livery_id

- - - - - -

SPAWN.modulation

- - - - - -

SPAWN.skill

+

SPAWN.frequency

@@ -3204,9 +3186,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.

-
@@ -3331,6 +3310,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
@@ -3430,20 +3420,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.

-
@@ -3488,6 +3464,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -3750,40 +3737,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-SPAWN.communication - - - -
- - -
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - - -
- -
-
-
- - -SPAWN.skill +SPAWN.frequency @@ -8606,9 +8560,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.

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

+ + +
+
@@ -8832,20 +8794,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.

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

+ + +
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -9152,40 +9111,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

-SPAWN.communication - - - - - - -
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - - -
- -
-
-
- - -SPAWN.skill +SPAWN.frequency diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index c28aa51ae..24d513a75 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3252,17 +3252,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -6420,17 +6409,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -7230,17 +7208,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -8010,17 +7977,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -9683,17 +9639,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index d9682af0f..34ee68828 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18390,7 +18390,7 @@ BASE:TraceOnOff( false )
- + #number DETECTION_BASE.RefreshTimeInterval @@ -23092,7 +23092,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval @@ -24850,7 +24850,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index 78b59adc0..885466634 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -1966,20 +1966,6 @@ 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

- -
- -
@@ -2210,20 +2196,6 @@ 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 2185c89e9..0f22fa55c 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3216,6 +3216,12 @@ manager:Stop(7200)

RAT.termtype

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

+ + + +

RAT.type

+ + @@ -4179,25 +4185,7 @@ and any spaces before and after the resulting name are removed.

-

RAT.communication

- - - - - -

RAT.livery_id

- - - - - -

RAT.modulation

- - - - - -

RAT.skill

+

RAT.frequency

@@ -6487,6 +6475,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 + + +
@@ -14367,6 +14366,17 @@ Initializes the ratcraft array and group menu.

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

+
+ +
+
+
+ + +RAT.type + + +
@@ -20302,6 +20312,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 6d80097a5..cd6cfc8df 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -37718,20 +37718,6 @@ BASE:TraceOnOff( false )
-
-
-
- - -AIRBOSS.PlayerData.flag - - - - -

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

- -
-
@@ -37866,7 +37852,7 @@ BASE:TraceOnOff( false ) -

Make player section lead if he was not before.

+

Set section lead of player flight.

diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index 687360e33..67468c54b 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2680,6 +2680,17 @@ but can separately be modified later in your mission using the +
+ +
+
+
@@ -7316,6 +7327,17 @@ 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 7c0da864a..8a3bba9f9 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -1651,6 +1651,12 @@ So, this method will be called only ONCE when a player joins a

TASK_A2A_DISPATCHER:SetEngageRadius(EngageRadius)

Define the radius to when an ENGAGE task will be generated for any nearby by airborne friendlies, which are executing cap or returning from an intercept mission.

+ + + +

TASK_A2A_DISPATCHER:SetSendMessages(onoff)

+ +

Set flashing player messages on or off

@@ -2626,7 +2632,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -3298,6 +3304,39 @@ If too large, any airborne cap may not be able to reach the detected target area
+
+ + +
+ + + +

Set flashing player messages on or off

+ +
+
+

Defined in:

+
+

TASK_A2A_DISPATCHER

+
+

Parameter:

+
+
+

+ #boolean + onoff +

+
+
+ +

Set messages on (true) or off (false)

+ +
+
+
+
@@ -3318,7 +3357,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -4494,7 +4533,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -5977,7 +6016,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_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index 3c8f00af4..52ac029dc 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -1879,6 +1879,12 @@ TaskDispatcher = TASK_A2G_DISPATCHER

TASK_A2G_DISPATCHER:EvaluateSEAD(DetectedItem)

Creates a SEAD task when there are targets for it.

+ + + +

TASK_A2G_DISPATCHER.FlashNewTask

+ + @@ -1915,6 +1921,12 @@ TaskDispatcher = TASK_A2G_DISPATCHER

TASK_A2G_DISPATCHER.SetGroup

The groups to which the FAC will report to.

+ + + +

TASK_A2G_DISPATCHER:SetSendMessages(onoff)

+ +

Set flashing player messages on or off

@@ -2884,6 +2896,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The DETECTION_BASE object that is used to report the detected objects.

+
+ +
+ @@ -3403,6 +3426,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+ +
+ + + +

Set flashing player messages on or off

+ +
+
+

Defined in:

+
+

TASK_A2G_DISPATCHER

+
+

Parameter:

+
+
+

+ #boolean + onoff +

+
+
+ +

Set messages on (true) or off (false)

+ +
+
+
+
@@ -3417,6 +3473,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The DETECTION_BASE object that is used to report the detected objects.

+ + + +
+
@@ -4593,6 +4660,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The DETECTION_BASE object that is used to report the detected objects.

+ + + +
+
@@ -6076,6 +6154,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The DETECTION_BASE object that is used to report the detected objects.

+ + + +
+
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index dd5b30698..5b3ae29a7 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2973,22 +2973,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 bcdebb62d..542ee81e3 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2906,50 +2906,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
- - -
-
- - -
-
- - -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -2964,11 +2920,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ +
+
+
@@ -4029,50 +3996,6 @@ This method can only be used once!

Field(s)

-
- - -
-
- - -
-
- - -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -4087,11 +4010,22 @@ This method can only be used once!

+ @@ -4931,50 +4865,6 @@ This method can only be used once!

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -4989,11 +4879,22 @@ This method can only be used once!

+ @@ -6469,50 +6370,6 @@ This method can only be used once!

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -6527,11 +6384,22 @@ This method can only be used once!

+ diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index aed739fa4..940b8272b 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2805,6 +2805,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +MARKER.tocoaliton + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +
@@ -4889,6 +4911,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +MARKER.tocoaliton + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +
@@ -6482,6 +6526,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +MARKER.tocoaliton + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +
diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index a1762b023..c0dd2e8f3 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3287,6 +3287,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
@@ -6682,6 +6693,17 @@ Coordinates are dependent on the position of the maps origin.

+ + + +
+
@@ -7259,6 +7281,17 @@ If the Identifiable is alive, true is returned.

+ + + +
+
@@ -7442,6 +7475,17 @@ If the Identifiable is alive, true is returned.

+ + + +
+