From 5f717889cd99500af8fb21229ee10791f1638ddf Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Thu, 25 Aug 2022 08:54:10 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2G_Dispatcher.html | 44 - Documentation/AI.AI_Air.html | 88 + Documentation/AI.AI_Cargo.html | 12 - Documentation/AI.AI_Cargo_Airplane.html | 12 + Documentation/AI.AI_Cargo_Helicopter.html | 40 +- Documentation/Cargo.CargoCrate.html | 22 + Documentation/Cargo.CargoGroup.html | 6 - Documentation/Cargo.CargoUnit.html | 22 - Documentation/Core.Point.html | 33 + Documentation/Core.Settings.html | 26 +- Documentation/Core.Spawn.html | 268 +- Documentation/Core.Spot.html | 99 - Documentation/Functional.ATC_Ground.html | 10 +- Documentation/Functional.Designate.html | 110 - Documentation/Functional.Detection.html | 66 + Documentation/Functional.Mantis.html | 6 + Documentation/Functional.Rat.html | 69 + Documentation/Functional.Scoring.html | 4 +- Documentation/Ops.Airboss.html | 85 +- Documentation/Ops.CSAR.html | 72 +- Documentation/Ops.CTLD.html | 141 +- Documentation/Sound.MSRS.html | 4840 ++++++++++++++++- Documentation/Tasking.Task.html | 22 - Documentation/Tasking.Task_Cargo.html | 2 +- .../Tasking.Task_Cargo_Dispatcher.html | 8 +- Documentation/Utils.FiFo.html | 22 - Documentation/Wrapper.Marker.html | 66 + 27 files changed, 5647 insertions(+), 548 deletions(-) diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 5ce1bc4a2..8706ec973 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4670,17 +4670,6 @@ 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 - - -
@@ -13115,17 +13104,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -16077,17 +16044,6 @@ 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 c49485b48..ec023a6f6 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -3073,6 +3073,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_AIR.RTBSpeedMaxFactor + + + +
+ +
+
+
+ + #number +AI_AIR.RTBSpeedMinFactor + + +
@@ -5890,6 +5912,28 @@ A random value in this bracket is then applied in the waypoint routing generatio + + + +
+
+ + #number +AI_AIR.RTBSpeedMaxFactor + + + +
+ +
+
+
+ + #number +AI_AIR.RTBSpeedMinFactor + + +
@@ -6626,6 +6670,28 @@ A random value in this bracket is then applied in the waypoint routing generatio + + + +
+
+ + #number +AI_AIR.RTBSpeedMaxFactor + + + +
+ +
+
+
+ + #number +AI_AIR.RTBSpeedMinFactor + + +
@@ -8254,6 +8320,28 @@ A random value in this bracket is then applied in the waypoint routing generatio + + + +
+
+ + #number +AI_AIR.RTBSpeedMaxFactor + + + +
+ +
+
+
+ + #number +AI_AIR.RTBSpeedMinFactor + + +
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index bca84de36..2f3958971 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2682,9 +2682,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.

- @@ -4715,9 +4712,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.

- @@ -5330,9 +5324,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.

- @@ -6837,9 +6828,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 10ae68c0a..791b47499 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2661,6 +2661,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a depoly mission.

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

Aircraft is on a depoly mission.

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

Aircraft is on a depoly mission.

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

Aircraft is on a depoly mission.

+ diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index 1c8376119..d9e6f3133 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -2796,22 +2796,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -4714,22 +4720,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -5384,22 +5396,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -6946,22 +6964,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
diff --git a/Documentation/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index 30f891073..a39fb1589 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1760,6 +1760,17 @@ Controls a network of short range air/missile defense groups.

Field(s)

+
+
+ + +CARGO_CRATE.CargoCarrier + + + +
+ +
@@ -2428,6 +2439,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 c7850c4ae..04e412dad 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1849,9 +1849,6 @@ Controls a network of short range air/missile defense groups.

- -

Then we register the new group in the database

-
@@ -3184,9 +3181,6 @@ This works for ground only groups.

- -

Then we register the new group in the database

-
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index e583436c6..4c3bb671d 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1738,17 +1738,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

- - - -
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2464,17 +2453,6 @@ 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.Point.html b/Documentation/Core.Point.html index 8383707ea..787dec99e 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -17257,6 +17257,17 @@ When moose is loading dynamically (for moose class development), tracing is swit

the y coordinate in meters.

+ + + +
+
+ + +POINT_VEC2.z + + +
@@ -18055,6 +18066,17 @@ When moose is loading dynamically (for moose class development), tracing is swit

the y coordinate in meters.

+ + + +
+
+ + +POINT_VEC2.z + + +
@@ -26309,6 +26331,17 @@ Creates a line on the F10 map from one point to another.

the y coordinate in meters.

+ + + +
+
+ + +POINT_VEC2.z + + +
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 99b88db53..3d7fcb8c2 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2780,11 +2780,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -4874,11 +4885,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 1f9a854b1..42580f2b2 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2746,6 +2746,36 @@ 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

+ + + + + +

SPAWN.uncontrolled

+ + @@ -3451,6 +3481,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnGrouping + + +
@@ -3487,6 +3528,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnInitAirbase + + +
@@ -3520,6 +3572,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -3586,20 +3649,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

By default, no InitLimit

- - - - -
-
- - -SPAWN.SpawnInitModu - - -
@@ -3642,7 +3691,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3656,7 +3705,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3802,17 +3851,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -3825,7 +3863,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.

