From 764ebee8337689deac1adfcffc50044f5040208c Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Wed, 26 Jun 2019 18:05:28 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A.html | 44 ------- Documentation/AI.AI_A2A_Dispatcher.html | 44 ------- Documentation/AI.AI_Cargo_Airplane.html | 44 ------- Documentation/Cargo.CargoGroup.html | 62 ++++++++++ Documentation/Cargo.CargoUnit.html | 22 ---- Documentation/Core.Fsm.html | 26 +++- Documentation/Core.Point.html | 39 +----- Documentation/Core.Settings.html | 26 +++- Documentation/Core.Spawn.html | 116 +++--------------- Documentation/Core.SpawnStatic.html | 66 ---------- Documentation/Functional.Designate.html | 30 ++--- Documentation/Functional.Detection.html | 6 +- Documentation/Functional.Movement.html | 28 ----- Documentation/Functional.Rat.html | 57 ++++++--- Documentation/Tasking.CommandCenter.html | 22 ++++ Documentation/Tasking.Task_Cargo.html | 11 ++ .../Tasking.Task_Cargo_Dispatcher.html | 44 +++++++ Documentation/Wrapper.Group.html | 78 +++++++++++- 18 files changed, 338 insertions(+), 427 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_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index 76760752f..3fb8d6e8e 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -3866,17 +3866,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - #number -AI_A2A_DISPATCHER.DefenderCAPIndex - - - -
- -
@@ -9088,17 +9077,6 @@ They will lock the parking spot.

Field(s)

-
-
- - #number -AI_A2A_DISPATCHER.DefenderCAPIndex - - - -
- -
@@ -10105,17 +10083,6 @@ They will lock the parking spot.

Field(s)

-
-
- - #number -AI_A2A_DISPATCHER.DefenderCAPIndex - - - -
- -
@@ -11408,17 +11375,6 @@ They will lock the parking spot.

Field(s)

-
-
- - #number -AI_A2A_DISPATCHER.DefenderCAPIndex - - - -
- -
diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index bf4c59bf5..f1734a8f1 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 - - - -
- -
@@ -3662,17 +3651,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

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

Field(s)

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

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - -
- -
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 10860c75b..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

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

+
@@ -2742,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

+
@@ -2757,6 +2805,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..9053b3d08 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1331,17 +1331,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles -
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2054,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 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 51b4db22e..ac116b9bf 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,17 +12281,6 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

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

the y coordinate in meters.

- - - -
-
- - -POINT_VEC2.z - - -
@@ -18467,17 +18451,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 684bd7d9f..fa9a2860d 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2164,11 +2164,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -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 42f50bd59..86ab0b176 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2214,24 +2214,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.livery_id

- - - - - -

SPAWN.skill

- - - - - -

SPAWN.uncontrolled

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

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

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

By default, no InitLimit

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

@@ -3224,39 +3206,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 - - - -
- -
-
-
- - -SPAWN.skill - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
@@ -7388,6 +7337,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.

+ @@ -7588,12 +7540,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

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

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

By default, no InitLimit

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

@@ -7850,39 +7799,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 - - - -
- -
-
-
- - -SPAWN.skill - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index bf51601a5..88821384b 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1734,39 +1734,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWNSTATIC.CoalitionID - - - -
- -
-
-
- - -SPAWNSTATIC.CountryID - - - -
- -
-
-
- - #number -SPAWNSTATIC.SpawnIndex - - -
@@ -2274,39 +2241,6 @@ 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 aa22a08cf..2cf617288 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2929,7 +2929,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -2939,8 +2939,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -6097,7 +6097,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -6107,8 +6107,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -6907,7 +6907,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -6917,8 +6917,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -7687,7 +7687,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -7697,8 +7697,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -9105,7 +9105,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -9115,8 +9115,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index b34c849d8..667211c28 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -16471,7 +16471,7 @@ BASE:TraceOnOff( false )
- + #number DETECTION_BASE.RefreshTimeInterval @@ -20803,7 +20803,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval @@ -22306,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.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 8176c0005..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,24 +3783,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

RAT.livery_id

- - - - - -

RAT.skill

- - - - - -

RAT.uncontrolled

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

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

+
+ +
+
+
+ + +RAT.type + + +
@@ -18946,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/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 54a43fd80..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 + +
+ diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index f7b4bfe0f..2dad315eb 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2634,7 +2634,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -3757,7 +3768,18 @@ This method can only be used once!

+ #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4659,7 +4681,18 @@ This method can only be used once!

+ #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5942,7 +5975,18 @@ This method can only be used once!

+ #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones 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 + + + +
+ +
+