From 61bf5f914e687f9787b9b1deefa41669f53d11c5 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Thu, 7 Mar 2019 13:11:49 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A_Dispatcher.html | 44 +++++ Documentation/AI.AI_Cargo.html | 20 +- Documentation/AI.AI_Cargo_Airplane.html | 44 +++++ Documentation/AI.AI_Patrol.html | 12 -- Documentation/Cargo.CargoGroup.html | 62 ++++++ Documentation/Core.Fsm.html | 22 +++ Documentation/Core.Point.html | 33 ---- Documentation/Core.Settings.html | 8 +- Documentation/Core.Spawn.html | 126 ++++++------- Documentation/Core.SpawnStatic.html | 22 +++ Documentation/Functional.Designate.html | 110 +++++++++++ Documentation/Functional.Detection.html | 39 +++- Documentation/Functional.Movement.html | 28 +++ Documentation/Functional.Rat.html | 51 +++++ Documentation/Functional.ZoneGoal.html | 42 ----- Documentation/Tasking.Task.html | 22 +++ Documentation/Tasking.Task_Cargo.html | 8 +- .../Tasking.Task_Cargo_Dispatcher.html | 176 ++++++++++++++++++ Documentation/Wrapper.Positionable.html | 44 +++++ 19 files changed, 745 insertions(+), 168 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..64059b519 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,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.

+
@@ -4065,7 +4068,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -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.

+
@@ -4677,7 +4683,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -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.

+
@@ -5927,7 +5936,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -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..bf4c59bf5 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 + + + +
+ +
@@ -3651,6 +3662,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

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

Field(s)

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + +
+ +
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 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/Core.Fsm.html b/Documentation/Core.Fsm.html index 5c2852433..e9678267e 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -4836,6 +4836,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +FSM.current + + +
@@ -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..f135ce13d 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -12275,17 +12275,6 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

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

the y coordinate in meters.

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

- #string + SETTINGS.A2GSystem @@ -4049,7 +4049,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 7e56af583..6bfe7b88f 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.skill

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

-
@@ -2940,20 +2949,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 +2960,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

By default, no InitLimit

-
@@ -2999,7 +2991,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3013,7 +3005,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3159,17 +3151,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -3220,6 +3201,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.skill + + +
@@ -7351,9 +7354,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 +7547,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 +7558,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

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

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

- #number + SPAWN.SpawnMaxUnitsAlive @@ -7766,17 +7749,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -7827,6 +7799,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.skill + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 117f504cc..bf51601a5 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1756,6 +1756,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +SPAWNSTATIC.SpawnIndex + + +
@@ -2285,6 +2296,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +SPAWNSTATIC.SpawnIndex + + +
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 35d02144e..d00ce2c67 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2922,6 +2922,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -2933,6 +2944,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6079,6 +6101,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -6090,6 +6123,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6878,6 +6922,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -6889,6 +6944,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -7647,6 +7713,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -7658,6 +7735,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -9054,6 +9142,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -9065,6 +9164,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 9312c6e46..563fcf108 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -16311,6 +16311,17 @@ BASE:TraceOnOff( false ) + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -16449,7 +16460,7 @@ BASE:TraceOnOff( false )
- #number + DETECTION_BASE.RefreshTimeInterval @@ -20621,6 +20632,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -20759,7 +20781,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #number + DETECTION_BASE.RefreshTimeInterval @@ -22102,6 +22124,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -22240,7 +22273,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 98ff88773..7aef91696 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -1653,6 +1653,20 @@ 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

+ +
+ +
@@ -1883,6 +1897,20 @@ 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..71284385d 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.skill

+ + @@ -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.html b/Documentation/Tasking.Task.html index 61a8eaaf4..0db5ade13 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2380,6 +2380,17 @@ but can separately be modified later in your mission using the + + + +
+
+ + +TASK.TaskControlMenu + + +
@@ -6892,6 +6903,17 @@ 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 9350dc897..3c598c08e 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2678,7 +2678,7 @@ based on the tasking capabilities defined in
- Cargo.Cargo#CARGO + FSM_PROCESS.Cargo @@ -2726,7 +2726,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -4102,7 +4102,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -8521,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 65e75dc18..2dad315eb 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2587,6 +2587,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -3677,6 +3721,50 @@ This method can only be used once!

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -4546,6 +4634,50 @@ This method can only be used once!

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -5796,6 +5928,50 @@ This method can only be used once!

Field(s)

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

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

+
+ +
+ @@ -6438,6 +6471,17 @@ If the Identifiable is alive, true is returned.

+
+ +
+