From 49e537bc56ff6ab5f44615f83b025840b37afebb Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Wed, 16 Mar 2022 07:53:12 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2G_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_Patrol.html | 12 - Documentation/Cargo.CargoGroup.html | 6 + Documentation/Cargo.CargoUnit.html | 44 +- Documentation/Core.Settings.html | 30 +- Documentation/Core.Spawn.html | 132 +- Documentation/Core.SpawnStatic.html | 84 + Documentation/Functional.Designate.html | 55 - Documentation/Functional.Detection.html | 33 - Documentation/Functional.Mantis.html | 28 + Documentation/Functional.Rat.html | 53 +- Documentation/Ops.Airboss.html | 96 +- Documentation/Ops.CSAR.html | 102 +- Documentation/Ops.CTLD.html | 28 +- Documentation/Tasking.Task.html | 22 + .../Tasking.Task_A2A_Dispatcher.html | 8 +- .../Tasking.Task_A2G_Dispatcher.html | 20 +- Documentation/Tasking.Task_Cargo.html | 19 +- .../Tasking.Task_Cargo_Dispatcher.html | 220 - Documentation/Wrapper.Client.html | 14 +- Documentation/Wrapper.Group.html | 78 +- Documentation/Wrapper.Marker.html | 132 +- Documentation/Wrapper.Positionable.html | 44 - Documentation/Wrapper.Static.html | 9232 ++++++++++++++++- 27 files changed, 9893 insertions(+), 721 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.html b/Documentation/AI.AI_Air.html index 8396e6637..159977bc1 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -2934,6 +2934,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -5678,6 +5689,17 @@ Once the time is finished, the old AI will return to the base.

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

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

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

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

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

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

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

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

+ @@ -6817,6 +6826,9 @@ 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_Patrol.html b/Documentation/AI.AI_Patrol.html index 7e42cf341..8732f72f8 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -3136,9 +3136,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

- @@ -8772,9 +8763,6 @@ 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 21a6a6d92..f82ea5469 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1824,6 +1824,9 @@ Controls a network of short range air/missile defense groups.

+ +

Then we register the new group in the database

+ @@ -3142,6 +3145,9 @@ 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 b3c66a4d4..49aa6ed95 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1698,17 +1698,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- - -
-
- - CARGO_UNIT.CargoInAir @@ -1727,6 +1716,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

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

Set cargo object.

+
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 2b8856ff5..8f8db79f6 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,22 +2769,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric -
- -
-
-
- - -SETTINGS.PlayerMenu - - -
@@ -4830,7 +4819,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2GSystem @@ -4874,22 +4863,11 @@ 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 c54f3a3ed..528a10071 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2732,19 +2732,7 @@ and any spaces before and after the resulting name are removed.

-

SPAWN.communication

- - - - - -

SPAWN.livery_id

- - - - - -

SPAWN.skill

+

SPAWN.uncontrolled

@@ -3466,17 +3454,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.SpawnGrouping - - -
@@ -3513,6 +3490,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.SpawnInitAirbase + + +
@@ -3645,6 +3633,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -3859,7 +3858,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

When the first Spawn executes, all the Groups need to be made visible before start.

+

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

@@ -3918,29 +3917,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-SPAWN.communication - - - -
- - -
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.skill +SPAWN.uncontrolled @@ -8877,17 +8854,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

+ + +
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -9270,7 +9258,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

When the first Spawn executes, all the Groups need to be made visible before start.

+

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

@@ -9329,29 +9317,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

-SPAWN.communication - - - - - - -
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.skill +SPAWN.uncontrolled 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/Functional.Designate.html b/Documentation/Functional.Designate.html index f0b0bac3b..aeaf658fa 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3444,17 +3444,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -6623,17 +6612,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -7444,17 +7422,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -8235,17 +8202,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -9918,17 +9874,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 32d3c15ad..903a03706 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -19033,17 +19033,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -23735,17 +23724,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -25492,17 +25470,6 @@ 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..3e282e831 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -2899,6 +2899,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The #DETECTION_AREAS object for AWACS

+ + + +
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -3334,6 +3345,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

switch alarm state RED

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

The #DETECTION_AREAS object for AWACS

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

switch alarm state RED

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

RAT.termtype

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

+ + + +

RAT.type

+ + @@ -4322,19 +4328,7 @@ and any spaces before and after the resulting name are removed.

-

RAT.communication

- - - - - -

RAT.livery_id

- - - - - -

RAT.skill

+

RAT.uncontrolled

@@ -6706,6 +6700,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 + + +
@@ -14586,6 +14591,17 @@ Initializes the ratcraft array and group menu.

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

+ + + +
+
+ + +RAT.type + + +
@@ -20547,6 +20563,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

+ + + +
+
+ + +RAT.type + + +
diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 47e35640f..2533c463c 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -9207,6 +9207,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

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

Radio queue of marshal.

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

Radio queue of LSO.

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

Radio queue of marshal.

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

Radio queue of LSO.

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

Radio queue of marshal.

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

Set case of f

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

Also decrease flag for section members of flight.

+ +
+
@@ -38749,6 +38832,17 @@ 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 + + +
@@ -38940,7 +39034,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Set time stamp.

+

Set new time stamp.

diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index 353797cff..6ad8367bc 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -2285,12 +2285,6 @@ Create a late-activated single infantry unit as template in the mission editor a

CSAR.inTransitGroups

- - - -

CSAR.index

- - @@ -3668,14 +3662,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.allheligroupset - -

GROUP_SET of all helis

-
@@ -3909,11 +3900,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -4012,17 +4017,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 - - -
@@ -8466,14 +8460,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.allheligroupset - -

GROUP_SET of all helis

-
@@ -8707,11 +8698,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -8810,17 +8815,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 - - -
@@ -10757,14 +10751,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.allheligroupset - -

GROUP_SET of all helis

-
@@ -10998,11 +10989,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -11101,17 +11106,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 abceb1e70..6a4712aa3 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -6412,7 +6412,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.CtldUnits @@ -6495,7 +6495,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.FreeFMFrequencies @@ -13936,7 +13936,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.CtldUnits @@ -14019,7 +14019,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.FreeFMFrequencies @@ -16301,7 +16301,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.CtldUnits @@ -16384,7 +16384,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.FreeFMFrequencies @@ -20860,6 +20860,17 @@ When moose is loading dynamically (for moose class development), tracing is swit

Can transport crate.

+
+ +
+
+
+ + #number +CTLD.UnitCapabilities.length + + +
@@ -24546,14 +24557,11 @@ When moose is loading dynamically (for moose class development), tracing is swit
- #string + CTLD_ENGINEERING.State - -

Start State.

-
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/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index a4ec41421..0a4ca9a12 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -2813,7 +2813,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -3538,7 +3538,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -4714,7 +4714,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -6196,7 +6196,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index 3706ef23d..9d0f09a1e 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -3083,11 +3083,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -3660,11 +3663,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -4847,11 +4853,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -6340,11 +6349,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 368f270b7..9ebaf8408 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3113,22 +3113,11 @@ based on the tasking capabilities defined in
- Cargo.Cargo#CARGO + FSM_PROCESS.Cargo -
- -
-
-
- - -FSM_PROCESS.DeployZone - - -
@@ -3161,7 +3150,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4583,7 +4572,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -9115,7 +9104,7 @@ If the Unit is part of the Task, true is returned.

