From a5f52b22161029e5c60846dfc1f8a72b27f45332 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Wed, 13 Jan 2021 09:23:52 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A_Dispatcher.html | 5 +- Documentation/AI.AI_Air.html | 44 ++++ Documentation/AI.AI_Air_Squadron.html | 22 -- Documentation/AI.AI_Cargo_Airplane.html | 12 + Documentation/Cargo.CargoGroup.html | 34 +++ Documentation/Core.Settings.html | 26 +- Documentation/Core.Spawn.html | 242 +++++------------- Documentation/Core.SpawnStatic.html | 84 ++++++ Documentation/Core.Spot.html | 132 ---------- Documentation/Functional.Designate.html | 55 ++++ Documentation/Functional.Mantis.html | 69 +++-- Documentation/Functional.Rat.html | 63 +++-- Documentation/Ops.Airboss.html | 15 +- Documentation/Tasking.Task_Cargo.html | 13 +- .../Tasking.Task_Cargo_Dispatcher.html | 8 +- Documentation/Wrapper.Client.html | 14 +- Documentation/Wrapper.Controllable.html | 2 +- Documentation/Wrapper.Group.html | 78 +----- 18 files changed, 419 insertions(+), 499 deletions(-) diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index 4ac8d80fe..d4899627e 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -2106,7 +2106,10 @@ The first function enables this for all squadrons, the latter only for specific of the race track will randomly selected between 90 (West to East) and 180 (North to South) degrees. After a random duration between 10 and 20 minutes, the flight will get a new random orbit location.

-

Note that all parameters except the squadron name are optional. If not specified, default values are taken. Speed and altitude are taken from the

+

Note that all parameters except the squadron name are optional. If not specified, default values are taken. Speed and altitude are taken from the CAP command used earlier on, e.g.

+ +
 A2ADispatcher:SetSquadronCap( "Mineralnye", CAPZoneEast, 4000, 10000, 500, 600, 800, 900 )
+

Also note that the center of the race track pattern is chosen randomly within the patrol zone and can be close the the boarder of the zone. Hence, it cannot be guaranteed that the whole pattern lies within the patrol zone.

diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index b069736a5..d2d803f9d 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -2809,6 +2809,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -5553,6 +5564,17 @@ Once the time is finished, the old AI will return to the base.

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

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

+ + + +
+
+ + #number +AI_AIR.IdleCount + + +
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 37c7768aa..93e1bddc5 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2312,17 +2312,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
@@ -3394,17 +3383,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 7338d7bb2..826c5111c 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2550,6 +2550,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

+ diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 6cae0f95d..0ef22b6b2 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1724,10 +1724,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

+
@@ -3042,10 +3059,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/Core.Settings.html b/Documentation/Core.Settings.html index 78c9539d8..56c18b8c7 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2589,7 +2589,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2ASystem @@ -2649,17 +2649,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SETTINGS.PlayerMenu - - -
@@ -4691,7 +4680,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem @@ -4751,17 +4740,6 @@ It is advised to use this method at the start of the mission.

-
- -
-
-
- - -SETTINGS.PlayerMenu - - -
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 941f10680..b933b2510 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2634,30 +2634,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.frequency

- - - - - -

SPAWN.livery_id

- - - - - -

SPAWN.modulation

- - - - - -

SPAWN.skill

- - @@ -3260,9 +3236,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.

- @@ -3318,20 +3291,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

-
@@ -3354,6 +3313,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnGrouping + + +
@@ -3390,6 +3360,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
@@ -3423,6 +3404,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -3513,7 +3505,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-SPAWN.SpawnInitModex +SPAWN.SpawnInitLivery @@ -3708,17 +3700,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- - -
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -3731,7 +3712,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.

@@ -3783,50 +3764,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.frequency - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - - -
- -
-
-
- - -SPAWN.skill - - -
@@ -8646,9 +8583,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.

- @@ -8704,20 +8638,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

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

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

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

+ + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -8899,7 +8852,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

-SPAWN.SpawnInitModex +SPAWN.SpawnInitLivery @@ -9094,17 +9047,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -9117,7 +9059,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.

@@ -9169,50 +9111,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.frequency - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.modulation - - - -
- -
-
-
- - -SPAWN.skill - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index a1e01596e..e337a619b 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1769,6 +1769,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

+ + @@ -2652,6 +2670,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+ + +
+
+ + +
+
+
@@ -3873,6 +3924,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+ + +
+
+ + +
+
+
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index c84e8a257..dec2394ee 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2544,50 +2544,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
@@ -3801,50 +3757,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
@@ -5350,50 +5262,6 @@ 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 5267e3811..e0ad4d90f 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3297,6 +3297,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
@@ -6454,6 +6465,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -7253,6 +7275,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -8022,6 +8055,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -9684,6 +9728,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 8015c46c8..11ea08d1d 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -1487,7 +1487,8 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%

2. Start up your MANTIS with a basic setting

-

myredmantis = MANTIS:New("myredmantis","Red SAM","Red EWR",nil,"red",false)

+

myredmantis = MANTIS:New("myredmantis","Red SAM","Red EWR",nil,"red",false) + myredmantis:Start()

[optional] Use

