From cd26c32fa88be416a69e46bbd5480b5f4fc465b0 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Sat, 26 Jan 2019 22:37:36 +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 | 20 +- Documentation/AI.AI_Cargo_Airplane.html | 56 ----- Documentation/AI.AI_Patrol.html | 12 -- Documentation/Cargo.CargoCrate.html | 22 ++ Documentation/Cargo.CargoGroup.html | 28 +++ Documentation/Cargo.CargoUnit.html | 44 ++++ Documentation/Core.Fsm.html | 4 +- Documentation/Core.Settings.html | 34 ++- Documentation/Core.Spawn.html | 94 +------- Documentation/Core.SpawnStatic.html | 44 ++++ Documentation/Functional.Designate.html | 30 +-- Documentation/Functional.Movement.html | 28 --- Documentation/Functional.Rat.html | 12 -- Documentation/Functional.ZoneGoal.html | 42 ---- Documentation/Tasking.Task_Cargo.html | 11 - .../Tasking.Task_Cargo_Dispatcher.html | 200 ++++++++++++++++-- Documentation/Wrapper.Group.html | 78 ++++++- 19 files changed, 549 insertions(+), 298 deletions(-) diff --git a/Documentation/AI.AI_A2A.html b/Documentation/AI.AI_A2A.html index 24ed52a30..b4d3ff5b6 100644 --- a/Documentation/AI.AI_A2A.html +++ b/Documentation/AI.AI_A2A.html @@ -2391,6 +2391,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_A2A.IdleCount + + +
@@ -4959,6 +4970,17 @@ Once the time is finished, the old AI will return to the base.

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

+ + + +
+
+ + #number +AI_A2A.IdleCount + + +
@@ -6975,6 +7008,17 @@ 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..64059b519 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 @@ -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.

+
@@ -4065,7 +4068,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -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.

+
@@ -4677,7 +4683,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -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.

+
@@ -5927,7 +5936,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -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 bf4c59bf5..d3eca5987 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2114,17 +2114,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - -
- -
@@ -5657,9 +5604,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)

+
+
+ + +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 4034bfef8..d3ca4eade 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1459,6 +1459,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.

+
@@ -2791,6 +2805,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 c9d544d0c..0c67f699f 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1305,6 +1305,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ + +
+
+ + CARGO_UNIT.CargoInAir @@ -1320,6 +1331,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles +
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
@@ -2006,6 +2028,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ + +
+
+ + CARGO_UNIT.CargoInAir @@ -2021,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 e9678267e..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 @@ -6147,7 +6147,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index c029b2dab..346242ecd 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 ed8f6f8f7..bc75e1473 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2214,18 +2214,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.skill

- - - - - -

SPAWN.uncontrolled

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

-
@@ -2952,20 +2937,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnInitKeepUnitNames - - - - -

Overwrite unit names by default with group name.

-
@@ -3191,7 +3162,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.

@@ -3229,28 +3200,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 - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
@@ -7382,9 +7331,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.

-
@@ -7578,20 +7524,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-
- - #boolean -SPAWN.SpawnInitKeepUnitNames - - - - -

Overwrite unit names by default with group name.

-
@@ -7817,7 +7749,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.

@@ -7855,28 +7787,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 - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 121a0b483..bf51601a5 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1734,6 +1734,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.CoalitionID + + + +
+ +
+
+
+ + +SPAWNSTATIC.CountryID + + +
@@ -2252,6 +2274,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.CoalitionID + + + +
+ +
+
+
+ + +SPAWNSTATIC.CountryID + + +
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index aa22a08cf..2cf617288 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.LaseDuration +DESIGNATE.LaseStart @@ -2939,8 +2939,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -6097,7 +6097,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -6107,8 +6107,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -6907,7 +6907,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -6917,8 +6917,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -7687,7 +7687,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -7697,8 +7697,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -9105,7 +9105,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -9115,8 +9115,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes 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 b15006835..a4cab81af 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3783,18 +3783,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

RAT.skill

- - - - - -

RAT.uncontrolled

- - 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.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 14c06cd7c..25dfa2545 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2683,17 +2683,6 @@ based on the tasking capabilities defined in - -
- diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index b31c25d4a..2d7709a0d 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2590,8 +2590,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -2602,7 +2602,51 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-TASK_CARGO_DISPATCHER.MaxCSAR +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -3669,8 +3713,8 @@ This method can only be used once!

- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -3681,7 +3725,51 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.MaxCSAR +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4527,8 +4615,8 @@ This method can only be used once!

- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -4539,7 +4627,51 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.MaxCSAR +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5766,8 +5898,8 @@ This method can only be used once!

- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -5778,7 +5910,51 @@ This method can only be used once!

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