From 152095aff73817757b795b46ee26335a656a46c5 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Mon, 9 Sep 2019 17:33:57 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A.html | 44 ----- Documentation/AI.AI_Cargo_Airplane.html | 56 ++++-- Documentation/AI.AI_Patrol.html | 12 ++ Documentation/Cargo.CargoCrate.html | 22 +++ Documentation/Cargo.CargoGroup.html | 6 + Documentation/Cargo.CargoUnit.html | 22 --- Documentation/Core.Fsm.html | 26 ++- Documentation/Core.Settings.html | 34 +++- Documentation/Core.Spawn.html | 48 +---- Documentation/Core.SpawnStatic.html | 66 +++++++ Documentation/Functional.Designate.html | 110 +++++++++++ Documentation/Functional.Detection.html | 39 +++- Documentation/Functional.Movement.html | 28 +++ Documentation/Functional.Rat.html | 39 ++++ Documentation/Functional.ZoneGoal.html | 42 ----- Documentation/Tasking.CommandCenter.html | 22 +++ Documentation/Tasking.Task.html | 22 +++ Documentation/Tasking.Task_Cargo.html | 17 +- .../Tasking.Task_Cargo_Dispatcher.html | 176 ++++++++++++++++++ Documentation/Wrapper.Group.html | 78 +++++++- 20 files changed, 712 insertions(+), 197 deletions(-) diff --git a/Documentation/AI.AI_A2A.html b/Documentation/AI.AI_A2A.html index b4d3ff5b6..24ed52a30 100644 --- a/Documentation/AI.AI_A2A.html +++ b/Documentation/AI.AI_A2A.html @@ -2391,17 +2391,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_A2A.IdleCount - - -
@@ -4970,17 +4959,6 @@ Once the time is finished, the old AI will return to the base.

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

- - - -
-
- - #number -AI_A2A.IdleCount - - -
@@ -7008,17 +6975,6 @@ 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 f1734a8f1..c3c2603a3 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2114,6 +2114,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

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

Field(s)

+
+
+ + +CARGO_CRATE.CargoCarrier + + + +
+ +
@@ -2024,6 +2035,17 @@ 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 aa7cce832..d3ca4eade 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1445,6 +1445,9 @@ which are excellent tools to be reused in an OO environment!.

+ +

Then we register the new group in the database

+
@@ -2788,6 +2791,9 @@ This works for ground only groups.

+ +

Then we register the new group in the database

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

By default, no InitLimit

-
- -
-
-
- - -SPAWN.SpawnInitLivery - - - -
- -
-
-
- - #string -SPAWN.SpawnInitSkill - - -
@@ -3193,7 +3171,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.

@@ -7586,28 +7564,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

-
- -
-
-
- - -SPAWN.SpawnInitLivery - - - -
- -
-
-
- - #string -SPAWN.SpawnInitSkill - - -
@@ -7811,7 +7767,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.

diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 88821384b..bf51601a5 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1734,6 +1734,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWNSTATIC.CoalitionID + + + +
+ +
+
+
+ + +SPAWNSTATIC.CountryID + + + +
+ +
+
+
+ + #number +SPAWNSTATIC.SpawnIndex + + +
@@ -2241,6 +2274,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWNSTATIC.CoalitionID + + + +
+ +
+
+
+ + +SPAWNSTATIC.CountryID + + + +
+ +
+
+
+ + #number +SPAWNSTATIC.SpawnIndex + + +
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 35d02144e..d00ce2c67 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2922,6 +2922,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -2933,6 +2944,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6079,6 +6101,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -6090,6 +6123,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6878,6 +6922,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -6889,6 +6944,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -7647,6 +7713,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -7658,6 +7735,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -9054,6 +9142,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -9065,6 +9164,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index dc195281d..786ace3e0 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -16311,6 +16311,17 @@ BASE:TraceOnOff( false ) + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -16449,7 +16460,7 @@ BASE:TraceOnOff( false )
- + #number DETECTION_BASE.RefreshTimeInterval @@ -20621,6 +20632,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -20759,7 +20781,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval @@ -22102,6 +22124,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -22240,7 +22273,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..a4cab81af 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

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

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

+
+ +
+
+
+ + +RAT.type + + +
@@ -18928,6 +18956,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/Functional.ZoneGoal.html b/Documentation/Functional.ZoneGoal.html index 725deec17..5d593eaa5 100644 --- a/Documentation/Functional.ZoneGoal.html +++ b/Documentation/Functional.ZoneGoal.html @@ -1956,20 +1956,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -ZONE_GOAL.SmokeTime - - - - -

self.SmokeColor = nil

-
@@ -2099,20 +2085,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -ZONE_GOAL.SmokeTime - - - - -

self.SmokeColor = nil

-
@@ -3352,20 +3324,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -ZONE_GOAL.SmokeTime - - - - -

self.SmokeColor = nil

-
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.html b/Documentation/Tasking.Task.html index 61a8eaaf4..0db5ade13 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2380,6 +2380,17 @@ but can separately be modified later in your mission using the +
+ +
+
+
+ + +TASK.TaskControlMenu + + +
@@ -6892,6 +6903,17 @@ If the Unit is part of the Task, true is returned.

+
+ +
+
+
+ + +TASK.TaskControlMenu + + +
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 14c06cd7c..54a43fd80 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2683,17 +2683,6 @@ based on the tasking capabilities defined in - - -
-
- - -FSM_PROCESS.DeployZone - - -
@@ -2726,7 +2715,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4102,7 +4091,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -8521,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 5e4454239..851da258c 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2587,6 +2587,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -3666,6 +3710,50 @@ This method can only be used once!

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -4524,6 +4612,50 @@ This method can only be used once!

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -5763,6 +5895,50 @@ This method can only be used once!

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
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 + + + +
+ +
+