@@ -1499,13 +1500,12 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
  • MANTIS:SetAutoRelocate(hq, ewr)
  • -

    to fine-tune your setup.

    - -

    myredmantis:Start()

    +

    before starting #MANTIS to fine-tune your setup.

    If you want to use a separate AWACS unit (default detection range: 250km) to support your EWR system, use e.g. the following setup:

    -

    mybluemantis = MANTIS:New("bluemantis","Blue SAM","Blue EWR",nil,"blue",false,"Blue Awacs")

    +

    mybluemantis = MANTIS:New("bluemantis","Blue SAM","Blue EWR",nil,"blue",false,"Blue Awacs") + mybluemantis:Start()

    3. Default settings

    @@ -1704,7 +1704,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)

    -

    Function instantiate new class

    +

    Function to instantiate a new object of class MANTIS

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

    MANTIS:SetEWRRange(radius)

    Function to set the detection radius of the EWR in meters

    + + + +

    MANTIS:SetNewSAMRangeWhileRunning(range)

    + +

    Function to set a new SAM firing engage range, use this method to adjust range while running MANTIS, e.g.

    @@ -1979,7 +1985,7 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
    @@ -1993,17 +1999,6 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75% -
    - -
    -
    -
    - - -MANTIS.AWACS_Prefix - - -
    @@ -2496,7 +2491,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)

    -

    Function instantiate new class

    +

    Function to instantiate a new object of class MANTIS

    @@ -2883,6 +2878,42 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
    + + + +
    + + + +

    Function to set a new SAM firing engage range, use this method to adjust range while running MANTIS, e.g.

    + + +

    for different setups day and night

    + +
    +
    +

    Defined in:

    +
    +

    MANTIS

    +
    +

    Parameter:

    +
    +
    +

    + #number + range +

    +
    +
    + +

    Percent of the max fire range

    + +
    +
    +
    +
    diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index c765726ce..ea08379ea 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3260,6 +3260,12 @@ manager:Stop(7200)

    RAT.termtype

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

    + + + +

    RAT.type

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

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

    - - - -

    RAT.frequency

    - - - - - -

    RAT.livery_id

    - - - - - -

    RAT.modulation

    - - - - - -

    RAT.skill

    - - @@ -6555,6 +6537,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 + + +
    @@ -14435,6 +14428,17 @@ Initializes the ratcraft array and group menu.

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

    + + + +
    +
    + + +RAT.type + + +
    @@ -20370,6 +20374,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 7e71c605b..23869f07a 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -37856,13 +37856,10 @@ BASE:TraceOnOff( false )
    + #AIRBOSS.GroovePos +AIRBOSS.PlayerData.groove -AIRBOSS.PlayerData.flag - - - - -

    Also decrease flag for section members of flight.

    +

    Data table at each position in the groove. Elements are of type AIRBOSS.GrooveData.

    @@ -37870,10 +37867,10 @@ BASE:TraceOnOff( false )
    - #AIRBOSS.GroovePos -AIRBOSS.PlayerData.groove + #boolean +AIRBOSS.PlayerData.holding -

    Data table at each position in the groove. Elements are of type AIRBOSS.GrooveData.

    +
    diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 4ef0a3001..667744a35 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3017,22 +3017,11 @@ based on the tasking capabilities defined in - -
    -
    -
    diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index c89c3b0c3..daf0b862c 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3009,7 +3009,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4132,7 +4132,7 @@ This method can only be used once!

    - #table + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5034,7 +5034,7 @@ This method can only be used once!

    - #table + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -6572,7 +6572,7 @@ This method can only be used once!

    - #table + TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index fc5aee63e..cfc21581a 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -4076,7 +4076,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

    Alive2.

    +

    Alive.

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

    Alive2.

    +

    Alive.

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

    -

    Alive2.

    +

    Alive.

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

    Alive2.

    +

    Alive.

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

    -

    Alive2.

    +

    Alive.

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

    -

    Alive2.

    +

    Alive.

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

    -

    Alive2.

    +

    Alive.

    diff --git a/Documentation/Wrapper.Controllable.html b/Documentation/Wrapper.Controllable.html index b9e02f5e6..d38e1d77c 100644 --- a/Documentation/Wrapper.Controllable.html +++ b/Documentation/Wrapper.Controllable.html @@ -1558,7 +1558,7 @@ The method CONTROLLABLE.SetTaskWaypoi
  • CONTROLLABLE.Route(): Make the Controllable to follow a given route.
  • CONTROLLABLE.RouteGroundTo(): Make the GROUND Controllable to drive towards a specific coordinate.
  • CONTROLLABLE.RouteAirTo(): Make the AIR Controllable to fly towards a specific coordinate.
  • -
  • CONTROLLABLE.RelocateGroundRandomInRadius(): Relocate the GROUND controllable to a random point in a given radius.
  • +
  • CONTROLLABLE.RelocateGroundRandomInRadius(): Relocate the GROUND controllable to a random point in a given radius.
  • 5) Option methods

    diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 28aa77dff..51030a6f1 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -4590,18 +4590,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -
    -
    -
    - - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -8575,18 +8564,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu - -
    -
    -
    - - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -17021,18 +16999,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of - -
    -
    -
    - - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -20496,18 +20463,7 @@ Coordinates are dependent on the position of the maps origin.

    - -
    -
    -
    - - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -21161,18 +21117,7 @@ If the Identifiable is alive, true is returned.

    - -
    -