@@ -3877,6 +3915,61 @@ 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 + + + +
+ +
+
+
+ + +SPAWN.uncontrolled + + +
@@ -8825,6 +8918,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

+ + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -8960,20 +9086,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

- - - - -
-
- - -SPAWN.SpawnInitModu - - -
@@ -9016,7 +9128,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

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

@@ -9251,6 +9352,61 @@ 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 + + + +
+ +
+
+
+ + +SPAWN.uncontrolled + + +
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 229dd073b..74e776abd 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2680,39 +2680,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - -
@@ -3926,39 +3893,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - -
@@ -5463,39 +5397,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - -
diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index a3a94fcac..56f8f3343 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -3750,7 +3750,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table ATC_GROUND.Airbases @@ -3766,6 +3766,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Kickspeed

+
@@ -4332,7 +4335,7 @@ An airbase can be specified to set the maximum kick speed for.

- + #table ATC_GROUND.Airbases @@ -4348,6 +4351,9 @@ An airbase can be specified to set the maximum kick speed for.

+ +

Kickspeed

+
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index f0c6998a0..846460ae9 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3433,17 +3433,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -3455,17 +3444,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -6612,17 +6590,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -6634,17 +6601,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -7433,17 +7389,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -7455,17 +7400,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -8224,17 +8158,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -8246,17 +8169,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -9907,17 +9819,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -9929,17 +9830,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index c3fdfb6c2..1bafcdbef 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18901,6 +18901,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -19044,6 +19055,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -23582,6 +23604,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -23725,6 +23758,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -25328,6 +25372,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -25471,6 +25526,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 589fe3a7a..91edc082c 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -3356,6 +3356,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

switch alarm state RED

