From 660f04511bbc4b292acff8397c25243aa2e010ad Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Sat, 6 Jul 2019 18:39:24 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A.html | 44 ++++ Documentation/AI.AI_Cargo.html | 8 +- Documentation/AI.AI_Cargo_Airplane.html | 24 +- Documentation/AI.AI_Patrol.html | 12 - Documentation/Cargo.CargoGroup.html | 34 ++- Documentation/Cargo.CargoUnit.html | 22 -- Documentation/Core.Point.html | 33 +++ Documentation/Core.Settings.html | 30 ++- Documentation/Core.Spawn.html | 80 +++---- Documentation/Core.SpawnStatic.html | 44 ++++ Documentation/Functional.Designate.html | 55 +++++ Documentation/Functional.Detection.html | 72 +++++- Documentation/Functional.Rat.html | 45 ++++ Documentation/Functional.ZoneGoal.html | 42 ++++ Documentation/Tasking.CommandCenter.html | 22 ++ Documentation/Tasking.Task_Cargo.html | 17 +- .../Tasking.Task_Cargo_Dispatcher.html | 220 ++++++++++++++++++ 17 files changed, 692 insertions(+), 112 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_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 06ee0479d..abec83831 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2169,9 +2169,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Aircraft is on a depoly mission.

- @@ -5672,6 +5669,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/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.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 0c67f699f..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 @@ -2028,17 +2017,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.Point.html b/Documentation/Core.Point.html index f135ce13d..51b4db22e 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -12275,6 +12275,17 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

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

the y coordinate in meters.

+
+ + +
+
+ + +POINT_VEC2.z + + +
@@ -18445,6 +18467,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.Settings.html b/Documentation/Core.Settings.html index 3f21d29a5..8bea7b798 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 @@ -2169,6 +2169,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -3994,7 +4005,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem @@ -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 babb49e9d..1c8282249 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.skill

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

-
@@ -2940,20 +2943,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnInitKeepUnitNames - - - - -

Overwrite unit names by default with group name.

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

By default, no InitLimit

- @@ -3010,7 +2996,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3024,7 +3010,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3182,7 +3168,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.

@@ -3220,6 +3206,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.skill + + +
@@ -7351,9 +7348,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.

-
@@ -7547,20 +7541,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - #boolean -SPAWN.SpawnInitKeepUnitNames - - - - -

Overwrite unit names by default with group name.

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

By default, no InitLimit

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

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

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

@@ -7827,6 +7804,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.skill + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 121a0b483..bf51601a5 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1734,6 +1734,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.CoalitionID + + + +
+ +
+
+
+ + +SPAWNSTATIC.CountryID + + +
@@ -2252,6 +2274,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.CoalitionID + + + +
+ +
+
+
+ + +SPAWNSTATIC.CountryID + + +
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index aa22a08cf..d00ce2c67 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2944,6 +2944,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6112,6 +6123,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6922,6 +6944,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -7702,6 +7735,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -9120,6 +9164,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index dc195281d..667211c28 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -16311,6 +16311,28 @@ BASE:TraceOnOff( false ) + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -16449,7 +16471,7 @@ BASE:TraceOnOff( false )
- + #number DETECTION_BASE.RefreshTimeInterval @@ -20621,6 +20643,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -20759,7 +20803,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval @@ -22102,6 +22146,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -22240,7 +22306,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 df099abd9..0548d1d0f 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.skill

+ + @@ -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.CommandCenter.html b/Documentation/Tasking.CommandCenter.html index 4eb198c15..3a2899feb 100644 --- a/Documentation/Tasking.CommandCenter.html +++ b/Documentation/Tasking.CommandCenter.html @@ -1963,6 +1963,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + #boolean +COMMANDCENTER.AutoAssignTasks + + + +
+ +
@@ -3109,6 +3120,17 @@ CC:SetReferenceZones( "Station" )

Field(s)

+
+
+ + #boolean +COMMANDCENTER.AutoAssignTasks + + + +
+ +
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 25dfa2545..9350dc897 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2683,6 +2683,17 @@ based on the tasking capabilities defined in + +
+
+
+ + +FSM_PROCESS.DeployZone + + +
@@ -2715,7 +2726,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4091,7 +4102,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -8510,7 +8521,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 a9e15d283..2dad315eb 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2591,6 +2591,61 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+TASK_CARGO_DISPATCHER.CSARBriefing + + + +
+ +
+ + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -3670,6 +3725,61 @@ This method can only be used once!

+TASK_CARGO_DISPATCHER.CSARBriefing + + + +
+ +
+ + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4528,6 +4638,61 @@ This method can only be used once!

+TASK_CARGO_DISPATCHER.CSARBriefing + + + +
+ +
+ + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5767,6 +5932,61 @@ This method can only be used once!

+TASK_CARGO_DISPATCHER.CSARBriefing + + + +
+ +
+ + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
+