From 99aa80b2d6ef4593efdac90128075217be532e6e Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Wed, 19 Jun 2019 16:03:06 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A.html | 44 ------ Documentation/AI.AI_Cargo.html | 12 ++ Documentation/AI.AI_Cargo_Airplane.html | 12 -- Documentation/AI.AI_Patrol.html | 12 ++ Documentation/Cargo.CargoCrate.html | 22 +++ Documentation/Cargo.CargoGroup.html | 56 ++++---- Documentation/Cargo.CargoUnit.html | 22 --- Documentation/Core.Point.html | 33 ----- Documentation/Core.Settings.html | 8 +- Documentation/Core.Spawn.html | 88 ++---------- Documentation/Core.SpawnStatic.html | 22 +++ Documentation/Core.Spot.html | 132 ++++++++++++++++++ Documentation/Functional.Designate.html | 55 ++++++++ Documentation/Functional.Detection.html | 33 ----- Documentation/Functional.Rat.html | 45 +++++- Documentation/Tasking.CommandCenter.html | 22 +++ Documentation/Tasking.Task.html | 22 +++ Documentation/Tasking.Task_Cargo.html | 17 ++- .../Tasking.Task_Cargo_Dispatcher.html | 44 ++++++ Documentation/Wrapper.Group.html | 78 +---------- Documentation/Wrapper.Positionable.html | 44 ++++++ 21 files changed, 492 insertions(+), 331 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.html b/Documentation/AI.AI_Cargo.html index 1e105b17a..64059b519 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -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.

+ @@ -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.

+ @@ -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.

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

Aircraft is on a depoly mission.

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

Aircraft is on a depoly mission.

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

Aircraft is on a depoly mission.

- @@ -5644,9 +5635,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 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 d262f77d7..e583250bc 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1427,20 +1427,6 @@ which are excellent tools to be reused in an OO environment!.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup @@ -1456,6 +1442,20 @@ which are excellent tools to be reused in an OO environment!.

+
+ +
+
+
+ + +CARGO_GROUP.CargoObject + + + + +

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

+
@@ -2756,20 +2756,6 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup @@ -2785,6 +2771,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 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.Point.html b/Documentation/Core.Point.html index 51b4db22e..f135ce13d 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -12275,17 +12275,6 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

- - - -
-
- - -POINT_VEC2.z - - -
@@ -13084,17 +13073,6 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

- - - -
-
- - -POINT_VEC2.z - - -
@@ -18467,17 +18445,6 @@ 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 8891a4cbd..54a5c07b9 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 @@ -2164,7 +2164,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SETTINGS.Metric @@ -3994,7 +3994,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem @@ -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 1c8282249..7514a347a 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2214,12 +2214,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.skill

- - @@ -2750,6 +2744,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.

+
@@ -2954,27 +2951,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- -SPAWN.SpawnInitLivery - - - -
- -
-
-
- - #string -SPAWN.SpawnInitSkill - - +

By default, no InitLimit

@@ -2996,7 +2974,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxGroups @@ -3010,7 +2988,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxUnitsAlive @@ -3168,7 +3146,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.

@@ -3206,17 +3184,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.skill - - -
@@ -7348,6 +7315,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.

+
@@ -7552,27 +7522,8 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-
- -SPAWN.SpawnInitLivery - - - -
- -
-
-
- - #string -SPAWN.SpawnInitSkill - - +

By default, no InitLimit

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

- + #number SPAWN.SpawnMaxGroups @@ -7608,7 +7559,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- + #number SPAWN.SpawnMaxUnitsAlive @@ -7766,7 +7717,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.

@@ -7804,17 +7755,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.skill - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 88821384b..121a0b483 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1734,6 +1734,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #number +SPAWNSTATIC.SpawnIndex + + +
@@ -2241,6 +2252,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 f5e56447c..e72eb76e2 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2139,6 +2139,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + + +
+ +
+
+
+ + +SPOT.Target + + +
@@ -3070,6 +3114,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + + +
+ +
+
+
+ + +SPOT.Target + + +
@@ -4309,6 +4397,50 @@ 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 35d02144e..2cf617288 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 786ace3e0..9312c6e46 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -16311,17 +16311,6 @@ BASE:TraceOnOff( false ) - - - -
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -20632,17 +20621,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -22124,17 +22102,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index e21b7484a..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

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

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

- - - -

RAT.skill

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

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

+ + + +
+
+ + +RAT.type + + +
@@ -18934,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/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 d209dd33d..3c598c08e 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2683,6 +2683,17 @@ based on the tasking capabilities defined in + + +
+
+ + +FSM_PROCESS.DeployZone + + +
@@ -2715,7 +2726,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -4091,7 +4102,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -8510,7 +8521,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..f733d834c 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2606,6 +2606,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.MaxCSAR + + +
@@ -3685,6 +3696,17 @@ This method can only be used once!

+
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.MaxCSAR + + +
@@ -4543,6 +4565,17 @@ This method can only be used once!

+ + + +
+
+ + +TASK_CARGO_DISPATCHER.MaxCSAR + + +
@@ -5782,6 +5815,17 @@ This method can only be used once!

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

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

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

-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone 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.

+
+ +
+
+
+ + Core.Spot#SPOT +POSITIONABLE.Spot + + +
@@ -6288,6 +6310,17 @@ If the Identifiable is alive, true is returned.

+
+ +
+
+
+ + Core.Spot#SPOT +POSITIONABLE.Spot + + +
@@ -6438,6 +6471,17 @@ If the Identifiable is alive, true is returned.

+
+ + +
+
+ + Core.Spot#SPOT +POSITIONABLE.Spot + + +