- #number + TASK_CARGO.CargoLimit diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 4aa82f84b..8b819c9cc 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3091,61 +3091,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- -
- - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4214,61 +4159,6 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- -
- - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5116,61 +5006,6 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- -
- - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -6653,61 +6488,6 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- -
- - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index 8d96f37fd..4b6007512 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -4231,7 +4231,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive.

+

Alive2.

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

Alive.

+

Alive2.

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

-

Alive.

+

Alive2.

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

Alive.

+

Alive2.

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

-

Alive.

+

Alive2.

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

-

Alive.

+

Alive2.

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

-

Alive.

+

Alive2.

diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 0e2851380..1a3c3b356 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -4757,7 +4757,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -8902,7 +8913,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -17444,7 +17466,18 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -21083,7 +21116,18 @@ Coordinates are dependent on the position of the maps origin.

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

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

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

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -2974,28 +2996,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Text displayed in the mark panel.

-
- -
-
-
- - #boolean -MARKER.toall - - - -
- -
-
-
- - #boolean -MARKER.tocoalition - - -
@@ -5003,6 +5003,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -5080,28 +5102,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Text displayed in the mark panel.

-
- -
-
-
- - #boolean -MARKER.toall - - - -
- -
-
-
- - #boolean -MARKER.tocoalition - - -
@@ -6617,6 +6617,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -6694,28 +6716,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Text displayed in the mark panel.

-
- -
-
-
- - #boolean -MARKER.toall - - - -
- -
-
-
- - #boolean -MARKER.tocoalition - - -
diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index f3544e87e..a83daeb86 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3515,17 +3515,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
- @@ -7088,17 +7077,6 @@ Coordinates are dependent on the position of the maps origin.

-
- -
- @@ -7676,17 +7654,6 @@ If the Identifiable is alive, true is returned.

-
- -
-
-
- - Core.Spot#SPOT -POSITIONABLE.Spot - - -
@@ -7870,17 +7837,6 @@ If the Identifiable is alive, true is returned.

-
- -
-
-
- - Core.Spot#SPOT -POSITIONABLE.Spot - - -
diff --git a/Documentation/Wrapper.Static.html b/Documentation/Wrapper.Static.html index b9891f6fc..478ae83fb 100644 --- a/Documentation/Wrapper.Static.html +++ b/Documentation/Wrapper.Static.html @@ -1511,7 +1511,7 @@ Controls a network of short range air/missile defense groups.

Global STATIC

- +

Wrapper class to handle Static objects.

@@ -1519,9 +1519,41 @@ Controls a network of short range air/missile defense groups.

- #table + #STATIC STATIC +

Wrapper class to handle Static objects.

+ + + +

Note that Statics are almost the same as Units, but they don't have a controller. +The Wrapper.Static#STATIC class is a wrapper class to handle the DCS Static objects:

+ +
    +
  • Wraps the DCS Static objects.
    • +
  • Support all DCS Static APIs.
    • +
  • Enhance with Static specific APIs not in the DCS API set.
    • +
+ +

STATIC reference methods

+ +

For each DCS Static will have a STATIC wrapper object (instance) within the _DATABASE object. +This is done at the beginning of the mission (when the mission starts).

+ +

The STATIC class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference +using the Static Name.

+ +

Another thing to know is that STATIC objects do not "contain" the DCS Static object. +The STATIc methods will reference the DCS Static object by name when it is needed during API execution. +If the DCS Static object does not exist or is nil, the STATIC methods will return nil and log an exception in the DCS.log file.

+ +

The STATIc class provides the following functions to retrieve quickly the relevant STATIC instance:

+ +
    +
  • STATIC.FindByName(): Find a STATIC instance from the _DATABASE object using a DCS Static name.
    • +
+ +

IMPORTANT: ONE SHOULD NEVER SANATIZE these STATIC OBJECT REFERENCES! (make the STATIC object references nil).

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

Type STATIC

STATIC +, extends Wrapper.Positionable#POSITIONABLE +, extends Wrapper.Identifiable#IDENTIFIABLE +, extends Wrapper.Object#OBJECT +, extends Core.Base#BASE
@@ -1538,10 +1574,1276 @@ Controls a network of short range air/missile defense groups.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from STATIC Description

STATIC:Destroy(GenerateEvent)

 +

Destroys the STATIC.

+

STATIC:Find(DCSStatic)

 +

Finds a STATIC from the _DATABASE using a DCSStatic object.

+

STATIC:FindByName(StaticName, RaiseError)

 +

Finds a STATIC from the _DATABASE using the relevant Static Name.

+

STATIC:GetDCSObject()

 +

Get DCS object of static of static.

+

STATIC:GetThreatLevel()

 +

Get threat level of static.

+

STATIC:GetUnits()

 +

Returns a list of one Static.

+

STATIC:ReSpawn(CountryID, Delay)

 +

Respawn the Wrapper.Unit at the same location with the same properties.

+

STATIC:ReSpawnAt(Coordinate, Heading, Delay)

 +

Respawn the Wrapper.Unit at a defined Coordinate with an optional heading.

+

STATIC:Register(StaticName)

 +

Register a static object.

+

STATIC:SpawnAt(Coordinate, Heading, Delay)

 +

Spawn the Wrapper.Static at a specific coordinate and heading.

+

STATIC.StaticName

 +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from POSITIONABLEDescription

STATIC:AddCargo(Cargo)

 +

Add cargo.

+

STATIC:CargoItemCount()

 +

Get cargo item count.

+

STATIC:ClearCargo()

 +

Clear all cargo.

+

STATIC:Destroy(GenerateEvent)

 +

Destroys the POSITIONABLE.

+

STATIC:Flare(FlareColor)

 +

Signal a flare at the position of the POSITIONABLE.

+

STATIC:FlareGreen()

 +

Signal a green flare at the position of the POSITIONABLE.

+

STATIC:FlareRed()

 +

Signal a red flare at the position of the POSITIONABLE.

+

STATIC:FlareWhite()

 +

Signal a white flare at the position of the POSITIONABLE.

+

STATIC:FlareYellow()

 +

Signal a yellow flare at the position of the POSITIONABLE.

+

STATIC:GetAltitude()

 +

Returns the altitude of the POSITIONABLE.

+

STATIC:GetAoA()

 +

Returns the Angle of Attack of a POSITIONABLE.

+

STATIC:GetBeacon()

 +

Create a Core.Radio#BEACON, to allow this POSITIONABLE to broadcast beacon signals

+

STATIC:GetBoundingBox()

 +

Get the bounding box of the underlying POSITIONABLE DCS Object.

+

STATIC:GetBoundingRadius(MinDist)

 +

Get the bounding radius of the underlying POSITIONABLE DCS Object.

+

STATIC:GetCargo()

 +

Get all contained cargo.

+

STATIC:GetCargoBayFreeWeight()

 +

Get Cargo Bay Free Weight in kg.

+

STATIC:GetClimbAngle()

 +

Returns the climb or descent angle of the POSITIONABLE.

+

STATIC:GetCoord()

 +

Returns a reference to a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

+

STATIC:GetCoordinate()

 +

Returns a new COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

+

STATIC:GetDCSObject()

 +

