From 4dc08473acc9664d81a9cbc98c5931756b0c5faa Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Tue, 15 Dec 2020 11:04:06 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_Air.html | 44 ++++ Documentation/AI.AI_Cargo.html | 8 +- Documentation/AI.AI_Cargo_Airplane.html | 12 + Documentation/AI.AI_Patrol.html | 12 + Documentation/Cargo.CargoCrate.html | 22 ++ Documentation/Cargo.CargoGroup.html | 62 +++++ Documentation/Cargo.CargoUnit.html | 22 ++ Documentation/Core.Fsm.html | 4 +- Documentation/Core.Point.html | 33 +++ Documentation/Core.Settings.html | 4 +- Documentation/Core.Spawn.html | 242 +++--------------- Documentation/Core.SpawnStatic.html | 84 ++++++ Documentation/Functional.Detection.html | 33 +++ Documentation/Functional.Rat.html | 63 +++-- Documentation/Ops.Airboss.html | 66 +++++ Documentation/Tasking.Task.html | 22 ++ Documentation/Tasking.Task_Cargo.html | 8 +- .../Tasking.Task_Cargo_Dispatcher.html | 44 ---- Documentation/Wrapper.Marker.html | 72 +----- Documentation/Wrapper.Positionable.html | 44 ---- 20 files changed, 498 insertions(+), 403 deletions(-) diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 07c5e40b6..b1d85c386 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -2773,6 +2773,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -5517,6 +5528,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -6242,6 +6264,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -7860,6 +7893,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_AIR.IdleCount + + +
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index d2d5dcabf..9efb23600 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2472,7 +2472,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -4509,7 +4509,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -5121,7 +5121,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -6626,7 +6626,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 4e8dbc7bf..e0661d9e5 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2467,6 +2467,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Set destination airbase for next :Route() command.

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

Set destination airbase for next :Route() command.

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

Set destination airbase for next :Route() command.

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

Set destination airbase for next :Route() command.

+
diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index b556c79ef..dfd8bd833 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -2975,6 +2975,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

+ @@ -8603,6 +8612,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 84d2cff16..d71b5f62e 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1629,6 +1629,17 @@ Controls a network of SAM sites.

Field(s)

+
+
+ + +CARGO_CRATE.CargoCarrier + + + +
+ +
@@ -2297,6 +2308,17 @@ Controls a network of SAM sites.

Field(s)

+
+
+ + +CARGO_CRATE.CargoCarrier + + + +
+ +
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 0d6814843..033262a83 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1700,10 +1700,27 @@ Controls a network of SAM sites.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

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

Then we register the new group in the database

+
@@ -1715,6 +1732,20 @@ Controls a network of SAM sites.

+
+ +
+
+
+ + +CARGO_GROUP.CargoObject + + + + +

Now we spawn the new group based on the template created.

+
@@ -3015,10 +3046,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

+
@@ -3030,6 +3078,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 90d2e10bd..128edd4d1 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1593,6 +1593,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles + + + +
+
+ + #number +CARGO_UNIT.RunCount + + +
@@ -2294,6 +2305,17 @@ 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 29b3062ed..e948ee123 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5368,7 +5368,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState @@ -6972,7 +6972,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index ad18fd5b8..6ff239ce1 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -14570,6 +14570,17 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

+
+ +
+
+
+ + +POINT_VEC2.z + + +
@@ -15368,6 +15379,17 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

+
+ +
+
+
+ + +POINT_VEC2.z + + +
@@ -22041,6 +22063,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 7206383fb..9bc105c4d 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2608,7 +2608,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SETTINGS.Metric @@ -4710,7 +4710,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 871f442be..5c0dd47c5 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2610,30 +2610,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.communication

- - - - - -

SPAWN.frequency

- - - - - -

SPAWN.skill

- - - - - -

SPAWN.uncontrolled

- - @@ -3224,6 +3200,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.

+
@@ -3301,17 +3280,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.SpawnGrouping - - -
@@ -3458,20 +3426,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.

-
@@ -3492,30 +3446,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -SPAWN.SpawnInitLivery - - - -
- -
-
-
- - -SPAWN.SpawnInitModex - - - -
- -
-
-
- - -SPAWN.SpawnInitModu + #string +SPAWN.SpawnInitSkill @@ -3710,6 +3642,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -3774,50 +3717,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.communication - - - -
- -
-
-
- - -SPAWN.frequency - - - -
- -
-
-
- - -SPAWN.skill - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
@@ -8637,6 +8536,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.

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

