From e5070dfaa9fd1861121ccee65825924ba563d4ff Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Mon, 4 Feb 2019 22:38:28 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_Cargo.html | 12 +++ Documentation/AI.AI_Cargo_Airplane.html | 24 ++--- Documentation/AI.AI_Patrol.html | 12 +++ Documentation/Cargo.CargoCrate.html | 22 ++++ Documentation/Cargo.CargoGroup.html | 62 +++++------ Documentation/Core.Fsm.html | 26 ++++- Documentation/Core.Point.html | 33 ++++++ Documentation/Core.Settings.html | 34 ++++-- Documentation/Core.Spawn.html | 134 ++++-------------------- Documentation/Core.SpawnStatic.html | 22 ---- Documentation/Core.Spot.html | 132 +++++++++++++++++++++++ Documentation/Functional.Designate.html | 55 ++++++++++ Documentation/Functional.Rat.html | 18 ---- Documentation/Functional.ZoneGoal.html | 42 ++++++++ Documentation/Tasking.Task_Cargo.html | 2 +- 15 files changed, 423 insertions(+), 207 deletions(-) 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 bf4c59bf5..11237e681 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2122,6 +2122,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

+ @@ -5657,9 +5660,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/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index ad6e190c2..c476f71b6 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -2636,6 +2636,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

This table contains the targets detected during patrol.

+ @@ -5883,6 +5886,9 @@ Note that this method is required, as triggers the next route when patrolling fo + +

This table contains the targets detected during patrol.

+ @@ -6627,6 +6633,9 @@ Note that this method is required, as triggers the next route when patrolling fo + +

This table contains the targets detected during patrol.

+ @@ -8009,6 +8018,9 @@ 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.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index 516c24590..a28641796 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1356,6 +1356,17 @@ which are excellent tools to be reused in an OO environment!.

Field(s)

+
+
+ + +CARGO_CRATE.CargoCarrier + + + +
+ +
@@ -2024,6 +2035,17 @@ which are excellent tools to be reused in an OO environment!.

Field(s)

+
+
+ + +CARGO_CRATE.CargoCarrier + + + +
+ +
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index dc181768b..d262f77d7 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1427,13 +1427,24 @@ 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

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

-
@@ -2759,13 +2756,24 @@ This works for ground only groups.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

+ +
+ +
+
+
+ + CARGO_GROUP.CargoGroup - -

Then we register the new group in the database

-
@@ -2777,20 +2785,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/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 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 54a5c07b9..3aad862c9 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 @@ -2164,11 +2164,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric +
+ +
+
+
+ + +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 @@ -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 8ddb12f75..bc75e1473 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

- - @@ -2966,8 +2948,16 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ -

By default, no InitLimit

+SPAWN.SpawnInitLivery + +
@@ -3000,7 +2990,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3014,7 +3004,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3160,17 +3150,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -3221,39 +3200,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 - - -
@@ -7589,8 +7535,16 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ -

By default, no InitLimit

+SPAWN.SpawnInitLivery + +
@@ -7623,7 +7577,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -7844,39 +7787,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..117f504cc 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1756,17 +1756,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #number -SPAWNSTATIC.SpawnIndex - - -
@@ -2296,17 +2285,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #number -SPAWNSTATIC.SpawnIndex - - -
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index f5e56447c..e72eb76e2 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2139,6 +2139,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + + +
+ +
+
+
+ + +SPOT.Target + + +
@@ -3070,6 +3114,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + + +
+ +
+
+
+ + +SPOT.Target + + +
@@ -4309,6 +4397,50 @@ 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 2cf617288..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 + + +
@@ -6090,6 +6101,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -6900,6 +6922,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -7680,6 +7713,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -9098,6 +9142,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index 8176c0005..df099abd9 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3777,24 +3777,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

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