From 9e8e517d3d046785983de84d8aa2f78288d0f047 Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Tue, 8 Feb 2022 06:58:39 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2G_Dispatcher.html | 44 - Documentation/AI.AI_AIR_Dispatcher.html | 44 - Documentation/AI.AI_Air.html | 44 - Documentation/AI.AI_Air_Squadron.html | 22 - Documentation/AI.AI_Cargo.html | 12 - Documentation/AI.AI_Cargo_Airplane.html | 56 +- Documentation/AI.AI_Patrol.html | 12 + Documentation/Cargo.CargoGroup.html | 56 +- Documentation/Cargo.CargoUnit.html | 22 - Documentation/Core.Point.html | 33 - Documentation/Core.Settings.html | 8 +- Documentation/Core.Spawn.html | 66 - Documentation/Core.SpawnStatic.html | 84 + Documentation/Core.Spot.html | 99 - Documentation/Functional.Detection.html | 99 + Documentation/Functional.Mantis.html | 6 + Documentation/Functional.Range.html | 12 +- Documentation/Functional.Rat.html | 39 - Documentation/Ops.Airboss.html | 100 +- Documentation/Ops.CSAR.html | 25 +- Documentation/Ops.CTLD.html | 4475 +++-------------------- Documentation/Tasking.Task.html | 22 + Documentation/Wrapper.Marker.html | 72 +- 23 files changed, 788 insertions(+), 4664 deletions(-) diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 2bf247784..959d4ed2b 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4659,17 +4659,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 - - -
@@ -13104,17 +13093,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -16066,17 +16033,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_Dispatcher.html b/Documentation/AI.AI_AIR_Dispatcher.html index b2641ffc8..30bb524cf 100644 --- a/Documentation/AI.AI_AIR_Dispatcher.html +++ b/Documentation/AI.AI_AIR_Dispatcher.html @@ -4437,17 +4437,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -9745,17 +9734,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -11073,17 +11051,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -12707,17 +12674,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 159977bc1..8396e6637 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -2934,17 +2934,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -5689,17 +5678,6 @@ Once the time is finished, the old AI will return to the base.

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

- - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -8053,17 +8020,6 @@ 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 fc1f0f648..0d4013861 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2437,17 +2437,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
@@ -3519,17 +3508,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index 3802dd9c7..9d5e82608 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2671,9 +2671,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.

- @@ -4704,9 +4701,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.

- @@ -5319,9 +5313,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.

- @@ -6826,9 +6817,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 42f867d10..d5c13b2bd 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2620,6 +2620,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + +
+ +
@@ -2675,9 +2686,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + +
+ +
@@ -4451,9 +4470,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + +
+ +
@@ -5069,9 +5096,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + +
+ +
@@ -6579,9 +6614,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

+ diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index f82ea5469..3e9bd798b 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1820,6 +1820,20 @@ Controls a network of short range air/missile defense groups.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

+ +
+ + +
+
+ + CARGO_GROUP.CargoGroup @@ -1838,20 +1852,6 @@ Controls a network of short range air/missile defense groups.

-
- -
-
-
- - -CARGO_GROUP.CargoObject - - - - -

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

-
@@ -3141,6 +3141,20 @@ This works for ground only groups.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

+ +
+ + +
+
+ + CARGO_GROUP.CargoGroup @@ -3159,20 +3173,6 @@ This works for ground only groups.

-
- -
-
-
- - -CARGO_GROUP.CargoObject - - - - -

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

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

Set cargo object.

- - - -
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2453,17 +2442,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 eee73c591..a8e97dfba 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -17091,17 +17091,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

the y coordinate in meters.

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

the y coordinate in meters.

- - - -
-
- - -POINT_VEC2.z - - -
@@ -26037,17 +26015,6 @@ 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 2b8856ff5..d673618b1 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2725,7 +2725,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2GSystem @@ -2769,7 +2769,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric @@ -4830,7 +4830,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2GSystem @@ -4874,7 +4874,7 @@ It is advised to use this method at the start of the mission.

- #boolean + SETTINGS.Metric diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 2e4cee68f..a00aa6509 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -3454,17 +3454,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.SpawnGrouping - - -
@@ -3617,17 +3606,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

By default, no InitLimit

-
- -
-
-
- - -SPAWN.SpawnInitModu - - -
@@ -3819,17 +3797,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -8833,17 +8800,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

