From 11c0fe8191bb271845b8b36c5e39b296eb1b0489 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Tue, 11 Feb 2020 15:22:17 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_Cargo_Airplane.html | 56 ++------ Documentation/Cargo.CargoGroup.html | 34 +++++ Documentation/Cargo.CargoUnit.html | 44 +++--- Documentation/Core.Fsm.html | 26 +--- Documentation/Core.Point.html | 39 ++++++ Documentation/Core.Spawn.html | 118 ++++++++++++++-- Documentation/Core.SpawnStatic.html | 44 ------ Documentation/Core.Spot.html | 132 ------------------ Documentation/Functional.Designate.html | 55 ++++++++ Documentation/Functional.Movement.html | 28 ++++ Documentation/Functional.Rat.html | 45 ++++++ Documentation/Functional.ZoneGoal.html | 42 ++++++ 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 ++++++ 17 files changed, 571 insertions(+), 299 deletions(-) diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 882aa1266..dac20058e 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 - - - -
- -
@@ -2194,6 +2183,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a pickup mission.

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

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - -
- -
@@ -5660,6 +5625,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/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index e583250bc..d3ca4eade 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1427,10 +1427,27 @@ 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,10 +2773,27 @@ 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 b3d466d88..9053b3d08 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,17 +1331,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles -
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2017,6 +2017,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ + +
+
+ + CARGO_UNIT.CargoInAir @@ -2032,17 +2043,6 @@ 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 8fa4351b6..5c2852433 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,17 +4836,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -FSM.current - - -
@@ -6147,7 +6136,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -6163,17 +6152,6 @@ 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..15b9dce66 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -4154,6 +4154,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Coordinates.

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

Coordinates.

+ @@ -12275,6 +12281,17 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

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

the y coordinate in meters.

+ + + +
+
+ + +POINT_VEC2.z + + +
@@ -18445,6 +18473,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.Spawn.html b/Documentation/Core.Spawn.html index 62d1194da..1aabcc712 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2226,6 +2226,12 @@ and any spaces before and after the resulting name are removed.

SPAWN.skill

+ + + +

SPAWN.uncontrolled

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

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

By default, no InitLimit

+ + + + +
+
+ + +SPAWN.SpawnInitLivery + + + +
+ +
+
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -2997,7 +3025,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxGroups @@ -3011,7 +3039,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxUnitsAlive @@ -3157,6 +3185,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -3169,7 +3208,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,6 +3268,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + +SPAWN.uncontrolled + + +
@@ -7360,9 +7410,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.

- @@ -7581,6 +7628,31 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

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

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

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

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

@@ -7833,6 +7916,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 117f504cc..88821384b 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1734,28 +1734,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWNSTATIC.CoalitionID - - - -
- -
-
-
- - -SPAWNSTATIC.CountryID - - -
@@ -2263,28 +2241,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWNSTATIC.CoalitionID - - - -
- -
-
-
- - -SPAWNSTATIC.CountryID - - -
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.Designate.html b/Documentation/Functional.Designate.html index 35d02144e..2cf617288 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2933,6 +2933,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6090,6 +6101,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6889,6 +6911,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -7658,6 +7691,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -9065,6 +9109,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
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 406cad1b4..a31aae459 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -2939,6 +2939,12 @@ manager:Stop(7200)

RAT.termtype

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

+ + + +

RAT.type

+ + @@ -3789,6 +3795,12 @@ and any spaces before and after the resulting name are removed.

RAT.skill

+ + + +

RAT.uncontrolled

+ + @@ -5934,6 +5946,17 @@ 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 + + +
@@ -13715,6 +13738,17 @@ Initializes the ratcraft array and group menu.

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

+
+ +
+
+
+ + +RAT.type + + +
@@ -18940,6 +18974,17 @@ 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.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 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 -
- - -
-
- - -FSM_PROCESS.DeployZone - - -
@@ -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 b31c25d4a..65e75dc18 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 + + + +
+ +
@@ -3666,6 +3677,17 @@ This method can only be used once!

Field(s)

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

Field(s)

+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
@@ -5763,6 +5796,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.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 + + + +
+ +
+
+
+ + +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.

+
+ +
+