From 0f05254349dcd6723215b99e67013f47d6da09d2 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Wed, 14 Nov 2018 20:41:57 +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 | 34 +++++++ Documentation/Cargo.CargoUnit.html | 22 ----- Documentation/Core.Fsm.html | 26 ++++- Documentation/Core.Point.html | 39 -------- Documentation/Core.Settings.html | 12 +-- Documentation/Core.Spawn.html | 94 +++++++++++++------ Documentation/Core.SpawnStatic.html | 66 +++++++++++++ Documentation/Functional.Designate.html | 55 ----------- Documentation/Functional.Movement.html | 28 ------ Documentation/Functional.Rat.html | 51 ++++++++++ Documentation/Functional.ZoneGoal.html | 42 --------- Documentation/Tasking.Task_Cargo.html | 13 ++- .../Tasking.Task_Cargo_Dispatcher.html | 8 +- Documentation/Wrapper.Positionable.html | 44 --------- 19 files changed, 367 insertions(+), 309 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)

+
+
+ + #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..882aa1266 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)

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

Aircraft is on a pickup mission.

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

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + +
+ +
@@ -5625,9 +5660,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 ad6e190c2..c476f71b6 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -2636,6 +2636,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

This table contains the targets detected during patrol.

+
@@ -5883,6 +5886,9 @@ Note that this method is required, as triggers the next route when patrolling fo + +

This table contains the targets detected during patrol.

+
@@ -6627,6 +6633,9 @@ Note that this method is required, as triggers the next route when patrolling fo + +

This table contains the targets detected during patrol.

+
@@ -8009,6 +8018,9 @@ 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)

-
-
- - -CARGO_CRATE.CargoCarrier - - - -
- -
@@ -2035,17 +2024,6 @@ 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 10860c75b..dc181768b 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1431,6 +1431,9 @@ which are excellent tools to be reused in an OO environment!.

+ +

Then we register the new group in the database

+
@@ -1442,6 +1445,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.

+
@@ -2746,6 +2763,9 @@ This works for ground only groups.

+ +

Then we register the new group in the database

+
@@ -2757,6 +2777,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 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.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir @@ -2017,17 +2006,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir 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 15b9dce66..f135ce13d 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.

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

the y coordinate in meters.

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

the y coordinate in meters.

- - - -
-
- - -POINT_VEC2.z - - -
@@ -18473,17 +18445,6 @@ 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 3f21d29a5..b432910d2 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,7 +2164,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric @@ -3994,7 +3994,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem @@ -4005,7 +4005,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2GSystem @@ -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 4015a4300..f5ab44faf 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2214,6 +2214,18 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

SPAWN.livery_id

+ + + + + +

SPAWN.uncontrolled

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

-
@@ -2947,27 +2956,21 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -SPAWN.SpawnInitKeepUnitNames +SPAWN.SpawnInitLimit - -

Overwrite unit names by default with group name.

-
- #boolean -SPAWN.SpawnInitLimit + #string +SPAWN.SpawnInitSkill - -

By default, no InitLimit

-
@@ -2988,7 +2991,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3002,7 +3005,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3209,6 +3212,28 @@ 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.uncontrolled + + +
@@ -7340,9 +7365,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.

-
@@ -7543,27 +7565,21 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

#boolean -SPAWN.SpawnInitKeepUnitNames +SPAWN.SpawnInitLimit - -

Overwrite unit names by default with group name.

-
- #boolean -SPAWN.SpawnInitLimit + #string +SPAWN.SpawnInitSkill - -

By default, no InitLimit

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

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

- #number + SPAWN.SpawnMaxUnitsAlive @@ -7805,6 +7821,28 @@ 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.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/Functional.Designate.html b/Documentation/Functional.Designate.html index 2cf617288..35d02144e 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2933,17 +2933,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -6101,17 +6090,6 @@ Designate:SetFlashStatusMenu( false ) -
- - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -6911,17 +6889,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -7691,17 +7658,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -9109,17 +9065,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #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 df099abd9..8a4b16d43 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

+ + @@ -3777,6 +3783,18 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

RAT.livery_id

+ + + + + +

RAT.uncontrolled

+ + @@ -5922,6 +5940,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 + + +
@@ -13703,6 +13732,17 @@ Initializes the ratcraft array and group menu.

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

+
+ +
+
+
+ + +RAT.type + + +
@@ -18928,6 +18968,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 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 d209dd33d..9350dc897 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2678,11 +2678,22 @@ based on the tasking capabilities defined in
- + Cargo.Cargo#CARGO FSM_PROCESS.Cargo +
+ + +
+
+ + +FSM_PROCESS.DeployZone + + +
diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 5e4454239..fa4dbdf42 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2601,7 +2601,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -3680,7 +3680,7 @@ This method can only be used once!

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

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

- + #table TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 0a5f6b76b..5cd706425 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -2825,17 +2825,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
- @@ -5760,17 +5749,6 @@ Coordinates are dependent on the position of the maps origin.

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

-
- -
-
-
- - Core.Spot#SPOT -POSITIONABLE.Spot - - -
@@ -6471,17 +6438,6 @@ If the Identifiable is alive, true is returned.

-
- -
-
-
- - Core.Spot#SPOT -POSITIONABLE.Spot - - -