From c601eac94df5d251c4c9983806622c844ae7a467 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Fri, 9 Nov 2018 05:54:24 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A.html | 44 ------ Documentation/AI.AI_Cargo.html | 20 +-- Documentation/AI.AI_Cargo_Airplane.html | 68 ++------ Documentation/Cargo.CargoGroup.html | 34 +++- Documentation/Cargo.CargoUnit.html | 44 +++--- Documentation/Core.Settings.html | 30 +++- Documentation/Core.Spawn.html | 78 ++++----- Documentation/Core.SpawnStatic.html | 30 +--- Documentation/Core.Spot.html | 132 ---------------- Documentation/Functional.Designate.html | 65 +++++++- Documentation/Functional.Detection.html | 6 +- Documentation/Functional.Rat.html | 45 +++++- Documentation/Functional.ZoneGoal.html | 42 ----- Documentation/Tasking.Task.html | 22 --- Documentation/Tasking.Task_Cargo.html | 13 +- .../Tasking.Task_Cargo_Dispatcher.html | 148 +++++++++++++++++- 16 files changed, 392 insertions(+), 429 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 64059b519..483bca1a5 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,9 +2165,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

-
@@ -4068,7 +4065,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -4106,9 +4103,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

-
@@ -4683,7 +4677,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -4721,9 +4715,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

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

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

Aircraft is on a pickup mission.

+
@@ -3662,20 +3651,6 @@ 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.

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

Aircraft is on a pickup mission.

+
@@ -4302,20 +4280,6 @@ 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.

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

Aircraft is on a pickup mission.

+
@@ -5580,20 +5547,6 @@ 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.

- -
- -
@@ -5660,6 +5613,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 a01bfefb8..e583250bc 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1431,9 +1431,6 @@ which are excellent tools to be reused in an OO environment!.

- -

Then we register the new group in the database

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

+
@@ -2749,9 +2760,6 @@ This works for ground only groups.

- -

Then we register the new group in the database

- @@ -2763,6 +2771,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..b3d466d88 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 @@ -1331,6 +1320,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles +
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
@@ -2017,17 +2017,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- - -
-
- - CARGO_UNIT.CargoInAir @@ -2043,6 +2032,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles +
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 54a5c07b9..fa9a2860d 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 @@ -2164,11 +2164,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -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 cf7e4ad97..4015a4300 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2214,12 +2214,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.livery_id

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

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

By default, no InitLimit

+

Overwrite unit names by default with group name.

@@ -2963,11 +2960,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string -SPAWN.SpawnInitSkill + #boolean +SPAWN.SpawnInitLimit + +

By default, no InitLimit

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

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

#boolean -SPAWN.SpawnInitLimit +SPAWN.SpawnInitKeepUnitNames -

By default, no InitLimit

+

Overwrite unit names by default with group name.

@@ -7553,11 +7556,14 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

By default, no InitLimit

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

+ + +
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -7788,17 +7805,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.livery_id - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 117f504cc..121a0b483 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1740,19 +1740,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -SPAWNSTATIC.CoalitionID - - - -
- -
-
-
- - -SPAWNSTATIC.CountryID + #number +SPAWNSTATIC.SpawnIndex @@ -2269,19 +2258,8 @@ 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/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 9f0efeb8f..15a7ced40 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2922,7 +2922,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + DESIGNATE.LaseDuration @@ -2938,6 +2938,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6046,7 +6057,7 @@ Designate:SetFlashStatusMenu( false )
- #number + DESIGNATE.LaseDuration @@ -6062,6 +6073,17 @@ Designate:SetFlashStatusMenu( false ) +
+ +
+
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6856,7 +6878,7 @@ Designate:SetFlashStatusMenu( false )
- #number + DESIGNATE.LaseDuration @@ -6872,6 +6894,17 @@ Designate:SetFlashStatusMenu( false ) +
+ +
+
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -7636,7 +7669,7 @@ Designate:SetFlashStatusMenu( false )
- #number + DESIGNATE.LaseDuration @@ -7652,6 +7685,17 @@ Designate:SetFlashStatusMenu( false ) +
+ +
+
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -9054,7 +9098,7 @@ Designate:SetFlashStatusMenu( false )
- #number + DESIGNATE.LaseDuration @@ -9070,6 +9114,17 @@ Designate:SetFlashStatusMenu( false ) +
+ +
+
+
+ + #table +DESIGNATE.LaserCodes + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 9312c6e46..dc195281d 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.Rat.html b/Documentation/Functional.Rat.html index 3df0fedc3..a4cab81af 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,12 +3783,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

RAT.livery_id

- - @@ -5928,6 +5928,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 + + +
@@ -13709,6 +13720,17 @@ Initializes the ratcraft array and group menu.

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

+
+ +
+
+
+ + +RAT.type + + +
@@ -18934,6 +18956,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.html b/Documentation/Tasking.Task.html index 0db5ade13..61a8eaaf4 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2380,17 +2380,6 @@ but can separately be modified later in your mission using the - - - -
-
- - -TASK.TaskControlMenu - - -
@@ -6903,17 +6892,6 @@ 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 21cbd84f3..14c06cd7c 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 a9e15d283..23dc242ec 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2591,7 +2591,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-TASK_CARGO_DISPATCHER.DefaultDeployZones +TASK_CARGO_DISPATCHER.CSARBriefing @@ -2602,7 +2602,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-TASK_CARGO_DISPATCHER.MaxCSAR +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.CSARTaskName + + + +
+ +
+
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -3670,7 +3703,7 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.DefaultDeployZones +TASK_CARGO_DISPATCHER.CSARBriefing @@ -3681,7 +3714,40 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.MaxCSAR +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.CSARTaskName + + + +
+ +
+
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4528,7 +4594,7 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.DefaultDeployZones +TASK_CARGO_DISPATCHER.CSARBriefing @@ -4539,7 +4605,40 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.MaxCSAR +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5767,7 +5866,7 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.DefaultDeployZones +TASK_CARGO_DISPATCHER.CSARBriefing @@ -5778,7 +5877,40 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.MaxCSAR +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+