From 82b1ced46f477e3b1534b6e62f94e18cb436acca Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Wed, 11 Dec 2019 20:24:57 +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 | 36 --------- Documentation/AI.AI_Patrol.html | 12 --- Documentation/Cargo.CargoCrate.html | 22 ----- Documentation/Cargo.CargoGroup.html | 34 -------- Documentation/Cargo.CargoUnit.html | 22 ----- Documentation/Core.Point.html | 6 -- Documentation/Core.Settings.html | 4 +- Documentation/Core.Spawn.html | 80 ++++++++++++++++--- Documentation/Core.SpawnStatic.html | 66 +++++++++++++++ Documentation/Functional.Designate.html | 55 ------------- Documentation/Functional.Detection.html | 6 +- Documentation/Functional.Movement.html | 28 +++++++ Documentation/Functional.Rat.html | 51 +++--------- Documentation/Functional.ZoneGoal.html | 42 ++++++++++ Documentation/Tasking.CommandCenter.html | 22 ----- Documentation/Tasking.Task.html | 22 +++++ Documentation/Tasking.Task_Cargo.html | 19 +---- .../Tasking.Task_Cargo_Dispatcher.html | 44 ++++++++++ Documentation/Wrapper.Group.html | 78 ++++++++++++++++-- Documentation/Wrapper.Positionable.html | 44 ++++++++++ 23 files changed, 511 insertions(+), 290 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)

+
+ + +
@@ -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 1e105b17a..29967c911 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 b5cbe1232..c3c2603a3 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.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

- @@ -5681,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 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)

-
- - -
@@ -2035,17 +2024,6 @@ 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 d3ca4eade..e583250bc 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1427,27 +1427,10 @@ 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

-
@@ -2773,27 +2756,10 @@ 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/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 9053b3d08..c9d544d0c 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1305,17 +1305,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles - -
-
-
- - CARGO_UNIT.CargoInAir @@ -2017,17 +2006,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles - -
-
-
- - CARGO_UNIT.CargoInAir diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 15b9dce66..51b4db22e 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -4154,9 +4154,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Coordinates.

-
@@ -9595,9 +9592,6 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t - -

Coordinates.

-
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 8c50790f3..a32b84f71 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2214,12 +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

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

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

By default, no InitLimit

+
@@ -2999,7 +3011,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxGroups @@ -3013,7 +3025,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxUnitsAlive @@ -3171,7 +3183,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.

@@ -3209,6 +3221,17 @@ 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 + + +
@@ -3220,6 +3243,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + +SPAWN.uncontrolled + + +
@@ -7351,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.

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

By default, no InitLimit

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

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

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

@@ -7810,6 +7844,17 @@ 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 + + +
@@ -7821,6 +7866,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +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.CountryID + + + +
+ +
+
+
+ + #number +SPAWNSTATIC.SpawnIndex + + +
@@ -2241,6 +2274,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+ + +
+
+
+ + +SPAWNSTATIC.CountryID + + + +
+ +
+
+
+ + #number +SPAWNSTATIC.SpawnIndex + + +
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index aa22a08cf..35d02144e 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2922,17 +2922,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
@@ -6090,17 +6079,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
@@ -6900,17 +6878,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
@@ -7680,17 +7647,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
@@ -9098,17 +9054,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index dc195281d..9312c6e46 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -16449,7 +16449,7 @@ BASE:TraceOnOff( false )
- + #number DETECTION_BASE.RefreshTimeInterval @@ -20759,7 +20759,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval @@ -22240,7 +22240,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval 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.Rat.html b/Documentation/Functional.Rat.html index 0548d1d0f..8176c0005 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -2939,12 +2939,6 @@ manager:Stop(7200)

RAT.termtype

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

- - - -

RAT.type

- - @@ -3783,12 +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

+ + @@ -5934,17 +5940,6 @@ 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 - - -
@@ -13726,17 +13721,6 @@ Initializes the ratcraft array and group menu.

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

-
- -
-
-
- - -RAT.type - - -
@@ -18962,17 +18946,6 @@ 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/Functional.ZoneGoal.html b/Documentation/Functional.ZoneGoal.html index 5d593eaa5..725deec17 100644 --- a/Documentation/Functional.ZoneGoal.html +++ b/Documentation/Functional.ZoneGoal.html @@ -1956,6 +1956,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +ZONE_GOAL.SmokeTime + + + + +

self.SmokeColor = nil

+
@@ -2085,6 +2099,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +ZONE_GOAL.SmokeTime + + + + +

self.SmokeColor = nil

+
@@ -3324,6 +3352,20 @@ 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 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 +
+ +
+
+
@@ -6892,6 +6903,17 @@ 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..21cbd84f3 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2678,22 +2678,11 @@ based on the tasking capabilities defined in
- Cargo.Cargo#CARGO + FSM_PROCESS.Cargo -
- - -
-
@@ -2726,7 +2715,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -4102,7 +4091,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -8521,7 +8510,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 705e51133..5e4454239 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2587,6 +2587,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
@@ -3655,6 +3666,17 @@ This method can only be used once!

Field(s)

+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
@@ -4502,6 +4524,17 @@ This method can only be used once!

Field(s)

+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
@@ -5730,6 +5763,17 @@ This method can only be used once!

Field(s)

+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
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.InitRespawnRandomizePositionOuter @@ -6944,7 +6955,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu + +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -12730,7 +12752,18 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of + +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -15698,7 +15731,18 @@ Coordinates are dependent on the position of the maps origin.

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

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

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

+
+ +
+