From e23b31a0fbd8945319345a73eee1bc0887613b2c Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Tue, 5 Jan 2021 10:51:51 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_Air.html | 44 +++ Documentation/AI.AI_Cargo.html | 12 + Documentation/AI.AI_Cargo_Airplane.html | 12 + Documentation/Cargo.CargoGroup.html | 34 +++ Documentation/Core.Fsm.html | 4 +- Documentation/Core.Point.html | 33 ++ Documentation/Core.Settings.html | 34 +-- Documentation/Core.Spawn.html | 284 ++++-------------- Documentation/Functional.Designate.html | 30 +- Documentation/Functional.Detection.html | 105 ++++--- Documentation/Functional.Movement.html | 28 ++ Documentation/Functional.Rat.html | 69 ----- Documentation/Ops.Airboss.html | 22 +- .../Tasking.Task_A2A_Dispatcher.html | 8 +- Documentation/Tasking.Task_Cargo.html | 19 +- .../Tasking.Task_Cargo_Dispatcher.html | 192 +++++++++++- Documentation/Wrapper.Positionable.html | 44 --- 17 files changed, 524 insertions(+), 450 deletions(-) diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 25efd1839..87ba679ee 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -2809,6 +2809,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -5553,6 +5564,17 @@ Once the time is finished, the old AI will return to the base.

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

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

+ + + +
+
+ + #number +AI_AIR.IdleCount + + +
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index 2128e67f8..9c8012e6b 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2546,6 +2546,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

No loading happened, so we need to pickup something else.

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

No loading happened, so we need to pickup something else.

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

No loading happened, so we need to pickup something else.

+ @@ -6700,6 +6709,9 @@ 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 aa62fb896..ed546770e 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2550,6 +2550,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

+ @@ -6446,6 +6455,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 14e805126..f3b02ce47 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1724,10 +1724,27 @@ Controls a network of SAM sites.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

+ +
+ + +
+
+ + CARGO_GROUP.CargoGroup + +

Then we register the new group in the database

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

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

+ +
+ + +
+
+ + CARGO_GROUP.CargoGroup + +

Then we register the new group in the database

+
diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 4545658b7..691a3cb1b 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5440,7 +5440,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -7044,7 +7044,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 2896976b1..4f0e777eb 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 aec412930..d84a455eb 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2589,7 +2589,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + SETTINGS.A2ASystem @@ -2600,7 +2600,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2GSystem @@ -2644,22 +2644,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric -
- -
-
-
- - -SETTINGS.PlayerMenu - - -
@@ -4691,7 +4680,7 @@ It is advised to use this method at the start of the mission.

- #string + SETTINGS.A2ASystem @@ -4702,7 +4691,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2GSystem @@ -4746,22 +4735,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 e5aefd555..a65c027f0 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2634,36 +2634,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.communication

- - - - - -

SPAWN.frequency

- - - - - -

SPAWN.livery_id

- - - - - -

SPAWN.modulation

- - - - - -

SPAWN.skill

- - @@ -3266,6 +3236,9 @@ 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.

+
@@ -3343,17 +3316,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.SpawnGrouping - - -
@@ -3500,6 +3462,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.

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

By default, no InitLimit

-
- -
-
-
- - -SPAWN.SpawnInitLivery - - - -
- -
-
-
- - -SPAWN.SpawnInitModex - - - -
- -
-
-
- - -SPAWN.SpawnInitModu - - -
@@ -3738,6 +3681,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -3802,61 +3756,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.frequency - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - - -
- -
-
-
- - -SPAWN.skill - - -
@@ -8676,6 +8575,9 @@ 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.

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

- - -
-
- - -SPAWN.SpawnGrouping - - -
@@ -8910,6 +8801,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.

+
@@ -8924,39 +8829,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

- - - -
-
- - -SPAWN.SpawnInitLivery - - - -
- -
-
-
- - -SPAWN.SpawnInitModex - - - -
- -
-
-
- - -SPAWN.SpawnInitModu - - -
@@ -9148,6 +9020,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -9212,61 +9095,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.frequency - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - - -
- -
-
-
- - -SPAWN.skill - - -
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 0a787a9f5..325f05a38 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3304,7 +3304,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -3314,8 +3314,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -6472,7 +6472,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -6482,8 +6482,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -7282,7 +7282,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -7292,8 +7292,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -8062,7 +8062,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -8072,8 +8072,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -9735,7 +9735,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -9745,8 +9745,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index a2216f91a..c57886bfa 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18392,6 +18392,28 @@ BASE:TraceOnOff( false ) +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -18541,18 +18563,7 @@ BASE:TraceOnOff( false )
- #boolean -DETECTION_BASE.Locking - - - -
- -
-
-
- - + #number DETECTION_BASE.RefreshTimeInterval @@ -23094,6 +23105,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -23243,18 +23276,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #boolean -DETECTION_BASE.Locking - - - -
- -
-
-
- - + #number DETECTION_BASE.RefreshTimeInterval @@ -24852,6 +24874,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -25001,18 +25045,7 @@ 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.Movement.html b/Documentation/Functional.Movement.html index 686ce5e45..70bc3e5cf 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 0db3a69ac..07249780e 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3260,12 +3260,6 @@ manager:Stop(7200)

RAT.termtype

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

- - - -

RAT.type

- - @@ -4226,36 +4220,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

RAT.communication

- - - - - -

RAT.frequency

- - - - - -

RAT.livery_id

- - - - - -

RAT.modulation

- - - - - -

RAT.skill

- - @@ -6567,17 +6531,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 - - -
@@ -14458,17 +14411,6 @@ Initializes the ratcraft array and group menu.

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

-
- -
-
-
- - -RAT.type - - -
@@ -20404,17 +20346,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 7c93610fb..4b4fc9aed 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -37793,7 +37793,7 @@ BASE:TraceOnOff( false ) -

Set current case.

+

Set case of f

@@ -37852,6 +37852,20 @@ BASE:TraceOnOff( false )
+
+
+
+ + +AIRBOSS.PlayerData.flag + + + + +

Also decrease flag for section members of flight.

+ +
+
@@ -37985,6 +37999,9 @@ BASE:TraceOnOff( false ) + +

Set section lead of player flight.

+
@@ -38029,6 +38046,9 @@ BASE:TraceOnOff( false ) + +

Set new time stamp.

+
diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index 1a2e237ca..c1097f775 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 ad4bd218c..0827d4252 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3017,22 +3017,11 @@ based on the tasking capabilities defined in
- Cargo.Cargo#CARGO + FSM_PROCESS.Cargo -
- -
-
-
- - -FSM_PROCESS.DeployZone - - -
@@ -3065,7 +3054,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4487,7 +4476,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -9019,7 +9008,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 9026d64ff..ffd8b26f4 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2965,8 +2965,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number -TASK_CARGO_DISPATCHER.CountCSAR + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -2977,10 +2977,54 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+ + @@ -4044,8 +4088,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -4056,10 +4100,54 @@ This method can only be used once!

+TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+ + @@ -4902,8 +4990,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -4914,10 +5002,54 @@ This method can only be used once!

+TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+ + @@ -6396,8 +6528,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -6408,10 +6540,54 @@ This method can only be used once!

+TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+ + diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 4c80d4270..9f7328e1b 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3355,17 +3355,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
- @@ -6753,17 +6742,6 @@ Coordinates are dependent on the position of the maps origin.

-
- -
- @@ -7341,17 +7319,6 @@ If the Identifiable is alive, true is returned.

-
- -
- @@ -7535,17 +7502,6 @@ If the Identifiable is alive, true is returned.

-
- -
-