From cbfc0168f33b4a9bfe7ddb9ea4516064421a58cf Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Thu, 31 Oct 2019 18:04:49 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A_Dispatcher.html | 44 ++++++ Documentation/AI.AI_Cargo.html | 8 +- Documentation/AI.AI_Cargo_Airplane.html | 56 +++++-- Documentation/AI.AI_Patrol.html | 12 -- Documentation/Cargo.CargoCrate.html | 22 +++ Documentation/Cargo.CargoGroup.html | 62 ++++---- Documentation/Core.Fsm.html | 26 +++- Documentation/Core.Point.html | 33 ++++ Documentation/Core.Settings.html | 4 +- Documentation/Core.Spawn.html | 146 +++++++++++------- Documentation/Core.Spot.html | 132 ++++++++++++++++ Documentation/Functional.Designate.html | 30 ++-- Documentation/Functional.Rat.html | 18 +++ Documentation/Tasking.Task.html | 22 --- Documentation/Tasking.Task_Cargo.html | 13 +- .../Tasking.Task_Cargo_Dispatcher.html | 24 +-- Documentation/Wrapper.Group.html | 78 +--------- 17 files changed, 475 insertions(+), 255 deletions(-) diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index 3fb8d6e8e..76760752f 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -3866,6 +3866,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+ + +
@@ -9077,6 +9088,17 @@ They will lock the parking spot.

Field(s)

+
+ + +
@@ -10083,6 +10105,17 @@ They will lock the parking spot.

Field(s)

+
+ + +
@@ -11375,6 +11408,17 @@ They will lock the parking spot.

Field(s)

+
+ + +
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index 483bca1a5..1e105b17a 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 @@ -4065,7 +4065,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -4677,7 +4677,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -5927,7 +5927,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier 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)

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

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

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

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

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

Field(s)

+
+ + +
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index dc181768b..d262f77d7 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

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

-
@@ -2759,13 +2756,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

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

the y coordinate in meters.

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

the y coordinate in meters.

+
+ +
+
+
+ + +POINT_VEC2.z + + +
@@ -18445,6 +18467,17 @@ 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 3a7a11128..8bea7b798 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 @@ -4016,7 +4016,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2GSystem diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 1396fa161..b16202e0c 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

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

By default, no InitLimit

- -
- -
-
-
@@ -2982,7 +2986,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -2996,7 +3000,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3142,17 +3146,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -3165,7 +3158,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.

@@ -3203,6 +3196,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 + + +
@@ -7538,20 +7564,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

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

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

- #number + SPAWN.SpawnMaxUnitsAlive @@ -7732,17 +7744,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -7755,7 +7756,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.

@@ -7793,6 +7794,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.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 2cf617288..aa22a08cf 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2929,7 +2929,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-DESIGNATE.LaseStart +DESIGNATE.LaseDuration @@ -2939,8 +2939,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table -DESIGNATE.LaserCodes + +DESIGNATE.LaseStart @@ -6097,7 +6097,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseStart +DESIGNATE.LaseDuration @@ -6107,8 +6107,8 @@ Designate:SetFlashStatusMenu( false )
- #table -DESIGNATE.LaserCodes + +DESIGNATE.LaseStart @@ -6907,7 +6907,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseStart +DESIGNATE.LaseDuration @@ -6917,8 +6917,8 @@ Designate:SetFlashStatusMenu( false )
- #table -DESIGNATE.LaserCodes + +DESIGNATE.LaseStart @@ -7687,7 +7687,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseStart +DESIGNATE.LaseDuration @@ -7697,8 +7697,8 @@ Designate:SetFlashStatusMenu( false )
- #table -DESIGNATE.LaserCodes + +DESIGNATE.LaseStart @@ -9105,7 +9105,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseStart +DESIGNATE.LaseDuration @@ -9115,8 +9115,8 @@ Designate:SetFlashStatusMenu( false )
- #table -DESIGNATE.LaserCodes + +DESIGNATE.LaseStart diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index df099abd9..8176c0005 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3777,6 +3777,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

+ + 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 -
- -
-
-
@@ -6903,17 +6892,6 @@ If the Unit is part of the Task, true is returned.

-
- -
-
-
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 9350dc897..d209dd33d 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2678,22 +2678,11 @@ based on the tasking capabilities defined in - -
-
-
diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 851da258c..17cb38586 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2634,8 +2634,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number -TASK_CARGO_DISPATCHER.CountCSAR + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -2646,7 +2646,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-TASK_CARGO_DISPATCHER.DefaultDeployZones +TASK_CARGO_DISPATCHER.MaxCSAR @@ -3757,8 +3757,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -3769,7 +3769,7 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.DefaultDeployZones +TASK_CARGO_DISPATCHER.MaxCSAR @@ -4659,8 +4659,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4671,7 +4671,7 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.DefaultDeployZones +TASK_CARGO_DISPATCHER.MaxCSAR @@ -5942,8 +5942,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5954,7 +5954,7 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.DefaultDeployZones +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.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.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -12752,18 +12730,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of - -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -15731,18 +15698,7 @@ Coordinates are dependent on the position of the maps origin.

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

- -
-