From 4d231bb0ecb1003c41df251b1944a9cbcd303b14 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Sun, 11 Aug 2019 09:09:06 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A.html | 44 ---- Documentation/AI.AI_A2A_Dispatcher.html | 44 ++++ Documentation/AI.AI_Cargo.html | 8 +- Documentation/AI.AI_Cargo_Airplane.html | 68 +++++- Documentation/AI.AI_Patrol.html | 12 - Documentation/Cargo.CargoCrate.html | 22 ++ Documentation/Cargo.CargoGroup.html | 34 +-- Documentation/Core.Fsm.html | 26 +- Documentation/Core.Settings.html | 4 +- Documentation/Core.Spawn.html | 148 +++++++++--- Documentation/Core.SpawnStatic.html | 66 +++++ Documentation/Core.Spot.html | 132 ---------- Documentation/Functional.Detection.html | 33 --- Documentation/Functional.Movement.html | 28 --- Documentation/Functional.Rat.html | 18 ++ Documentation/Tasking.Task.html | 22 ++ Documentation/Tasking.Task_Cargo.html | 11 - .../Tasking.Task_Cargo_Dispatcher.html | 228 +++++++++++++++++- Documentation/Wrapper.Group.html | 78 +----- Documentation/Wrapper.Positionable.html | 44 ++++ 20 files changed, 654 insertions(+), 416 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_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)

+
+
+ + #number +AI_A2A_DISPATCHER.DefenderCAPIndex + + + +
+ +
@@ -9077,6 +9088,17 @@ They will lock the parking spot.

Field(s)

+
+
+ + #number +AI_A2A_DISPATCHER.DefenderCAPIndex + + + +
+ +
@@ -10083,6 +10105,17 @@ They will lock the parking spot.

Field(s)

+
+
+ + #number +AI_A2A_DISPATCHER.DefenderCAPIndex + + + +
+ +
@@ -11375,6 +11408,17 @@ They will lock the parking spot.

Field(s)

+
+
+ + #number +AI_A2A_DISPATCHER.DefenderCAPIndex + + + +
+ +
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 dac20058e..abec83831 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2114,6 +2114,20 @@ 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.

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

Aircraft is on a depoly mission.

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

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

Aircraft is on a depoly mission.

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

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

Aircraft is on a depoly mission.

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

+ +
+ +
@@ -5597,9 +5644,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 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..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

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

+
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 b432910d2..684bd7d9f 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 @@ -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 a96806dca..06071bbaf 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

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

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

By default, no InitLimit

+
@@ -2962,6 +2980,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -2982,7 +3011,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxGroups @@ -2996,7 +3025,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxUnitsAlive @@ -3142,17 +3171,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -3203,6 +3221,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 + + +
@@ -7334,9 +7385,6 @@ 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.

-
@@ -7541,6 +7589,9 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

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

+ +
+
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -7572,7 +7634,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -7793,6 +7844,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.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/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 563fcf108..dc195281d 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.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..a31aae459 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3783,6 +3783,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 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 04537fe93..d209dd33d 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 - - -
diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index b31c25d4a..e863c7ca0 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2590,7 +2590,62 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + +TASK_CARGO_DISPATCHER.CSARBriefing + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.CSARTaskName + + + +
+ +
+
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -3669,7 +3724,62 @@ This method can only be used once!

- #table + +TASK_CARGO_DISPATCHER.CSARBriefing + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.CSARTaskName + + + +
+ +
+
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4527,7 +4637,62 @@ This method can only be used once!

- #table + +TASK_CARGO_DISPATCHER.CSARBriefing + + + +
+ +
+ + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5766,7 +5931,62 @@ This method can only be used once!

- #table + +TASK_CARGO_DISPATCHER.CSARBriefing + + + +
+ +
+ + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + TASK_CARGO_DISPATCHER.DefaultDeployZones 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.

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

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

+
+ +
+