- - -
-
- - -SPAWN.SpawnGrouping - - -
@@ -8871,20 +8762,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.

-
@@ -8905,30 +8782,8 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -SPAWN.SpawnInitLivery - - - -
- - -
-
- - -SPAWN.SpawnInitModex - - - -
- -
-
-
- - -SPAWN.SpawnInitModu + #string +SPAWN.SpawnInitSkill @@ -9123,6 +8978,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -9187,50 +9053,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.communication - - - -
- -
-
-
- - -SPAWN.frequency - - - -
- -
-
-
- - -SPAWN.skill - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 1a56ed056..82d89609f 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1745,6 +1745,24 @@ such as position and heading.

SPAWNSTATIC:_SpawnStatic(Template, CountryID)

Spawns a new static using a given template.

+ + + +

SPAWNSTATIC.heliport_callsign_id

+ + + + + +

SPAWNSTATIC.heliport_frequency

+ + + + + +

SPAWNSTATIC.heliport_modulation

+ + @@ -2616,6 +2634,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
@@ -3837,6 +3888,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 163b6f969..9d831fdc1 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18250,6 +18250,17 @@ BASE:TraceOnOff( false ) + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -22952,6 +22963,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -24710,6 +24732,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index bf3204b0f..daee2dd9e 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3236,6 +3236,12 @@ manager:Stop(7200)

RAT.termtype

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

+ + + +

RAT.type

+ + @@ -4196,30 +4202,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

RAT.communication

- - - - - -

RAT.frequency

- - - - - -

RAT.skill

- - - - - -

RAT.uncontrolled

- - @@ -6507,6 +6489,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 + + +
@@ -14387,6 +14380,17 @@ Initializes the ratcraft array and group menu.

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

+ + + +
+
+ + +RAT.type + + +
@@ -20322,6 +20326,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/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 5d40ba4a3..320c52c52 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -8854,6 +8854,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

+ + + +
+
+ + +AIRBOSS.RQLid + + +
@@ -8865,6 +8876,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of marshal.

+ + + +
+
+ + +AIRBOSS.RQMid + + +
@@ -27772,6 +27794,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

+ + + +
+
+ + +AIRBOSS.RQLid + + +
@@ -27783,6 +27816,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

+ + + +
+
+ + +AIRBOSS.RQMid + + +
@@ -30696,6 +30740,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

+ + + +
+
+ + +AIRBOSS.RQLid + + +
@@ -30707,6 +30762,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

+ + + +
+
+ + +AIRBOSS.RQMid + + +
diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index aa930d7f6..36bcb212c 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2700,6 +2700,17 @@ but can separately be modified later in your mission using the + + + +
+
+ + +TASK.TaskControlMenu + + +
@@ -7336,6 +7347,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 ff50956cf..52860a0c0 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2993,7 +2993,7 @@ based on the tasking capabilities defined in
- + Cargo.Cargo#CARGO FSM_PROCESS.Cargo @@ -3041,7 +3041,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4463,7 +4463,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -8995,7 +8995,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 1129acbfd..c6b86e5fb 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2926,17 +2926,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
@@ -4016,17 +4005,6 @@ This method can only be used once!

Field(s)

-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
@@ -4885,17 +4863,6 @@ This method can only be used once!

Field(s)

-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
@@ -6390,17 +6357,6 @@ This method can only be used once!

Field(s)

-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 2a0987af8..f7de19e3b 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2737,28 +2737,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -2843,7 +2821,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall @@ -4843,28 +4821,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -4949,7 +4905,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall @@ -6458,28 +6414,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -6564,7 +6498,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index d7e1d8599..7e4b7416c 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3307,17 +3307,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
- @@ -6705,17 +6694,6 @@ Coordinates are dependent on the position of the maps origin.

-
- -
- @@ -7293,17 +7271,6 @@ If the Identifiable is alive, true is returned.

-
- -
- @@ -7487,17 +7454,6 @@ If the Identifiable is alive, true is returned.

-
- -
-
-
- - Core.Spot#SPOT -POSITIONABLE.Spot - - -