From b3656bf5d1e653989f28450f42ee5ced3f35370e Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Tue, 7 May 2019 20:16:56 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A.html | 44 --------- Documentation/AI.AI_Cargo.html | 12 +++ Documentation/AI.AI_Cargo_Airplane.html | 80 ++++++++++++++--- Documentation/Cargo.CargoGroup.html | 62 ++----------- Documentation/Cargo.CargoUnit.html | 22 ----- Documentation/Core.Fsm.html | 26 +++++- Documentation/Core.Settings.html | 26 +++++- Documentation/Core.Spawn.html | 90 ++++++++++++------- Documentation/Functional.Designate.html | 55 ------------ Documentation/Functional.Rat.html | 45 ++++++++++ Documentation/Functional.ZoneGoal.html | 42 +++++++++ Documentation/Tasking.Task_Cargo.html | 17 +--- .../Tasking.Task_Cargo_Dispatcher.html | 32 +++---- 13 files changed, 296 insertions(+), 257 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_Cargo.html b/Documentation/AI.AI_Cargo.html index 1e105b17a..64059b519 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -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.

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

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

+ @@ -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 f1734a8f1..06ee0479d 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,6 +2169,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

- @@ -3651,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.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

- @@ -4280,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.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

- @@ -5547,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.

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

Aircraft is on a depoly mission.

+
@@ -5613,9 +5672,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/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index aa7cce832..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

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

-
@@ -2770,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

+
@@ -2799,20 +2763,6 @@ 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.Settings.html b/Documentation/Core.Settings.html index 54a5c07b9..8bea7b798 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2131,7 +2131,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2GSystem @@ -2169,6 +2169,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -4005,7 +4016,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2GSystem @@ -4043,6 +4054,17 @@ It is advised to use this method at the start of the mission.

+
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 4015a4300..5e0589dde 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2214,6 +2214,12 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

SPAWN.uncontrolled

+ + @@ -2947,12 +2953,12 @@ 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.

+

By default, no InitLimit

@@ -2960,13 +2966,21 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean -SPAWN.SpawnInitLimit + +SPAWN.SpawnInitLivery +
+ +
+
+
+ + #string +SPAWN.SpawnInitSkill -

By default, no InitLimit

+
@@ -3148,17 +3162,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -3171,7 +3174,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.

@@ -3209,6 +3212,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.uncontrolled + + +
@@ -7543,12 +7557,12 @@ 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.

+

By default, no InitLimit

@@ -7556,13 +7570,21 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

By default, no InitLimit

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

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

@@ -7805,6 +7816,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.uncontrolled + + +
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index d00ce2c67..aa22a08cf 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2944,17 +2944,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -6123,17 +6112,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -6944,17 +6922,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -7735,17 +7702,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -9164,17 +9120,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index df099abd9..e0398b03c 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,12 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

RAT.uncontrolled

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

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

+ + + +
+
+ + +RAT.type + + +
@@ -18928,6 +18962,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_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 14c06cd7c..54a43fd80 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 - - -
@@ -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 17cb38586..2d7709a0d 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2634,8 +2634,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -2645,8 +2645,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -TASK_CARGO_DISPATCHER.MaxCSAR + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -3757,8 +3757,8 @@ This method can only be used once!

- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -3768,8 +3768,8 @@ This method can only be used once!

- -TASK_CARGO_DISPATCHER.MaxCSAR + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4659,8 +4659,8 @@ This method can only be used once!

- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -4670,8 +4670,8 @@ This method can only be used once!

- -TASK_CARGO_DISPATCHER.MaxCSAR + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5942,8 +5942,8 @@ This method can only be used once!

- #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + #number +TASK_CARGO_DISPATCHER.CountCSAR @@ -5953,8 +5953,8 @@ This method can only be used once!