By default, no InitLimit

-
- - -
-
- - -SPAWN.SpawnInitModu - - -
@@ -9198,17 +9143,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - #boolean -SPAWN.SpawnUnControlled - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 77e8446f4..d6ae8cb0f 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1865,6 +1865,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

+ + @@ -2771,6 +2789,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
@@ -3992,6 +4043,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 41988fee0..a09822339 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2669,39 +2669,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - -
@@ -3915,39 +3882,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - -
@@ -5452,39 +5386,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.Detection.html b/Documentation/Functional.Detection.html index 903a03706..f48c71976 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18890,6 +18890,28 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -19033,6 +19055,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -23581,6 +23614,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -23724,6 +23779,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -25327,6 +25393,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -25470,6 +25558,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 20e252425..5ac6964ed 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -3334,6 +3334,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

switch alarm state RED

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

switch alarm state RED

+ diff --git a/Documentation/Functional.Range.html b/Documentation/Functional.Range.html index 6086c2553..5c100056d 100644 --- a/Documentation/Functional.Range.html +++ b/Documentation/Functional.Range.html @@ -15692,13 +15692,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
- #number + RANGE.BombResult.roundsFired -

Rangeboss Edit

+

RANGEBOSS

@@ -15706,13 +15706,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
- #number + RANGE.BombResult.roundsHit -

Rangeboss Edit

+

RANGEBOSS

@@ -15720,13 +15720,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
- #string + RANGE.BombResult.roundsQuality -

Rangeboss Edit

+

RANGEBOSS

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

RAT.termtype

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

- - - -

RAT.type

- - @@ -6694,17 +6688,6 @@ 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,17 +14568,6 @@ Initializes the ratcraft array and group menu.

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

-
- - -
-
- - -RAT.type - - -
@@ -20557,17 +20529,6 @@ 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 79cdbb2fa..09675d954 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -9207,17 +9207,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

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

Radio queue of marshal.

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

Radio queue of LSO.

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

Radio queue of marshal.

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

Radio queue of LSO.

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

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -38749,6 +38683,9 @@ When moose is loading dynamically (for moose class development), tracing is swit + +

Set case to that of lead.

+ @@ -38806,20 +38743,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -
-
- - -AIRBOSS.PlayerData.flag - - - - -

Set stack flag.

- -
-
@@ -38829,17 +38752,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 - - -
@@ -38975,9 +38887,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

Make player section lead if he was not before.

- @@ -39033,9 +38942,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 69c24bef9..d9356c911 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -3546,7 +3546,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.FreeVHFFrequencies @@ -3635,11 +3635,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.allheligroupset + +

GROUP_SET of all helis

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

Name of the zone.

+

Name of the zone. Can also be passed as a (normal, round) ZONE object.

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

Name of the zone.

+

Name of the zone. Can also be passed as a (normal, round) ZONE object.

@@ -8307,7 +8310,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.FreeVHFFrequencies @@ -8396,11 +8399,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.allheligroupset + +

GROUP_SET of all helis

+
@@ -10587,7 +10593,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.FreeVHFFrequencies @@ -10676,11 +10682,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.allheligroupset + +

GROUP_SET of all helis

+
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index 5fc35007c..475757b7f 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -1676,6 +1676,7 @@ Create the late-activated troops, vehicles, that will make up your deployable fo my_ctld.FlareColor = FLARECOLOR.Red -- color to use when flaring from heli my_ctld.basetype = "container_cargo" -- default shape of the cargo container my_ctld.droppedbeacontimeout = 600 -- dropped beacon lasts 10 minutes + my_ctld.usesubcats = false -- use sub-category names for crates, adds an extra menu layer in "Get Crates", useful if you have > 10 crate types.

2.1 User functions

@@ -2016,17 +2017,23 @@ If you use units build by multiple templates, they will effectively double on lo

CTLD:AddCTLDZone(Name, Type, Color, Active, HasBeacon, Shiplength, Shipwidth)

-

User function - Crates and adds a #CTLD.CargoZone zone for this CTLD instance.

+

User function - Creates and adds a #CTLD.CargoZone zone for this CTLD instance.

-

CTLD:AddCratesCargo(Name, Templates, Type, NoCrates, PerCrateMass, Stock)

+

CTLD:AddCTLDZoneFromAirbase(AirbaseName, Type, Color, Active, HasBeacon)

+ +