+ @@ -7018,6 +7021,9 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` + +

switch alarm state RED

+ diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index 32715e717..0e846fee5 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3369,6 +3369,12 @@ manager:Stop(7200)

RAT.termtype

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

+ + + +

RAT.type

+ + @@ -4336,6 +4342,36 @@ 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

+ + + + + +

RAT.uncontrolled

+ + @@ -6705,6 +6741,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 + + +
@@ -14585,6 +14632,17 @@ Initializes the ratcraft array and group menu.

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

+ + + +
+
+ + +RAT.type + + +
@@ -20575,6 +20633,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.Scoring.html b/Documentation/Functional.Scoring.html index 2936b6650..d0522797b 100644 --- a/Documentation/Functional.Scoring.html +++ b/Documentation/Functional.Scoring.html @@ -2994,7 +2994,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SCORING.penaltyonfratricide @@ -5514,7 +5514,7 @@ The scale magnifies the scores given to the players.

- #boolean + SCORING.penaltyonfratricide diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index e0654bbc1..1e331de6a 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -9246,17 +9246,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

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

Radio queue of marshal.

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

Radio queue of LSO.

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

Radio queue of marshal.

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

Radio queue of LSO.

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

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -38819,7 +38753,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Set current case.

+

Set case to that of lead.

@@ -38887,17 +38821,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

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

- - - -
-
- - #boolean -AIRBOSS.PlayerData.holding - - -
@@ -39058,6 +38981,9 @@ When moose is loading dynamically (for moose class development), tracing is swit + +

Set Stable Hover

+ @@ -39091,9 +39017,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

Set new time stamp.

- diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index 28ec85693..16282ce50 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -2337,12 +2337,6 @@ Create a late-activated single infantry unit as template in the mission editor a

CSAR.inTransitGroups

- - - -

CSAR.index

- - @@ -4008,6 +4002,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -4106,17 +4111,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

contain a table for each SAR with all units he has with the original names

- - - -
-
- - -CSAR.index - - -
@@ -9022,6 +9016,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -9120,17 +9125,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

contain a table for each SAR with all units he has with the original names

- - - -
-
- - -CSAR.index - - -
@@ -11343,6 +11337,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -11441,17 +11446,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

contain a table for each SAR with all units he has with the original names

- - - -
-
- - -CSAR.index - - -
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index 9409f8808..4289c3af1 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -6936,6 +6936,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Name of the class.

+ + + +
+
+ + #number +CTLD.CrateCounter + + +
@@ -6967,7 +6978,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.CtldUnits @@ -6989,7 +7000,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -7014,11 +7025,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

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

Beacons

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

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -7651,7 +7679,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

noob catch

+

time to repair a unit/group

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

Name of the class.

+ + + +
+
+ + #number +CTLD.CrateCounter + + +
@@ -14491,7 +14530,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.CtldUnits @@ -14513,7 +14552,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -14538,11 +14577,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

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

Beacons

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

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -15175,7 +15231,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

noob catch

+

time to repair a unit/group

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

Name of the class.

+ + + +
+
+ + #number +CTLD.CrateCounter + + +
@@ -16856,7 +16923,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.CtldUnits @@ -16878,7 +16945,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -16903,11 +16970,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

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

Beacons

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

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -17540,7 +17624,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

noob catch

+

time to repair a unit/group

@@ -21447,6 +21531,17 @@ When moose is loading dynamically (for moose class development), tracing is swit

Can transport crate.

+ + + +
+
+ + #number +CTLD.UnitCapabilities.length + + +
@@ -25183,6 +25278,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + Core.Point#COORDINATE +CTLD_ENGINEERING.currwpt + + +
@@ -25836,6 +25942,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + Core.Point#COORDINATE +CTLD_ENGINEERING.currwpt + + +
diff --git a/Documentation/Sound.MSRS.html b/Documentation/Sound.MSRS.html index 0546be778..76b0b906f 100644 --- a/Documentation/Sound.MSRS.html +++ b/Documentation/Sound.MSRS.html @@ -1546,8 +1546,6 @@ Controls a network of short range air/missile defense groups.

-

Banner Image

-

The MSRS Concept

This class allows to broadcast sound files or text via Simple Radio Standalone (SRS).

@@ -1565,8 +1563,6 @@ Controls a network of short range air/missile defense groups.

-

Banner Image

-

The MSRS Concept

This class allows to broadcast sound files or text via Simple Radio Standalone (SRS).

@@ -1641,6 +1637,27 @@ Google's supported voices: https://cloud.google.com/text-to-speech/docs/voicesUse MSRS.SetVolume to define the SRS volume. Defaults to 1.0. Allowed values are between 0.0 and 1.0, from silent to loudest.

+ + + +
+ + + + + +

Global MSRSQUEUE

 + +
+
+
+
+ + #MSRSQUEUE +MSRSQUEUE + + +
@@ -1738,6 +1755,12 @@ Google's supported voices: https://cloud.google.com/text-to-speech/docs/voices

MSRS:PlayText(Text, Delay)

Play text message via STTS.

+ + + +

MSRS:PlayTextExt(Text, Delay, Frequencies, Modulations, Gender, Culture, Voice, Volume, Label)

+ +

Play text message via STTS with explicitly specified options.

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

MSRS:onEvent(event)

+ + + + + +

Type MSRSQUEUE

+
+ MSRSQUEUE +, extends Core.Base#BASE +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from MSRSQUEUEDescription

MSRSQUEUE:AddTransmission(transmission)

 +

Add a transmission to the radio queue.

+

MSRSQUEUE:Broadcast(transmission)

 +

Broadcast radio message.

+

MSRSQUEUE:CalcTransmisstionDuration()

 +

Calculate total transmission duration of all transmission in the queue.

+

MSRSQUEUE.ClassName

 +

Name of the class "MSRSQUEUE".

+

MSRSQUEUE:Clear()

 +

Clear the radio queue.

+

MSRSQUEUE.Debugmode

 + +

MSRSQUEUE:New(alias)

 +

Create a new MSRSQUEUE object for a given radio frequency/modulation.

+

MSRSQUEUE:NewTransmission(text, duration, msrs, tstart, interval, subgroups, subtitle, subduration, frequency, modulation)

 +

Create a new transmission and add it to the radio queue.

+

MSRSQUEUE.Tlast

 +

Time (abs) when the last transmission finished.

+

MSRSQUEUE:_CheckRadioQueue(delay)

 +

Check radio queue for transmissions to be broadcasted.

+

MSRSQUEUE.alias

 +

Name of the radio queue.

+

MSRSQUEUE.checking

 +

If true, the queue update function is scheduled to be called again.

+

MSRSQUEUE.dt

 +

Time interval in seconds for checking the radio queue.

+

MSRSQUEUE.lid

 +

ID for dcs.log.

+

MSRSQUEUE.queue

 +

The queue of transmissions.

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from BASEDescription

MSRSQUEUE.ClassID

 +

The ID number of the class.

+

MSRSQUEUE.ClassName

 +

The name of the class.

+

MSRSQUEUE.ClassNameAndID

 +

The name of the class concatenated with the ID number of the class.

+

MSRSQUEUE:ClearState(Object, StateName)

 +

Clear the state of an object.

+

MSRSQUEUE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

 +

Creation of a Birth Event.

+

MSRSQUEUE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Crash Event.

+

MSRSQUEUE:CreateEventDead(EventTime, Initiator)

 +

Creation of a Dead Event.

+

MSRSQUEUE:CreateEventPlayerEnterAircraft(PlayerUnit)

 +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

MSRSQUEUE:CreateEventRemoveUnit(EventTime, Initiator)

 +

Creation of a Remove Unit Event.

+

MSRSQUEUE:CreateEventTakeoff(EventTime, Initiator)

 +

Creation of a Takeoff Event.

+

MSRSQUEUE:E(Arguments)

 +

Log an exception which will be traced always.

+

MSRSQUEUE:EventDispatcher()

 +

Returns the event dispatcher

+

MSRSQUEUE:EventRemoveAll()

 +

Remove all subscribed events

+

MSRSQUEUE:F(Arguments)

 +

Trace a function call.

+

MSRSQUEUE:F2(Arguments)

 +

Trace a function call level 2.

+

MSRSQUEUE:F3(Arguments)

 +

Trace a function call level 3.

+

MSRSQUEUE:GetClassID()

 +

Get the ClassID of the class instance.

+

MSRSQUEUE:GetClassName()

 +

Get the ClassName of the class instance.

+

MSRSQUEUE:GetClassNameAndID()

 +

Get the ClassName + ClassID of the class instance.

+

MSRSQUEUE:GetEventPriority()

 +

Get the Class Event processing Priority.

+

MSRSQUEUE:GetParent(Child, FromClass)

 +

This is the worker method to retrieve the Parent class.

+

MSRSQUEUE:GetState(Object, Key)

 +

Get a Value given a Key from the Object.

+

MSRSQUEUE:HandleEvent(EventID, EventFunction)

 +

Subscribe to a DCS Event.

+

MSRSQUEUE:I(Arguments)

 +

Log an information which will be traced always.

+

MSRSQUEUE:Inherit(Child, Parent)

 +

This is the worker method to inherit from a parent class.

+

MSRSQUEUE:IsInstanceOf(ClassName)

 +

This is the worker method to check if an object is an (sub)instance of a class.

+

MSRSQUEUE:IsTrace()

 +

Enquires if tracing is on (for the class).

+

MSRSQUEUE:New()

 +

BASE constructor.

+

MSRSQUEUE:OnEvent(EventData)

 +

Occurs when an object is completely destroyed.

+

MSRSQUEUE:OnEventBDA(EventData)

 +

BDA.

+

MSRSQUEUE:OnEventBaseCaptured(EventData)

 +

Occurs when a ground unit captures either an airbase or a farp.

+

MSRSQUEUE:OnEventBirth(EventData)

 +

Occurs when any object is spawned into the mission.

+

MSRSQUEUE:OnEventCrash(EventData)

 +

Occurs when any aircraft crashes into the ground and is completely destroyed.

+

MSRSQUEUE:OnEventDead(EventData)

 +

Occurs when an object is dead.

+

MSRSQUEUE:OnEventDetailedFailure(EventData)

 +

Unknown precisely what creates this event, likely tied into newer damage model.

+

MSRSQUEUE:OnEventDiscardChairAfterEjection(EventData)

 +

Discard chair after ejection.

+

MSRSQUEUE:OnEventEjection(EventData)

 +

Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

+

MSRSQUEUE:OnEventEngineShutdown(EventData)

 +

Occurs when any aircraft shuts down its engines.

+

MSRSQUEUE:OnEventEngineStartup(EventData)

 +

Occurs when any aircraft starts its engines.

+

MSRSQUEUE:OnEventHit(EventData)

 +

Occurs whenever an object is hit by a weapon.

+

MSRSQUEUE:OnEventHumanFailure(EventData)

 +

Occurs when any system fails on a human controlled aircraft.

+

MSRSQUEUE:OnEventKill(EventData)

 +

Occurs on the death of a unit.

+

MSRSQUEUE:OnEventLand(EventData)

 +

Occurs when an aircraft lands at an airbase, farp or ship +initiator : The unit that has landed.

+

MSRSQUEUE:OnEventLandingAfterEjection(EventData)

 +

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

+

MSRSQUEUE:OnEventLandingQualityMark(EventData)

 +

Landing quality mark.

+

MSRSQUEUE:OnEventMarkAdded(EventData)

 +

Occurs when a new mark was added.

+

MSRSQUEUE:OnEventMarkChange(EventData)

 +

Occurs when a mark text was changed.

+

MSRSQUEUE:OnEventMarkRemoved(EventData)

 +

Occurs when a mark was removed.

+

MSRSQUEUE:OnEventMissionEnd(EventData)

 +

Occurs when a mission ends.

+

MSRSQUEUE:OnEventMissionStart(EventData)

 +

Occurs when a mission starts.

+

MSRSQUEUE:OnEventParatrooperLanding(EventData)

 +

Weapon add.

+

MSRSQUEUE:OnEventPilotDead(EventData)

 +

Occurs when the pilot of an aircraft is killed.

+

MSRSQUEUE:OnEventPlayerEnterAircraft(EventData)

 +

Occurs when a player enters a slot and takes control of an aircraft.

+

MSRSQUEUE:OnEventPlayerEnterUnit(EventData)

 +

Occurs when any player assumes direct control of a unit.

+

MSRSQUEUE:OnEventPlayerLeaveUnit(EventData)

 +

Occurs when any player relieves control of a unit to the AI.

+

MSRSQUEUE:OnEventRefueling(EventData)

 +

Occurs when an aircraft connects with a tanker and begins taking on fuel.

+

MSRSQUEUE:OnEventRefuelingStop(EventData)

 +

Occurs when an aircraft is finished taking fuel.

+

MSRSQUEUE:OnEventScore(EventData)

 +

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

+

MSRSQUEUE:OnEventShootingEnd(EventData)

 +

Occurs when any unit stops firing its weapon.

+

MSRSQUEUE:OnEventShootingStart(EventData)

 +

Occurs when any unit begins firing a weapon that has a high rate of fire.

+

MSRSQUEUE:OnEventShot(EventData)

 +

Occurs whenever any unit in a mission fires a weapon.

+

MSRSQUEUE:OnEventTakeoff(EventData)

 +

Occurs when an aircraft takes off from an airbase, farp, or ship.

+

MSRSQUEUE:OnEventTriggerZone(EventData)

 +

Trigger zone.

+

MSRSQUEUE:OnEventUnitLost(EventData)

 +

Occurs when the game thinks an object is destroyed.

+

MSRSQUEUE:ScheduleOnce(Start, SchedulerFunction, ...)

 +

Schedule a new time event.

+

MSRSQUEUE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

 +

Schedule a new time event.

+

MSRSQUEUE:ScheduleStop(SchedulerFunction)

 +

Stops the Schedule.

+

MSRSQUEUE.Scheduler

 + +

MSRSQUEUE:SetEventPriority(EventPriority)

 +

Set the Class Event processing Priority.

+

MSRSQUEUE:SetState(Object, Key, Value)

 +

Set a state or property of the Object given a Key and a Value.

+

MSRSQUEUE:T(Arguments)

 +

Trace a function logic level 1.

+

MSRSQUEUE:T2(Arguments)

 +

Trace a function logic level 2.

+

MSRSQUEUE:T3(Arguments)

 +

Trace a function logic level 3.

+

MSRSQUEUE:TraceAll(TraceAll)

 +

Trace all methods in MOOSE

+

MSRSQUEUE:TraceClass(Class)

 +

Set tracing for a class

+

MSRSQUEUE:TraceClassMethod(Class, Method)

 +

Set tracing for a specific method of class

+

MSRSQUEUE:TraceLevel(Level)

 +

Set trace level

+

MSRSQUEUE:TraceOff()

 +

Set trace off.

+

MSRSQUEUE:TraceOn()

 +

Set trace on.

+

MSRSQUEUE:TraceOnOff(TraceOnOff)

 +

Set trace on or off +Note that when trace is off, no BASE.Debug statement is performed, increasing performance! +When Moose is loaded statically, (as one file), tracing is switched off by default.

+

MSRSQUEUE:UnHandleEvent(EventID)

 +

UnSubscribe to a DCS event.

+

MSRSQUEUE._

 + +

MSRSQUEUE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function call.

+

MSRSQUEUE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

MSRSQUEUE.__

 + +

MSRSQUEUE:onEvent(event)

 + +
+
+ +

Type MSRSQUEUE.Transmission

+
+ MSRSQUEUE.Transmission +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from MSRSQUEUE.TransmissionDescription

MSRSQUEUE.Transmission.Tplay

 +

Mission time (abs) in seconds when the transmission should be played.

+

MSRSQUEUE.Transmission.Tstarted

 +

Mission time (abs) in seconds when the transmission started.

+

MSRSQUEUE.Transmission.duration

 +

Duration in seconds.

+

MSRSQUEUE.Transmission.frequency

 +

Frequency.

+

MSRSQUEUE.Transmission.interval

 +

Interval in seconds before next transmission.

+

MSRSQUEUE.Transmission.isplaying

 +

If true, transmission is currently playing.

+

MSRSQUEUE.Transmission.modulation

 +

Modulation.

+

MSRSQUEUE.Transmission.msrs

 +

MOOSE SRS object.

+

MSRSQUEUE.Transmission.subduration

 +

Duration of the subtitle being displayed.

+

MSRSQUEUE.Transmission.subgroups

 +

Groups to send subtitle to.

+

MSRSQUEUE.Transmission.subtitle

 +

Subtitle of the transmission.

+

MSRSQUEUE.Transmission.text

 +

Text to be transmitted.
@@ -3140,6 +3880,154 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ + + +
+ +
+

MSRS:PlayTextExt(Text, Delay, Frequencies, Modulations, Gender, Culture, Voice, Volume, Label)

+
+ +

Play text message via STTS with explicitly specified options.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameters:

+
+
+

+ #string + Text +

+
+
+ +

Text message.

+ +
+
+
+
+

+ #number + Delay +

+
+
+ +

Delay in seconds, before the message is played.

+ +
+
+
+
+

+ #table + Frequencies +

+
+
+ +

Radio frequencies.

+ +
+
+
+
+

+ #table + Modulations +

+
+
+ +

Radio modulations.

+ +
+
+
+
+

+ #string + Gender +

+
+
+ +

Gender.

+ +
+
+
+
+

+ #string + Culture +

+
+
+ +

Culture.

+ +
+
+
+
+

+ #string + Voice +

+
+
+ +

Voice.

+ +
+
+
+
+

+ #number + Volume +

+
+
+ +

Volume.

+ +
+
+
+
+

+ #string + Label +

+
+
+ +

Label.

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+
@@ -7421,6 +8309,3950 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +

Type MSRSQUEUE

+
+
+ +

Manages radio transmissions.

+ + + +

The purpose of the MSRSQUEUE class is to manage SRS text-to-speech (TTS) messages using the MSRS class. +This can be used to submit multiple TTS messages and the class takes care that they are transmitted one after the other (and not overlapping).

+ + +
+

Field(s)

+
+
+
+ + #string +MSRSQUEUE.ClassName + +

Name of the class "MSRSQUEUE".

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Tlast + +

Time (abs) when the last transmission finished.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.alias + +

Name of the radio queue.

+ +
+ +
+
+
+ + #boolean +MSRSQUEUE.checking + +

If true, the queue update function is scheduled to be called again.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.dt + +

Time interval in seconds for checking the radio queue.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.lid + +

ID for dcs.log.

+ +
+ +
+
+
+ + #table +MSRSQUEUE.queue + +

The queue of transmissions.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

MSRSQUEUE:AddTransmission(transmission)

+
+ +

Add a transmission to the radio queue.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Parameter:

+
+
+

+ #MSRSQUEUE.Transmission + transmission +

+
+
+ +

The transmission data table.

+ +
+
+

Return value:

+
+
+

#MSRSQUEUE:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:Broadcast(transmission)

+
+ +

Broadcast radio message.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Parameter:

+
+
+

+ #MSRSQUEUE.Transmission + transmission +

+
+
+ +

The transmission.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CalcTransmisstionDuration()

+
+ +

Calculate total transmission duration of all transmission in the queue.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Return value:

+
+
+

#number:

+
+
+ +

Total transmission duration.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:Clear()

+
+ +

Clear the radio queue.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Return value:

+
+
+

#MSRSQUEUE:

+
+
+ +

self The MSRSQUEUE object.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:New(alias)

+
+ +

Create a new MSRSQUEUE object for a given radio frequency/modulation.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Parameter:

+
+
+

+ #string + alias +

+
+
+ +

(Optional) Name of the radio queue.

+ +
+
+

Return value:

+
+
+

#MSRSQUEUE:

+
+
+ +

self The MSRSQUEUE object.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:NewTransmission(text, duration, msrs, tstart, interval, subgroups, subtitle, subduration, frequency, modulation)

+
+ +

Create a new transmission and add it to the radio queue.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Parameters:

+
+
+

+ #string + text +

+
+
+ +

Text to play.

+ +
+
+
+
+

+ #number + duration +

+
+
+ +

Duration in seconds the file lasts. Default is determined by number of characters of the text message.

+ +
+
+
+
+

+ Sound.SRS#MSRS + msrs +

+
+
+ +

MOOSE SRS object.

+ +
+
+
+
+

+ #number + tstart +

+
+
+ +

Start time (abs) seconds. Default now.

+ +
+
+
+
+

+ #number + interval +

+
+
+ +

Interval in seconds after the last transmission finished.

+ +
+
+
+
+

+ #table + subgroups +

+
+
+ +

Groups that should receive the subtiltle.

+ +
+
+
+
+

+ #string + subtitle +

+
+
+ +

Subtitle displayed when the message is played.

+ +
+
+
+
+

+ #number + subduration +

+
+
+ +

Duration [sec] of the subtitle being displayed. Default 5 sec.

+ +
+
+
+
+

+ #number + frequency +

+
+
+ +

Radio frequency if other than MSRS default.

+ +
+
+
+
+

+ #number + modulation +

+
+
+ +

Radio modulation if other then MSRS default.

+ +
+
+

Return value:

+
+
+

#MSRSQUEUE.Transmission:

+
+
+ +

Radio transmission table.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:_CheckRadioQueue(delay)

+
+ +

Check radio queue for transmissions to be broadcasted.

+ +
+
+

Defined in:

+
+

MSRSQUEUE

+
+

Parameter:

+
+
+

+ #number + delay +

+
+
+ +

Delay in seconds before checking.

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + #string +MSRSQUEUE.ClassName + +

Name of the class "MSRSQUEUE".

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Tlast + +

Time (abs) when the last transmission finished.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.alias + +

Name of the radio queue.

+ +
+ +
+
+
+ + #boolean +MSRSQUEUE.checking + +

If true, the queue update function is scheduled to be called again.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.dt + +

Time interval in seconds for checking the radio queue.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.lid + +

ID for dcs.log.

+ +
+ +
+
+
+ + #table +MSRSQUEUE.queue + +

The queue of transmissions.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

MSRSQUEUE:ClearState(Object, StateName)

+
+ +

Clear the state of an object.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ StateName +

+
+
+ +

The key that is should be cleared.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

+
+ +

Creation of a Birth Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ #string + IniUnitName +

+
+
+ +

The initiating unit name.

+ +
+
+
+
+

+ place +

+
+
+

+
+
+
+
+

+ subplace +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

+
+ +

Creation of a Crash Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ IniObjectCategory +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventDead(EventTime, Initiator)

+
+ +

Creation of a Dead Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventPlayerEnterAircraft(PlayerUnit)

+
+ +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Wrapper.Unit#UNIT + PlayerUnit +

+
+
+ +

The aircraft unit the player entered.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventRemoveUnit(EventTime, Initiator)

+
+ +

Creation of a Remove Unit Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:CreateEventTakeoff(EventTime, Initiator)

+
+ +

Creation of a Takeoff Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:E(Arguments)

+
+ +

Log an exception which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:F(Arguments)

+
+ +

Trace a function call.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:F2(Arguments)

+
+ +

Trace a function call level 2.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:F3(Arguments)

+
+ +

Trace a function call level 3.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetClassNameAndID()

+
+ +

Get the ClassName + ClassID of the class instance.

+ + +

The ClassName + ClassID is formatted as '%s#%09d'.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName + ClassID of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetEventPriority()

+
+ +

Get the Class Event processing Priority.

+ + +

The Event processing Priority is a number from 1 to 10, +reflecting the order of the classes subscribed to the Event to be processed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The Event processing Priority.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetParent(Child, FromClass)

+
+ +

This is the worker method to retrieve the Parent class.

+ + +

Note that the Parent class must be passed to call the parent class method.

+ +
self:GetParent(self):ParentMethod()
+
+ + + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #BASE + Child +

+
+
+ +

This is the Child class from which the Parent class needs to be retrieved.

+ +
+
+
+
+

+ #BASE + FromClass +

+
+
+ +

(Optional) The class from which to get the parent.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:GetState(Object, Key)

+
+ +

Get a Value given a Key from the Object.

+ + +

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ Key +

+
+
+ +

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

+ +
+
+

Return value:

+
+
+
+
+ +

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:HandleEvent(EventID, EventFunction)

+
+ +

Subscribe to a DCS Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+
+
+

+ #function + EventFunction +

+
+
+ +

(optional) The function to be called when the event occurs for the unit.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:I(Arguments)

+
+ +

Log an information which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:Inherit(Child, Parent)

+
+ +

This is the worker method to inherit from a parent class.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Child +

+
+
+ +

is the Child class that inherits.

+ +
+
+
+
+

+ #BASE + Parent +

+
+
+ +

is the Parent class that the Child inherits from.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

Child

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:IsInstanceOf(ClassName)

+
+ +

This is the worker method to check if an object is an (sub)instance of a class.

+ + + +

Examples:

+ +
    +

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

    • +

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ ClassName +

+
+
+ +

is the name of the class or the class itself to run the check against

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:New()

+
+ +

BASE constructor.

+ + + +

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

+ +
function EVENT:New()
+  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
+  return self
+end
+
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEvent(EventData)

+
+ +

Occurs when an object is completely destroyed.

+ + +

initiator : The unit that is was destroyed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventBDA(EventData)

+
+ +

BDA.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventBaseCaptured(EventData)

+
+ +

Occurs when a ground unit captures either an airbase or a farp.

+ + +

initiator : The unit that captured the base. +place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventBirth(EventData)

+
+ +

Occurs when any object is spawned into the mission.

+ + +

initiator : The unit that was spawned.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventCrash(EventData)

+
+ +

Occurs when any aircraft crashes into the ground and is completely destroyed.

+ + +

initiator : The unit that has crashed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventDead(EventData)

+
+ +

Occurs when an object is dead.

+ + +

initiator : The unit that is dead.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventDetailedFailure(EventData)

+
+ +

Unknown precisely what creates this event, likely tied into newer damage model.

+ + +

Will update this page when new information become available.

+ +
    +
  • initiator: The unit that had the failure.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventDiscardChairAfterEjection(EventData)

+
+ +

Discard chair after ejection.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventEjection(EventData)

+
+ +

Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventEngineShutdown(EventData)

+
+ +

Occurs when any aircraft shuts down its engines.

+ + +

initiator : The unit that is stopping its engines..

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventEngineStartup(EventData)

+
+ +

Occurs when any aircraft starts its engines.

+ + +

initiator : The unit that is starting its engines..

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventHit(EventData)

+
+ +

Occurs whenever an object is hit by a weapon.

+ + +

initiator : The unit object the fired the weapon. +weapon: Weapon object that hit the target. +target: The Object that was hit.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventHumanFailure(EventData)

+
+ +

Occurs when any system fails on a human controlled aircraft.

+ + +

initiator : The unit that had the failure.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventKill(EventData)

+
+ +

Occurs on the death of a unit.

+ + +

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.

+ +
    +
  • initiator: The unit that killed the target.
    • +
  • target: Target Object
    • +
  • weapon: Weapon Object
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventLand(EventData)

+
+ +

Occurs when an aircraft lands at an airbase, farp or ship +initiator : The unit that has landed.

+ + +

place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventLandingAfterEjection(EventData)

+
+ +

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

+ + +

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.

+ +
    +
  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
    • +
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
    • +
  • subplace: is always 0 for unknown reasons.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventLandingQualityMark(EventData)

+
+ +

Landing quality mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventMarkAdded(EventData)

+
+ +

Occurs when a new mark was added.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventMarkChange(EventData)

+
+ +

Occurs when a mark text was changed.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventMarkRemoved(EventData)

+
+ +

Occurs when a mark was removed.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventMissionEnd(EventData)

+
+ +

Occurs when a mission ends.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventMissionStart(EventData)

+
+ +

Occurs when a mission starts.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventParatrooperLanding(EventData)

+
+ +

Weapon add.

+ + +

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventPilotDead(EventData)

+
+ +

Occurs when the pilot of an aircraft is killed.

+ + +

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. +initiator : The unit that the pilot has died in.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventPlayerEnterAircraft(EventData)

+
+ +

Occurs when a player enters a slot and takes control of an aircraft.

+ + +

NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. +initiator : The unit that is being taken control of.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventPlayerEnterUnit(EventData)

+
+ +

Occurs when any player assumes direct control of a unit.

+ + +

initiator : The unit that is being taken control of.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventPlayerLeaveUnit(EventData)

+
+ +

Occurs when any player relieves control of a unit to the AI.

+ + +

initiator : The unit that the player left.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventRefueling(EventData)

+
+ +

Occurs when an aircraft connects with a tanker and begins taking on fuel.

+ + +

initiator : The unit that is receiving fuel.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventRefuelingStop(EventData)

+
+ +

Occurs when an aircraft is finished taking fuel.

+ + +

initiator : The unit that was receiving fuel.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventScore(EventData)

+
+ +

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

+ + +

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventShootingEnd(EventData)

+
+ +

Occurs when any unit stops firing its weapon.

+ + +

Event will always correspond with a shooting start event. +initiator : The unit that was doing the shooting.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventShootingStart(EventData)

+
+ +

Occurs when any unit begins firing a weapon that has a high rate of fire.

+ + +

Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. +initiator : The unit that is doing the shooting. +target: The unit that is being targeted.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventShot(EventData)

+
+ +

Occurs whenever any unit in a mission fires a weapon.

+ + +

But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventTakeoff(EventData)

+
+ +

Occurs when an aircraft takes off from an airbase, farp, or ship.

+ + +

initiator : The unit that took off. +place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventTriggerZone(EventData)

+
+ +

Trigger zone.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:OnEventUnitLost(EventData)

+
+ +

Occurs when the game thinks an object is destroyed.

+ + + +
    +
  • initiator: The unit that is was destroyed.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:ScheduleOnce(Start, SchedulerFunction, ...)

+
+ +

Schedule a new time event.

+ + +

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

+ +
+
+

Return value:

+
+
+

#number:

+
+
+ +

The ScheduleID of the planned schedule.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

+
+ +

Schedule a new time event.

+ + +

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

+ +
+
+
+
+

+ #number + Repeat +

+
+
+ +

Specifies the interval in seconds when the scheduler will call the event function.

+ +
+
+
+
+

+ #number + RandomizeFactor +

+
+
+ +

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

+ +
+
+
+
+

+ #number + Stop +

+
+
+ +

Specifies the amount of seconds when the scheduler will be stopped.

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

+ +
+
+

Return value:

+
+
+

#number:

+
+
+ +

The ScheduleID of the planned schedule.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:ScheduleStop(SchedulerFunction)

+
+ +

Stops the Schedule.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #function + SchedulerFunction +

+
+
+ +

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:SetEventPriority(EventPriority)

+
+ +

Set the Class Event processing Priority.

+ + +

The Event processing Priority is a number from 1 to 10, +reflecting the order of the classes subscribed to the Event to be processed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + EventPriority +

+
+
+ +

The Event processing Priority.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:SetState(Object, Key, Value)

+
+ +

Set a state or property of the Object given a Key and a Value.

+ + +

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that will hold the Value set by the Key.

+ +
+
+
+
+

+ Key +

+
+
+ +

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

+ +
+
+
+
+

+ Value +

+
+
+ +

The value to is stored in the object.

+ +
+
+

Return value:

+
+
+
+
+ +

The Value set.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:T(Arguments)

+
+ +

Trace a function logic level 1.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:T2(Arguments)

+
+ +

Trace a function logic level 2.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:T3(Arguments)

+
+ +

Trace a function logic level 3.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

+ +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+

+
+
+
+
+

+ #string + Method +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing Off
+BASE:TraceOff()
+ +
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing On
+BASE:TraceOn()
+ +
+ +
+
+ +
+ +
+

MSRSQUEUE:TraceOnOff(TraceOnOff)

+
+ +

Set trace on or off +Note that when trace is off, no BASE.Debug statement is performed, increasing performance! +When Moose is loaded statically, (as one file), tracing is switched off by default.

+ + +

So tracing must be switched on manually in your mission if you are using Moose statically. +When moose is loading dynamically (for moose class development), tracing is switched on by default.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceOnOff +

+
+
+ +

Switch the tracing on or off.

+ +
+
+

Usage:

+ 

+  -- Switch the tracing On
+  BASE:TraceOnOff( true )
+
+  -- Switch the tracing Off
+  BASE:TraceOnOff( false )
+
+ +
+ +
+
+ +
+ +
+

MSRSQUEUE:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function call.

+ + +

This function is private.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MSRSQUEUE:onEvent(event)

+
+ + + + +

TODO: Complete DCS#Event structure. +- The main event handling function... This function captures all events generated for the class. + @param #BASE self + @param DCS#Event event

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ event +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

Type MSRSQUEUE.Transmission

+
+
+ +

Radio queue transmission data.

+ +
+

Field(s)

+
+
+
+ + #number +MSRSQUEUE.Transmission.Tplay + +

Mission time (abs) in seconds when the transmission should be played.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.Tstarted + +

Mission time (abs) in seconds when the transmission started.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.duration + +

Duration in seconds.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.frequency + +

Frequency.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.interval + +

Interval in seconds before next transmission.

+ +
+ +
+
+
+ + #boolean +MSRSQUEUE.Transmission.isplaying + +

If true, transmission is currently playing.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.modulation + +

Modulation.

+ +
+ +
+
+
+ + Sound.SRS#MSRS +MSRSQUEUE.Transmission.msrs + +

MOOSE SRS object.

+ +
+ +
+
+
+ + #number +MSRSQUEUE.Transmission.subduration + +

Duration of the subtitle being displayed.

+ +
+ +
+
+
+ + #table +MSRSQUEUE.Transmission.subgroups + +

Groups to send subtitle to.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.Transmission.subtitle + +

Subtitle of the transmission.

+ +
+ +
+
+
+ + #string +MSRSQUEUE.Transmission.text + +

Text to be transmitted.

+ +
+ +
+
+

Function(s)

+
diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index 75217c0a1..2995d3cbe 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2831,17 +2831,6 @@ but can separately be modified later in your mission using the - - - -
-
- - -TASK.TaskControlMenu - - -
@@ -7478,17 +7467,6 @@ 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 924246e8a..a6661be53 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3124,7 +3124,7 @@ based on the tasking capabilities defined in
- + Cargo.Cargo#CARGO FSM_PROCESS.Cargo diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index e88d898b2..edefbeeee 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3156,7 +3156,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4279,7 +4279,7 @@ This method can only be used once!

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

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

- #table + TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Utils.FiFo.html b/Documentation/Utils.FiFo.html index 170fffb6c..721769430 100644 --- a/Documentation/Utils.FiFo.html +++ b/Documentation/Utils.FiFo.html @@ -3136,17 +3136,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #number -FIFO.uniquecounter - - -
@@ -3996,17 +3985,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #number -FIFO.uniquecounter - - -
diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index a50fb7999..55123ea1d 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2996,6 +2996,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +MARKER.tocoalition + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +
@@ -5080,6 +5102,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +MARKER.tocoalition + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +
@@ -6672,6 +6716,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + #boolean +MARKER.tocoalition + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +