From e861d5df709a06e71c0bfebf240762e217b8c1b2 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Sun, 28 Jul 2019 21:00:01 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A.html | 44 ++++ Documentation/AI.AI_Cargo_Airplane.html | 68 +----- Documentation/AI.AI_Patrol.html | 12 + Documentation/Cargo.CargoCrate.html | 22 -- Documentation/Cargo.CargoUnit.html | 22 ++ Documentation/Core.Fsm.html | 26 +-- Documentation/Core.Point.html | 6 + Documentation/Core.Settings.html | 8 +- Documentation/Core.Spawn.html | 116 ++++++++- Documentation/Core.SpawnStatic.html | 22 -- Documentation/Functional.Detection.html | 6 +- Documentation/Functional.Movement.html | 28 +++ Documentation/Functional.Rat.html | 57 +++++ Documentation/Tasking.CommandCenter.html | 22 ++ Documentation/Tasking.Task_Cargo.html | 2 +- .../Tasking.Task_Cargo_Dispatcher.html | 220 ------------------ Documentation/Wrapper.Group.html | 78 ++++++- Documentation/Wrapper.Positionable.html | 44 ---- 18 files changed, 399 insertions(+), 404 deletions(-) diff --git a/Documentation/AI.AI_A2A.html b/Documentation/AI.AI_A2A.html index 24ed52a30..b4d3ff5b6 100644 --- a/Documentation/AI.AI_A2A.html +++ b/Documentation/AI.AI_A2A.html @@ -2391,6 +2391,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_A2A.IdleCount + + +
@@ -4959,6 +4970,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_A2A.IdleCount + + +
@@ -5648,6 +5670,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_A2A.IdleCount + + +
@@ -6975,6 +7008,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_A2A.IdleCount + + +
diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 882aa1266..f1734a8f1 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2114,17 +2114,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - -
- -
@@ -2166,9 +2155,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - -
- -
@@ -3714,9 +3692,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - -
- -
@@ -4354,9 +4321,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - -
- -
@@ -5632,9 +5588,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

-
@@ -5660,6 +5613,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 ad6e190c2..c476f71b6 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -2636,6 +2636,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

+ @@ -8009,6 +8018,9 @@ 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 a28641796..516c24590 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1356,17 +1356,6 @@ which are excellent tools to be reused in an OO environment!.

Field(s)

-
-
- - -CARGO_CRATE.CargoCarrier - - - -
- -
@@ -2035,17 +2024,6 @@ which are excellent tools to be reused in an OO environment!.

Field(s)

-
-
- - -CARGO_CRATE.CargoCarrier - - - -
- -
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index c9d544d0c..9053b3d08 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1305,6 +1305,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ +
+
+
+ + CARGO_UNIT.CargoInAir @@ -2006,6 +2017,17 @@ 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.Fsm.html b/Documentation/Core.Fsm.html index 8fa4351b6..5c2852433 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -4820,7 +4820,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -4836,17 +4836,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -FSM.current - - -
@@ -6147,7 +6136,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -6163,17 +6152,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -FSM.current - - -
diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index f135ce13d..ac116b9bf 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -4154,6 +4154,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Coordinates.

+
@@ -9592,6 +9595,9 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t + +

Coordinates.

+
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 54a5c07b9..b432910d2 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2131,7 +2131,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2GSystem @@ -2164,7 +2164,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric @@ -4005,7 +4005,7 @@ It is advised to use this method at the start of the mission.

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

- #boolean + SETTINGS.Metric diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index a5e8173f4..0779cb243 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2214,6 +2214,24 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

SPAWN.livery_id

+ + + + + +

SPAWN.skill

+ + + + + +

SPAWN.uncontrolled

+ + @@ -2940,6 +2958,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.

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

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

+

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

@@ -3195,6 +3227,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.livery_id + + + +
+ +
+
+
+ + +SPAWN.skill + + + +
+ +
+
+
+ + +SPAWN.uncontrolled + + +
@@ -7522,6 +7587,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.

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

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

+

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

@@ -7777,6 +7856,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.livery_id + + + +
+ +
+
+
+ + +SPAWN.skill + + + +
+ +
+
+
+ + +SPAWN.uncontrolled + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index bf51601a5..117f504cc 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1756,17 +1756,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- - -
-
- - #number -SPAWNSTATIC.SpawnIndex - - -
@@ -2296,17 +2285,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -SPAWNSTATIC.SpawnIndex - - -
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 667211c28..b34c849d8 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -16471,7 +16471,7 @@ BASE:TraceOnOff( false )
- #number + DETECTION_BASE.RefreshTimeInterval @@ -20803,7 +20803,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #number + DETECTION_BASE.RefreshTimeInterval @@ -22306,7 +22306,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 98ff88773..7aef91696 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -1653,6 +1653,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

+ +
+ +
@@ -1883,6 +1897,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 df099abd9..a31aae459 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -2939,6 +2939,12 @@ manager:Stop(7200)

RAT.termtype

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

+ + + +

RAT.type

+ + @@ -3777,6 +3783,24 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

RAT.livery_id

+ + + + + +

RAT.skill

+ + + + + +

RAT.uncontrolled

+ + @@ -5922,6 +5946,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 + + +
@@ -13703,6 +13738,17 @@ Initializes the ratcraft array and group menu.

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

+
+ +
+
+
+ + +RAT.type + + +
@@ -18928,6 +18974,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/Tasking.CommandCenter.html b/Documentation/Tasking.CommandCenter.html index 4eb198c15..3a2899feb 100644 --- a/Documentation/Tasking.CommandCenter.html +++ b/Documentation/Tasking.CommandCenter.html @@ -1963,6 +1963,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + #boolean +COMMANDCENTER.AutoAssignTasks + + + +
+ +
@@ -3109,6 +3120,17 @@ CC:SetReferenceZones( "Station" )

Field(s)

+
+
+ + #boolean +COMMANDCENTER.AutoAssignTasks + + + +
+ +
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 3c598c08e..14c06cd7c 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2678,7 +2678,7 @@ 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 2dad315eb..b31c25d4a 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2587,61 +2587,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
@@ -3721,61 +3666,6 @@ This method can only be used once!

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
@@ -4634,61 +4524,6 @@ This method can only be used once!

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
@@ -5928,61 +5763,6 @@ This method can only be used once!

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 9515cbf39..3218c622e 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -3602,7 +3602,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -6944,7 +6955,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -12730,7 +12752,18 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -15698,7 +15731,18 @@ Coordinates are dependent on the position of the maps origin.

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

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

-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 0a5f6b76b..5cd706425 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -2825,17 +2825,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
- @@ -5760,17 +5749,6 @@ Coordinates are dependent on the position of the maps origin.

-
- -
- @@ -6310,17 +6288,6 @@ If the Identifiable is alive, true is returned.

-
- -
- @@ -6471,17 +6438,6 @@ If the Identifiable is alive, true is returned.

-
- -
-