From bc9374a86a7fa9364d94c7be65ff30063d19c080 Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Sat, 1 May 2021 15:36:52 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2G_Dispatcher.html | 44 ++++++ Documentation/AI.AI_Air.html | 44 ------ Documentation/AI.AI_Cargo.html | 20 +-- Documentation/AI.AI_Cargo_Airplane.html | 12 -- Documentation/Cargo.CargoCrate.html | 22 +++ Documentation/Cargo.CargoGroup.html | 34 ++++ Documentation/Cargo.CargoUnit.html | 44 +++--- Documentation/Core.Settings.html | 4 +- Documentation/Core.Spawn.html | 146 +++++++----------- Documentation/Functional.Designate.html | 55 +++++++ Documentation/Functional.Detection.html | 66 ++++---- Documentation/Functional.Mantis.html | 54 +++++-- Documentation/Ops.Airboss.html | 19 ++- .../Tasking.Task_Cargo_Dispatcher.html | 44 ------ Documentation/Wrapper.Client.html | 14 +- Documentation/Wrapper.Group.html | 78 +--------- Documentation/Wrapper.Marker.html | 72 +-------- 17 files changed, 342 insertions(+), 430 deletions(-) diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index ff4e154d2..9c635d58d 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4565,6 +4565,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -12908,6 +12919,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -14225,6 +14247,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -15849,6 +15882,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 15b0ec52b..59ffef49b 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -2855,17 +2855,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -5610,17 +5599,6 @@ Once the time is finished, the old AI will return to the base.

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

- - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -7975,17 +7942,6 @@ 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 d9879c40f..fa5731e59 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2554,7 +2554,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -2592,9 +2592,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

-
@@ -4587,7 +4584,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -4625,9 +4622,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

-
@@ -5202,7 +5196,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -5240,9 +5234,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

-
@@ -6710,7 +6701,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -6748,9 +6739,6 @@ 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 0b9806ef7..85e4d3d2e 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2549,9 +2549,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Set destination airbase for next :Route() command.

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

Set destination airbase for next :Route() command.

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

Set destination airbase for next :Route() command.

- @@ -6487,9 +6478,6 @@ 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/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index 2e0ac09d3..d7102e2eb 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1669,6 +1669,17 @@ Controls a network of short range air/missile defense groups.

Field(s)

+
+
+ + +CARGO_CRATE.CargoCarrier + + + +
+ +
@@ -2337,6 +2348,17 @@ Controls a network of short range air/missile defense groups.

Field(s)

+
+
+ + +CARGO_CRATE.CargoCarrier + + + +
+ +
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 26708e8b4..f28196628 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1740,10 +1740,27 @@ Controls a network of short range air/missile defense groups.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

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

Then we register the new group in the database

+
@@ -3058,10 +3075,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

+
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index b293dbaa0..78c4cc492 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1618,17 +1618,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir @@ -1647,6 +1636,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

+
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
@@ -2333,17 +2333,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir @@ -2362,6 +2351,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

+
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 045f6a054..4963739cb 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2635,7 +2635,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + SETTINGS.A2ASystem @@ -4726,7 +4726,7 @@ It is advised to use this method at the start of the mission.

- #string + SETTINGS.A2ASystem diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 4d1089d16..001af93b1 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -3376,17 +3376,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.SpawnGrouping - - -
@@ -3423,17 +3412,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.SpawnInitAirbase - - -
@@ -3467,17 +3445,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWN.SpawnInitFreq - - -
@@ -3533,6 +3500,20 @@ 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.

+
@@ -3553,19 +3534,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -SPAWN.SpawnInitLivery - - - -
- -
-
-
- - -SPAWN.SpawnInitModex + #string +SPAWN.SpawnInitSkill @@ -3760,6 +3730,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -8737,17 +8718,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - -SPAWN.SpawnGrouping - - -
@@ -8784,17 +8754,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - -SPAWN.SpawnInitAirbase - - -
@@ -8828,17 +8787,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - -SPAWN.SpawnInitFreq - - -
@@ -8894,6 +8842,20 @@ 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.

+
@@ -8914,19 +8876,8 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index a34563cb5..6caf7e64d 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3343,6 +3343,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -6500,6 +6511,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -7299,6 +7321,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -8068,6 +8101,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -9730,6 +9774,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index d5702ad6b..e938d177a 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18696,6 +18696,17 @@ BASE:TraceOnOff( false ) + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -18845,18 +18856,7 @@ BASE:TraceOnOff( false )
- #boolean -DETECTION_BASE.Locking - - -
- -
-
-
- - #number DETECTION_BASE.RefreshTimeInterval @@ -23398,6 +23398,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -23547,18 +23558,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #boolean -DETECTION_BASE.Locking - - -
- -
-
-
- - #number DETECTION_BASE.RefreshTimeInterval @@ -25156,6 +25156,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -25305,18 +25316,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #boolean -DETECTION_BASE.Locking - - -
- -
-
-
- - #number DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 704f962ab..34c0e5fe7 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -1739,7 +1739,7 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75% -