User function - Creates and adds a #CTLD.CargoZone zone for this CTLD instance from an Airbase or FARP name.

+ + + +

CTLD:AddCratesCargo(Name, Templates, Type, NoCrates, PerCrateMass, Stock, SubCategory)

User function - Add generic crate-type loadable as cargo.

-

CTLD:AddCratesRepair(Name, Template, Type, NoCrates, PerCrateMass, Stock)

+

CTLD:AddCratesRepair(Name, Template, Type, NoCrates, PerCrateMass, Stock, SubCategory)

User function - Add generic repair crates loadable as cargo.

@@ -2509,6 +2516,12 @@ If you use units build by multiple templates, they will effectively double on lo

CTLD.Stock

+ + + +

CTLD.Subcategory

+ + @@ -3091,6 +3104,12 @@ If you use units build by multiple templates, they will effectively double on lo

CTLD.smokedistance

+ + + +

CTLD.subcats

+ + @@ -3103,6 +3122,12 @@ If you use units build by multiple templates, they will effectively double on lo

CTLD.useprefix

+ + + +

CTLD.usesubcats

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

CTLD_CARGO.CargoType

Enumerator of Type.

+ + + +

CTLD_CARGO.ClassName

+ +

Class name.

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

CTLD_CARGO.PerCrateMass

-

Mass in kg

+

Mass in kg.

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

CTLD_CARGO.Stock

-

Number of builds available, -1 for unlimited

+

Number of builds available, -1 for unlimited.

+ + + +

CTLD_CARGO.Subcategory

+ +

Sub-category name.

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

CTLD_CARGO:onEvent(event)

- - - -
- -

Type CTLD_CARGO.Enum

-
- CTLD_CARGO.Enum -
-
- - - - - - - -
Fields and Methods inherited from CTLD_CARGO.EnumDescription

CTLD_CARGO.Enum.Type

 -

Type of Cargo.
@@ -4922,7 +4940,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Type CTLD_ENGINEERING

CTLD_ENGINEERING -, extends Core.Base#BASE
@@ -4940,12 +4957,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - - @@ -5072,534 +5083,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

CTLD_ENGINEERING:Build()

(Internal) Set build status.

-

CTLD_ENGINEERING.ClassName

 -

CTLD_ENGINEERING.marktimer

 -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from BASEDescription

CTLD_ENGINEERING.ClassID

 -

The ID number of the class.

-

CTLD_ENGINEERING.ClassName

 -

The name of the class.

-

CTLD_ENGINEERING.ClassNameAndID

 -

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

-

CTLD_ENGINEERING:ClearState(Object, StateName)

 -

Clear the state of an object.

-

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

 -

Creation of a Birth Event.

-

CTLD_ENGINEERING:CreateEventCrash(EventTime, Initiator)

 -

Creation of a Crash Event.

-

CTLD_ENGINEERING:CreateEventDead(EventTime, Initiator)

 -

Creation of a Dead Event.

-

CTLD_ENGINEERING:CreateEventPlayerEnterAircraft(PlayerUnit)

 -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

-

CTLD_ENGINEERING:CreateEventRemoveUnit(EventTime, Initiator)

 -

Creation of a Remove Unit Event.

-

CTLD_ENGINEERING:CreateEventTakeoff(EventTime, Initiator)

 -

Creation of a Takeoff Event.

-

CTLD_ENGINEERING:E(Arguments)

 -

Log an exception which will be traced always.

-

CTLD_ENGINEERING:EventDispatcher()

 -

Returns the event dispatcher

-

CTLD_ENGINEERING:EventRemoveAll()

 -

Remove all subscribed events

-

CTLD_ENGINEERING:F(Arguments)

 -

Trace a function call.

-

CTLD_ENGINEERING:F2(Arguments)

 -

Trace a function call level 2.

-

CTLD_ENGINEERING:F3(Arguments)

 -

Trace a function call level 3.

-

CTLD_ENGINEERING:GetClassID()

 -

Get the ClassID of the class instance.

-

CTLD_ENGINEERING:GetClassName()

 -

Get the ClassName of the class instance.

-

CTLD_ENGINEERING:GetClassNameAndID()

 -

Get the ClassName + ClassID of the class instance.

-

CTLD_ENGINEERING:GetEventPriority()

 -

Get the Class Event processing Priority.

-

CTLD_ENGINEERING:GetParent(Child, FromClass)

 -

This is the worker method to retrieve the Parent class.

-

CTLD_ENGINEERING:GetState(Object, Key)

 -

Get a Value given a Key from the Object.

-

CTLD_ENGINEERING:HandleEvent(EventID, EventFunction)

 -

Subscribe to a DCS Event.

-

CTLD_ENGINEERING:I(Arguments)

 -

Log an information which will be traced always.

-

CTLD_ENGINEERING:Inherit(Child, Parent)

 -

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

-

CTLD_ENGINEERING:IsInstanceOf(ClassName)

 -

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

-

CTLD_ENGINEERING:IsTrace()

 -

Enquires if tracing is on (for the class).

-

CTLD_ENGINEERING:New()

 -

BASE constructor.

-

CTLD_ENGINEERING:OnEvent(EventData)

 -

Occurs when an object is completely destroyed.

-

CTLD_ENGINEERING:OnEventBDA(EventData)

 -

BDA.

-

CTLD_ENGINEERING:OnEventBaseCaptured(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventBirth(EventData)

 -

Occurs when any object is spawned into the mission.

-

CTLD_ENGINEERING:OnEventCrash(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventDead(EventData)

 -

Occurs when an object is dead.

-

CTLD_ENGINEERING:OnEventDetailedFailure(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventDiscardChairAfterEjection(EventData)

 -

Discard chair after ejection.

-

CTLD_ENGINEERING:OnEventEjection(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventEngineShutdown(EventData)

 -

Occurs when any aircraft shuts down its engines.

-

CTLD_ENGINEERING:OnEventEngineStartup(EventData)

 -

Occurs when any aircraft starts its engines.

-

CTLD_ENGINEERING:OnEventHit(EventData)

 -

Occurs whenever an object is hit by a weapon.

-

CTLD_ENGINEERING:OnEventHumanFailure(EventData)

 -

Occurs when any system fails on a human controlled aircraft.

-

CTLD_ENGINEERING:OnEventKill(EventData)

 -

Occurs on the death of a unit.

-

CTLD_ENGINEERING:OnEventLand(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventLandingAfterEjection(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventLandingQualityMark(EventData)

 -

Landing quality mark.

-

CTLD_ENGINEERING:OnEventMarkAdded(EventData)

 -

Occurs when a new mark was added.

-

CTLD_ENGINEERING:OnEventMarkChange(EventData)

 -

Occurs when a mark text was changed.

-

CTLD_ENGINEERING:OnEventMarkRemoved(EventData)

 -

Occurs when a mark was removed.

-

CTLD_ENGINEERING:OnEventMissionEnd(EventData)

 -

Occurs when a mission ends.

-

CTLD_ENGINEERING:OnEventMissionStart(EventData)

 -

Occurs when a mission starts.

-

CTLD_ENGINEERING:OnEventParatrooperLanding(EventData)

 -

Weapon add.

-

CTLD_ENGINEERING:OnEventPilotDead(EventData)

 -

Occurs when the pilot of an aircraft is killed.

-

CTLD_ENGINEERING:OnEventPlayerEnterAircraft(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventPlayerEnterUnit(EventData)

 -

Occurs when any player assumes direct control of a unit.

-

CTLD_ENGINEERING:OnEventPlayerLeaveUnit(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventRefueling(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventRefuelingStop(EventData)

 -

Occurs when an aircraft is finished taking fuel.

-

CTLD_ENGINEERING:OnEventScore(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventShootingEnd(EventData)

 -

Occurs when any unit stops firing its weapon.

-

CTLD_ENGINEERING:OnEventShootingStart(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventShot(EventData)

 -

Occurs whenever any unit in a mission fires a weapon.

-

CTLD_ENGINEERING:OnEventTakeoff(EventData)

 -

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

-

CTLD_ENGINEERING:OnEventTriggerZone(EventData)

 -

Trigger zone.

-

CTLD_ENGINEERING:OnEventUnitLost(EventData)

 -

Occurs when the game thinks an object is destroyed.

-

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

 -

Schedule a new time event.

-

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

 -

Schedule a new time event.

-

CTLD_ENGINEERING:ScheduleStop(SchedulerFunction)

 -

Stops the Schedule.

-

CTLD_ENGINEERING.Scheduler

 - -

CTLD_ENGINEERING:SetEventPriority(EventPriority)

 -

Set the Class Event processing Priority.

-

CTLD_ENGINEERING:SetState(Object, Key, Value)

 -

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

-

CTLD_ENGINEERING:T(Arguments)

 -

Trace a function logic level 1.

-

CTLD_ENGINEERING:T2(Arguments)

 -

Trace a function logic level 2.

-

CTLD_ENGINEERING:T3(Arguments)

 -

Trace a function logic level 3.

-

CTLD_ENGINEERING:TraceAll(TraceAll)

 -

Trace all methods in MOOSE

-

CTLD_ENGINEERING:TraceClass(Class)

 -

Set tracing for a class

-

CTLD_ENGINEERING:TraceClassMethod(Class, Method)

 -

Set tracing for a specific method of class

-

CTLD_ENGINEERING:TraceLevel(Level)

 -

Set trace level

-

CTLD_ENGINEERING:TraceOff()

 -

Set trace off.

-

CTLD_ENGINEERING:TraceOn()

 -

Set trace on.

-

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

-

CTLD_ENGINEERING:UnHandleEvent(EventID)

 -

UnSubscribe to a DCS event.

-

CTLD_ENGINEERING._

 - -

CTLD_ENGINEERING:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function call.

-

CTLD_ENGINEERING:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function logic.

-

CTLD_ENGINEERING.__

 - -

CTLD_ENGINEERING:onEvent(event)

 -
@@ -6939,7 +6422,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -6964,11 +6447,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ #number +CTLD.Engineers + + + +

use as counter

+ +
+ +
+
+
+ + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -7011,7 +6511,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -7027,6 +6527,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Beacons

+
@@ -7152,11 +6655,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.PilotGroups + +

tables

+
@@ -7240,6 +6746,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #number +CTLD.TroopCounter + + +
@@ -7384,6 +6901,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

#1570

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

noob catch

+

time to repair a unit/group

@@ -7636,6 +7164,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #table +CTLD.subcats + + +
@@ -7666,6 +7205,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
+
+ + #boolean +CTLD.usesubcats + + + + +

sub categories

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

CTLD:AddCTLDZone(Name, Type, Color, Active, HasBeacon, Shiplength, Shipwidth)

-

User function - Crates and adds a #CTLD.CargoZone zone for this CTLD instance.

+

User function - Creates and adds a #CTLD.CargoZone zone for this CTLD instance.

Zones of type LOAD: Players load crates and troops here.
@@ -7892,7 +7445,108 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

-

CTLD:AddCratesCargo(Name, Templates, Type, NoCrates, PerCrateMass, Stock)

+

CTLD:AddCTLDZoneFromAirbase(AirbaseName, Type, Color, Active, HasBeacon)

+
+ +

User function - Creates and adds a #CTLD.CargoZone zone for this CTLD instance from an Airbase or FARP name.

+ + +

Zones of type LOAD: Players load crates and troops here.
+ Zones of type DROP: Players can drop crates here. Note that troops can be unloaded anywhere.
+ Zone of type MOVE: Dropped troops and vehicles will start moving to the nearest zone of this type (also see options).

+ +
+
+

Defined in:

+
+

CTLD

+
+

Parameters:

+
+
+

+ #string + AirbaseName +

+
+
+ +

Name of the Airbase, can be e.g. AIRBASE.Caucasus.Beslan or "Beslan". For FARPs, this will be the UNIT name.

+ +
+
+
+
+

+ #string + Type +

+
+
+ +

Type of this zone, #CTLD.CargoZoneType

+ +
+
+
+
+

+ #number + Color +

+
+
+ +

Smoke/Flare color e.g. #SMOKECOLOR.Red

+ +
+
+
+
+

+ #string + Active +

+
+
+ +

Is this zone currently active?

+ +
+
+
+
+

+ #string + HasBeacon +

+
+
+ +

Does this zone have a beacon if it is active?

+ +
+
+

Return value:

+
+
+

#CTLD:

+
+
+ +

self

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

CTLD:AddCratesCargo(Name, Templates, Type, NoCrates, PerCrateMass, Stock, SubCategory)

User function - Add generic crate-type loadable as cargo.

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

Number of groups in stock. Nil for unlimited.

+
+
+
+
+

+ #string + SubCategory +

+
+
+ +

Name of sub-category (optional).

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

CTLD:AddCratesRepair(Name, Template, Type, NoCrates, PerCrateMass, Stock)

+

CTLD:AddCratesRepair(Name, Template, Type, NoCrates, PerCrateMass, Stock, SubCategory)

User function - Add generic repair crates loadable as cargo.

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

Number of groups in stock. Nil for unlimited.

+
+ +
+
+

+ #string + SubCategory +

+
+
+ +

Name of the sub-category (optional).

+
@@ -14251,7 +13931,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -14276,11 +13956,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ #number +CTLD.Engineers + + + +

use as counter

+ +
+ +
+
+
+ + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -14323,7 +14020,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -14339,6 +14036,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Beacons

+
@@ -14464,11 +14164,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.PilotGroups + +

tables

+
@@ -14552,6 +14255,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #number +CTLD.TroopCounter + + +
@@ -14696,6 +14410,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

#1570

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

noob catch

+

time to repair a unit/group

@@ -14948,6 +14673,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #table +CTLD.subcats + + +
@@ -14978,6 +14714,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
+
+ + #boolean +CTLD.usesubcats + + + + +

sub categories

+ +
+
@@ -16580,7 +16330,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -16605,11 +16355,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ #number +CTLD.Engineers + + + +

use as counter

+ +
+ +
+
+
+ + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -16652,7 +16419,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -16668,6 +16435,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Beacons

+
@@ -16793,11 +16563,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.PilotGroups + +

tables

+
@@ -16881,6 +16654,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #number +CTLD.TroopCounter + + +
@@ -17025,6 +16809,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

#1570

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

noob catch

+

time to repair a unit/group

@@ -17277,6 +17072,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #table +CTLD.subcats + + +
@@ -17307,6 +17113,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
+
+ + #boolean +CTLD.usesubcats + + + + +

sub categories

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

Can transport crate.

+
+ +
+
+
+ + #number +CTLD.UnitCapabilities.length + + +
@@ -21192,6 +21023,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + +
+
+ + #string +CTLD_CARGO.ClassName + +

Class name.

+ +
+
@@ -21265,7 +21107,7 @@ When moose is loading dynamically (for moose class development), tracing is swit #number CTLD_CARGO.PerCrateMass -

Mass in kg

+

Mass in kg.

@@ -21287,7 +21129,18 @@ When moose is loading dynamically (for moose class development), tracing is swit #number CTLD_CARGO.Stock -

Number of builds available, -1 for unlimited

+

Number of builds available, -1 for unlimited.

+ +
+ + +
+
+ + #string +CTLD_CARGO.Subcategory + +

Sub-category name.

@@ -21319,6 +21172,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
+ +
+
+ + #string +CTLD_CARGO.ClassName + +

Class name.

+ +
+
@@ -21392,7 +21256,7 @@ When moose is loading dynamically (for moose class development), tracing is swit #number CTLD_CARGO.PerCrateMass -

Mass in kg

+

Mass in kg.

@@ -21414,7 +21278,18 @@ When moose is loading dynamically (for moose class development), tracing is swit #number CTLD_CARGO.Stock -

Number of builds available, -1 for unlimited

+

Number of builds available, -1 for unlimited.

+ +
+ + +
+
+ + #string +CTLD_CARGO.Subcategory + +

Sub-category name.

@@ -24664,57 +24539,15 @@ When moose is loading dynamically (for moose class development), tracing is swit
- - - -

Type CTLD_CARGO.Enum

-
-
- -

Define cargo types.

- -
-

Field(s)

-
-
-
- - #string -CTLD_CARGO.Enum.Type - -

Type of Cargo.

- -
- -
-
-

Function(s)

-

Type CTLD_ENGINEERING

- -
    -
  • CTLD_ENGINEERING class, extends Core.Base#BASE
    • -
-

Field(s)

-
-
- - #string -CTLD_ENGINEERING.ClassName - - - -
- -
@@ -24745,6 +24578,9 @@ When moose is loading dynamically (for moose class development), tracing is swit + +

self.distance = Distance or UTILS.NMToMeters(1)

+
@@ -24762,7 +24598,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
- #string + CTLD_ENGINEERING.State @@ -24778,6 +24614,9 @@ When moose is loading dynamically (for moose class development), tracing is swit + +

self.C_Ops = C_Ops -- Ops.CTLD#CTLD

+
@@ -24795,18 +24634,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
- Core.Point#COORDINATE -CTLD_ENGINEERING.currwpt - - -
- -
-
-
- - #string CTLD_ENGINEERING.lid @@ -25365,3367 +25193,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-
-

Field(s)

-
-
-
- - #string -CTLD_ENGINEERING.ClassName - - - -
- -
-
-
- - Wrapper.Group#GROUP -CTLD_ENGINEERING.Group - - - -
- -
-
-
- - Wrapper.Group#GROUP -CTLD_ENGINEERING.HeliGroup - - - -
- -
-
-
- - Wrapper.Unit#UNIT -CTLD_ENGINEERING.HeliUnit - - - -
- -
-
-
- - #string -CTLD_ENGINEERING.Name - - - -
- -
-
-
- - #string -CTLD_ENGINEERING.State - - - -
- -
-
-
- - Wrapper.Unit#UNIT -CTLD_ENGINEERING.Unit - - - -
- -
-
-
- - #string -CTLD_ENGINEERING.Version - - - -
- -
-
-
- - Core.Point#COORDINATE -CTLD_ENGINEERING.currwpt - - - -
- -
-
-
- - #string -CTLD_ENGINEERING.lid - - - -
- -
-
-
- - #number -CTLD_ENGINEERING.marktimer - - - - -

wait this many secs before trying a crate again

- -
- -
-
-

Function(s)

-
-
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING: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 -

-
-
-

-
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:CreateEventCrash(EventTime, Initiator)

-
- -

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.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:EventDispatcher()

-
- -

Returns the event dispatcher

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

Core.Event#EVENT:

-
-
- - - -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:EventRemoveAll()

-
- -

Remove all subscribed events

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:GetClassID()

-
- -

Get the ClassID of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassID of the class instance.

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:GetClassName()

-
- -

Get the ClassName of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName of the class instance.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING: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:

-
-
- - - -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING: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:

-
-
- - - -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING: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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING: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:

-
-
- - - -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:IsTrace()

-
- -

Enquires if tracing is on (for the class).

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING: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:

-
-
- - - -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:OnEventBDA(EventData)

-
- -

BDA.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:OnEventDiscardChairAfterEjection(EventData)

-
- -

Discard chair after ejection.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:OnEventLandingQualityMark(EventData)

-
- -

Landing quality mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:OnEventMissionEnd(EventData)

-
- -

Occurs when a mission ends.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:OnEventMissionStart(EventData)

-
- -

Occurs when a mission starts.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:OnEventTriggerZone(EventData)

-
- -

Trigger zone.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING: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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:TraceAll(TraceAll)

-
- -

Trace all methods in MOOSE

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceAll -

-
-
- -

true = trace all methods in MOOSE.

- -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:TraceClass(Class)

-
- -

Set tracing for a class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - Class -

-
-
-

-
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:TraceClassMethod(Class, Method)

-
- -

Set tracing for a specific method of class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #string - Class -

-
-
-

-
-
-
-
-

- #string - Method -

-
-
-

-
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:TraceLevel(Level)

-
- -

Set trace level

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - Level -

-
-
-

-
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:TraceOff()

-
- -

Set trace off.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

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

CTLD_ENGINEERING:TraceOn()

-
- -

Set trace on.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

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

CTLD_ENGINEERING: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 )
-
- -
- -
-
- -
- -
-

CTLD_ENGINEERING:UnHandleEvent(EventID)

-
- -

UnSubscribe to a DCS event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:_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 -

-
-
-

-
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

CTLD_ENGINEERING: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 -

-
-
-

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

template for a group of 10 paratroopers

- - - -
-
- - #number -CTLD_HERCULES.j - - -
@@ -30130,17 +26586,6 @@ Expected template names are the ones in the rounded brackets.

template for a group of 10 paratroopers

- - - -
-
- - #number -CTLD_HERCULES.j - - -
diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index b008311e8..4a6038ba4 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2820,6 +2820,17 @@ but can separately be modified later in your mission using the + + + +
+
+ + +TASK.TaskControlMenu + + +
@@ -7456,6 +7467,17 @@ If the Unit is part of the Task, true is returned.

+ + + +
+
+ + +TASK.TaskControlMenu + + +
diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 29be84504..4c24760e1 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2897,28 +2897,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

- - - -
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -3003,7 +2981,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall @@ -5003,28 +4981,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- - -
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -5109,7 +5065,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall @@ -6617,28 +6573,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

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