Returns the DCS object.

+

STATIC:GetHeading()

 +

Returns the POSITIONABLE heading in degrees.

+

STATIC:GetHeight()

 +

Returns the POSITIONABLE height in meters.

+

STATIC:GetLaserCode()

 +

Get the last assigned laser code

+

STATIC:GetMessage(Message, Duration, Name)

 +

Returns a message with the callsign embedded (if there is one).

+

STATIC:GetMessageText(Message, Name)

 +

Returns the message text with the callsign embedded (if there is one).

+

STATIC:GetMessageType(Message, MessageType, Name)

 +

Returns a message of a specified type with the callsign embedded (if there is one).

+

STATIC:GetObjectSize()

 +

Get the object size.

+

STATIC:GetOffsetCoordinate(x, y, z)

 +

Returns a COORDINATE object, which is offset with respect to the orientation of the POSITIONABLE.

+

STATIC:GetOrientation()

 +

Returns a {@DCS#Vec3} table of the objects current orientation in 3D space.

+

STATIC:GetOrientationX()

 +

Returns a {@DCS#Vec3} table of the objects current X orientation in 3D space, i.e.

+

STATIC:GetOrientationY()

 +

Returns a {@DCS#Vec3} table of the objects current Y orientation in 3D space, i.e.

+

STATIC:GetOrientationZ()

 +

Returns a {@DCS#Vec3} table of the objects current Z orientation in 3D space, i.e.

+

STATIC:GetPitch()

 +

Returns the pitch angle of a POSITIONABLE.

+

STATIC:GetPointVec2()

 +

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

STATIC:GetPointVec3()

 +

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

STATIC:GetPosition()

 +

Returns a pos3 table of the objects current position and orientation in 3D space.

+

STATIC:GetPositionVec3()

 +

Returns the DCS#Position3 position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.

+

STATIC:GetRadio()

 +

Create a Core.Radio#RADIO, to allow radio transmission for this POSITIONABLE.

+

STATIC:GetRandomVec3(Radius)

 +

Returns a random DCS#Vec3 vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.

+

STATIC:GetRelativeVelocity(Positionable)

 +

Get relative velocity with respect to another POSITIONABLE.

+

STATIC:GetRoll()

 +

Returns the roll angle of a unit.

+

STATIC:GetSize()

 + +

STATIC:GetSpot()

 +

Get the Spot

+

STATIC:GetVec2()

 +

Returns the DCS#Vec2 vector indicating the point in 2D of the POSITIONABLE within the mission.

+

STATIC:GetVec3()

 +

Returns the DCS#Vec3 vector indicating the 3D vector of the POSITIONABLE within the mission.

+

STATIC:GetVelocity()

 +

Returns the a Velocity object from the POSITIONABLE.

+

STATIC:GetVelocityKMH()

 +

Returns the POSITIONABLE velocity in km/h.

+

STATIC:GetVelocityKNOTS()

 +

Returns the POSITIONABLE velocity in knots.

+

STATIC:GetVelocityMPS()

 +

Returns the POSITIONABLE velocity in meters per second.

+

STATIC:GetVelocityVec3()

 +

Returns the POSITIONABLE velocity Vec3 vector.

+

STATIC:GetYaw()

 +

Returns the yaw angle of a POSITIONABLE.

+

STATIC:HasCargo(Cargo)

 +

Returns if carrier has given cargo.

+

STATIC:InAir()

 +

Returns true if the POSITIONABLE is in the air.

+

STATIC:IsAboveRunway()

 +

Returns if the Positionable is located above a runway.

+

STATIC:IsAir()

 +

Returns if the unit is of an air category.

+

STATIC:IsCargoEmpty()

 +

Is cargo bay empty.

+

STATIC:IsGround()

 +

Returns if the unit is of an ground category.

+

STATIC:IsInZone(Zone)

 +

Returns true if the unit is within a Zone.

+

STATIC:IsLasing()

 +

Check if the POSITIONABLE is lasing a target

+

STATIC:IsNotInZone(Zone)

 +

Returns true if the unit is not within a Zone.

+

STATIC:IsShip()

 +

Returns if the unit is of ship category.

+

STATIC:IsSubmarine()

 +

Returns if the unit is a submarine.

+

STATIC:LaseCoordinate(Coordinate, LaserCode, Duration)

 +

Start Lasing a COORDINATE.

+

STATIC:LaseOff()

 +

Stop Lasing a POSITIONABLE

+

STATIC:LaseUnit(Target, LaserCode, Duration)

 +

Start Lasing a POSITIONABLE

+

STATIC.LaserCode

 + +

STATIC:Message(Message, Duration, Name)

 +

Send a message to the players in the Wrapper.Group.

+

STATIC:MessageToAll(Message, Duration, Name)

 +

Send a message to all coalitions.

+

STATIC:MessageToBlue(Message, Duration, Name)

 +

Send a message to the blue coalition.

+

STATIC:MessageToClient(Message, Duration, Client, Name)

 +

Send a message to a client.

+

STATIC:MessageToCoalition(Message, Duration, MessageCoalition, Name)

 +

Send a message to a coalition.

+

STATIC:MessageToGroup(Message, Duration, MessageGroup, Name)

 +

Send a message to a Wrapper.Group.

+

STATIC:MessageToRed(Message, Duration, Name)

 +

Send a message to the red coalition.

+

STATIC:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)

 +

Send a message to a Core.Set#SET_GROUP.

+

STATIC:MessageTypeToCoalition(Message, MessageType, MessageCoalition, Name)

 +

Send a message to a coalition.

+

STATIC:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)

 +

Send a message of a message type to a Wrapper.Group.

+

STATIC:New(PositionableName)

 +

Create a new POSITIONABLE from a DCSPositionable

+

STATIC.PositionableName

 + +

STATIC:RemoveCargo(Cargo)

 +

Remove cargo.

+

STATIC:SetCargoBayWeightLimit(WeightLimit)

 +

Set Cargo Bay Weight Limit in kg.

+

STATIC:Smoke(SmokeColor, Range, AddHeight)

 +

Smoke the POSITIONABLE.

+

STATIC:SmokeBlue()

 +

Smoke the POSITIONABLE Blue.

+

STATIC:SmokeGreen()

 +

Smoke the POSITIONABLE Green.

+

STATIC:SmokeOrange()

 +

Smoke the POSITIONABLE Orange.

+

STATIC:SmokeRed()

 +

Smoke the POSITIONABLE Red.

+

STATIC:SmokeWhite()

 +

Smoke the POSITIONABLE White.

+

STATIC.Spot

 + +

STATIC.__

 + +

STATIC.coordinate

 +

Coordinate object.

+

STATIC.pointvec3

 +

Point Vec3 object.

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from IDENTIFIABLEDescription

STATIC:GetCallsign()

 +

Gets the CallSign of the IDENTIFIABLE, which is a blank by default.

+

STATIC:GetCategory()

 +

Returns object category of the DCS Identifiable.

+

STATIC:GetCategoryName()

 +

Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.

+

STATIC:GetCoalition()

 +

Returns coalition of the Identifiable.

+

STATIC:GetCoalitionName()

 +

Returns the name of the coalition of the Identifiable.

+

STATIC:GetCountry()

 +

Returns country of the Identifiable.

+

STATIC:GetCountryName()

 +

Returns country name of the Identifiable.

+

STATIC:GetDesc()

 +

Returns Identifiable descriptor.

+

STATIC:GetName()

 +

Returns DCS Identifiable object name.

+

STATIC:GetThreatLevel()

 + +

STATIC:GetTypeName()

 +

Returns the type name of the DCS Identifiable.

+

STATIC:HasAttribute(AttributeName)

 +

Check if the Object has the attribute.

+

STATIC.IdentifiableName

 +

The name of the identifiable.

+

STATIC:IsAlive()

 +

Returns if the Identifiable is alive.

+

STATIC:New(IdentifiableName)

 +

Create a new IDENTIFIABLE from a DCSIdentifiable

+
+
+
+ + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from OBJECTDescription

STATIC:Destroy()

 +

Destroys the OBJECT.

+

STATIC:GetID()

 +

Returns the unit's unique identifier.

+

STATIC:New(ObjectName, Test)

 +

Create a new OBJECT from a DCSObject

+

STATIC.ObjectName

 +

The name of the Object.

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

STATIC.ClassID

 +

The ID number of the class.

+

STATIC.ClassName

 +

The name of the class.

+

STATIC.ClassNameAndID

 +

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

+

STATIC:ClearState(Object, StateName)

 +

Clear the state of an object.

+

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

 +

Creation of a Birth Event.

+

STATIC:CreateEventCrash(EventTime, Initiator)

 +

Creation of a Crash Event.

+

STATIC:CreateEventDead(EventTime, Initiator)

 +

Creation of a Dead Event.

+

STATIC:CreateEventPlayerEnterAircraft(PlayerUnit)

 +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

STATIC:CreateEventRemoveUnit(EventTime, Initiator)

 +

Creation of a Remove Unit Event.

+

STATIC:CreateEventTakeoff(EventTime, Initiator)

 +

Creation of a Takeoff Event.

+

STATIC:E(Arguments)

 +

Log an exception which will be traced always.

+

STATIC:EventDispatcher()

 +

Returns the event dispatcher

+

STATIC:EventRemoveAll()

 +

Remove all subscribed events

+

STATIC:F(Arguments)

 +

Trace a function call.

+

STATIC:F2(Arguments)

 +

Trace a function call level 2.

+

STATIC:F3(Arguments)

 +

Trace a function call level 3.

+

STATIC:GetClassID()

 +

Get the ClassID of the class instance.

+

STATIC:GetClassName()

 +

Get the ClassName of the class instance.

+

STATIC:GetClassNameAndID()

 +

Get the ClassName + ClassID of the class instance.

+

STATIC:GetEventPriority()

 +

Get the Class Event processing Priority.

+

STATIC:GetParent(Child, FromClass)

 +

This is the worker method to retrieve the Parent class.

+

STATIC:GetState(Object, Key)

 +

Get a Value given a Key from the Object.

+

STATIC:HandleEvent(EventID, EventFunction)

 +

Subscribe to a DCS Event.

+

STATIC:I(Arguments)

 +

Log an information which will be traced always.

+

STATIC:Inherit(Child, Parent)

 +

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

+

STATIC:IsInstanceOf(ClassName)

 +

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

+

STATIC:IsTrace()

 +

Enquires if tracing is on (for the class).

+

STATIC:New()

 +

BASE constructor.

+

STATIC:OnEvent(EventData)

 +

Occurs when an object is completely destroyed.

+

STATIC:OnEventBDA(EventData)

 +

BDA.

+

STATIC:OnEventBaseCaptured(EventData)

 +

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

+

STATIC:OnEventBirth(EventData)

 +

Occurs when any object is spawned into the mission.

+

STATIC:OnEventCrash(EventData)

 +

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

+

STATIC:OnEventDead(EventData)

 +

Occurs when an object is dead.

+

STATIC:OnEventDetailedFailure(EventData)

 +

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

+

STATIC:OnEventDiscardChairAfterEjection(EventData)

 +

Discard chair after ejection.

+

STATIC:OnEventEjection(EventData)

 +

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

+

STATIC:OnEventEngineShutdown(EventData)

 +

Occurs when any aircraft shuts down its engines.

+

STATIC:OnEventEngineStartup(EventData)

 +

Occurs when any aircraft starts its engines.

+

STATIC:OnEventHit(EventData)

 +

Occurs whenever an object is hit by a weapon.

+

STATIC:OnEventHumanFailure(EventData)

 +

Occurs when any system fails on a human controlled aircraft.

+

STATIC:OnEventKill(EventData)

 +

Occurs on the death of a unit.

+

STATIC:OnEventLand(EventData)

 +

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

+

STATIC:OnEventLandingAfterEjection(EventData)

 +

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

+

STATIC:OnEventLandingQualityMark(EventData)

 +

Landing quality mark.

+

STATIC:OnEventMarkAdded(EventData)

 +

Occurs when a new mark was added.

+

STATIC:OnEventMarkChange(EventData)

 +

Occurs when a mark text was changed.

+

STATIC:OnEventMarkRemoved(EventData)

 +

Occurs when a mark was removed.

+

STATIC:OnEventMissionEnd(EventData)

 +

Occurs when a mission ends.

+

STATIC:OnEventMissionStart(EventData)

 +

Occurs when a mission starts.

+

STATIC:OnEventParatrooperLanding(EventData)

 +

Weapon add.

+

STATIC:OnEventPilotDead(EventData)

 +

Occurs when the pilot of an aircraft is killed.

+

STATIC:OnEventPlayerEnterAircraft(EventData)

 +

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

+

STATIC:OnEventPlayerEnterUnit(EventData)

 +

Occurs when any player assumes direct control of a unit.

+

STATIC:OnEventPlayerLeaveUnit(EventData)

 +

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

+

STATIC:OnEventRefueling(EventData)

 +

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

+

STATIC:OnEventRefuelingStop(EventData)

 +

Occurs when an aircraft is finished taking fuel.

+

STATIC:OnEventScore(EventData)

 +

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

+

STATIC:OnEventShootingEnd(EventData)

 +

Occurs when any unit stops firing its weapon.

+

STATIC:OnEventShootingStart(EventData)

 +

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

+

STATIC:OnEventShot(EventData)

 +

Occurs whenever any unit in a mission fires a weapon.

+

STATIC:OnEventTakeoff(EventData)

 +

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

+

STATIC:OnEventTriggerZone(EventData)

 +

Trigger zone.

+

STATIC:OnEventUnitLost(EventData)

 +

Occurs when the game thinks an object is destroyed.

+

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

 +

Schedule a new time event.

+

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

 +

Schedule a new time event.

+

STATIC:ScheduleStop(SchedulerFunction)

 +

Stops the Schedule.

+

STATIC.Scheduler

 + +

STATIC:SetEventPriority(EventPriority)

 +

Set the Class Event processing Priority.

+

STATIC:SetState(Object, Key, Value)

 +

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

+

STATIC:T(Arguments)

 +

Trace a function logic level 1.

+

STATIC:T2(Arguments)

 +

Trace a function logic level 2.

+

STATIC:T3(Arguments)

 +

Trace a function logic level 3.

+

STATIC:TraceAll(TraceAll)

 +

Trace all methods in MOOSE

+

STATIC:TraceClass(Class)

 +

Set tracing for a class

+

STATIC:TraceClassMethod(Class, Method)

 +

Set tracing for a specific method of class

+

STATIC:TraceLevel(Level)

 +

Set trace level

+

STATIC:TraceOff()

 +

Set trace off.

+

STATIC:TraceOn()

 +

Set trace on.

+

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

+

STATIC:UnHandleEvent(EventID)

 +

UnSubscribe to a DCS event.

+

STATIC._

 + +

STATIC:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function call.

+

STATIC:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

STATIC.__

 + +

STATIC:onEvent(event)

 +
@@ -1576,6 +2878,7932 @@ Controls a network of short range air/missile defense groups.

Function(s)

+
+ +
+

STATIC:Destroy(GenerateEvent)

+
+ +

Destroys the STATIC.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Parameter:

+
+
+

+ #boolean + GenerateEvent +

+
+
+ +

(Optional) true if you want to generate a crash or dead event for the static.

+ +
+
+

Return value:

+
+
+

#nil:

+
+
+ +

The DCS StaticObject is not existing or alive.

+ +
+
+

Usages:

+
    + 
  • -- Air static example: destroy the static Helicopter and generate a S_EVENT_CRASH.
+Helicopter = STATIC:FindByName( "Helicopter" )
+Helicopter:Destroy( true )
+
    • + 
  • -- Ground static example: destroy the static Tank and generate a S_EVENT_DEAD.
+Tanks = UNIT:FindByName( "Tank" )
+Tanks:Destroy( true )
+
    • + 
  • -- Ship static example: destroy the Ship silently.
+Ship = STATIC:FindByName( "Ship" )
+Ship:Destroy()
+
    • + 
  • -- Destroy without event generation example.
+Ship = STATIC:FindByName( "Boat" )
+Ship:Destroy( false ) -- Don't generate an event upon destruction.
+
    • +
+ +
+ +
+
+ +
+ +
+

STATIC:Find(DCSStatic)

+
+ +

Finds a STATIC from the _DATABASE using a DCSStatic object.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Parameter:

+
+
+

+ DCS#StaticObject + DCSStatic +

+
+
+ +

An existing DCS Static object reference.

+ +
+
+

Return value:

+
+
+

#STATIC:

+
+
+ +

self

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

STATIC:FindByName(StaticName, RaiseError)

+
+ +

Finds a STATIC from the _DATABASE using the relevant Static Name.

+ + +

As an optional parameter, a briefing text can be given also.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Parameters:

+
+
+

+ #string + StaticName +

+
+
+ +

Name of the DCS Static as defined within the Mission Editor.

+ +
+
+
+
+

+ #boolean + RaiseError +

+
+
+ +

Raise an error if not found.

+ +
+
+

Return value:

+
+
+

#STATIC:

+
+
+ +

self or nil

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

STATIC:GetDCSObject()

+
+ +

Get DCS object of static of static.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Return value:

+
+
+
+
+ +

DCS static object

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

STATIC:GetThreatLevel()

+
+ +

Get threat level of static.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Return values:

+
+
+

#number:

+
+
+ +

Threat level 1.

+ +
+
+

#string:

+
+
+ +

"Static"

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

STATIC:GetUnits()

+
+ +

Returns a list of one Static.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Return value:

+
+
+

#list<Wrapper.Static#STATIC>:

+
+
+ +

A list of one Static.

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

STATIC:ReSpawn(CountryID, Delay)

+
+ +

Respawn the Wrapper.Unit at the same location with the same properties.

+ + +

This is useful to respawn a cargo after it has been destroyed.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Parameters:

+
+
+

+ DCS#country.id + CountryID +

+
+
+ +

(Optional) The country ID used for spawning the new static. Default is same as currently.

+ +
+
+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay in seconds before static is respawned. Default now.

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

STATIC:ReSpawnAt(Coordinate, Heading, Delay)

+
+ +

Respawn the Wrapper.Unit at a defined Coordinate with an optional heading.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Parameters:

+
+
+

+ Core.Point#COORDINATE + Coordinate +

+
+
+ +

The coordinate where to spawn the new Static.

+ +
+
+
+
+

+ #number + Heading +

+
+
+ +

(Optional) The heading of the static respawn in degrees. Default the current heading.

+ +
+
+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay in seconds before static is respawned. Default now.

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

STATIC:Register(StaticName)

+
+ +

Register a static object.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Parameter:

+
+
+

+ #string + StaticName +

+
+
+ +

Name of the static object.

+ +
+
+

Return value:

+
+
+

#STATIC:

+
+
+ +

self

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

STATIC:SpawnAt(Coordinate, Heading, Delay)

+
+ +

Spawn the Wrapper.Static at a specific coordinate and heading.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Parameters:

+
+
+

+ Core.Point#COORDINATE + Coordinate +

+
+
+ +

The coordinate where to spawn the new Static.

+ +
+
+
+
+

+ #number + Heading +

+
+
+ +

The heading of the static respawn in degrees. Default is 0 deg.

+ +
+
+
+
+

+ #number + Delay +

+
+
+ +

Delay in seconds before the static is spawned.

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + +STATIC.StaticName + + + + +

Set static name.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

STATIC:AddCargo(Cargo)

+
+ +

Add cargo.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Core.Cargo#CARGO + Cargo +

+
+
+

+
+
+

Return value:

+
+
+

#POSITIONABLE:

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

STATIC:CargoItemCount()

+
+ +

Get cargo item count.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Core.Cargo#CARGO:

+
+
+ +

Cargo

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

STATIC:ClearCargo()

+
+ +

Clear all cargo.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

STATIC:Destroy(GenerateEvent)

+
+ +

Destroys the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #boolean + GenerateEvent +

+
+
+ +

(Optional) If true, generates a crash or dead event for the unit. If false, no event generated. If nil, a remove event is generated.

+ +
+
+

Return value:

+
+
+

#nil:

+
+
+ +

The DCS Unit is not existing or alive.

+ +
+
+

Usages:

+
    + 
  • 
+Air unit example: destroy the Helicopter and generate a S_EVENT_CRASH for each unit in the Helicopter group.
+Helicopter = UNIT:FindByName( "Helicopter" )
+Helicopter:Destroy( true )
+
    • + 
  • -- Ground unit example: destroy the Tanks and generate a S_EVENT_DEAD for each unit in the Tanks group.
+Tanks = UNIT:FindByName( "Tanks" )
+Tanks:Destroy( true )
+
    • + 
  • -- Ship unit example: destroy the Ship silently.
+Ship = STATIC:FindByName( "Ship" )
+Ship:Destroy()
+
    • + 
  • -- Destroy without event generation example.
+Ship = STATIC:FindByName( "Boat" )
+Ship:Destroy( false ) -- Don't generate an event upon destruction.
+
    • +
+ +
+ +
+
+ +
+ +
+

STATIC:Flare(FlareColor)

+
+ +

Signal a flare at the position of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Utilities.Utils#FLARECOLOR + FlareColor +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

STATIC:FlareGreen()

+
+ +

Signal a green flare at the position of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

STATIC:FlareRed()

+
+ +

Signal a red flare at the position of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

STATIC:FlareWhite()

+
+ +

Signal a white flare at the position of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

STATIC:FlareYellow()

+
+ +

Signal a yellow flare at the position of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

STATIC:GetAltitude()

+
+ +

Returns the altitude of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Distance:

+
+
+ +

The altitude of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetAoA()

+
+ +

Returns the Angle of Attack of a POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

Angle of attack in degrees.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetBeacon()

+
+ +

Create a Core.Radio#BEACON, to allow this POSITIONABLE to broadcast beacon signals

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Core.Radio#RADIO:

+
+
+ +

Radio

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

STATIC:GetBoundingBox()

+
+ +

Get the bounding box of the underlying POSITIONABLE DCS Object.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Box3:

+
+
+ +

The bounding box of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetBoundingRadius(MinDist)

+
+ +

Get the bounding radius of the underlying POSITIONABLE DCS Object.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #number + MinDist +

+
+
+ +

(Optional) If bounding box is smaller than this value, MinDist is returned.

+ +
+
+

Return values:

+
+
+

DCS#Distance:

+
+
+ +

The bounding radius of the POSITIONABLE

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetCargo()

+
+ +

Get all contained cargo.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#POSITIONABLE:

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

STATIC:GetCargoBayFreeWeight()

+
+ +

Get Cargo Bay Free Weight in kg.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

CargoBayFreeWeight

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

STATIC:GetClimbAngle()

+
+ +

Returns the climb or descent angle of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

Climb or descent angle in degrees. Or 0 if velocity vector norm is zero.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetCoord()

+
+ +

Returns a reference to a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

+ + +

This function works similar to POSITIONABLE.GetCoordinate(), however, this function caches, updates and re-uses the same COORDINATE object stored +within the POSITIONABLE. This has higher performance, but comes with all considerations associated with the possible referencing to the same COORDINATE object. +This should only be used when performance is critical and there is sufficient awareness of the possible pitfalls. However, in most instances, GetCoordinate() is +preferred as it will return a fresh new COORDINATE and thus avoid potentially unexpected issues.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Core.Point#COORDINATE:

+
+
+ +

A reference to the COORDINATE object of the POSITIONABLE.

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

STATIC:GetCoordinate()

+
+ +

Returns a new COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Core.Point#COORDINATE:

+
+
+ +

A new COORDINATE object of the POSITIONABLE.

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

STATIC:GetDCSObject()

+
+ +

Returns the DCS object.

+ + +

Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

DCS#Object:

+
+
+ +

The DCS object.

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

STATIC:GetHeading()

+
+ +

Returns the POSITIONABLE heading in degrees.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

The POSITIONABLE heading in degrees.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetHeight()

+
+ +

Returns the POSITIONABLE height in meters.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

The height of the POSITIONABLE in meters.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetLaserCode()

+
+ +

Get the last assigned laser code

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The laser code

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

STATIC:GetMessage(Message, Duration, Name)

+
+ +

Returns a message with the callsign embedded (if there is one).

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

+ +
+
+

Return value:

+
+
+

Core.Message#MESSAGE:

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

STATIC:GetMessageText(Message, Name)

+
+ +

Returns the message text with the callsign embedded (if there is one).

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

+ +
+
+

Return values:

+
+
+

#string:

+
+
+ +

The message text.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetMessageType(Message, MessageType, Name)

+
+ +

Returns a message of a specified type with the callsign embedded (if there is one).

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ Core.Message#MESSAGE + MessageType +

+
+
+ +

MessageType The message type.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

+ +
+
+

Return value:

+
+
+

Core.Message#MESSAGE:

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

STATIC:GetObjectSize()

+
+ +

Get the object size.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Distance:

+
+
+ +

Max size of object in x, z or 0 if bounding box could not be obtained.

+ +
+
+

DCS#Distance:

+
+
+ +

Length x or 0 if bounding box could not be obtained.

+ +
+
+

DCS#Distance:

+
+
+ +

Height y or 0 if bounding box could not be obtained.

+ +
+
+

DCS#Distance:

+
+
+ +

Width z or 0 if bounding box could not be obtained.

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

STATIC:GetOffsetCoordinate(x, y, z)

+
+ +

Returns a COORDINATE object, which is offset with respect to the orientation of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #number + x +

+
+
+ +

Offset in the direction "the nose" of the unit is pointing in meters. Default 0 m.

+ +
+
+
+
+

+ #number + y +

+
+
+ +

Offset "above" the unit in meters. Default 0 m.

+ +
+
+
+
+

+ #number + z +

+
+
+ +

Offset in the direction "the wing" of the unit is pointing in meters. z>0 starboard, z<0 port. Default 0 m.

+ +
+
+

Return value:

+
+
+

Core.Point#COORDINATE:

+
+
+ +

The COORDINATE of the offset with respect to the orientation of the POSITIONABLE.

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

STATIC:GetOrientation()

+
+ +

Returns a {@DCS#Vec3} table of the objects current orientation in 3D space.

+ + +

X, Y, Z values are unit vectors defining the objects orientation. + X is the orientation parallel to the movement of the object, Z perpendicular and Y vertical orientation.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

X orientation, i.e. parallel to the direction of movement.

+ +
+
+

DCS#Vec3:

+
+
+ +

Y orientation, i.e. vertical.

+ +
+
+

DCS#Vec3:

+
+
+ +

Z orientation, i.e. perpendicular to the direction of movement.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetOrientationX()

+
+ +

Returns a {@DCS#Vec3} table of the objects current X orientation in 3D space, i.e.

+ + +

along the direction of movement.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

X orientation, i.e. parallel to the direction of movement.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetOrientationY()

+
+ +

Returns a {@DCS#Vec3} table of the objects current Y orientation in 3D space, i.e.

+ + +

vertical orientation.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

Y orientation, i.e. vertical.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetOrientationZ()

+
+ +

Returns a {@DCS#Vec3} table of the objects current Z orientation in 3D space, i.e.

+ + +

perpendicular to direction of movement.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

Z orientation, i.e. perpendicular to movement.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetPitch()

+
+ +

Returns the pitch angle of a POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

Pitch angle in degrees.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetPointVec2()

+
+ +

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

Core.Point#POINT_VEC2:

+
+
+ +

The 2D point vector of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetPointVec3()

+
+ +

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

Core.Point#POINT_VEC3:

+
+
+ +

The 3D point vector of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetPosition()

+
+ +

Returns a pos3 table of the objects current position and orientation in 3D space.

+ + +

X, Y, Z values are unit vectors defining the objects orientation. +Coordinates are dependent on the position of the maps origin.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

DCS#Position3:

+
+
+ +

Table consisting of the point and orientation tables.

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

STATIC:GetPositionVec3()

+
+ +

Returns the DCS#Position3 position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Position:

+
+
+ +

The 3D position vectors of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetRadio()

+
+ +

Create a Core.Radio#RADIO, to allow radio transmission for this POSITIONABLE.

+ + +

Set parameters with the methods provided, then use RADIO:Broadcast() to actually broadcast the message

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Core.Radio#RADIO:

+
+
+ +

Radio

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

STATIC:GetRandomVec3(Radius)

+
+ +

Returns a random DCS#Vec3 vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #number + Radius +

+
+
+

+
+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

The 3D point vector of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

+ +
+
+

Usage:

+ 
-- If Radius is ignored, returns the DCS#Vec3 of first UNIT of the GROUP
+ +
+ +
+
+ +
+ +
+

STATIC:GetRelativeVelocity(Positionable)

+
+ +

Get relative velocity with respect to another POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #POSITIONABLE + Positionable +

+
+
+ +

Other POSITIONABLE.

+ +
+
+

Return value:

+
+
+

#number:

+
+
+ +

Relative velocity in m/s.

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

STATIC:GetRoll()

+
+ +

Returns the roll angle of a unit.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

Pitch angle in degrees.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetSize()

+
+ + + +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

STATIC:GetSpot()

+
+ +

Get the Spot

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Core.Spot#SPOT:

+
+
+ +

The Spot

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

STATIC:GetVec2()

+
+ +

Returns the DCS#Vec2 vector indicating the point in 2D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec2:

+
+
+ +

The 2D point vector of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetVec3()

+
+ +

Returns the DCS#Vec3 vector indicating the 3D vector of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

The 3D point vector of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetVelocity()

+
+ +

Returns the a Velocity object from the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

Core.Velocity#VELOCITY:

+
+
+ +

Velocity The Velocity object.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetVelocityKMH()

+
+ +

Returns the POSITIONABLE velocity in km/h.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The velocity in km/h.

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

STATIC:GetVelocityKNOTS()

+
+ +

Returns the POSITIONABLE velocity in knots.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The velocity in knots.

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

STATIC:GetVelocityMPS()

+
+ +

Returns the POSITIONABLE velocity in meters per second.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The velocity in meters per second.

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

STATIC:GetVelocityVec3()

+
+ +

Returns the POSITIONABLE velocity Vec3 vector.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

The velocity Vec3 vector

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:GetYaw()

+
+ +

Returns the yaw angle of a POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

Yaw angle in degrees.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:HasCargo(Cargo)

+
+ +

Returns if carrier has given cargo.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Cargo +

+
+
+

+
+
+

Return value:

+
+
+

Core.Cargo#CARGO:

+
+
+ +

Cargo

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

STATIC:InAir()

+
+ +

Returns true if the POSITIONABLE is in the air.

+ + +

Polymorphic, is overridden in GROUP and UNIT.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

true if in the air.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:IsAboveRunway()

+
+ +

Returns if the Positionable is located above a runway.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

true if Positionable is above a runway.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:IsAir()

+
+ +

Returns if the unit is of an air category.

+ + +

If the unit is a helicopter or a plane, then this method will return true, otherwise false.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

Air category evaluation result.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:IsCargoEmpty()

+
+ +

Is cargo bay empty.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

STATIC:IsGround()

+
+ +

Returns if the unit is of an ground category.

+ + +

If the unit is a ground vehicle or infantry, this method will return true, otherwise false.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

Ground category evaluation result.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:IsInZone(Zone)

+
+ +

Returns true if the unit is within a Zone.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Core.Zone#ZONE_BASE + Zone +

+
+
+ +

The zone to test.

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

Returns true if the unit is within the Core.Zone#ZONE_BASE

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

STATIC:IsLasing()

+
+ +

Check if the POSITIONABLE is lasing a target

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

true if it is lasing a target

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

STATIC:IsNotInZone(Zone)

+
+ +

Returns true if the unit is not within a Zone.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Core.Zone#ZONE_BASE + Zone +

+
+
+ +

The zone to test.

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

Returns true if the unit is not within the Core.Zone#ZONE_BASE

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

STATIC:IsShip()

+
+ +

Returns if the unit is of ship category.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

Ship category evaluation result.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

STATIC:IsSubmarine()

+
+ +

Returns if the unit is a submarine.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

Submarines attributes result.

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

STATIC:LaseCoordinate(Coordinate, LaserCode, Duration)

+
+ +

Start Lasing a COORDINATE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ Core.Point#COORDINATE + Coordinate +

+
+
+ +

The coordinate where the lase is pointing at.

+ +
+
+
+
+

+ #number + LaserCode +

+
+
+ +

Laser code or random number in [1000, 9999].

+ +
+
+
+
+

+ #number + Duration +

+
+
+ +

Duration of lasing in seconds.

+ +
+
+

Return value:

+
+
+

Core.Spot#SPOT:

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

STATIC:LaseOff()

+
+ +

Stop Lasing a POSITIONABLE

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#POSITIONABLE:

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

STATIC:LaseUnit(Target, LaserCode, Duration)

+
+ +

Start Lasing a POSITIONABLE

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #POSITIONABLE + Target +

+
+
+ +

The target to lase.

+ +
+
+
+
+

+ #number + LaserCode +

+
+
+ +

Laser code or random number in [1000, 9999].

+ +
+
+
+
+

+ #number + Duration +

+
+
+ +

Duration of lasing in seconds.

+ +
+
+

Return value:

+
+
+

Core.Spot#SPOT:

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

STATIC:Message(Message, Duration, Name)

+
+ +

Send a message to the players in the Wrapper.Group.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

STATIC:MessageToAll(Message, Duration, Name)

+
+ +

Send a message to all coalitions.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

STATIC:MessageToBlue(Message, Duration, Name)

+
+ +

Send a message to the blue coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

STATIC:MessageToClient(Message, Duration, Client, Name)

+
+ +

Send a message to a client.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ Wrapper.Client#CLIENT + Client +

+
+
+ +

The client object receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

STATIC:MessageToCoalition(Message, Duration, MessageCoalition, Name)

+
+ +

Send a message to a coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ DCS#coalition + MessageCoalition +

+
+
+ +

The Coalition receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

STATIC:MessageToGroup(Message, Duration, MessageGroup, Name)

+
+ +

Send a message to a Wrapper.Group.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ Wrapper.Group#GROUP + MessageGroup +

+
+
+ +

The GROUP object receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

STATIC:MessageToRed(Message, Duration, Name)

+
+ +

Send a message to the red coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

STATIC:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)

+
+ +

Send a message to a Core.Set#SET_GROUP.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ Core.Set#SET_GROUP + MessageSetGroup +

+
+
+ +

The SET_GROUP collection receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

STATIC:MessageTypeToCoalition(Message, MessageType, MessageCoalition, Name)

+
+ +

Send a message to a coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ Core.Message#MESSAGE.Type + MessageType +

+
+
+ +

The message type that determines the duration.

+ +
+
+
+
+

+ DCS#coalition + MessageCoalition +

+
+
+ +

The Coalition receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

STATIC:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)

+
+ +

Send a message of a message type to a Wrapper.Group.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ Core.Message#MESSAGE.Type + MessageType +

+
+
+ +

The message type that determines the duration.

+ +
+
+
+
+

+ Wrapper.Group#GROUP + MessageGroup +

+
+
+ +

The GROUP object receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, the Name is the type of the POSITIONABLE.

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

STATIC:New(PositionableName)

+
+ +

Create a new POSITIONABLE from a DCSPositionable

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #string + PositionableName +

+
+
+ +

The POSITIONABLE name

+ +
+
+

Return value:

+
+
+

#POSITIONABLE:

+
+
+ +

self

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

STATIC:RemoveCargo(Cargo)

+
+ +

Remove cargo.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Core.Cargo#CARGO + Cargo +

+
+
+

+
+
+

Return value:

+
+
+

#POSITIONABLE:

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

STATIC:SetCargoBayWeightLimit(WeightLimit)

+
+ +

Set Cargo Bay Weight Limit in kg.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #number + WeightLimit +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

STATIC:Smoke(SmokeColor, Range, AddHeight)

+
+ +

Smoke the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ Utilities.Utils#SMOKECOLOR + SmokeColor +

+
+
+ +

The smoke color.

+ +
+
+
+
+

+ #number + Range +

+
+
+ +

The range in meters to randomize the smoking around the POSITIONABLE.

+ +
+
+
+
+

+ #number + AddHeight +

+
+
+ +

The height in meters to add to the altitude of the POSITIONABLE.

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

STATIC:SmokeBlue()

+
+ +

Smoke the POSITIONABLE Blue.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

STATIC:SmokeGreen()

+
+ +

Smoke the POSITIONABLE Green.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

STATIC:SmokeOrange()

+
+ +

Smoke the POSITIONABLE Orange.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

STATIC:SmokeRed()

+
+ +

Smoke the POSITIONABLE Red.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

STATIC:SmokeWhite()

+
+ +

Smoke the POSITIONABLE White.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + +STATIC.StaticName + + + + +

Set static name.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

STATIC:GetCallsign()

+
+ +

Gets the CallSign of the IDENTIFIABLE, which is a blank by default.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The CallSign of the IDENTIFIABLE.

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

STATIC:GetCategory()

+
+ +

Returns object category of the DCS Identifiable.

+ + +

One of

+ +
    +
  • Object.Category.UNIT = 1
    • +
  • Object.Category.WEAPON = 2
    • +
  • Object.Category.STATIC = 3
    • +
  • Object.Category.BASE = 4
    • +
  • Object.Category.SCENERY = 5
    • +
  • Object.Category.Cargo = 6 +
    • +
+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

DCS#Object.Category:

+
+
+ +

The category ID, i.e. a number.

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

STATIC:GetCategoryName()

+
+ +

Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The DCS Identifiable Category Name

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

STATIC:GetCoalition()

+
+ +

Returns coalition of the Identifiable.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return values:

+
+
+

DCS#coalition.side:

+
+
+ +

The side of the coalition.

+ +
+
+

#nil:

+
+
+ +

The DCS Identifiable is not existing or alive.

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

STATIC:GetCoalitionName()

+
+ +

Returns the name of the coalition of the Identifiable.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return values:

+
+
+

#string:

+
+
+ +

The name of the coalition.

+ +
+
+

#nil:

+
+
+ +

The DCS Identifiable is not existing or alive.

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

STATIC:GetCountry()

+
+ +

Returns country of the Identifiable.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return values:

+
+
+

DCS#country.id:

+
+
+ +

The country identifier.

+ +
+
+

#nil:

+
+
+ +

The DCS Identifiable is not existing or alive.

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

STATIC:GetCountryName()

+
+ +

Returns country name of the Identifiable.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

#string:

+
+
+ +

Name of the country.

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

STATIC:GetDesc()

+
+ +

Returns Identifiable descriptor.

+ + +

Descriptor type depends on Identifiable category.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return values:

+
+
+

DCS#Object.Desc:

+
+
+ +

The Identifiable descriptor.

+ +
+
+

#nil:

+
+
+ +

The DCS Identifiable is not existing or alive.

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

STATIC:GetName()

+
+ +

Returns DCS Identifiable object name.

+ + +

The function provides access to non-activated objects too.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return values:

+
+
+

#string:

+
+
+ +

The name of the DCS Identifiable.

+ +
+
+

#nil:

+
+
+ +

The DCS Identifiable is not existing or alive.

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

STATIC:GetThreatLevel()

+
+ + + +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+
+ +
+
+ +
+ +
+

STATIC:GetTypeName()

+
+ +

Returns the type name of the DCS Identifiable.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The type name of the DCS Identifiable.

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

STATIC:HasAttribute(AttributeName)

+
+ +

Check if the Object has the attribute.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Parameter:

+
+
+

+ #string + AttributeName +

+
+
+ +

The attribute name.

+ +
+
+

Return values:

+
+
+

#boolean:

+
+
+ +

true if the attribute exists.

+ +
+
+

#nil:

+
+
+ +

The DCS Identifiable is not existing or alive.

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

STATIC:IsAlive()

+
+ +

Returns if the Identifiable is alive.

+ + +

If the Identifiable is not alive, nil is returned.
+If the Identifiable is alive, true is returned.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

true if Identifiable is alive.

+ +
+
+

#nil:

+
+
+ +

if the Identifiable is not existing or is not alive.

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

STATIC:New(IdentifiableName)

+
+ +

Create a new IDENTIFIABLE from a DCSIdentifiable

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Parameter:

+
+
+

+ #string + IdentifiableName +

+
+
+ +

The DCS Identifiable name

+ +
+
+

Return value:

+
+
+

#IDENTIFIABLE:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + +STATIC.StaticName + + + + +

Set static name.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

STATIC:Destroy()

+
+ +

Destroys the OBJECT.

+ +
+
+

Defined in:

+
+

Wrapper.Object#OBJECT

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

true if the object is destroyed.

+ +
+
+

#nil:

+
+
+ +

The DCS Unit is not existing or alive.

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

STATIC:GetID()

+
+ +

Returns the unit's unique identifier.

+ +
+
+

Defined in:

+
+

Wrapper.Object#OBJECT

+
+

Return value:

+
+
+

DCS#Object.ID:

+
+
+ +

ObjectID or #nil if the DCS Object is not existing or alive. Note that the ID is passed as a string and not a number.

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

STATIC:New(ObjectName, Test)

+
+ +

Create a new OBJECT from a DCSObject

+ +
+
+

Defined in:

+
+

Wrapper.Object#OBJECT

+
+

Parameters:

+
+
+

+ DCS#Object + ObjectName +

+
+
+ +

The Object name

+ +
+
+
+
+

+ Test +

+
+
+

+
+
+

Return value:

+
+
+

#OBJECT:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + +STATIC.StaticName + + + + +

Set static name.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

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

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

STATIC: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

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

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

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

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

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

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

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

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

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

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

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

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

STATIC:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

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

STATIC:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

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

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

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

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

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

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

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

STATIC:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

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

STATIC:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

STATIC:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

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

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

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

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

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

STATIC:OnEventBDA(EventData)

+
+ +

BDA.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

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

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

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

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

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

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

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

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

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

STATIC:OnEventDiscardChairAfterEjection(EventData)

+
+ +

Discard chair after ejection.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

STATIC:OnEventLandingQualityMark(EventData)

+
+ +

Landing quality mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

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

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

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

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

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

STATIC:OnEventMissionEnd(EventData)

+
+ +

Occurs when a mission ends.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

STATIC:OnEventMissionStart(EventData)

+
+ +

Occurs when a mission starts.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

STATIC:OnEventTriggerZone(EventData)

+
+ +

Trigger zone.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

STATIC:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

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

STATIC:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

STATIC:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+

+
+
+
+
+

+ #string + Method +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

STATIC:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

STATIC:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

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

STATIC:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

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

STATIC: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 )
+
+ +
+ +
+
+ +
+ +
+

STATIC:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

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

STATIC:_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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

STATIC:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

STATIC: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 +

+
+
+

+
+
+
+ +
+
+