From 8ae2c2de76788baacf10a04576bcf7bf9f2710a5 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Tue, 13 Nov 2018 20:49:30 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A.html | 44 ++++++ Documentation/AI.AI_Cargo.html | 20 ++- Documentation/AI.AI_Cargo_Airplane.html | 68 --------- Documentation/AI.AI_Patrol.html | 12 -- Documentation/Cargo.CargoCrate.html | 22 --- Documentation/Cargo.CargoGroup.html | 34 ++++- Documentation/Cargo.CargoUnit.html | 22 --- Documentation/Core.Fsm.html | 26 +--- Documentation/Core.Settings.html | 34 ++++- Documentation/Core.Spawn.html | 88 +++++++++++- Documentation/Core.SpawnStatic.html | 22 +++ Documentation/Core.Spot.html | 132 ------------------ Documentation/Functional.Designate.html | 55 ++++++++ Documentation/Functional.Detection.html | 6 +- Documentation/Functional.Movement.html | 28 ---- Documentation/Functional.Rat.html | 51 ++----- Documentation/Tasking.CommandCenter.html | 22 --- Documentation/Tasking.Task_Cargo.html | 8 +- .../Tasking.Task_Cargo_Dispatcher.html | 52 +------ Documentation/Wrapper.Group.html | 78 ++++++++++- Documentation/Wrapper.Positionable.html | 44 ++++++ 21 files changed, 420 insertions(+), 448 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.html b/Documentation/AI.AI_Cargo.html index 483bca1a5..64059b519 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2127,7 +2127,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -2165,6 +2165,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.

+
@@ -4065,7 +4068,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -4103,6 +4106,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.

+
@@ -4677,7 +4683,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -4715,6 +4721,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.

+
@@ -5927,7 +5936,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -5965,6 +5974,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 06ee0479d..d3eca5987 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2114,20 +2114,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.

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

Aircraft is on a depoly mission.

-
@@ -3665,20 +3648,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.

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

Aircraft is on a depoly mission.

-
@@ -4308,20 +4274,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.

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

Aircraft is on a depoly mission.

-
@@ -5589,20 +5538,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.

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

Aircraft is on a depoly mission.

-
diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index c476f71b6..ad6e190c2 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -2636,9 +2636,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

- @@ -8018,9 +8009,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 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.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index dc181768b..aa7cce832 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1427,13 +1427,24 @@ which are excellent tools to be reused in an OO environment!.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

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

Then we register the new group in the database

-
@@ -2759,13 +2770,24 @@ 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/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index b3d466d88..c9d544d0c 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1320,17 +1320,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles -
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2032,17 +2021,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 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.Settings.html b/Documentation/Core.Settings.html index 8891a4cbd..8bea7b798 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2120,7 +2120,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2ASystem @@ -2131,7 +2131,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2GSystem @@ -2164,11 +2164,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -3994,7 +4005,7 @@ It is advised to use this method at the start of the mission.

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

- + #string SETTINGS.A2GSystem @@ -4038,11 +4049,22 @@ 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 bc75e1473..46988bcfb 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2214,6 +2214,18 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

SPAWN.skill

+ + + + + +

SPAWN.uncontrolled

+ + @@ -2937,6 +2949,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.

+
@@ -3162,7 +3188,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.

@@ -3200,6 +3226,28 @@ 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.skill + + + +
+ +
+
+
+ + +SPAWN.uncontrolled + + +
@@ -7524,6 +7572,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.

+
@@ -7749,7 +7811,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.

@@ -7787,6 +7849,28 @@ 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.skill + + + +
+ +
+
+
+ + +SPAWN.uncontrolled + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 117f504cc..bf51601a5 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1756,6 +1756,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +SPAWNSTATIC.SpawnIndex + + +
@@ -2285,6 +2296,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +SPAWNSTATIC.SpawnIndex + + +
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index e72eb76e2..f5e56447c 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2139,50 +2139,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
@@ -3114,50 +3070,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
@@ -4397,50 +4309,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index adb16839b..9c25957b5 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2933,6 +2933,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6090,6 +6101,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6889,6 +6911,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -7658,6 +7691,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -9065,6 +9109,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index dc195281d..9312c6e46 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -16449,7 +16449,7 @@ BASE:TraceOnOff( false )
- + #number DETECTION_BASE.RefreshTimeInterval @@ -20759,7 +20759,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval @@ -22240,7 +22240,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 7aef91696..98ff88773 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -1653,20 +1653,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

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

RAT.termtype

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

- - - -

RAT.type

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

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

+ + + +

RAT.skill

+ + + + + +

RAT.uncontrolled

+ + @@ -5928,17 +5934,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 - - -
@@ -13720,17 +13715,6 @@ Initializes the ratcraft array and group menu.

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

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

Field(s)

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

Field(s)

-
-
- - #boolean -COMMANDCENTER.AutoAssignTasks - - - -
- -
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 25dfa2545..d209dd33d 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 @@ -2715,7 +2715,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4091,7 +4091,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -8510,7 +8510,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 e863c7ca0..2d7709a0d 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2645,22 +2645,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - @@ -3779,22 +3768,11 @@ This method can only be used once!

- @@ -4692,22 +4670,11 @@ This method can only be used once!

- @@ -5986,22 +5953,11 @@ This method can only be used once!

- 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 5cd706425..0a5f6b76b 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -2825,6 +2825,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+ @@ -5749,6 +5760,17 @@ Coordinates are dependent on the position of the maps origin.

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

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

+
+ +
+