MANTIS:New(name, samprefix, ewrprefix, hq, coaltion, dynamic, awacs, AIOnOff)

+

MANTIS:New(name, samprefix, ewrprefix, hq, coaltion, dynamic, awacs, EmOnOff)

Function to instantiate a new object of class MANTIS

@@ -1841,9 +1841,9 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75% -

MANTIS:SetUsingAIOnOff(switch)

+

MANTIS:SetUsingEmOnOff(switch)

-

Set using AI on/off instead of changing alarm state

+

Set using Emissions on/off instead of changing alarm state

@@ -1895,9 +1895,9 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75% -

MANTIS.UseAIOnOff

+

MANTIS.UseEmOnOff

-

Decide if we are using AI on/off (true) or AlarmState red/green (default)

+

Decide if we are using Emissions on/off (true) or AlarmState red/green (default)

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

The #DETECTION_AREAS object for AWACS

+
+ +
+
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -2818,9 +2829,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MANTIS.UseAIOnOff +MANTIS.UseEmOnOff -

Decide if we are using AI on/off (true) or AlarmState red/green (default)

+

Decide if we are using Emissions on/off (true) or AlarmState red/green (default)

@@ -3205,7 +3216,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

MANTIS:New(name, samprefix, ewrprefix, hq, coaltion, dynamic, awacs, AIOnOff)

+

MANTIS:New(name, samprefix, ewrprefix, hq, coaltion, dynamic, awacs, EmOnOff)

Function to instantiate a new object of class MANTIS

@@ -3312,12 +3323,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

#boolean - AIOnOff + EmOnOff

-

Make MANTIS switch AI on and off instead of changing the alarm state between RED and GREEN (optional)

+

Make MANTIS switch Emissions on and off instead of changing the alarm state between RED and GREEN (optional, deault true)

@@ -3816,12 +3827,12 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
-

MANTIS:SetUsingAIOnOff(switch)

+

MANTIS:SetUsingEmOnOff(switch)

-

Set using AI on/off instead of changing alarm state

+

Set using Emissions on/off instead of changing alarm state

-
+

Defined in:

@@ -3837,7 +3848,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
-

Decide if we are changing alarm state or AI state

+

Decide if we are changing alarm state or Emission state

@@ -4195,6 +4206,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

The #DETECTION_AREAS object for AWACS

+
+ +
+
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -4400,9 +4422,9 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
#boolean -MANTIS.UseAIOnOff +MANTIS.UseEmOnOff -

Decide if we are using AI on/off (true) or AlarmState red/green (default)

+

Decide if we are using Emissions on/off (true) or AlarmState red/green (default)

diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 524633f03..633e37765 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -38122,6 +38122,20 @@ BASE:TraceOnOff( false )
+ +
+
+ + +AIRBOSS.PlayerData.flag + + + + +

Set stack flag.

+ +
+
@@ -38256,7 +38270,7 @@ BASE:TraceOnOff( false ) -

Set section lead of player flight.

+

Make player section lead if he was not before.

@@ -38302,6 +38316,9 @@ BASE:TraceOnOff( false ) + +

Set time stamp.

+
diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index f465b9312..ccef9fa08 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3027,17 +3027,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -4117,17 +4106,6 @@ This method can only be used once!

- - - -
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -4986,17 +4964,6 @@ This method can only be used once!

- - - -
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -6491,17 +6458,6 @@ This method can only be used once!

- - - -
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index bfca530b7..ea7af5eed 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -4146,7 +4146,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive.

+

Alive2.

@@ -5260,7 +5260,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive.

+

Alive2.

@@ -7519,7 +7519,7 @@ If the Unit is alive but not active, false is returned.

-

Alive.

+

Alive2.

@@ -16066,7 +16066,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of -

Alive.

+

Alive2.

@@ -19550,7 +19550,7 @@ Coordinates are dependent on the position of the maps origin.

-

Alive.

+

Alive2.

@@ -20224,7 +20224,7 @@ If the Identifiable is alive, true is returned.

-

Alive.

+

Alive2.

@@ -20504,7 +20504,7 @@ If the Identifiable is alive, true is returned.

-

Alive.

+

Alive2.

diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 7e3cc9d30..e8e1c0884 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -4648,18 +4648,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-GROUP.InitRespawnRandomizePositionInner - - - -
- - -
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -8664,18 +8653,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -17202,18 +17180,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -20677,18 +20644,7 @@ Coordinates are dependent on the position of the maps origin.

-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -21342,18 +21298,7 @@ If the Identifiable is alive, true is returned.

-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -21613,18 +21558,7 @@ If the Identifiable is alive, true is returned.

-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index c3296199c..b8d92a966 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2819,28 +2819,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -2925,7 +2903,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall @@ -4925,28 +4903,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -5031,7 +4987,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall @@ -6540,28 +6496,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -6646,7 +6580,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall