From 9232ea04df0420f23841e4ab3daf45610fb5293b Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Sat, 12 Jan 2019 23:10:31 +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 | 24 +-- Documentation/AI.AI_Patrol.html | 12 ++ Documentation/Cargo.CargoCrate.html | 22 --- Documentation/Cargo.CargoGroup.html | 62 +----- Documentation/Cargo.CargoUnit.html | 22 +++ Documentation/Core.Fsm.html | 26 ++- Documentation/Core.Point.html | 33 ---- Documentation/Core.Settings.html | 4 +- Documentation/Core.Spawn.html | 26 ++- Documentation/Core.SpawnStatic.html | 22 +++ Documentation/Core.Spot.html | 132 ------------- Documentation/Functional.Detection.html | 33 ++++ Documentation/Functional.Movement.html | 28 +++ Documentation/Functional.ZoneGoal.html | 42 ----- Documentation/Tasking.CommandCenter.html | 22 --- Documentation/Tasking.Task.html | 22 --- Documentation/Tasking.Task_Cargo.html | 8 +- .../Tasking.Task_Cargo_Dispatcher.html | 176 ++++++++++++++++++ Documentation/Wrapper.Group.html | 78 +++++++- 21 files changed, 449 insertions(+), 401 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..2a05dd101 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2122,9 +2122,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

- @@ -5672,6 +5669,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.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index aa7cce832..a01bfefb8 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1427,24 +1427,13 @@ 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

+
@@ -1456,20 +1445,6 @@ 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.

-
@@ -2770,24 +2745,13 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

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

Then we register the new group in the database

+
@@ -2799,20 +2763,6 @@ 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 9053b3d08..0c67f699f 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1331,6 +1331,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles + + + +
+
+ + #number +CARGO_UNIT.RunCount + + +
@@ -2043,6 +2054,17 @@ 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 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.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 8bea7b798..fa9a2860d 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2164,7 +2164,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric @@ -4049,7 +4049,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 bbb1bb6f9..9ad679766 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -3145,6 +3145,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -3157,7 +3168,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

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

+

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

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

+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -7739,7 +7761,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

+

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

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.Detection.html b/Documentation/Functional.Detection.html index 9312c6e46..786ace3e0 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -16311,6 +16311,17 @@ BASE:TraceOnOff( false ) + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -20621,6 +20632,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -22102,6 +22124,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
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.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 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.html b/Documentation/Tasking.Task.html index 0db5ade13..61a8eaaf4 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2380,17 +2380,6 @@ but can separately be modified later in your mission using the -
- -
-
-
- - -TASK.TaskControlMenu - - -
@@ -6903,17 +6892,6 @@ 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 04537fe93..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 @@ -2726,7 +2726,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -4102,7 +4102,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -8521,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 65e75dc18..2dad315eb 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 + + + +
+ +
@@ -3677,6 +3721,50 @@ This method can only be used once!

Field(s)

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

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -5796,6 +5928,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 + + + +
+ +
+