From 72704a66f7811886ea126dc93dc697bc090f4d7e Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Sat, 1 Jul 2023 11:21:57 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2G_Dispatcher.html | 44 - Documentation/AI.AI_Air.html | 44 - Documentation/AI.AI_Cargo_Airplane.html | 24 - Documentation/AI.AI_Patrol.html | 12 - Documentation/Cargo.CargoUnit.html | 44 +- Documentation/Core.Fsm.html | 4 +- Documentation/Core.Settings.html | 26 +- Documentation/Core.Spawn.html | 250 +- Documentation/Core.SpawnStatic.html | 84 + Documentation/Core.Spot.html | 33 - Documentation/Functional.ATC_Ground.html | 6 + Documentation/Functional.Designate.html | 55 - Documentation/Functional.Detection.html | 66 + Documentation/Functional.Mantis.html | 105 + Documentation/Functional.RAT.html | 63 - Documentation/Functional.Scoring.html | 77 +- Documentation/Ops.Airboss.html | 30 +- Documentation/Ops.CSAR.html | 177 +- Documentation/Ops.CTLD.html | 109 +- .../Tasking.Task_A2A_Dispatcher.html | 8 +- Documentation/Tasking.Task_CARGO.html | 8 +- .../Tasking.Task_Cargo_Dispatcher.html | 88 + Documentation/Utilities.FiFo.html | 22 + Documentation/Utilities.Utils.html | 21 - Documentation/Wrapper.Airbase.html | 11772 +--------------- Documentation/Wrapper.Group.html | 78 +- Documentation/Wrapper.Marker.html | 132 +- 27 files changed, 831 insertions(+), 12551 deletions(-) diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index a2b4290d2..14f311756 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4758,17 +4758,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 - - -
@@ -13291,17 +13280,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -16271,17 +16238,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 bdea53af1..378991209 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -3070,17 +3070,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -5909,17 +5898,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -6667,17 +6645,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -8313,17 +8280,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.IdleCount - - -
diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 0f1b84d50..57d1954d0 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2746,9 +2746,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

- diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index 76d627149..1254dff54 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -3254,9 +3254,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

- @@ -8886,9 +8877,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.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index ea616f890..e49f4a5f5 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1808,17 +1808,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- - -
-
- - CARGO_UNIT.CargoInAir @@ -1837,6 +1826,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

+
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
@@ -2523,17 +2523,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- - -
-
- - CARGO_UNIT.CargoInAir @@ -2552,6 +2541,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.Fsm.html b/Documentation/Core.Fsm.html index d554ab9f0..679c3ff63 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5793,7 +5793,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState @@ -7392,7 +7392,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 9f2b6b184..7bda76ed0 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2905,22 +2905,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric -
- -
-
-
- - -SETTINGS.PlayerMenu - - -
@@ -5073,22 +5062,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 5f1cf37c2..3b3ec6ae4 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2881,30 +2881,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.communication

- - - - - -

SPAWN.frequency

- - - - - -

SPAWN.livery_id

- - - - - -

SPAWN.skill

- - @@ -3464,11 +3440,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SPAWN.AIOnOff + +

The AI is on by default when spawning a group.

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

Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

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

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

+
@@ -3742,6 +3738,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #boolean +SPAWN.SpawnInitKeepUnitNames + + + + +

Overwrite unit names by default with group name.

+
@@ -3775,28 +3785,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWN.SpawnInitModu - - - -
- -
-
-
- - #string -SPAWN.SpawnInitSkill - - -
@@ -3988,6 +3976,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -4096,50 +4095,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWN.communication - - - -
- -
-
-
- - -SPAWN.frequency - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.skill - - -
@@ -9104,11 +9059,14 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- + #boolean SPAWN.AIOnOff + +

The AI is on by default when spawning a group.

+
@@ -9181,6 +9139,9 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

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

+ + +
+
+ + #number +SPAWN.SpawnCount + + + + +

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

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

+ + +
+
+ + #boolean +SPAWN.SpawnInitKeepUnitNames + + + + +

Overwrite unit names by default with group name.

+
@@ -9415,28 +9404,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - -SPAWN.SpawnInitModu - - - -
- -
-
-
- - #string -SPAWN.SpawnInitSkill - - -
@@ -9628,6 +9595,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -9736,50 +9714,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - -SPAWN.communication - - - -
- -
-
-
- - -SPAWN.frequency - - - -
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.skill - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 4ee1da585..5a2154b78 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1993,6 +1993,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

+ + @@ -2907,6 +2925,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 + + +
@@ -4260,6 +4311,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index b4ded204a..3d93c6c4f 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2845,17 +2845,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.Target - - -
@@ -4172,17 +4161,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.Target - - -
@@ -5738,17 +5716,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.Target - - -
diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index 2b3dce017..c87078fb9 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -3881,6 +3881,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Kickspeed

+ @@ -4463,6 +4466,9 @@ An airbase can be specified to set the maximum kick speed for.

+ +

Kickspeed

+ diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index b2657721d..b46e197c0 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3540,17 +3540,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -6726,17 +6715,6 @@ Using the menu system, the player can "forget" a designation, so that gradually - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -7547,17 +7525,6 @@ Using the menu system, the player can "forget" a designation, so that gradually - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -8338,17 +8305,6 @@ Using the menu system, the player can "forget" a designation, so that gradually - - - -
-
- - -DESIGNATE.LaseDuration - - -
@@ -10017,17 +9973,6 @@ Using the menu system, the player can "forget" a designation, so that gradually - - - -
-
- - -DESIGNATE.LaseDuration - - -
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 1081b8987..53985b5fe 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -19134,6 +19134,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -19277,6 +19288,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -23815,6 +23837,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -23958,6 +23991,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -25557,6 +25601,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -25700,6 +25755,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index df92eafdf..fffd7d380 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -3459,6 +3459,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MANTIS.SamData.SA-9

+ + + +

MANTIS.SamData.SHORAD

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

Prefix for logging

+ + + +
+
+ + #number +MANTIS.maxclassic + + + +
+ +
+
+
+ + #number +MANTIS.maxlongrange + + + +
+ +
+
+
+ + #number +MANTIS.maxmidrange + + + +
+ +
+
+
+ + #number +MANTIS.maxshortrange + + +
@@ -8747,6 +8797,50 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

Prefix for logging

+ + + +
+
+ + #number +MANTIS.maxclassic + + + +
+ +
+
+
+ + #number +MANTIS.maxlongrange + + + +
+ +
+
+
+ + #number +MANTIS.maxmidrange + + + +
+ +
+
+
+ + #number +MANTIS.maxshortrange + + +
@@ -12577,6 +12671,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #table +MANTIS.SamData.SHORAD + + +
diff --git a/Documentation/Functional.RAT.html b/Documentation/Functional.RAT.html index d76062a37..804ab5cf0 100644 --- a/Documentation/Functional.RAT.html +++ b/Documentation/Functional.RAT.html @@ -3468,12 +3468,6 @@ manager:Stop(7200)

RAT.termtype

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

- - - -

RAT.type

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

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

- - - -

RAT.communication

- - - - - -

RAT.frequency

- - - - - -

RAT.livery_id

- - - - - -

RAT.skill

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

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

- - - -
-
- - -RAT.type - - -
@@ -14783,17 +14742,6 @@ Initializes the ratcraft array and group menu.

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

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

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

- - - -
-
- - -RAT.type - - -
diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html index cff7a3513..cd71a4235 100644 --- a/Documentation/Functional.Scoring.html +++ b/Documentation/Functional.Scoring.html @@ -1868,69 +1868,6 @@ Various methods exist to configure:

- - - -
- - - - - -

Global nHours

 - -
-
-
-
- - -nHours - - - -
- -
-
- - - - - -

Global nMins

 - -
-
-
-
- - -nMins - - - -
- -
-
- - - - - -

Global nSecs

 - -
-
-
-
- - -nSecs - - -
@@ -2926,11 +2863,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SCORING.AutoSave + +

Create the CSV file.

+
@@ -3113,7 +3053,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SCORING.penaltyoncoalitionchange @@ -5512,11 +5452,14 @@ The scale magnifies the scores given to the players.

- + #boolean SCORING.AutoSave + +

Create the CSV file.

+
@@ -5699,7 +5642,7 @@ The scale magnifies the scores given to the players.

- + #boolean SCORING.penaltyoncoalitionchange diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 1a0ee707b..f2d5339d3 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -39778,20 +39778,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-AIRBOSS.PlayerData.flag - - - - -

Set stack flag.

- -
- -
-
-
- - AIRBOSS.PlayerData.grade @@ -39810,17 +39796,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

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

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

Set Stable Hover

+
@@ -40015,7 +39993,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Set new time stamp.

+

Set time stamp.

diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index 3f47c014a..f42377095 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -2586,12 +2586,6 @@ Dropped troop noMessage and forcedesc parameters aren't saved.

CSAR.inTransitGroups

- - - -

CSAR.index

- - @@ -3964,7 +3958,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.FreeVHFFrequencies @@ -4405,11 +4399,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -4533,17 +4541,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 - - -
@@ -4752,6 +4749,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
+
+ + #number +CSAR.rescuedpilots + + + + +

counter for saved pilots

+ +
+
@@ -4777,6 +4788,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+ + #number +CSAR.rescues + + + + +

counter for successful rescue landings at FARP/AFB/MASH

+ +
+
@@ -9946,7 +9971,7 @@ callsigns from playername or group name.

- + #table CSAR.FreeVHFFrequencies @@ -10387,11 +10412,25 @@ callsigns from playername or group name.

- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -10515,17 +10554,6 @@ callsigns from playername or group name.

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

-
- -
-
-
- - -CSAR.index - - -
@@ -10734,6 +10762,20 @@ callsigns from playername or group name.

+
+
+
+ + #number +CSAR.rescuedpilots + + + + +

counter for saved pilots

+ +
+
@@ -10759,6 +10801,20 @@ callsigns from playername or group name.

+
+
+
+ + #number +CSAR.rescues + + + + +

counter for successful rescue landings at FARP/AFB/MASH

+ +
+
@@ -12413,7 +12469,7 @@ callsigns from playername or group name.

- + #table CSAR.FreeVHFFrequencies @@ -12854,11 +12910,25 @@ callsigns from playername or group name.

- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -12982,17 +13052,6 @@ callsigns from playername or group name.

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

-
- -
-
-
- - -CSAR.index - - -
@@ -13201,6 +13260,20 @@ callsigns from playername or group name.

+
+
+
+ + #number +CSAR.rescuedpilots + + + + +

counter for saved pilots

+ +
+
@@ -13226,6 +13299,20 @@ callsigns from playername or group name.

+
+
+
+ + #number +CSAR.rescues + + + + +

counter for successful rescue landings at FARP/AFB/MASH

+ +
+
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index 3e58c43c7..5786065e4 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -7780,7 +7780,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -7791,14 +7791,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.FreeVHFFrequencies - -

Beacons

-
@@ -7971,6 +7968,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #number +CTLD.TroopCounter + + +
@@ -8151,6 +8159,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -17398,7 +17417,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeUHFFrequencies @@ -17409,14 +17428,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeVHFFrequencies - -

Beacons

-
@@ -17589,6 +17605,17 @@ However, if you create a new folder inside the miz file, which contains the soun +
+ +
+
+
+ + #number +CTLD.TroopCounter + + +
@@ -17769,6 +17796,17 @@ However, if you create a new folder inside the miz file, which contains the soun

#1570

+ + + +
+
+ + #table +CTLD.droppedBeacons + + +
@@ -19843,7 +19881,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeUHFFrequencies @@ -19854,14 +19892,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeVHFFrequencies - -

Beacons

-
@@ -20034,6 +20069,17 @@ However, if you create a new folder inside the miz file, which contains the soun +
+ +
+
+
+ + #number +CTLD.TroopCounter + + +
@@ -20214,6 +20260,17 @@ However, if you create a new folder inside the miz file, which contains the soun

#1570

+ + + +
+
+ + #table +CTLD.droppedBeacons + + +
@@ -33726,17 +33783,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

template for a group of 10 paratroopers

- - - -
-
- - #number -CTLD_HERCULES.j - - -
@@ -35063,17 +35109,6 @@ Use either this method to integrate the Hercules **or** the one from the "normal

template for a group of 10 paratroopers

- - - -
-
- - #number -CTLD_HERCULES.j - - -
diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index 86d5d534d..c41dceb9f 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -2931,7 +2931,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -3656,7 +3656,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -4832,7 +4832,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -6310,7 +6310,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_CARGO.html b/Documentation/Tasking.Task_CARGO.html index 7c7d9e5eb..e4e69621b 100644 --- a/Documentation/Tasking.Task_CARGO.html +++ b/Documentation/Tasking.Task_CARGO.html @@ -3223,7 +3223,7 @@ based on the tasking capabilities defined in
- + Cargo.Cargo#CARGO FSM_PROCESS.Cargo @@ -3260,7 +3260,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4682,7 +4682,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -9214,7 +9214,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 09d62b56e..da9a8eb65 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3205,6 +3205,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
@@ -3213,6 +3224,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+ @@ -4300,6 +4322,17 @@ This method can only be used once!

Field(s)

+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
@@ -4308,6 +4341,17 @@ This method can only be used once!

+
+ +
+ @@ -5147,6 +5191,17 @@ This method can only be used once!

Field(s)

+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
@@ -5155,6 +5210,17 @@ This method can only be used once!

+
+ +
+ @@ -6625,6 +6691,17 @@ This method can only be used once!

Field(s)

+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
+ +
@@ -6633,6 +6710,17 @@ This method can only be used once!

+
+ +
+ diff --git a/Documentation/Utilities.FiFo.html b/Documentation/Utilities.FiFo.html index 54ef00a0e..741d29a8d 100644 --- a/Documentation/Utilities.FiFo.html +++ b/Documentation/Utilities.FiFo.html @@ -7606,6 +7606,17 @@ When moose is loading dynamically (for moose class development), tracing is swit +
+ +
+
+
+ + #number +LIFO.uniquecounter + + +
@@ -8455,6 +8466,17 @@ When moose is loading dynamically (for moose class development), tracing is swit +
+ +
+
+
+ + #number +LIFO.uniquecounter + + +
diff --git a/Documentation/Utilities.Utils.html b/Documentation/Utilities.Utils.html index 1a955cd64..b4cbeec8c 100644 --- a/Documentation/Utilities.Utils.html +++ b/Documentation/Utilities.Utils.html @@ -1744,27 +1744,6 @@ -
- -
-
- - - - - -

Global lookup_table

 - -
-
-
-
- - #table -lookup_table - - -
diff --git a/Documentation/Wrapper.Airbase.html b/Documentation/Wrapper.Airbase.html index 6fe0ac74b..125a2b113 100644 --- a/Documentation/Wrapper.Airbase.html +++ b/Documentation/Wrapper.Airbase.html @@ -1683,10 +1683,6 @@ is implemented in the AIRBASE class as AIRBASE.Get

Type AIRBASE

AIRBASE -, extends Wrapper.Positionable#POSITIONABLE -, extends Wrapper.Identifiable#IDENTIFIABLE -, extends Wrapper.Object#OBJECT -, extends Core.Base#BASE
@@ -1697,25 +1693,19 @@ is implemented in the AIRBASE class as AIRBASE.Get - - - - @@ -1728,12 +1718,6 @@ is implemented in the AIRBASE class as AIRBASE.Get - - - - @@ -2334,1341 +2318,73 @@ is implemented in the AIRBASE class as AIRBASE.Get - -

AIRBASE.AirbaseID

 -

Airbase ID.

+

AIRBASE.AirbaseName

 -

Name of the airbase.

+

AIRBASE.AirbaseZone

 -

Circular zone around the airbase with a radius of 2500 meters. For ships this is a ZONE_UNIT object.

-

AIRBASE.CategoryName

 -

Names of airbase categories.

+

AIRBASE:CheckOnRunWay(group, radius, despawn)

Function that checks if at leat one unit of a group has been spawned close to a spawn point on the runway.

-

AIRBASE.ClassName

 -

Name of the class, i.e. "AIRBASE".

AIRBASE.category

 -

Airbase category.

+

AIRBASE.descriptors

 -

DCS descriptors.

+

AIRBASE.isAirdrome

 -

Airbase is an airdrome.

+

AIRBASE.isHelipad

 -

Airbase is a helipad.

+

AIRBASE.isShip

 -

Airbase is a ship.

+

AIRBASE.parking

 -

Parking spot data.

+

AIRBASE.parkingBlacklist

 -

List of parking spot terminal IDs not considered for spawning.

+

AIRBASE.parkingByID

 -

Parking spot data table with ID as key.

+

AIRBASE.parkingWhitelist

 -

List of parking spot terminal IDs considered for spawning.

+

AIRBASE.runwayLanding

 -

Runway used for landing.

+

AIRBASE.runwayTakeoff

 -

Runway used for takeoff.

+

AIRBASE.runways

 -

Runways of airdromes.

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from POSITIONABLEDescription

AIRBASE:AddCargo(Cargo)

 -

Add cargo.

-

AIRBASE:CargoItemCount()

 -

Get cargo item count.

-

AIRBASE:ClearCargo()

 -

Clear all cargo.

-

AIRBASE:Destroy(GenerateEvent)

 -

Destroys the POSITIONABLE.

-

AIRBASE:Explode(power, delay)

 -

Triggers an explosion at the coordinates of the positionable.

-

AIRBASE:Flare(FlareColor)

 -

Signal a flare at the position of the POSITIONABLE.

-

AIRBASE:FlareGreen()

 -

Signal a green flare at the position of the POSITIONABLE.

-

AIRBASE:FlareRed()

 -

Signal a red flare at the position of the POSITIONABLE.

-

AIRBASE:FlareWhite()

 -

Signal a white flare at the position of the POSITIONABLE.

-

AIRBASE:FlareYellow()

 -

Signal a yellow flare at the position of the POSITIONABLE.

-

AIRBASE:GetAirspeedIndicated(oatcorr)

 -

Returns the indicated airspeed (IAS).

-

AIRBASE:GetAirspeedTrue()

 -

Returns the true airspeed (TAS).

-

AIRBASE:GetAltitude()

 -

Returns the altitude above sea level of the POSITIONABLE.

-

AIRBASE:GetAoA()

 -

Returns the Angle of Attack of a POSITIONABLE.

-

AIRBASE:GetBeacon()

 -

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

-

AIRBASE:GetBoundingBox()

 -

Get the bounding box of the underlying POSITIONABLE DCS Object.

-

AIRBASE:GetBoundingRadius(MinDist)

 -

Get the bounding radius of the underlying POSITIONABLE DCS Object.

-

AIRBASE:GetCargo()

 -

Get all contained cargo.

-

AIRBASE:GetCargoBayFreeWeight()

 -

Get Cargo Bay Free Weight in kg.

-

AIRBASE:GetCargoBayWeightLimit()

 -

Get Cargo Bay Weight Limit in kg.

-

AIRBASE:GetClimbAngle()

 -

Returns the climb or descent angle of the POSITIONABLE.

-

AIRBASE:GetCoord()

 -

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

-

AIRBASE:GetCoordinate()

 -

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

-

AIRBASE:GetDCSObject()

 -

Returns the DCS object.

-

AIRBASE:GetGroundSpeed()

 -

Returns the horizonal speed relative to eath's surface.

-

AIRBASE:GetHeading()

 -

Returns the POSITIONABLE heading in degrees.

-

AIRBASE:GetHeight()

 -

Returns the POSITIONABLE height above sea level in meters.

-

AIRBASE:GetLaserCode()

 -

Get the last assigned laser code

-

AIRBASE:GetMessage(Message, Duration, Name)

 -

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

-

AIRBASE:GetMessageText(Message, Name)

 -

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

-

AIRBASE:GetMessageType(Message, MessageType, Name)

 -

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

-

AIRBASE:GetObjectSize()

 -

Get the object size.

-

AIRBASE:GetOffsetCoordinate(x, y, z)

 -

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

-

AIRBASE:GetOrientation()

 -

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

-

AIRBASE:GetOrientationX()

 -

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

-

AIRBASE:GetOrientationY()

 -

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

-

AIRBASE:GetOrientationZ()

 -

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

-

AIRBASE:GetPitch()

 -

Returns the pitch angle of a POSITIONABLE.

-

AIRBASE:GetPointVec2()

 -

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

-

AIRBASE:GetPointVec3()

 -

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

-

AIRBASE:GetPosition()

 -

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

-

AIRBASE:GetPositionVec3()

 -

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

-

AIRBASE:GetRadio()

 -

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

-

AIRBASE:GetRandomVec3(Radius)

 -

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

-

AIRBASE:GetRelativeCoordinate(x, y, z)

 -

Returns a COORDINATE object, which is transformed to be relative to the POSITIONABLE.

-

AIRBASE:GetRelativeVelocity(Positionable)

 -

Get relative velocity with respect to another POSITIONABLE.

-

AIRBASE:GetRoll()

 -

Returns the roll angle of a unit.

-

AIRBASE:GetSize()

 -

AIRBASE:GetSpot()

 -

Get the Spot

-

AIRBASE:GetTroopCapacity()

 -

Get the number of infantry soldiers that can be embarked into an aircraft (airplane or helicopter).

-

AIRBASE:GetVec2()

 -

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

-

AIRBASE:GetVec3()

 -

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

-

AIRBASE:GetVelocity()

 -

Returns the Core.Velocity object from the POSITIONABLE.

-

AIRBASE:GetVelocityKMH()

 -

Returns the POSITIONABLE velocity in km/h.

-

AIRBASE:GetVelocityKNOTS()

 -

Returns the POSITIONABLE velocity in knots.

-

AIRBASE:GetVelocityMPS()

 -

Returns the POSITIONABLE velocity in meters per second.

-

AIRBASE:GetVelocityVec3()

 -

Returns the POSITIONABLE velocity Vec3 vector.

-

AIRBASE:GetYaw()

 -

Returns the yaw angle of a POSITIONABLE.

-

AIRBASE:HasCargo(Cargo)

 -

Returns if carrier has given cargo.

-

AIRBASE:InAir()

 -

Returns true if the POSITIONABLE is in the air.

-

AIRBASE:IsAboveRunway()

 -

Returns if the Positionable is located above a runway.

-

AIRBASE:IsAir()

 -

Returns if the unit is of an air category.

-

AIRBASE:IsCargoEmpty()

 -

Is cargo bay empty.

-

AIRBASE:IsGround()

 -

Returns if the unit is of an ground category.

-

AIRBASE:IsInZone(Zone)

 -

Returns true if the unit is within a Core.Zone.

-

AIRBASE:IsLasing()

 -

Check if the POSITIONABLE is lasing a target.

-

AIRBASE:IsNotInZone(Zone)

 -

Returns true if the unit is not within a Core.Zone.

-

AIRBASE:IsShip()

 -

Returns if the unit is of ship category.

-

AIRBASE:IsSubmarine()

 -

Returns if the unit is a submarine.

-

AIRBASE:LaseCoordinate(Coordinate, LaserCode, Duration)

 -

Start Lasing a COORDINATE.

-

AIRBASE:LaseOff()

 -

Stop Lasing a POSITIONABLE.

-

AIRBASE:LaseUnit(Target, LaserCode, Duration)

 -

Start Lasing a POSITIONABLE.

-

AIRBASE.LaserCode

 - -

AIRBASE:Message(Message, Duration, Name)

 -

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

-

AIRBASE:MessageToAll(Message, Duration, Name)

 -

Send a message to all coalitions.

-

AIRBASE:MessageToBlue(Message, Duration, Name)

 -

Send a message to the blue coalition.

-

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

 -

Send a message to a client.

-

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

 -

Send a message to a coalition.

-

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

 -

Send a message to a Wrapper.Group.

-

AIRBASE:MessageToRed(Message, Duration, Name)

 -

Send a message to the red coalition.

-

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

 -

Send a message to a Core.Set#SET_GROUP.

-

AIRBASE:MessageToSetUnit(Message, Duration, MessageSetUnit, Name)

 -

Send a message to a Core.Set#SET_UNIT.

-

AIRBASE:MessageToUnit(Message, Duration, MessageUnit, Name)

 -

Send a message to a Wrapper.Unit.

-

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

 -

Send a message to a coalition.

-

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

 -

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

-

AIRBASE:New(PositionableName)

 -

Create a new POSITIONABLE from a DCSPositionable

-

AIRBASE.PositionableName

 - -

AIRBASE:RemoveCargo(Cargo)

 -

Remove cargo.

-

AIRBASE:SetCargoBayWeightLimit(WeightLimit)

 -

Set Cargo Bay Weight Limit in kg.

-

AIRBASE:Smoke(SmokeColor, Range, AddHeight)

 -

Smoke the POSITIONABLE.

-

AIRBASE:SmokeBlue()

 -

Smoke the POSITIONABLE Blue.

-

AIRBASE:SmokeGreen()

 -

Smoke the POSITIONABLE Green.

-

AIRBASE:SmokeOrange()

 -

Smoke the POSITIONABLE Orange.

-

AIRBASE:SmokeRed()

 -

Smoke the POSITIONABLE Red.

-

AIRBASE:SmokeWhite()

 -

Smoke the POSITIONABLE White.

-

AIRBASE.Spot

 - -

AIRBASE.__

 - -

AIRBASE.coordinate

 -

Coordinate object.

-

AIRBASE.pointvec3

 -

Point Vec3 object.

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from IDENTIFIABLEDescription

AIRBASE:GetCallsign()

 -

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

-

AIRBASE:GetCategory()

 -

Returns object category of the DCS Identifiable.

-

AIRBASE:GetCategoryName()

 -

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

-

AIRBASE:GetCoalition()

 -

Returns coalition of the Identifiable.

-

AIRBASE:GetCoalitionName()

 -

Returns the name of the coalition of the Identifiable.

-

AIRBASE:GetCountry()

 -

Returns country of the Identifiable.

-

AIRBASE:GetCountryName()

 -

Returns country name of the Identifiable.

-

AIRBASE:GetDesc()

 -

Returns Identifiable descriptor.

-

AIRBASE:GetName()

 -

Returns DCS Identifiable object name.

-

AIRBASE:GetThreatLevel()

 -

Gets the threat level.

-

AIRBASE:GetTypeName()

 -

Returns the type name of the DCS Identifiable.

-

AIRBASE:HasAttribute(AttributeName)

 -

Check if the Object has the attribute.

-

AIRBASE.IdentifiableName

 -

The name of the identifiable.

-

AIRBASE:IsAlive()

 -

Returns if the Identifiable is alive.

-

AIRBASE:New(IdentifiableName)

 -

Create a new IDENTIFIABLE from a DCSIdentifiable

-
-
-
- - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from OBJECTDescription

AIRBASE:Destroy()

 -

Destroys the OBJECT.

-

AIRBASE:GetID()

 -

Returns the unit's unique identifier.

-

AIRBASE:New(ObjectName, Test)

 -

Create a new OBJECT from a DCSObject

-

AIRBASE.ObjectName

 -

The name of the Object.

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

AIRBASE.ClassID

 -

The ID number of the class.

-

AIRBASE.ClassName

 -

The name of the class.

-

AIRBASE.ClassNameAndID

 -

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

-

AIRBASE:ClearState(Object, StateName)

 -

Clear the state of an object.

-

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

 -

Creation of a Birth Event.

-

AIRBASE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Crash Event.

-

AIRBASE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Dead Event.

-

AIRBASE:CreateEventPlayerEnterAircraft(PlayerUnit)

 -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

-

AIRBASE:CreateEventRemoveUnit(EventTime, Initiator)

 -

Creation of a Remove Unit Event.

-

AIRBASE:CreateEventTakeoff(EventTime, Initiator)

 -

Creation of a Takeoff Event.

-

AIRBASE:CreateEventUnitLost(EventTime, Initiator)

 -

Creation of a Crash Event.

-

AIRBASE:E(Arguments)

 -

Log an exception which will be traced always.

-

AIRBASE:EventDispatcher()

 -

Returns the event dispatcher

-

AIRBASE:EventRemoveAll()

 -

Remove all subscribed events

-

AIRBASE:F(Arguments)

 -

Trace a function call.

-

AIRBASE:F2(Arguments)

 -

Trace a function call level 2.

-

AIRBASE:F3(Arguments)

 -

Trace a function call level 3.

-

AIRBASE:GetClassID()

 -

Get the ClassID of the class instance.

-

AIRBASE:GetClassName()

 -

Get the ClassName of the class instance.

-

AIRBASE:GetClassNameAndID()

 -

Get the ClassName + ClassID of the class instance.

-

AIRBASE:GetEventPriority()

 -

Get the Class Core.Event processing Priority.

-

AIRBASE:GetParent(Child, FromClass)

 -

This is the worker method to retrieve the Parent class.

-

AIRBASE:GetState(Object, Key)

 -

Get a Value given a Key from the Object.

-

AIRBASE:HandleEvent(EventID, EventFunction)

 -

Subscribe to a DCS Event.

-

AIRBASE:I(Arguments)

 -

Log an information which will be traced always.

-

AIRBASE:Inherit(Child, Parent)

 -

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

-

AIRBASE:IsInstanceOf(ClassName)

 -

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

-

AIRBASE:IsTrace()

 -

Enquires if tracing is on (for the class).

-

AIRBASE:New()

 -

BASE constructor.

-

AIRBASE:OnEvent(EventData)

 -

Occurs when an Event for an object is triggered.

-

AIRBASE:OnEventBDA(EventData)

 -

BDA.

-

AIRBASE:OnEventBaseCaptured(EventData)

 -

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

-

AIRBASE:OnEventBirth(EventData)

 -

Occurs when any object is spawned into the mission.

-

AIRBASE:OnEventCrash(EventData)

 -

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

-

AIRBASE:OnEventDead(EventData)

 -

Occurs when an object is dead.

-

AIRBASE:OnEventDetailedFailure(EventData)

 -

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

-

AIRBASE:OnEventDiscardChairAfterEjection(EventData)

 -

Discard chair after ejection.

-

AIRBASE:OnEventEjection(EventData)

 -

Occurs when a pilot ejects from an aircraft -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

AIRBASE:OnEventEngineShutdown(EventData)

 -

Occurs when any aircraft shuts down its engines.

-

AIRBASE:OnEventEngineStartup(EventData)

 -

Occurs when any aircraft starts its engines.

-

AIRBASE:OnEventHit(EventData)

 -

Occurs whenever an object is hit by a weapon.

-

AIRBASE:OnEventHumanFailure(EventData)

 -

Occurs when any system fails on a human controlled aircraft.

-

AIRBASE:OnEventKill(EventData)

 -

Occurs on the death of a unit.

-

AIRBASE:OnEventLand(EventData)

 -

Occurs when an aircraft lands at an airbase, farp or ship -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

AIRBASE:OnEventLandingAfterEjection(EventData)

 -

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

-

AIRBASE:OnEventLandingQualityMark(EventData)

 -

Landing quality mark.

-

AIRBASE:OnEventMarkAdded(EventData)

 -

Occurs when a new mark was added.

-

AIRBASE:OnEventMarkChange(EventData)

 -

Occurs when a mark text was changed.

-

AIRBASE:OnEventMarkRemoved(EventData)

 -

Occurs when a mark was removed.

-

AIRBASE:OnEventMissionEnd(EventData)

 -

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

AIRBASE:OnEventMissionStart(EventData)

 -

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

AIRBASE:OnEventParatrooperLanding(EventData)

 -

Weapon add.

-

AIRBASE:OnEventPilotDead(EventData)

 -

Occurs when the pilot of an aircraft is killed.

-

AIRBASE:OnEventPlayerEnterAircraft(EventData)

 -

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

-

AIRBASE:OnEventPlayerEnterUnit(EventData)

 -

Occurs when any player assumes direct control of a unit.

-

AIRBASE:OnEventPlayerLeaveUnit(EventData)

 -

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

-

AIRBASE:OnEventRefueling(EventData)

 -

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

-

AIRBASE:OnEventRefuelingStop(EventData)

 -

Occurs when an aircraft is finished taking fuel.

-

AIRBASE:OnEventScore(EventData)

 -

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

-

AIRBASE:OnEventShootingEnd(EventData)

 -

Occurs when any unit stops firing its weapon.

-

AIRBASE:OnEventShootingStart(EventData)

 -

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

-

AIRBASE:OnEventShot(EventData)

 -

Occurs whenever any unit in a mission fires a weapon.

-

AIRBASE:OnEventTakeoff(EventData)

 -

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

-

AIRBASE:OnEventTriggerZone(EventData)

 -

Trigger zone.

-

AIRBASE:OnEventUnitLost(EventData)

 -

Occurs when the game thinks an object is destroyed.

-

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

 -

Schedule a new time event.

-

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

 -

Schedule a new time event.

-

AIRBASE:ScheduleStop(SchedulerID)

 -

Stops the Schedule.

-

AIRBASE.Scheduler

 - -

AIRBASE:SetEventPriority(EventPriority)

 -

Set the Class Core.Event processing Priority.

-

AIRBASE:SetState(Object, Key, Value)

 -

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

-

AIRBASE:T(Arguments)

 -

Trace a function logic level 1.

-

AIRBASE:T2(Arguments)

 -

Trace a function logic level 2.

-

AIRBASE:T3(Arguments)

 -

Trace a function logic level 3.

-

AIRBASE:TraceAll(TraceAll)

 -

Trace all methods in MOOSE

-

AIRBASE:TraceClass(Class)

 -

Set tracing for a class

-

AIRBASE:TraceClassMethod(Class, Method)

 -

Set tracing for a specific method of class

-

AIRBASE:TraceLevel(Level)

 -

Set trace level

-

AIRBASE:TraceOff()

 -

Set trace off.

-

AIRBASE:TraceOn()

 -

Set trace on.

-

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

-

AIRBASE:UnHandleEvent(EventID)

 -

UnSubscribe to a DCS event.

-

AIRBASE._

 - -

AIRBASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function call.

-

AIRBASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function logic.

-

AIRBASE.__

 - -

AIRBASE:onEvent(event)

 -

The main event handling function...
@@ -3969,10 +2685,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + AIRBASE.AirbaseID -

Airbase ID.

+ + + +

Set airbase ID.

@@ -3980,10 +2699,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + AIRBASE.AirbaseName -

Name of the airbase.

+ + + +

Set airbase name.

@@ -3991,21 +2713,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Core.Zone#ZONE + AIRBASE.AirbaseZone -

Circular zone around the airbase with a radius of 2500 meters. For ships this is a ZONE_UNIT object.

-
- -
-
-
- - #table -AIRBASE.CategoryName - -

Names of airbase categories.

@@ -4047,17 +2758,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #string -AIRBASE.ClassName - -

Name of the class, i.e. "AIRBASE".

-
@@ -4449,21 +3149,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number -AIRBASE.category -

Airbase category.

- -
- -
-
-
- - #table AIRBASE.descriptors -

DCS descriptors.

+ + + +

Get descriptors.

@@ -4474,7 +3166,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #boolean AIRBASE.isAirdrome -

Airbase is an airdrome.

+
@@ -4485,7 +3177,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #boolean AIRBASE.isHelipad -

Airbase is a helipad.

+
@@ -4496,7 +3188,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #boolean AIRBASE.isShip -

Airbase is a ship.

+
@@ -4507,7 +3199,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #table AIRBASE.parking -

Parking spot data.

+ + + +

Init table.

@@ -4518,7 +3213,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #table AIRBASE.parkingBlacklist -

List of parking spot terminal IDs not considered for spawning.

+
@@ -4529,7 +3224,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #table AIRBASE.parkingByID -

Parking spot data table with ID as key.

+
@@ -4540,7 +3235,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #table AIRBASE.parkingWhitelist -

List of parking spot terminal IDs considered for spawning.

+
@@ -4548,10 +3243,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #AIRBASE.Runway + AIRBASE.runwayLanding -

Runway used for landing.

+
@@ -4559,10 +3254,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #AIRBASE.Runway + AIRBASE.runwayTakeoff -

Runway used for takeoff.

+
@@ -4573,7 +3268,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #table AIRBASE.runways -

Runways of airdromes.

+
@@ -6749,10385 +5444,6 @@ Note that this DOES NOT remove the airbase from the list. It just makes it unres
-
-

Field(s)

-
-
-
- - #number -AIRBASE.AirbaseID - -

Airbase ID.

- -
- -
-
-
- - #string -AIRBASE.AirbaseName - -

Name of the airbase.

- -
- -
-
-
- - Core.Zone#ZONE -AIRBASE.AirbaseZone - -

Circular zone around the airbase with a radius of 2500 meters. For ships this is a ZONE_UNIT object.

- -
- -
-
-
- - #table -AIRBASE.CategoryName - -

Names of airbase categories.

- -
- -
-
-
- - #table -AIRBASE.Caucasus - -

Enumeration to identify the airbases in the Caucasus region.

- - - -

Airbases of the Caucasus map:

- -
    -
  • AIRBASE.Caucasus.Gelendzhik
    • -
  • AIRBASE.Caucasus.Krasnodar_Pashkovsky
    • -
  • AIRBASE.Caucasus.Sukhumi_Babushara
    • -
  • AIRBASE.Caucasus.Gudauta
    • -
  • AIRBASE.Caucasus.Batumi
    • -
  • AIRBASE.Caucasus.Senaki_Kolkhi
    • -
  • AIRBASE.Caucasus.Kobuleti
    • -
  • AIRBASE.Caucasus.Kutaisi
    • -
  • AIRBASE.Caucasus.Tbilisi_Lochini
    • -
  • AIRBASE.Caucasus.Soganlug
    • -
  • AIRBASE.Caucasus.Vaziani
    • -
  • AIRBASE.Caucasus.Anapa_Vityazevo
    • -
  • AIRBASE.Caucasus.Krasnodar_Center
    • -
  • AIRBASE.Caucasus.Novorossiysk
    • -
  • AIRBASE.Caucasus.Krymsk
    • -
  • AIRBASE.Caucasus.Maykop_Khanskaya
    • -
  • AIRBASE.Caucasus.Sochi_Adler
    • -
  • AIRBASE.Caucasus.Mineralnye_Vody
    • -
  • AIRBASE.Caucasus.Nalchik
    • -
  • AIRBASE.Caucasus.Mozdok
    • -
  • AIRBASE.Caucasus.Beslan
    • -
- - -
- -
-
-
- - #string -AIRBASE.ClassName - -

Name of the class, i.e. "AIRBASE".

- -
- -
-
-
- - #table -AIRBASE.MarianaIslands - -

Airbases of the Mariana Islands map:

- -
    -
  • AIRBASE.MarianaIslands.Rota_Intl
    • -
  • AIRBASE.MarianaIslands.Andersen_AFB
    • -
  • AIRBASE.MarianaIslands.Antonio_B_Won_Pat_Intl
    • -
  • AIRBASE.MarianaIslands.Saipan_Intl
    • -
  • AIRBASE.MarianaIslands.Tinian_Intl
    • -
  • AIRBASE.MarianaIslands.Olf_Orote
    • -
- - -
- -
-
-
- - #table -AIRBASE.Nevada - -

Airbases of the Nevada map:

- -
    -
  • AIRBASE.Nevada.Creech_AFB
    • -
  • AIRBASE.Nevada.Groom_Lake_AFB
    • -
  • AIRBASE.Nevada.McCarran_International_Airport
    • -
  • AIRBASE.Nevada.Nellis_AFB
    • -
  • AIRBASE.Nevada.Beatty_Airport
    • -
  • AIRBASE.Nevada.Boulder_City_Airport
    • -
  • AIRBASE.Nevada.Echo_Bay
    • -
  • AIRBASE.Nevada.Henderson_Executive_Airport
    • -
  • AIRBASE.Nevada.Jean_Airport
    • -
  • AIRBASE.Nevada.Laughlin_Airport
    • -
  • AIRBASE.Nevada.Lincoln_County
    • -
  • AIRBASE.Nevada.Mesquite
    • -
  • AIRBASE.Nevada.Mina_Airport
    • -
  • AIRBASE.Nevada.North_Las_Vegas
    • -
  • AIRBASE.Nevada.Pahute_Mesa_Airstrip
    • -
  • AIRBASE.Nevada.Tonopah_Airport
    • -
  • AIRBASE.Nevada.Tonopah_Test_Range_Airfield
    • -
- - -
- -
-
-
- - #table -AIRBASE.Normandy - -

Airbases of the Normandy map:

- -
    -
  • AIRBASE.Normandy.Saint_Pierre_du_Mont
    • -
  • AIRBASE.Normandy.Lignerolles
    • -
  • AIRBASE.Normandy.Cretteville
    • -
  • AIRBASE.Normandy.Maupertus
    • -
  • AIRBASE.Normandy.Brucheville
    • -
  • AIRBASE.Normandy.Meautis
    • -
  • AIRBASE.Normandy.Cricqueville_en_Bessin
    • -
  • AIRBASE.Normandy.Lessay
    • -
  • AIRBASE.Normandy.Sainte_Laurent_sur_Mer
    • -
  • AIRBASE.Normandy.Biniville
    • -
  • AIRBASE.Normandy.Cardonville
    • -
  • AIRBASE.Normandy.Deux_Jumeaux
    • -
  • AIRBASE.Normandy.Chippelle
    • -
  • AIRBASE.Normandy.Beuzeville
    • -
  • AIRBASE.Normandy.Azeville
    • -
  • AIRBASE.Normandy.Picauville
    • -
  • AIRBASE.Normandy.Le_Molay
    • -
  • AIRBASE.Normandy.Longues_sur_Mer
    • -
  • AIRBASE.Normandy.Carpiquet
    • -
  • AIRBASE.Normandy.Bazenville
    • -
  • AIRBASE.Normandy.Sainte_Croix_sur_Mer
    • -
  • AIRBASE.Normandy.Beny_sur_Mer
    • -
  • AIRBASE.Normandy.Rucqueville
    • -
  • AIRBASE.Normandy.Sommervieu
    • -
  • AIRBASE.Normandy.Lantheuil
    • -
  • AIRBASE.Normandy.Evreux
    • -
  • AIRBASE.Normandy.Chailey
    • -
  • AIRBASE.Normandy.Needs_Oar_Point
    • -
  • AIRBASE.Normandy.Funtington
    • -
  • AIRBASE.Normandy.Tangmere
    • -
  • AIRBASE.Normandy.Ford
    • -
  • AIRBASE.Normandy.Argentan
    • -
  • AIRBASE.Normandy.Goulet
    • -
  • AIRBASE.Normandy.Barville
    • -
  • AIRBASE.Normandy.Essay
    • -
  • AIRBASE.Normandy.Hauterive
    • -
  • AIRBASE.Normandy.Lymington
    • -
  • AIRBASE.Normandy.Vrigny
    • -
  • AIRBASE.Normandy.Odiham
    • -
  • AIRBASE.Normandy.Conches
    • -
  • AIRBASE.Normandy.West_Malling
    • -
  • AIRBASE.Normandy.Villacoublay
    • -
  • AIRBASE.Normandy.Kenley
    • -
  • AIRBASE.Normandy.Beauvais_Tille
    • -
  • AIRBASE.Normandy.Cormeilles_en_Vexin
    • -
  • AIRBASE.Normandy.Creil
    • -
  • AIRBASE.Normandy.Guyancourt
    • -
  • AIRBASE.Normandy.Lonrai
    • -
  • AIRBASE.Normandy.Dinan_Trelivan
    • -
  • AIRBASE.Normandy.Heathrow
    • -
  • AIRBASE.Normandy.Fecamp_Benouville
    • -
  • AIRBASE.Normandy.Farnborough
    • -
  • AIRBASE.Normandy.Friston
    • -
  • AIRBASE.Normandy.Deanland
    • -
  • AIRBASE.Normandy.Triqueville
    • -
  • AIRBASE.Normandy.Poix
    • -
  • AIRBASE.Normandy.Orly
    • -
  • AIRBASE.Normandy.Stoney_Cross
    • -
  • AIRBASE.Normandy.Amiens_Glisy
    • -
  • AIRBASE.Normandy.Ronai
    • -
  • AIRBASE.Normandy.Rouen_Boos
    • -
  • AIRBASE.Normandy.Deauville
    • -
  • AIRBASE.Normandy.Saint_Aubin
    • -
  • AIRBASE.Normandy.Flers
    • -
  • AIRBASE.Normandy.Avranches_Le_Val_Saint_Pere
    • -
  • AIRBASE.Normandy.Gravesend
    • -
  • AIRBASE.Normandy.Beaumont_le_Roger
    • -
  • AIRBASE.Normandy.Broglie
    • -
  • AIRBASE.Normandy.Bernay_Saint_Martin
    • -
  • AIRBASE.Normandy.Saint_Andre_de_lEure
    • -
- - -
- -
-
-
- - #table -AIRBASE.NparkingTerminal - - - -
- -
-
-
- - #number -AIRBASE.NparkingTotal - - - -
- -
-
-
- - #table -AIRBASE.PersianGulf - -

Airbases of the Persion Gulf Map:

- -
    -
  • AIRBASE.PersianGulf.Abu_Dhabi_International_Airport
    • -
  • AIRBASE.PersianGulf.Abu_Musa_Island_Airport
    • -
  • AIRBASE.PersianGulf.Al_Bateen_Airport
    • -
  • AIRBASE.PersianGulf.Al_Ain_International_Airport
    • -
  • AIRBASE.PersianGulf.Al_Dhafra_AB
    • -
  • AIRBASE.PersianGulf.Al_Maktoum_Intl
    • -
  • AIRBASE.PersianGulf.Al_Minhad_AB
    • -
  • AIRBASE.PersianGulf.Bandar_e_Jask_airfield
    • -
  • AIRBASE.PersianGulf.Bandar_Abbas_Intl
    • -
  • AIRBASE.PersianGulf.Bandar_Lengeh
    • -
  • AIRBASE.PersianGulf.Dubai_Intl
    • -
  • AIRBASE.PersianGulf.Fujairah_Intl
    • -
  • AIRBASE.PersianGulf.Havadarya
    • -
  • AIRBASE.PersianGulf.Jiroft_Airport
    • -
  • AIRBASE.PersianGulf.Kerman_Airport
    • -
  • AIRBASE.PersianGulf.Khasab
    • -
  • AIRBASE.PersianGulf.Kish_International_Airport
    • -
  • AIRBASE.PersianGulf.Lar_Airbase
    • -
  • AIRBASE.PersianGulf.Lavan_Island_Airport
    • -
  • AIRBASE.PersianGulf.Liwa_Airbase
    • -
  • AIRBASE.PersianGulf.Qeshm_Island
    • -
  • AIRBASE.PersianGulf.Ras_Al_Khaimah
    • -
  • AIRBASE.PersianGulf.Sas_Al_Nakheel_Airport
    • -
  • AIRBASE.PersianGulf.Sharjah_Intl
    • -
  • AIRBASE.PersianGulf.Shiraz_International_Airport
    • -
  • AIRBASE.PersianGulf.Sir_Abu_Nuayr
    • -
  • AIRBASE.PersianGulf.Sirri_Island
    • -
  • AIRBASE.PersianGulf.Tunb_Island_AFB
    • -
  • AIRBASE.PersianGulf.Tunb_Kochak
    • -
- - -
- -
-
-
- - #table -AIRBASE.Sinai - -

Airbases of the Sinai map:

- -
    -
  • AIRBASE.Sinai.Abu_Suwayr
    • -
  • AIRBASE.Sinai.Sde_Dov
    • -
  • AIRBASE.Sinai.AzZaqaziq
    • -
  • AIRBASE.Sinai.Hatzor
    • -
  • AIRBASE.Sinai.Kedem
    • -
  • AIRBASE.Sinai.Nevatim
    • -
  • AIRBASE.Sinai.Cairo_International_Airport
    • -
  • AIRBASE.Sinai.Al_Ismailiyah
    • -
  • AIRBASE.Sinai.As_Salihiyah
    • -
  • AIRBASE.Sinai.Fayed
    • -
  • AIRBASE.Sinai.Bilbeis_Air_Base
    • -
  • AIRBASE.Sinai.Ramon_Airbase
    • -
  • AIRBASE.Sinai.Kibrit_Air_Base
    • -
  • AIRBASE.Sinai.El_Arish
    • -
  • AIRBASE.Sinai.Ovda
    • -
  • AIRBASE.Sinai.Melez
    • -
  • AIRBASE.Sinai.Al_Mansurah
    • -
  • AIRBASE.Sinai.Palmahim
    • -
  • AIRBASE.Sinai.Baluza
    • -
  • AIRBASE.Sinai.El_Gora
    • -
  • AIRBASE.Sinai.Difarsuwar_Airfield
    • -
  • AIRBASE.Sinai.Wadi_al_Jandali
    • -
  • AIRBASE.Sinai.St_Catherine
    • -
  • AIRBASE.Sinai.Tel_Nof
    • -
  • AIRBASE.Sinai.Abu_Rudeis
    • -
  • AIRBASE.Sinai.Inshas_Airbase
    • -
  • AIRBASE.Sinai.Ben_Gurion
    • -
  • AIRBASE.Sinai.Bir_Hasanah
    • -
  • AIRBASE.Sinai.Cairo_West
    • -
- - -
- -
-
-
- - #table -AIRBASE.SouthAtlantic - - - -
- -
-
-
- - #AIRBASE.SpotStatus -AIRBASE.SpotStatus - - - -
- -
-
-
- - #table -AIRBASE.Syria - -

Airbases of the Syria map:

- -
    -
  • AIRBASE.Syria.Kuweires
    • -
  • AIRBASE.Syria.Marj_Ruhayyil
    • -
  • AIRBASE.Syria.Kiryat_Shmona
    • -
  • AIRBASE.Syria.Marj_as_Sultan_North
    • -
  • AIRBASE.Syria.Eyn_Shemer
    • -
  • AIRBASE.Syria.Incirlik
    • -
  • AIRBASE.Syria.Damascus
    • -
  • AIRBASE.Syria.Bassel_Al_Assad
    • -
  • AIRBASE.Syria.Rosh_Pina
    • -
  • AIRBASE.Syria.Aleppo
    • -
  • AIRBASE.Syria.Al_Qusayr
    • -
  • AIRBASE.Syria.Wujah_Al_Hajar
    • -
  • AIRBASE.Syria.Al_Dumayr
    • -
  • AIRBASE.Syria.Gazipasa
    • -
  • AIRBASE.Syria.Hatay
    • -
  • AIRBASE.Syria.Nicosia [Deactivated by ED as of June/2023]
    • -
  • AIRBASE.Syria.Pinarbashi
    • -
  • AIRBASE.Syria.Paphos
    • -
  • AIRBASE.Syria.Kingsfield
    • -
  • AIRBASE.Syria.Thalah
    • -
  • AIRBASE.Syria.Haifa
    • -
  • AIRBASE.Syria.Khalkhalah
    • -
  • AIRBASE.Syria.Megiddo
    • -
  • AIRBASE.Syria.Lakatamia
    • -
  • AIRBASE.Syria.Rayak
    • -
  • AIRBASE.Syria.Larnaca
    • -
  • AIRBASE.Syria.Mezzeh
    • -
  • AIRBASE.Syria.Gecitkale
    • -
  • AIRBASE.Syria.Akrotiri
    • -
  • AIRBASE.Syria.Naqoura
    • -
  • AIRBASE.Syria.Gaziantep
    • -
  • AIRBASE.Syria.Sayqal
    • -
  • AIRBASE.Syria.Tiyas
    • -
  • AIRBASE.Syria.Shayrat
    • -
  • AIRBASE.Syria.Taftanaz
    • -
  • AIRBASE.Syria.H4
    • -
  • AIRBASE.Syria.King_Hussein_Air_College
    • -
  • AIRBASE.Syria.Rene_Mouawad
    • -
  • AIRBASE.Syria.Jirah
    • -
  • AIRBASE.Syria.Ramat_David
    • -
  • AIRBASE.Syria.Qabr_as_Sitt
    • -
  • AIRBASE.Syria.Minakh
    • -
  • AIRBASE.Syria.Adana_Sakirpasa
    • -
  • AIRBASE.Syria.Palmyra
    • -
  • AIRBASE.Syria.Hama
    • -
  • AIRBASE.Syria.Ercan
    • -
  • AIRBASE.Syria.Marj_as_Sultan_South
    • -
  • AIRBASE.Syria.Tabqa
    • -
  • AIRBASE.Syria.Beirut_Rafic_Hariri
    • -
  • AIRBASE.Syria.An_Nasiriyah
    • -
  • AIRBASE.Syria.Abu_al_Duhur
    • -
  • AIRBASE.Syria.At_Tanf
    • -
  • AIRBASE.Syria.H3
    • -
  • AIRBASE.Syria.H3_Northwest
    • -
  • AIRBASE.Syria.H3_Southwest
    • -
  • AIRBASE.Syria.Kharab_Ishk
    • -
  • AIRBASE.Syria.Raj_al_Issa_East (deleted by ED)
    • -
  • AIRBASE.Syria.Raj_al_Issa_West (deleted by ED)
    • -
  • AIRBASE.Syria.Ruwayshid
    • -
  • AIRBASE.Syria.Sanliurfa
    • -
  • AIRBASE.Syria.Tal_Siman
    • -
  • AIRBASE.Syria.Deir_ez_Zor
    • -
- - -
- -
-
-
- - #AIRBASE.TerminalType -AIRBASE.TerminalType - - - -
- -
-
-
- - #table -AIRBASE.TheChannel - -

Airbases of The Channel Map:

- -
    -
  • AIRBASE.TheChannel.Abbeville_Drucat
    • -
  • AIRBASE.TheChannel.Merville_Calonne
    • -
  • AIRBASE.TheChannel.Saint_Omer_Longuenesse
    • -
  • AIRBASE.TheChannel.Dunkirk_Mardyck
    • -
  • AIRBASE.TheChannel.Manston
    • -
  • AIRBASE.TheChannel.Hawkinge
    • -
  • AIRBASE.TheChannel.Lympne
    • -
  • AIRBASE.TheChannel.Detling
    • -
  • AIRBASE.TheChannel.High_Halden
    • -
  • AIRBASE.TheChannel.Biggin_Hill
    • -
  • AIRBASE.TheChannel.Eastchurch
    • -
  • AIRBASE.TheChannel.Headcorn
    • -
- - -
- -
-
-
- - #number -AIRBASE.category - -

Airbase category.

- -
- -
-
-
- - #table -AIRBASE.descriptors - -

DCS descriptors.

- -
- -
-
-
- - #boolean -AIRBASE.isAirdrome - -

Airbase is an airdrome.

- -
- -
-
-
- - #boolean -AIRBASE.isHelipad - -

Airbase is a helipad.

- -
- -
-
-
- - #boolean -AIRBASE.isShip - -

Airbase is a ship.

- -
- -
-
-
- - #table -AIRBASE.parking - -

Parking spot data.

- -
- -
-
-
- - #table -AIRBASE.parkingBlacklist - -

List of parking spot terminal IDs not considered for spawning.

- -
- -
-
-
- - #table -AIRBASE.parkingByID - -

Parking spot data table with ID as key.

- -
- -
-
-
- - #table -AIRBASE.parkingWhitelist - -

List of parking spot terminal IDs considered for spawning.

- -
- -
-
-
- - #AIRBASE.Runway -AIRBASE.runwayLanding - -

Runway used for landing.

- -
- -
-
-
- - #AIRBASE.Runway -AIRBASE.runwayTakeoff - -

Runway used for takeoff.

- -
- -
-
-
- - #table -AIRBASE.runways - -

Runways of airdromes.

- -
- -
-
-

Function(s)

-
-
- -
-

AIRBASE:AddCargo(Cargo)

-
- -

Add cargo.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Parameter:

-
-
-

- Core.Cargo#CARGO - Cargo -

-
-
-

-
-
-

Return value:

-
-
-

#POSITIONABLE:

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

AIRBASE:CargoItemCount()

-
- -

Get cargo item count.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

Core.Cargo#CARGO:

-
-
- -

Cargo

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

AIRBASE:ClearCargo()

-
- -

Clear all cargo.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
- -
-

AIRBASE: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.
-
    • -
- -
- -
-
- -
- -
-

AIRBASE:Explode(power, delay)

-
- -

Triggers an explosion at the coordinates of the positionable.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Parameters:

-
-
-

- #number - power -

-
-
- -

Power of the explosion in kg TNT. Default 100 kg TNT.

- -
-
-
-
-

- #number - delay -

-
-
- -

(Optional) Delay of explosion in seconds.

- -
-
-

Return value:

-
-
-

#POSITIONABLE:

-
-
- -

self

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

AIRBASE:Flare(FlareColor)

-
- -

Signal a flare at the position of the POSITIONABLE.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Parameter:

-
-
-

- Utilities.Utils#FLARECOLOR - FlareColor -

-
-
-

-
-
-
- -
-
- -
- -
-

AIRBASE:FlareGreen()

-
- -

Signal a green flare at the position of the POSITIONABLE.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
- -
-

AIRBASE:FlareRed()

-
- -

Signal a red flare at the position of the POSITIONABLE.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
- -
-

AIRBASE:FlareWhite()

-
- -

Signal a white flare at the position of the POSITIONABLE.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
- -
-

AIRBASE:FlareYellow()

-
- -

Signal a yellow flare at the position of the POSITIONABLE.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
- -
-

AIRBASE:GetAirspeedIndicated(oatcorr)

-
- -

Returns the indicated airspeed (IAS).

- - -

The IAS is calculated from the TAS under the approximation that TAS increases by ~2% with every 1000 feet altitude ASL.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Parameter:

-
-
-

- #number - oatcorr -

-
-
- -

(Optional) Outside air temperature (OAT) correction factor. Default 0.017 (=1.7%).

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

IAS in m/s. Returns 0 if the POSITIONABLE does not exist.

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

AIRBASE:GetAirspeedTrue()

-
- -

Returns the true airspeed (TAS).

- - -

This is calculated from the current velocity minus wind in 3D.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#number:

-
-
- -

TAS in m/s. Returns 0 if the POSITIONABLE does not exist.

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

AIRBASE:GetAltitude()

-
- -

Returns the altitude above sea level 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.

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

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

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

AIRBASE:GetBeacon()

-
- -

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

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

Core.Beacon#BEACON:

-
-
- -

Beacon

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

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

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

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

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

AIRBASE:GetCargo()

-
- -

Get all contained cargo.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#POSITIONABLE:

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

AIRBASE:GetCargoBayFreeWeight()

-
- -

Get Cargo Bay Free Weight in kg.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#number:

-
-
- -

CargoBayFreeWeight

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

AIRBASE:GetCargoBayWeightLimit()

-
- -

Get Cargo Bay Weight Limit in kg.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#number:

-
-
- -

Max cargo weight in kg.

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

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

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

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

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

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

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

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

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

AIRBASE:GetGroundSpeed()

-
- -

Returns the horizonal speed relative to eath's surface.

- - -

The vertical component of the velocity vector is projected out (set to zero).

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#number:

-
-
- -

Ground speed in m/s. Returns 0 if the POSITIONABLE does not exist.

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

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

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

AIRBASE:GetHeight()

-
- -

Returns the POSITIONABLE height above sea level in meters.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

DCS#Vec3:

-
-
- -

Height of the positionable in meters (or nil, if the object does not exist).

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

AIRBASE:GetLaserCode()

-
- -

Get the last assigned laser code

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#number:

-
-
- -

The laser code

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AIRBASE:GetRadio()

-
- -

Create a Sound.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:

-
-
-

Sound.Radio#RADIO:

-
-
- -

Radio

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

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

AIRBASE:GetRelativeCoordinate(x, y, z)

-
- -

Returns a COORDINATE object, which is transformed to be relative to the POSITIONABLE.

- - -

Inverse of POSITIONABLE.GetOffsetCoordinate.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Parameters:

-
-
-

- #number - x -

-
-
- -

Offset along the world x-axis in meters. Default 0 m.

- -
-
-
-
-

- #number - y -

-
-
- -

Offset along the world y-axis in meters. Default 0 m.

- -
-
-
-
-

- #number - z -

-
-
- -

Offset along the world z-axis in meters. Default 0 m.

- -
-
-

Return value:

-
-
-

Core.Point#COORDINATE:

-
-
- -

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

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

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

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

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

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

AIRBASE:GetSize()

-
- - - -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
- -
-

AIRBASE:GetSpot()

-
- -

Get the Spot

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

Core.Spot#SPOT:

-
-
- -

The Spot

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

AIRBASE:GetTroopCapacity()

-
- -

Get the number of infantry soldiers that can be embarked into an aircraft (airplane or helicopter).

- - -

Returns nil for ground or ship units.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#number:

-
-
- -

Descent number of soldiers that fit into the unit. Returns #nil for ground and ship units.

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

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

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

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

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

AIRBASE:GetVelocity()

-
- -

Returns the Core.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.

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

AIRBASE:GetVelocityKMH()

-
- -

Returns the POSITIONABLE velocity in km/h.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#number:

-
-
- -

The velocity in km/h.

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

AIRBASE:GetVelocityKNOTS()

-
- -

Returns the POSITIONABLE velocity in knots.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#number:

-
-
- -

The velocity in knots.

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

AIRBASE:GetVelocityMPS()

-
- -

Returns the POSITIONABLE velocity in meters per second.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#number:

-
-
- -

The velocity in meters per second.

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

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

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

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

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

AIRBASE:HasCargo(Cargo)

-
- -

Returns if carrier has given cargo.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Parameter:

-
-
-

- Cargo -

-
-
-

-
-
-

Return value:

-
-
-

Core.Cargo#CARGO:

-
-
- -

Cargo

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

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

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

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

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

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

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

AIRBASE:IsCargoEmpty()

-
- -

Is cargo bay empty.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
- -
-

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

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

AIRBASE:IsInZone(Zone)

-
- -

Returns true if the unit is within a Core.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

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

AIRBASE:IsLasing()

-
- -

Check if the POSITIONABLE is lasing a target.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#boolean:

-
-
- -

true if it is lasing a target

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

AIRBASE:IsNotInZone(Zone)

-
- -

Returns true if the unit is not within a Core.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

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

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

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

AIRBASE:IsSubmarine()

-
- -

Returns if the unit is a submarine.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#boolean:

-
-
- -

Submarines attributes result.

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

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

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

AIRBASE:LaseOff()

-
- -

Stop Lasing a POSITIONABLE.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Return value:

-
-
-

#POSITIONABLE:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AIRBASE:MessageToSetUnit(Message, Duration, MessageSetUnit, Name)

-
- -

Send a message to a Core.Set#SET_UNIT.

- - -

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_UNIT - MessageSetUnit -

-
-
- -

The SET_UNIT collection receiving the message.

- -
-
-
-
-

- #string - Name -

-
-
- -

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

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

AIRBASE:MessageToUnit(Message, Duration, MessageUnit, Name)

-
- -

Send a message to a Wrapper.Unit.

- - -

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.Unit#UNIT - MessageUnit -

-
-
- -

The UNIT object receiving the message.

- -
-
-
-
-

- #string - Name -

-
-
- -

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

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

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

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

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

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

AIRBASE:New(PositionableName)

-
- -

Create a new POSITIONABLE from a DCSPositionable

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Parameter:

-
-
-

- #string - PositionableName -

-
-
- -

The POSITIONABLE name

- -
-
-

Return value:

-
-
-

#POSITIONABLE:

-
-
- -

self

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

AIRBASE:RemoveCargo(Cargo)

-
- -

Remove cargo.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Parameter:

-
-
-

- Core.Cargo#CARGO - Cargo -

-
-
-

-
-
-

Return value:

-
-
-

#POSITIONABLE:

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

AIRBASE:SetCargoBayWeightLimit(WeightLimit)

-
- -

Set Cargo Bay Weight Limit in kg.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-

Parameter:

-
-
-

- #number - WeightLimit -

-
-
- -

(Optional) Weight limit in kg. If not given, the value is taken from the descriptors or hard coded.

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

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

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

AIRBASE:SmokeBlue()

-
- -

Smoke the POSITIONABLE Blue.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
- -
-

AIRBASE:SmokeGreen()

-
- -

Smoke the POSITIONABLE Green.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
- -
-

AIRBASE:SmokeOrange()

-
- -

Smoke the POSITIONABLE Orange.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
- -
-

AIRBASE:SmokeRed()

-
- -

Smoke the POSITIONABLE Red.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
- -
-

AIRBASE:SmokeWhite()

-
- -

Smoke the POSITIONABLE White.

- -
-
-

Defined in:

-
-

Wrapper.Positionable#POSITIONABLE

-
-
- -
-
- -
-

Field(s)

-
-
-
- - #number -AIRBASE.AirbaseID - -

Airbase ID.

- -
- -
-
-
- - #string -AIRBASE.AirbaseName - -

Name of the airbase.

- -
- -
-
-
- - Core.Zone#ZONE -AIRBASE.AirbaseZone - -

Circular zone around the airbase with a radius of 2500 meters. For ships this is a ZONE_UNIT object.

- -
- -
-
-
- - #table -AIRBASE.CategoryName - -

Names of airbase categories.

- -
- -
-
-
- - #table -AIRBASE.Caucasus - -

Enumeration to identify the airbases in the Caucasus region.

- - - -

Airbases of the Caucasus map:

- -
    -
  • AIRBASE.Caucasus.Gelendzhik
    • -
  • AIRBASE.Caucasus.Krasnodar_Pashkovsky
    • -
  • AIRBASE.Caucasus.Sukhumi_Babushara
    • -
  • AIRBASE.Caucasus.Gudauta
    • -
  • AIRBASE.Caucasus.Batumi
    • -
  • AIRBASE.Caucasus.Senaki_Kolkhi
    • -
  • AIRBASE.Caucasus.Kobuleti
    • -
  • AIRBASE.Caucasus.Kutaisi
    • -
  • AIRBASE.Caucasus.Tbilisi_Lochini
    • -
  • AIRBASE.Caucasus.Soganlug
    • -
  • AIRBASE.Caucasus.Vaziani
    • -
  • AIRBASE.Caucasus.Anapa_Vityazevo
    • -
  • AIRBASE.Caucasus.Krasnodar_Center
    • -
  • AIRBASE.Caucasus.Novorossiysk
    • -
  • AIRBASE.Caucasus.Krymsk
    • -
  • AIRBASE.Caucasus.Maykop_Khanskaya
    • -
  • AIRBASE.Caucasus.Sochi_Adler
    • -
  • AIRBASE.Caucasus.Mineralnye_Vody
    • -
  • AIRBASE.Caucasus.Nalchik
    • -
  • AIRBASE.Caucasus.Mozdok
    • -
  • AIRBASE.Caucasus.Beslan
    • -
- - -
- -
-
-
- - #string -AIRBASE.ClassName - -

Name of the class, i.e. "AIRBASE".

- -
- -
-
-
- - #table -AIRBASE.MarianaIslands - -

Airbases of the Mariana Islands map:

- -
    -
  • AIRBASE.MarianaIslands.Rota_Intl
    • -
  • AIRBASE.MarianaIslands.Andersen_AFB
    • -
  • AIRBASE.MarianaIslands.Antonio_B_Won_Pat_Intl
    • -
  • AIRBASE.MarianaIslands.Saipan_Intl
    • -
  • AIRBASE.MarianaIslands.Tinian_Intl
    • -
  • AIRBASE.MarianaIslands.Olf_Orote
    • -
- - -
- -
-
-
- - #table -AIRBASE.Nevada - -

Airbases of the Nevada map:

- -
    -
  • AIRBASE.Nevada.Creech_AFB
    • -
  • AIRBASE.Nevada.Groom_Lake_AFB
    • -
  • AIRBASE.Nevada.McCarran_International_Airport
    • -
  • AIRBASE.Nevada.Nellis_AFB
    • -
  • AIRBASE.Nevada.Beatty_Airport
    • -
  • AIRBASE.Nevada.Boulder_City_Airport
    • -
  • AIRBASE.Nevada.Echo_Bay
    • -
  • AIRBASE.Nevada.Henderson_Executive_Airport
    • -
  • AIRBASE.Nevada.Jean_Airport
    • -
  • AIRBASE.Nevada.Laughlin_Airport
    • -
  • AIRBASE.Nevada.Lincoln_County
    • -
  • AIRBASE.Nevada.Mesquite
    • -
  • AIRBASE.Nevada.Mina_Airport
    • -
  • AIRBASE.Nevada.North_Las_Vegas
    • -
  • AIRBASE.Nevada.Pahute_Mesa_Airstrip
    • -
  • AIRBASE.Nevada.Tonopah_Airport
    • -
  • AIRBASE.Nevada.Tonopah_Test_Range_Airfield
    • -
- - -
- -
-
-
- - #table -AIRBASE.Normandy - -

Airbases of the Normandy map:

- -
    -
  • AIRBASE.Normandy.Saint_Pierre_du_Mont
    • -
  • AIRBASE.Normandy.Lignerolles
    • -
  • AIRBASE.Normandy.Cretteville
    • -
  • AIRBASE.Normandy.Maupertus
    • -
  • AIRBASE.Normandy.Brucheville
    • -
  • AIRBASE.Normandy.Meautis
    • -
  • AIRBASE.Normandy.Cricqueville_en_Bessin
    • -
  • AIRBASE.Normandy.Lessay
    • -
  • AIRBASE.Normandy.Sainte_Laurent_sur_Mer
    • -
  • AIRBASE.Normandy.Biniville
    • -
  • AIRBASE.Normandy.Cardonville
    • -
  • AIRBASE.Normandy.Deux_Jumeaux
    • -
  • AIRBASE.Normandy.Chippelle
    • -
  • AIRBASE.Normandy.Beuzeville
    • -
  • AIRBASE.Normandy.Azeville
    • -
  • AIRBASE.Normandy.Picauville
    • -
  • AIRBASE.Normandy.Le_Molay
    • -
  • AIRBASE.Normandy.Longues_sur_Mer
    • -
  • AIRBASE.Normandy.Carpiquet
    • -
  • AIRBASE.Normandy.Bazenville
    • -
  • AIRBASE.Normandy.Sainte_Croix_sur_Mer
    • -
  • AIRBASE.Normandy.Beny_sur_Mer
    • -
  • AIRBASE.Normandy.Rucqueville
    • -
  • AIRBASE.Normandy.Sommervieu
    • -
  • AIRBASE.Normandy.Lantheuil
    • -
  • AIRBASE.Normandy.Evreux
    • -
  • AIRBASE.Normandy.Chailey
    • -
  • AIRBASE.Normandy.Needs_Oar_Point
    • -
  • AIRBASE.Normandy.Funtington
    • -
  • AIRBASE.Normandy.Tangmere
    • -
  • AIRBASE.Normandy.Ford
    • -
  • AIRBASE.Normandy.Argentan
    • -
  • AIRBASE.Normandy.Goulet
    • -
  • AIRBASE.Normandy.Barville
    • -
  • AIRBASE.Normandy.Essay
    • -
  • AIRBASE.Normandy.Hauterive
    • -
  • AIRBASE.Normandy.Lymington
    • -
  • AIRBASE.Normandy.Vrigny
    • -
  • AIRBASE.Normandy.Odiham
    • -
  • AIRBASE.Normandy.Conches
    • -
  • AIRBASE.Normandy.West_Malling
    • -
  • AIRBASE.Normandy.Villacoublay
    • -
  • AIRBASE.Normandy.Kenley
    • -
  • AIRBASE.Normandy.Beauvais_Tille
    • -
  • AIRBASE.Normandy.Cormeilles_en_Vexin
    • -
  • AIRBASE.Normandy.Creil
    • -
  • AIRBASE.Normandy.Guyancourt
    • -
  • AIRBASE.Normandy.Lonrai
    • -
  • AIRBASE.Normandy.Dinan_Trelivan
    • -
  • AIRBASE.Normandy.Heathrow
    • -
  • AIRBASE.Normandy.Fecamp_Benouville
    • -
  • AIRBASE.Normandy.Farnborough
    • -
  • AIRBASE.Normandy.Friston
    • -
  • AIRBASE.Normandy.Deanland
    • -
  • AIRBASE.Normandy.Triqueville
    • -
  • AIRBASE.Normandy.Poix
    • -
  • AIRBASE.Normandy.Orly
    • -
  • AIRBASE.Normandy.Stoney_Cross
    • -
  • AIRBASE.Normandy.Amiens_Glisy
    • -
  • AIRBASE.Normandy.Ronai
    • -
  • AIRBASE.Normandy.Rouen_Boos
    • -
  • AIRBASE.Normandy.Deauville
    • -
  • AIRBASE.Normandy.Saint_Aubin
    • -
  • AIRBASE.Normandy.Flers
    • -
  • AIRBASE.Normandy.Avranches_Le_Val_Saint_Pere
    • -
  • AIRBASE.Normandy.Gravesend
    • -
  • AIRBASE.Normandy.Beaumont_le_Roger
    • -
  • AIRBASE.Normandy.Broglie
    • -
  • AIRBASE.Normandy.Bernay_Saint_Martin
    • -
  • AIRBASE.Normandy.Saint_Andre_de_lEure
    • -
- - -
- -
-
-
- - #table -AIRBASE.NparkingTerminal - - - -
- -
-
-
- - #number -AIRBASE.NparkingTotal - - - -
- -
-
-
- - #table -AIRBASE.PersianGulf - -

Airbases of the Persion Gulf Map:

- -
    -
  • AIRBASE.PersianGulf.Abu_Dhabi_International_Airport
    • -
  • AIRBASE.PersianGulf.Abu_Musa_Island_Airport
    • -
  • AIRBASE.PersianGulf.Al_Bateen_Airport
    • -
  • AIRBASE.PersianGulf.Al_Ain_International_Airport
    • -
  • AIRBASE.PersianGulf.Al_Dhafra_AB
    • -
  • AIRBASE.PersianGulf.Al_Maktoum_Intl
    • -
  • AIRBASE.PersianGulf.Al_Minhad_AB
    • -
  • AIRBASE.PersianGulf.Bandar_e_Jask_airfield
    • -
  • AIRBASE.PersianGulf.Bandar_Abbas_Intl
    • -
  • AIRBASE.PersianGulf.Bandar_Lengeh
    • -
  • AIRBASE.PersianGulf.Dubai_Intl
    • -
  • AIRBASE.PersianGulf.Fujairah_Intl
    • -
  • AIRBASE.PersianGulf.Havadarya
    • -
  • AIRBASE.PersianGulf.Jiroft_Airport
    • -
  • AIRBASE.PersianGulf.Kerman_Airport
    • -
  • AIRBASE.PersianGulf.Khasab
    • -
  • AIRBASE.PersianGulf.Kish_International_Airport
    • -
  • AIRBASE.PersianGulf.Lar_Airbase
    • -
  • AIRBASE.PersianGulf.Lavan_Island_Airport
    • -
  • AIRBASE.PersianGulf.Liwa_Airbase
    • -
  • AIRBASE.PersianGulf.Qeshm_Island
    • -
  • AIRBASE.PersianGulf.Ras_Al_Khaimah
    • -
  • AIRBASE.PersianGulf.Sas_Al_Nakheel_Airport
    • -
  • AIRBASE.PersianGulf.Sharjah_Intl
    • -
  • AIRBASE.PersianGulf.Shiraz_International_Airport
    • -
  • AIRBASE.PersianGulf.Sir_Abu_Nuayr
    • -
  • AIRBASE.PersianGulf.Sirri_Island
    • -
  • AIRBASE.PersianGulf.Tunb_Island_AFB
    • -
  • AIRBASE.PersianGulf.Tunb_Kochak
    • -
- - -
- -
-
-
- - #table -AIRBASE.Sinai - -

Airbases of the Sinai map:

- -
    -
  • AIRBASE.Sinai.Abu_Suwayr
    • -
  • AIRBASE.Sinai.Sde_Dov
    • -
  • AIRBASE.Sinai.AzZaqaziq
    • -
  • AIRBASE.Sinai.Hatzor
    • -
  • AIRBASE.Sinai.Kedem
    • -
  • AIRBASE.Sinai.Nevatim
    • -
  • AIRBASE.Sinai.Cairo_International_Airport
    • -
  • AIRBASE.Sinai.Al_Ismailiyah
    • -
  • AIRBASE.Sinai.As_Salihiyah
    • -
  • AIRBASE.Sinai.Fayed
    • -
  • AIRBASE.Sinai.Bilbeis_Air_Base
    • -
  • AIRBASE.Sinai.Ramon_Airbase
    • -
  • AIRBASE.Sinai.Kibrit_Air_Base
    • -
  • AIRBASE.Sinai.El_Arish
    • -
  • AIRBASE.Sinai.Ovda
    • -
  • AIRBASE.Sinai.Melez
    • -
  • AIRBASE.Sinai.Al_Mansurah
    • -
  • AIRBASE.Sinai.Palmahim
    • -
  • AIRBASE.Sinai.Baluza
    • -
  • AIRBASE.Sinai.El_Gora
    • -
  • AIRBASE.Sinai.Difarsuwar_Airfield
    • -
  • AIRBASE.Sinai.Wadi_al_Jandali
    • -
  • AIRBASE.Sinai.St_Catherine
    • -
  • AIRBASE.Sinai.Tel_Nof
    • -
  • AIRBASE.Sinai.Abu_Rudeis
    • -
  • AIRBASE.Sinai.Inshas_Airbase
    • -
  • AIRBASE.Sinai.Ben_Gurion
    • -
  • AIRBASE.Sinai.Bir_Hasanah
    • -
  • AIRBASE.Sinai.Cairo_West
    • -
- - -
- -
-
-
- - #table -AIRBASE.SouthAtlantic - - - -
- -
-
-
- - #AIRBASE.SpotStatus -AIRBASE.SpotStatus - - - -
- -
-
-
- - #table -AIRBASE.Syria - -

Airbases of the Syria map:

- -
    -
  • AIRBASE.Syria.Kuweires
    • -
  • AIRBASE.Syria.Marj_Ruhayyil
    • -
  • AIRBASE.Syria.Kiryat_Shmona
    • -
  • AIRBASE.Syria.Marj_as_Sultan_North
    • -
  • AIRBASE.Syria.Eyn_Shemer
    • -
  • AIRBASE.Syria.Incirlik
    • -
  • AIRBASE.Syria.Damascus
    • -
  • AIRBASE.Syria.Bassel_Al_Assad
    • -
  • AIRBASE.Syria.Rosh_Pina
    • -
  • AIRBASE.Syria.Aleppo
    • -
  • AIRBASE.Syria.Al_Qusayr
    • -
  • AIRBASE.Syria.Wujah_Al_Hajar
    • -
  • AIRBASE.Syria.Al_Dumayr
    • -
  • AIRBASE.Syria.Gazipasa
    • -
  • AIRBASE.Syria.Hatay
    • -
  • AIRBASE.Syria.Nicosia [Deactivated by ED as of June/2023]
    • -
  • AIRBASE.Syria.Pinarbashi
    • -
  • AIRBASE.Syria.Paphos
    • -
  • AIRBASE.Syria.Kingsfield
    • -
  • AIRBASE.Syria.Thalah
    • -
  • AIRBASE.Syria.Haifa
    • -
  • AIRBASE.Syria.Khalkhalah
    • -
  • AIRBASE.Syria.Megiddo
    • -
  • AIRBASE.Syria.Lakatamia
    • -
  • AIRBASE.Syria.Rayak
    • -
  • AIRBASE.Syria.Larnaca
    • -
  • AIRBASE.Syria.Mezzeh
    • -
  • AIRBASE.Syria.Gecitkale
    • -
  • AIRBASE.Syria.Akrotiri
    • -
  • AIRBASE.Syria.Naqoura
    • -
  • AIRBASE.Syria.Gaziantep
    • -
  • AIRBASE.Syria.Sayqal
    • -
  • AIRBASE.Syria.Tiyas
    • -
  • AIRBASE.Syria.Shayrat
    • -
  • AIRBASE.Syria.Taftanaz
    • -
  • AIRBASE.Syria.H4
    • -
  • AIRBASE.Syria.King_Hussein_Air_College
    • -
  • AIRBASE.Syria.Rene_Mouawad
    • -
  • AIRBASE.Syria.Jirah
    • -
  • AIRBASE.Syria.Ramat_David
    • -
  • AIRBASE.Syria.Qabr_as_Sitt
    • -
  • AIRBASE.Syria.Minakh
    • -
  • AIRBASE.Syria.Adana_Sakirpasa
    • -
  • AIRBASE.Syria.Palmyra
    • -
  • AIRBASE.Syria.Hama
    • -
  • AIRBASE.Syria.Ercan
    • -
  • AIRBASE.Syria.Marj_as_Sultan_South
    • -
  • AIRBASE.Syria.Tabqa
    • -
  • AIRBASE.Syria.Beirut_Rafic_Hariri
    • -
  • AIRBASE.Syria.An_Nasiriyah
    • -
  • AIRBASE.Syria.Abu_al_Duhur
    • -
  • AIRBASE.Syria.At_Tanf
    • -
  • AIRBASE.Syria.H3
    • -
  • AIRBASE.Syria.H3_Northwest
    • -
  • AIRBASE.Syria.H3_Southwest
    • -
  • AIRBASE.Syria.Kharab_Ishk
    • -
  • AIRBASE.Syria.Raj_al_Issa_East (deleted by ED)
    • -
  • AIRBASE.Syria.Raj_al_Issa_West (deleted by ED)
    • -
  • AIRBASE.Syria.Ruwayshid
    • -
  • AIRBASE.Syria.Sanliurfa
    • -
  • AIRBASE.Syria.Tal_Siman
    • -
  • AIRBASE.Syria.Deir_ez_Zor
    • -
- - -
- -
-
-
- - #AIRBASE.TerminalType -AIRBASE.TerminalType - - - -
- -
-
-
- - #table -AIRBASE.TheChannel - -

Airbases of The Channel Map:

- -
    -
  • AIRBASE.TheChannel.Abbeville_Drucat
    • -
  • AIRBASE.TheChannel.Merville_Calonne
    • -
  • AIRBASE.TheChannel.Saint_Omer_Longuenesse
    • -
  • AIRBASE.TheChannel.Dunkirk_Mardyck
    • -
  • AIRBASE.TheChannel.Manston
    • -
  • AIRBASE.TheChannel.Hawkinge
    • -
  • AIRBASE.TheChannel.Lympne
    • -
  • AIRBASE.TheChannel.Detling
    • -
  • AIRBASE.TheChannel.High_Halden
    • -
  • AIRBASE.TheChannel.Biggin_Hill
    • -
  • AIRBASE.TheChannel.Eastchurch
    • -
  • AIRBASE.TheChannel.Headcorn
    • -
- - -
- -
-
-
- - #number -AIRBASE.category - -

Airbase category.

- -
- -
-
-
- - #table -AIRBASE.descriptors - -

DCS descriptors.

- -
- -
-
-
- - #boolean -AIRBASE.isAirdrome - -

Airbase is an airdrome.

- -
- -
-
-
- - #boolean -AIRBASE.isHelipad - -

Airbase is a helipad.

- -
- -
-
-
- - #boolean -AIRBASE.isShip - -

Airbase is a ship.

- -
- -
-
-
- - #table -AIRBASE.parking - -

Parking spot data.

- -
- -
-
-
- - #table -AIRBASE.parkingBlacklist - -

List of parking spot terminal IDs not considered for spawning.

- -
- -
-
-
- - #table -AIRBASE.parkingByID - -

Parking spot data table with ID as key.

- -
- -
-
-
- - #table -AIRBASE.parkingWhitelist - -

List of parking spot terminal IDs considered for spawning.

- -
- -
-
-
- - #AIRBASE.Runway -AIRBASE.runwayLanding - -

Runway used for landing.

- -
- -
-
-
- - #AIRBASE.Runway -AIRBASE.runwayTakeoff - -

Runway used for takeoff.

- -
- -
-
-
- - #table -AIRBASE.runways - -

Runways of airdromes.

- -
- -
-
-

Function(s)

-
-
- -
-

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

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

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

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

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

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

AIRBASE:GetCoalition()

-
- -

Returns coalition of the Identifiable.

- -
-
-

Defined in:

-
-

Wrapper.Identifiable#IDENTIFIABLE

-
-

Return value:

-
-
-

DCS#coalition.side:

-
-
- -

The side of the coalition or #nil The DCS Identifiable is not existing or alive.

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

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

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

AIRBASE:GetCountry()

-
- -

Returns country of the Identifiable.

- -
-
-

Defined in:

-
-

Wrapper.Identifiable#IDENTIFIABLE

-
-

Return value:

-
-
-

DCS#country.id:

-
-
- -

The country identifier or #nil The DCS Identifiable is not existing or alive.

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

AIRBASE:GetCountryName()

-
- -

Returns country name of the Identifiable.

- -
-
-

Defined in:

-
-

Wrapper.Identifiable#IDENTIFIABLE

-
-

Return value:

-
-
-

#string:

-
-
- -

Name of the country.

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

AIRBASE:GetDesc()

-
- -

Returns Identifiable descriptor.

- - -

Descriptor type depends on Identifiable category.

- -
-
-

Defined in:

-
-

Wrapper.Identifiable#IDENTIFIABLE

-
-

Return value:

-
-
-

DCS#Object.Desc:

-
-
- -

The Identifiable descriptor or #nil The DCS Identifiable is not existing or alive.

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

AIRBASE:GetName()

-
- -

Returns DCS Identifiable object name.

- - -

The function provides access to non-activated objects too.

- -
-
-

Defined in:

-
-

Wrapper.Identifiable#IDENTIFIABLE

-
-

Return value:

-
-
-

#string:

-
-
- -

The name of the DCS Identifiable or #nil.

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

AIRBASE:GetThreatLevel()

-
- -

Gets the threat level.

- -
-
-

Defined in:

-
-

Wrapper.Identifiable#IDENTIFIABLE

-
-

Return values:

-
-
-

#number:

-
-
- -

Threat level.

- -
-
-

#string:

-
-
- -

Type.

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

AIRBASE:GetTypeName()

-
- -

Returns the type name of the DCS Identifiable.

- -
-
-

Defined in:

-
-

Wrapper.Identifiable#IDENTIFIABLE

-
-

Return value:

-
-
-

#string:

-
-
- -

The type name of the DCS Identifiable.

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

AIRBASE:HasAttribute(AttributeName)

-
- -

Check if the Object has the attribute.

- -
-
-

Defined in:

-
-

Wrapper.Identifiable#IDENTIFIABLE

-
-

Parameter:

-
-
-

- #string - AttributeName -

-
-
- -

The attribute name.

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- -

true if the attribute exists or #nil The DCS Identifiable is not existing or alive.

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

AIRBASE: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 value:

-
-
-

#boolean:

-
-
- -

true if Identifiable is alive or #nil if the Identifiable is not existing or is not alive.

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

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

-
-
-
- - #number -AIRBASE.AirbaseID - -

Airbase ID.

- -
- -
-
-
- - #string -AIRBASE.AirbaseName - -

Name of the airbase.

- -
- -
-
-
- - Core.Zone#ZONE -AIRBASE.AirbaseZone - -

Circular zone around the airbase with a radius of 2500 meters. For ships this is a ZONE_UNIT object.

- -
- -
-
-
- - #table -AIRBASE.CategoryName - -

Names of airbase categories.

- -
- -
-
-
- - #table -AIRBASE.Caucasus - -

Enumeration to identify the airbases in the Caucasus region.

- - - -

Airbases of the Caucasus map:

- -
    -
  • AIRBASE.Caucasus.Gelendzhik
    • -
  • AIRBASE.Caucasus.Krasnodar_Pashkovsky
    • -
  • AIRBASE.Caucasus.Sukhumi_Babushara
    • -
  • AIRBASE.Caucasus.Gudauta
    • -
  • AIRBASE.Caucasus.Batumi
    • -
  • AIRBASE.Caucasus.Senaki_Kolkhi
    • -
  • AIRBASE.Caucasus.Kobuleti
    • -
  • AIRBASE.Caucasus.Kutaisi
    • -
  • AIRBASE.Caucasus.Tbilisi_Lochini
    • -
  • AIRBASE.Caucasus.Soganlug
    • -
  • AIRBASE.Caucasus.Vaziani
    • -
  • AIRBASE.Caucasus.Anapa_Vityazevo
    • -
  • AIRBASE.Caucasus.Krasnodar_Center
    • -
  • AIRBASE.Caucasus.Novorossiysk
    • -
  • AIRBASE.Caucasus.Krymsk
    • -
  • AIRBASE.Caucasus.Maykop_Khanskaya
    • -
  • AIRBASE.Caucasus.Sochi_Adler
    • -
  • AIRBASE.Caucasus.Mineralnye_Vody
    • -
  • AIRBASE.Caucasus.Nalchik
    • -
  • AIRBASE.Caucasus.Mozdok
    • -
  • AIRBASE.Caucasus.Beslan
    • -
- - -
- -
-
-
- - #string -AIRBASE.ClassName - -

Name of the class, i.e. "AIRBASE".

- -
- -
-
-
- - #table -AIRBASE.MarianaIslands - -

Airbases of the Mariana Islands map:

- -
    -
  • AIRBASE.MarianaIslands.Rota_Intl
    • -
  • AIRBASE.MarianaIslands.Andersen_AFB
    • -
  • AIRBASE.MarianaIslands.Antonio_B_Won_Pat_Intl
    • -
  • AIRBASE.MarianaIslands.Saipan_Intl
    • -
  • AIRBASE.MarianaIslands.Tinian_Intl
    • -
  • AIRBASE.MarianaIslands.Olf_Orote
    • -
- - -
- -
-
-
- - #table -AIRBASE.Nevada - -

Airbases of the Nevada map:

- -
    -
  • AIRBASE.Nevada.Creech_AFB
    • -
  • AIRBASE.Nevada.Groom_Lake_AFB
    • -
  • AIRBASE.Nevada.McCarran_International_Airport
    • -
  • AIRBASE.Nevada.Nellis_AFB
    • -
  • AIRBASE.Nevada.Beatty_Airport
    • -
  • AIRBASE.Nevada.Boulder_City_Airport
    • -
  • AIRBASE.Nevada.Echo_Bay
    • -
  • AIRBASE.Nevada.Henderson_Executive_Airport
    • -
  • AIRBASE.Nevada.Jean_Airport
    • -
  • AIRBASE.Nevada.Laughlin_Airport
    • -
  • AIRBASE.Nevada.Lincoln_County
    • -
  • AIRBASE.Nevada.Mesquite
    • -
  • AIRBASE.Nevada.Mina_Airport
    • -
  • AIRBASE.Nevada.North_Las_Vegas
    • -
  • AIRBASE.Nevada.Pahute_Mesa_Airstrip
    • -
  • AIRBASE.Nevada.Tonopah_Airport
    • -
  • AIRBASE.Nevada.Tonopah_Test_Range_Airfield
    • -
- - -
- -
-
-
- - #table -AIRBASE.Normandy - -

Airbases of the Normandy map:

- -
    -
  • AIRBASE.Normandy.Saint_Pierre_du_Mont
    • -
  • AIRBASE.Normandy.Lignerolles
    • -
  • AIRBASE.Normandy.Cretteville
    • -
  • AIRBASE.Normandy.Maupertus
    • -
  • AIRBASE.Normandy.Brucheville
    • -
  • AIRBASE.Normandy.Meautis
    • -
  • AIRBASE.Normandy.Cricqueville_en_Bessin
    • -
  • AIRBASE.Normandy.Lessay
    • -
  • AIRBASE.Normandy.Sainte_Laurent_sur_Mer
    • -
  • AIRBASE.Normandy.Biniville
    • -
  • AIRBASE.Normandy.Cardonville
    • -
  • AIRBASE.Normandy.Deux_Jumeaux
    • -
  • AIRBASE.Normandy.Chippelle
    • -
  • AIRBASE.Normandy.Beuzeville
    • -
  • AIRBASE.Normandy.Azeville
    • -
  • AIRBASE.Normandy.Picauville
    • -
  • AIRBASE.Normandy.Le_Molay
    • -
  • AIRBASE.Normandy.Longues_sur_Mer
    • -
  • AIRBASE.Normandy.Carpiquet
    • -
  • AIRBASE.Normandy.Bazenville
    • -
  • AIRBASE.Normandy.Sainte_Croix_sur_Mer
    • -
  • AIRBASE.Normandy.Beny_sur_Mer
    • -
  • AIRBASE.Normandy.Rucqueville
    • -
  • AIRBASE.Normandy.Sommervieu
    • -
  • AIRBASE.Normandy.Lantheuil
    • -
  • AIRBASE.Normandy.Evreux
    • -
  • AIRBASE.Normandy.Chailey
    • -
  • AIRBASE.Normandy.Needs_Oar_Point
    • -
  • AIRBASE.Normandy.Funtington
    • -
  • AIRBASE.Normandy.Tangmere
    • -
  • AIRBASE.Normandy.Ford
    • -
  • AIRBASE.Normandy.Argentan
    • -
  • AIRBASE.Normandy.Goulet
    • -
  • AIRBASE.Normandy.Barville
    • -
  • AIRBASE.Normandy.Essay
    • -
  • AIRBASE.Normandy.Hauterive
    • -
  • AIRBASE.Normandy.Lymington
    • -
  • AIRBASE.Normandy.Vrigny
    • -
  • AIRBASE.Normandy.Odiham
    • -
  • AIRBASE.Normandy.Conches
    • -
  • AIRBASE.Normandy.West_Malling
    • -
  • AIRBASE.Normandy.Villacoublay
    • -
  • AIRBASE.Normandy.Kenley
    • -
  • AIRBASE.Normandy.Beauvais_Tille
    • -
  • AIRBASE.Normandy.Cormeilles_en_Vexin
    • -
  • AIRBASE.Normandy.Creil
    • -
  • AIRBASE.Normandy.Guyancourt
    • -
  • AIRBASE.Normandy.Lonrai
    • -
  • AIRBASE.Normandy.Dinan_Trelivan
    • -
  • AIRBASE.Normandy.Heathrow
    • -
  • AIRBASE.Normandy.Fecamp_Benouville
    • -
  • AIRBASE.Normandy.Farnborough
    • -
  • AIRBASE.Normandy.Friston
    • -
  • AIRBASE.Normandy.Deanland
    • -
  • AIRBASE.Normandy.Triqueville
    • -
  • AIRBASE.Normandy.Poix
    • -
  • AIRBASE.Normandy.Orly
    • -
  • AIRBASE.Normandy.Stoney_Cross
    • -
  • AIRBASE.Normandy.Amiens_Glisy
    • -
  • AIRBASE.Normandy.Ronai
    • -
  • AIRBASE.Normandy.Rouen_Boos
    • -
  • AIRBASE.Normandy.Deauville
    • -
  • AIRBASE.Normandy.Saint_Aubin
    • -
  • AIRBASE.Normandy.Flers
    • -
  • AIRBASE.Normandy.Avranches_Le_Val_Saint_Pere
    • -
  • AIRBASE.Normandy.Gravesend
    • -
  • AIRBASE.Normandy.Beaumont_le_Roger
    • -
  • AIRBASE.Normandy.Broglie
    • -
  • AIRBASE.Normandy.Bernay_Saint_Martin
    • -
  • AIRBASE.Normandy.Saint_Andre_de_lEure
    • -
- - -
- -
-
-
- - #table -AIRBASE.NparkingTerminal - - - -
- -
-
-
- - #number -AIRBASE.NparkingTotal - - - -
- -
-
-
- - #table -AIRBASE.PersianGulf - -

Airbases of the Persion Gulf Map:

- -
    -
  • AIRBASE.PersianGulf.Abu_Dhabi_International_Airport
    • -
  • AIRBASE.PersianGulf.Abu_Musa_Island_Airport
    • -
  • AIRBASE.PersianGulf.Al_Bateen_Airport
    • -
  • AIRBASE.PersianGulf.Al_Ain_International_Airport
    • -
  • AIRBASE.PersianGulf.Al_Dhafra_AB
    • -
  • AIRBASE.PersianGulf.Al_Maktoum_Intl
    • -
  • AIRBASE.PersianGulf.Al_Minhad_AB
    • -
  • AIRBASE.PersianGulf.Bandar_e_Jask_airfield
    • -
  • AIRBASE.PersianGulf.Bandar_Abbas_Intl
    • -
  • AIRBASE.PersianGulf.Bandar_Lengeh
    • -
  • AIRBASE.PersianGulf.Dubai_Intl
    • -
  • AIRBASE.PersianGulf.Fujairah_Intl
    • -
  • AIRBASE.PersianGulf.Havadarya
    • -
  • AIRBASE.PersianGulf.Jiroft_Airport
    • -
  • AIRBASE.PersianGulf.Kerman_Airport
    • -
  • AIRBASE.PersianGulf.Khasab
    • -
  • AIRBASE.PersianGulf.Kish_International_Airport
    • -
  • AIRBASE.PersianGulf.Lar_Airbase
    • -
  • AIRBASE.PersianGulf.Lavan_Island_Airport
    • -
  • AIRBASE.PersianGulf.Liwa_Airbase
    • -
  • AIRBASE.PersianGulf.Qeshm_Island
    • -
  • AIRBASE.PersianGulf.Ras_Al_Khaimah
    • -
  • AIRBASE.PersianGulf.Sas_Al_Nakheel_Airport
    • -
  • AIRBASE.PersianGulf.Sharjah_Intl
    • -
  • AIRBASE.PersianGulf.Shiraz_International_Airport
    • -
  • AIRBASE.PersianGulf.Sir_Abu_Nuayr
    • -
  • AIRBASE.PersianGulf.Sirri_Island
    • -
  • AIRBASE.PersianGulf.Tunb_Island_AFB
    • -
  • AIRBASE.PersianGulf.Tunb_Kochak
    • -
- - -
- -
-
-
- - #table -AIRBASE.Sinai - -

Airbases of the Sinai map:

- -
    -
  • AIRBASE.Sinai.Abu_Suwayr
    • -
  • AIRBASE.Sinai.Sde_Dov
    • -
  • AIRBASE.Sinai.AzZaqaziq
    • -
  • AIRBASE.Sinai.Hatzor
    • -
  • AIRBASE.Sinai.Kedem
    • -
  • AIRBASE.Sinai.Nevatim
    • -
  • AIRBASE.Sinai.Cairo_International_Airport
    • -
  • AIRBASE.Sinai.Al_Ismailiyah
    • -
  • AIRBASE.Sinai.As_Salihiyah
    • -
  • AIRBASE.Sinai.Fayed
    • -
  • AIRBASE.Sinai.Bilbeis_Air_Base
    • -
  • AIRBASE.Sinai.Ramon_Airbase
    • -
  • AIRBASE.Sinai.Kibrit_Air_Base
    • -
  • AIRBASE.Sinai.El_Arish
    • -
  • AIRBASE.Sinai.Ovda
    • -
  • AIRBASE.Sinai.Melez
    • -
  • AIRBASE.Sinai.Al_Mansurah
    • -
  • AIRBASE.Sinai.Palmahim
    • -
  • AIRBASE.Sinai.Baluza
    • -
  • AIRBASE.Sinai.El_Gora
    • -
  • AIRBASE.Sinai.Difarsuwar_Airfield
    • -
  • AIRBASE.Sinai.Wadi_al_Jandali
    • -
  • AIRBASE.Sinai.St_Catherine
    • -
  • AIRBASE.Sinai.Tel_Nof
    • -
  • AIRBASE.Sinai.Abu_Rudeis
    • -
  • AIRBASE.Sinai.Inshas_Airbase
    • -
  • AIRBASE.Sinai.Ben_Gurion
    • -
  • AIRBASE.Sinai.Bir_Hasanah
    • -
  • AIRBASE.Sinai.Cairo_West
    • -
- - -
- -
-
-
- - #table -AIRBASE.SouthAtlantic - - - -
- -
-
-
- - #AIRBASE.SpotStatus -AIRBASE.SpotStatus - - - -
- -
-
-
- - #table -AIRBASE.Syria - -

Airbases of the Syria map:

- -
    -
  • AIRBASE.Syria.Kuweires
    • -
  • AIRBASE.Syria.Marj_Ruhayyil
    • -
  • AIRBASE.Syria.Kiryat_Shmona
    • -
  • AIRBASE.Syria.Marj_as_Sultan_North
    • -
  • AIRBASE.Syria.Eyn_Shemer
    • -
  • AIRBASE.Syria.Incirlik
    • -
  • AIRBASE.Syria.Damascus
    • -
  • AIRBASE.Syria.Bassel_Al_Assad
    • -
  • AIRBASE.Syria.Rosh_Pina
    • -
  • AIRBASE.Syria.Aleppo
    • -
  • AIRBASE.Syria.Al_Qusayr
    • -
  • AIRBASE.Syria.Wujah_Al_Hajar
    • -
  • AIRBASE.Syria.Al_Dumayr
    • -
  • AIRBASE.Syria.Gazipasa
    • -
  • AIRBASE.Syria.Hatay
    • -
  • AIRBASE.Syria.Nicosia [Deactivated by ED as of June/2023]
    • -
  • AIRBASE.Syria.Pinarbashi
    • -
  • AIRBASE.Syria.Paphos
    • -
  • AIRBASE.Syria.Kingsfield
    • -
  • AIRBASE.Syria.Thalah
    • -
  • AIRBASE.Syria.Haifa
    • -
  • AIRBASE.Syria.Khalkhalah
    • -
  • AIRBASE.Syria.Megiddo
    • -
  • AIRBASE.Syria.Lakatamia
    • -
  • AIRBASE.Syria.Rayak
    • -
  • AIRBASE.Syria.Larnaca
    • -
  • AIRBASE.Syria.Mezzeh
    • -
  • AIRBASE.Syria.Gecitkale
    • -
  • AIRBASE.Syria.Akrotiri
    • -
  • AIRBASE.Syria.Naqoura
    • -
  • AIRBASE.Syria.Gaziantep
    • -
  • AIRBASE.Syria.Sayqal
    • -
  • AIRBASE.Syria.Tiyas
    • -
  • AIRBASE.Syria.Shayrat
    • -
  • AIRBASE.Syria.Taftanaz
    • -
  • AIRBASE.Syria.H4
    • -
  • AIRBASE.Syria.King_Hussein_Air_College
    • -
  • AIRBASE.Syria.Rene_Mouawad
    • -
  • AIRBASE.Syria.Jirah
    • -
  • AIRBASE.Syria.Ramat_David
    • -
  • AIRBASE.Syria.Qabr_as_Sitt
    • -
  • AIRBASE.Syria.Minakh
    • -
  • AIRBASE.Syria.Adana_Sakirpasa
    • -
  • AIRBASE.Syria.Palmyra
    • -
  • AIRBASE.Syria.Hama
    • -
  • AIRBASE.Syria.Ercan
    • -
  • AIRBASE.Syria.Marj_as_Sultan_South
    • -
  • AIRBASE.Syria.Tabqa
    • -
  • AIRBASE.Syria.Beirut_Rafic_Hariri
    • -
  • AIRBASE.Syria.An_Nasiriyah
    • -
  • AIRBASE.Syria.Abu_al_Duhur
    • -
  • AIRBASE.Syria.At_Tanf
    • -
  • AIRBASE.Syria.H3
    • -
  • AIRBASE.Syria.H3_Northwest
    • -
  • AIRBASE.Syria.H3_Southwest
    • -
  • AIRBASE.Syria.Kharab_Ishk
    • -
  • AIRBASE.Syria.Raj_al_Issa_East (deleted by ED)
    • -
  • AIRBASE.Syria.Raj_al_Issa_West (deleted by ED)
    • -
  • AIRBASE.Syria.Ruwayshid
    • -
  • AIRBASE.Syria.Sanliurfa
    • -
  • AIRBASE.Syria.Tal_Siman
    • -
  • AIRBASE.Syria.Deir_ez_Zor
    • -
- - -
- -
-
-
- - #AIRBASE.TerminalType -AIRBASE.TerminalType - - - -
- -
-
-
- - #table -AIRBASE.TheChannel - -

Airbases of The Channel Map:

- -
    -
  • AIRBASE.TheChannel.Abbeville_Drucat
    • -
  • AIRBASE.TheChannel.Merville_Calonne
    • -
  • AIRBASE.TheChannel.Saint_Omer_Longuenesse
    • -
  • AIRBASE.TheChannel.Dunkirk_Mardyck
    • -
  • AIRBASE.TheChannel.Manston
    • -
  • AIRBASE.TheChannel.Hawkinge
    • -
  • AIRBASE.TheChannel.Lympne
    • -
  • AIRBASE.TheChannel.Detling
    • -
  • AIRBASE.TheChannel.High_Halden
    • -
  • AIRBASE.TheChannel.Biggin_Hill
    • -
  • AIRBASE.TheChannel.Eastchurch
    • -
  • AIRBASE.TheChannel.Headcorn
    • -
- - -
- -
-
-
- - #number -AIRBASE.category - -

Airbase category.

- -
- -
-
-
- - #table -AIRBASE.descriptors - -

DCS descriptors.

- -
- -
-
-
- - #boolean -AIRBASE.isAirdrome - -

Airbase is an airdrome.

- -
- -
-
-
- - #boolean -AIRBASE.isHelipad - -

Airbase is a helipad.

- -
- -
-
-
- - #boolean -AIRBASE.isShip - -

Airbase is a ship.

- -
- -
-
-
- - #table -AIRBASE.parking - -

Parking spot data.

- -
- -
-
-
- - #table -AIRBASE.parkingBlacklist - -

List of parking spot terminal IDs not considered for spawning.

- -
- -
-
-
- - #table -AIRBASE.parkingByID - -

Parking spot data table with ID as key.

- -
- -
-
-
- - #table -AIRBASE.parkingWhitelist - -

List of parking spot terminal IDs considered for spawning.

- -
- -
-
-
- - #AIRBASE.Runway -AIRBASE.runwayLanding - -

Runway used for landing.

- -
- -
-
-
- - #AIRBASE.Runway -AIRBASE.runwayTakeoff - -

Runway used for takeoff.

- -
- -
-
-
- - #table -AIRBASE.runways - -

Runways of airdromes.

- -
- -
-
-

Function(s)

-
-
- -
-

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

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

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

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

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

-
-
-
- - #number -AIRBASE.AirbaseID - -

Airbase ID.

- -
- -
-
-
- - #string -AIRBASE.AirbaseName - -

Name of the airbase.

- -
- -
-
-
- - Core.Zone#ZONE -AIRBASE.AirbaseZone - -

Circular zone around the airbase with a radius of 2500 meters. For ships this is a ZONE_UNIT object.

- -
- -
-
-
- - #table -AIRBASE.CategoryName - -

Names of airbase categories.

- -
- -
-
-
- - #table -AIRBASE.Caucasus - -

Enumeration to identify the airbases in the Caucasus region.

- - - -

Airbases of the Caucasus map:

- -
    -
  • AIRBASE.Caucasus.Gelendzhik
    • -
  • AIRBASE.Caucasus.Krasnodar_Pashkovsky
    • -
  • AIRBASE.Caucasus.Sukhumi_Babushara
    • -
  • AIRBASE.Caucasus.Gudauta
    • -
  • AIRBASE.Caucasus.Batumi
    • -
  • AIRBASE.Caucasus.Senaki_Kolkhi
    • -
  • AIRBASE.Caucasus.Kobuleti
    • -
  • AIRBASE.Caucasus.Kutaisi
    • -
  • AIRBASE.Caucasus.Tbilisi_Lochini
    • -
  • AIRBASE.Caucasus.Soganlug
    • -
  • AIRBASE.Caucasus.Vaziani
    • -
  • AIRBASE.Caucasus.Anapa_Vityazevo
    • -
  • AIRBASE.Caucasus.Krasnodar_Center
    • -
  • AIRBASE.Caucasus.Novorossiysk
    • -
  • AIRBASE.Caucasus.Krymsk
    • -
  • AIRBASE.Caucasus.Maykop_Khanskaya
    • -
  • AIRBASE.Caucasus.Sochi_Adler
    • -
  • AIRBASE.Caucasus.Mineralnye_Vody
    • -
  • AIRBASE.Caucasus.Nalchik
    • -
  • AIRBASE.Caucasus.Mozdok
    • -
  • AIRBASE.Caucasus.Beslan
    • -
- - -
- -
-
-
- - #string -AIRBASE.ClassName - -

Name of the class, i.e. "AIRBASE".

- -
- -
-
-
- - #table -AIRBASE.MarianaIslands - -

Airbases of the Mariana Islands map:

- -
    -
  • AIRBASE.MarianaIslands.Rota_Intl
    • -
  • AIRBASE.MarianaIslands.Andersen_AFB
    • -
  • AIRBASE.MarianaIslands.Antonio_B_Won_Pat_Intl
    • -
  • AIRBASE.MarianaIslands.Saipan_Intl
    • -
  • AIRBASE.MarianaIslands.Tinian_Intl
    • -
  • AIRBASE.MarianaIslands.Olf_Orote
    • -
- - -
- -
-
-
- - #table -AIRBASE.Nevada - -

Airbases of the Nevada map:

- -
    -
  • AIRBASE.Nevada.Creech_AFB
    • -
  • AIRBASE.Nevada.Groom_Lake_AFB
    • -
  • AIRBASE.Nevada.McCarran_International_Airport
    • -
  • AIRBASE.Nevada.Nellis_AFB
    • -
  • AIRBASE.Nevada.Beatty_Airport
    • -
  • AIRBASE.Nevada.Boulder_City_Airport
    • -
  • AIRBASE.Nevada.Echo_Bay
    • -
  • AIRBASE.Nevada.Henderson_Executive_Airport
    • -
  • AIRBASE.Nevada.Jean_Airport
    • -
  • AIRBASE.Nevada.Laughlin_Airport
    • -
  • AIRBASE.Nevada.Lincoln_County
    • -
  • AIRBASE.Nevada.Mesquite
    • -
  • AIRBASE.Nevada.Mina_Airport
    • -
  • AIRBASE.Nevada.North_Las_Vegas
    • -
  • AIRBASE.Nevada.Pahute_Mesa_Airstrip
    • -
  • AIRBASE.Nevada.Tonopah_Airport
    • -
  • AIRBASE.Nevada.Tonopah_Test_Range_Airfield
    • -
- - -
- -
-
-
- - #table -AIRBASE.Normandy - -

Airbases of the Normandy map:

- -
    -
  • AIRBASE.Normandy.Saint_Pierre_du_Mont
    • -
  • AIRBASE.Normandy.Lignerolles
    • -
  • AIRBASE.Normandy.Cretteville
    • -
  • AIRBASE.Normandy.Maupertus
    • -
  • AIRBASE.Normandy.Brucheville
    • -
  • AIRBASE.Normandy.Meautis
    • -
  • AIRBASE.Normandy.Cricqueville_en_Bessin
    • -
  • AIRBASE.Normandy.Lessay
    • -
  • AIRBASE.Normandy.Sainte_Laurent_sur_Mer
    • -
  • AIRBASE.Normandy.Biniville
    • -
  • AIRBASE.Normandy.Cardonville
    • -
  • AIRBASE.Normandy.Deux_Jumeaux
    • -
  • AIRBASE.Normandy.Chippelle
    • -
  • AIRBASE.Normandy.Beuzeville
    • -
  • AIRBASE.Normandy.Azeville
    • -
  • AIRBASE.Normandy.Picauville
    • -
  • AIRBASE.Normandy.Le_Molay
    • -
  • AIRBASE.Normandy.Longues_sur_Mer
    • -
  • AIRBASE.Normandy.Carpiquet
    • -
  • AIRBASE.Normandy.Bazenville
    • -
  • AIRBASE.Normandy.Sainte_Croix_sur_Mer
    • -
  • AIRBASE.Normandy.Beny_sur_Mer
    • -
  • AIRBASE.Normandy.Rucqueville
    • -
  • AIRBASE.Normandy.Sommervieu
    • -
  • AIRBASE.Normandy.Lantheuil
    • -
  • AIRBASE.Normandy.Evreux
    • -
  • AIRBASE.Normandy.Chailey
    • -
  • AIRBASE.Normandy.Needs_Oar_Point
    • -
  • AIRBASE.Normandy.Funtington
    • -
  • AIRBASE.Normandy.Tangmere
    • -
  • AIRBASE.Normandy.Ford
    • -
  • AIRBASE.Normandy.Argentan
    • -
  • AIRBASE.Normandy.Goulet
    • -
  • AIRBASE.Normandy.Barville
    • -
  • AIRBASE.Normandy.Essay
    • -
  • AIRBASE.Normandy.Hauterive
    • -
  • AIRBASE.Normandy.Lymington
    • -
  • AIRBASE.Normandy.Vrigny
    • -
  • AIRBASE.Normandy.Odiham
    • -
  • AIRBASE.Normandy.Conches
    • -
  • AIRBASE.Normandy.West_Malling
    • -
  • AIRBASE.Normandy.Villacoublay
    • -
  • AIRBASE.Normandy.Kenley
    • -
  • AIRBASE.Normandy.Beauvais_Tille
    • -
  • AIRBASE.Normandy.Cormeilles_en_Vexin
    • -
  • AIRBASE.Normandy.Creil
    • -
  • AIRBASE.Normandy.Guyancourt
    • -
  • AIRBASE.Normandy.Lonrai
    • -
  • AIRBASE.Normandy.Dinan_Trelivan
    • -
  • AIRBASE.Normandy.Heathrow
    • -
  • AIRBASE.Normandy.Fecamp_Benouville
    • -
  • AIRBASE.Normandy.Farnborough
    • -
  • AIRBASE.Normandy.Friston
    • -
  • AIRBASE.Normandy.Deanland
    • -
  • AIRBASE.Normandy.Triqueville
    • -
  • AIRBASE.Normandy.Poix
    • -
  • AIRBASE.Normandy.Orly
    • -
  • AIRBASE.Normandy.Stoney_Cross
    • -
  • AIRBASE.Normandy.Amiens_Glisy
    • -
  • AIRBASE.Normandy.Ronai
    • -
  • AIRBASE.Normandy.Rouen_Boos
    • -
  • AIRBASE.Normandy.Deauville
    • -
  • AIRBASE.Normandy.Saint_Aubin
    • -
  • AIRBASE.Normandy.Flers
    • -
  • AIRBASE.Normandy.Avranches_Le_Val_Saint_Pere
    • -
  • AIRBASE.Normandy.Gravesend
    • -
  • AIRBASE.Normandy.Beaumont_le_Roger
    • -
  • AIRBASE.Normandy.Broglie
    • -
  • AIRBASE.Normandy.Bernay_Saint_Martin
    • -
  • AIRBASE.Normandy.Saint_Andre_de_lEure
    • -
- - -
- -
-
-
- - #table -AIRBASE.NparkingTerminal - - - -
- -
-
-
- - #number -AIRBASE.NparkingTotal - - - -
- -
-
-
- - #table -AIRBASE.PersianGulf - -

Airbases of the Persion Gulf Map:

- -
    -
  • AIRBASE.PersianGulf.Abu_Dhabi_International_Airport
    • -
  • AIRBASE.PersianGulf.Abu_Musa_Island_Airport
    • -
  • AIRBASE.PersianGulf.Al_Bateen_Airport
    • -
  • AIRBASE.PersianGulf.Al_Ain_International_Airport
    • -
  • AIRBASE.PersianGulf.Al_Dhafra_AB
    • -
  • AIRBASE.PersianGulf.Al_Maktoum_Intl
    • -
  • AIRBASE.PersianGulf.Al_Minhad_AB
    • -
  • AIRBASE.PersianGulf.Bandar_e_Jask_airfield
    • -
  • AIRBASE.PersianGulf.Bandar_Abbas_Intl
    • -
  • AIRBASE.PersianGulf.Bandar_Lengeh
    • -
  • AIRBASE.PersianGulf.Dubai_Intl
    • -
  • AIRBASE.PersianGulf.Fujairah_Intl
    • -
  • AIRBASE.PersianGulf.Havadarya
    • -
  • AIRBASE.PersianGulf.Jiroft_Airport
    • -
  • AIRBASE.PersianGulf.Kerman_Airport
    • -
  • AIRBASE.PersianGulf.Khasab
    • -
  • AIRBASE.PersianGulf.Kish_International_Airport
    • -
  • AIRBASE.PersianGulf.Lar_Airbase
    • -
  • AIRBASE.PersianGulf.Lavan_Island_Airport
    • -
  • AIRBASE.PersianGulf.Liwa_Airbase
    • -
  • AIRBASE.PersianGulf.Qeshm_Island
    • -
  • AIRBASE.PersianGulf.Ras_Al_Khaimah
    • -
  • AIRBASE.PersianGulf.Sas_Al_Nakheel_Airport
    • -
  • AIRBASE.PersianGulf.Sharjah_Intl
    • -
  • AIRBASE.PersianGulf.Shiraz_International_Airport
    • -
  • AIRBASE.PersianGulf.Sir_Abu_Nuayr
    • -
  • AIRBASE.PersianGulf.Sirri_Island
    • -
  • AIRBASE.PersianGulf.Tunb_Island_AFB
    • -
  • AIRBASE.PersianGulf.Tunb_Kochak
    • -
- - -
- -
-
-
- - #table -AIRBASE.Sinai - -

Airbases of the Sinai map:

- -
    -
  • AIRBASE.Sinai.Abu_Suwayr
    • -
  • AIRBASE.Sinai.Sde_Dov
    • -
  • AIRBASE.Sinai.AzZaqaziq
    • -
  • AIRBASE.Sinai.Hatzor
    • -
  • AIRBASE.Sinai.Kedem
    • -
  • AIRBASE.Sinai.Nevatim
    • -
  • AIRBASE.Sinai.Cairo_International_Airport
    • -
  • AIRBASE.Sinai.Al_Ismailiyah
    • -
  • AIRBASE.Sinai.As_Salihiyah
    • -
  • AIRBASE.Sinai.Fayed
    • -
  • AIRBASE.Sinai.Bilbeis_Air_Base
    • -
  • AIRBASE.Sinai.Ramon_Airbase
    • -
  • AIRBASE.Sinai.Kibrit_Air_Base
    • -
  • AIRBASE.Sinai.El_Arish
    • -
  • AIRBASE.Sinai.Ovda
    • -
  • AIRBASE.Sinai.Melez
    • -
  • AIRBASE.Sinai.Al_Mansurah
    • -
  • AIRBASE.Sinai.Palmahim
    • -
  • AIRBASE.Sinai.Baluza
    • -
  • AIRBASE.Sinai.El_Gora
    • -
  • AIRBASE.Sinai.Difarsuwar_Airfield
    • -
  • AIRBASE.Sinai.Wadi_al_Jandali
    • -
  • AIRBASE.Sinai.St_Catherine
    • -
  • AIRBASE.Sinai.Tel_Nof
    • -
  • AIRBASE.Sinai.Abu_Rudeis
    • -
  • AIRBASE.Sinai.Inshas_Airbase
    • -
  • AIRBASE.Sinai.Ben_Gurion
    • -
  • AIRBASE.Sinai.Bir_Hasanah
    • -
  • AIRBASE.Sinai.Cairo_West
    • -
- - -
- -
-
-
- - #table -AIRBASE.SouthAtlantic - - - -
- -
-
-
- - #AIRBASE.SpotStatus -AIRBASE.SpotStatus - - - -
- -
-
-
- - #table -AIRBASE.Syria - -

Airbases of the Syria map:

- -
    -
  • AIRBASE.Syria.Kuweires
    • -
  • AIRBASE.Syria.Marj_Ruhayyil
    • -
  • AIRBASE.Syria.Kiryat_Shmona
    • -
  • AIRBASE.Syria.Marj_as_Sultan_North
    • -
  • AIRBASE.Syria.Eyn_Shemer
    • -
  • AIRBASE.Syria.Incirlik
    • -
  • AIRBASE.Syria.Damascus
    • -
  • AIRBASE.Syria.Bassel_Al_Assad
    • -
  • AIRBASE.Syria.Rosh_Pina
    • -
  • AIRBASE.Syria.Aleppo
    • -
  • AIRBASE.Syria.Al_Qusayr
    • -
  • AIRBASE.Syria.Wujah_Al_Hajar
    • -
  • AIRBASE.Syria.Al_Dumayr
    • -
  • AIRBASE.Syria.Gazipasa
    • -
  • AIRBASE.Syria.Hatay
    • -
  • AIRBASE.Syria.Nicosia [Deactivated by ED as of June/2023]
    • -
  • AIRBASE.Syria.Pinarbashi
    • -
  • AIRBASE.Syria.Paphos
    • -
  • AIRBASE.Syria.Kingsfield
    • -
  • AIRBASE.Syria.Thalah
    • -
  • AIRBASE.Syria.Haifa
    • -
  • AIRBASE.Syria.Khalkhalah
    • -
  • AIRBASE.Syria.Megiddo
    • -
  • AIRBASE.Syria.Lakatamia
    • -
  • AIRBASE.Syria.Rayak
    • -
  • AIRBASE.Syria.Larnaca
    • -
  • AIRBASE.Syria.Mezzeh
    • -
  • AIRBASE.Syria.Gecitkale
    • -
  • AIRBASE.Syria.Akrotiri
    • -
  • AIRBASE.Syria.Naqoura
    • -
  • AIRBASE.Syria.Gaziantep
    • -
  • AIRBASE.Syria.Sayqal
    • -
  • AIRBASE.Syria.Tiyas
    • -
  • AIRBASE.Syria.Shayrat
    • -
  • AIRBASE.Syria.Taftanaz
    • -
  • AIRBASE.Syria.H4
    • -
  • AIRBASE.Syria.King_Hussein_Air_College
    • -
  • AIRBASE.Syria.Rene_Mouawad
    • -
  • AIRBASE.Syria.Jirah
    • -
  • AIRBASE.Syria.Ramat_David
    • -
  • AIRBASE.Syria.Qabr_as_Sitt
    • -
  • AIRBASE.Syria.Minakh
    • -
  • AIRBASE.Syria.Adana_Sakirpasa
    • -
  • AIRBASE.Syria.Palmyra
    • -
  • AIRBASE.Syria.Hama
    • -
  • AIRBASE.Syria.Ercan
    • -
  • AIRBASE.Syria.Marj_as_Sultan_South
    • -
  • AIRBASE.Syria.Tabqa
    • -
  • AIRBASE.Syria.Beirut_Rafic_Hariri
    • -
  • AIRBASE.Syria.An_Nasiriyah
    • -
  • AIRBASE.Syria.Abu_al_Duhur
    • -
  • AIRBASE.Syria.At_Tanf
    • -
  • AIRBASE.Syria.H3
    • -
  • AIRBASE.Syria.H3_Northwest
    • -
  • AIRBASE.Syria.H3_Southwest
    • -
  • AIRBASE.Syria.Kharab_Ishk
    • -
  • AIRBASE.Syria.Raj_al_Issa_East (deleted by ED)
    • -
  • AIRBASE.Syria.Raj_al_Issa_West (deleted by ED)
    • -
  • AIRBASE.Syria.Ruwayshid
    • -
  • AIRBASE.Syria.Sanliurfa
    • -
  • AIRBASE.Syria.Tal_Siman
    • -
  • AIRBASE.Syria.Deir_ez_Zor
    • -
- - -
- -
-
-
- - #AIRBASE.TerminalType -AIRBASE.TerminalType - - - -
- -
-
-
- - #table -AIRBASE.TheChannel - -

Airbases of The Channel Map:

- -
    -
  • AIRBASE.TheChannel.Abbeville_Drucat
    • -
  • AIRBASE.TheChannel.Merville_Calonne
    • -
  • AIRBASE.TheChannel.Saint_Omer_Longuenesse
    • -
  • AIRBASE.TheChannel.Dunkirk_Mardyck
    • -
  • AIRBASE.TheChannel.Manston
    • -
  • AIRBASE.TheChannel.Hawkinge
    • -
  • AIRBASE.TheChannel.Lympne
    • -
  • AIRBASE.TheChannel.Detling
    • -
  • AIRBASE.TheChannel.High_Halden
    • -
  • AIRBASE.TheChannel.Biggin_Hill
    • -
  • AIRBASE.TheChannel.Eastchurch
    • -
  • AIRBASE.TheChannel.Headcorn
    • -
- - -
- -
-
-
- - #number -AIRBASE.category - -

Airbase category.

- -
- -
-
-
- - #table -AIRBASE.descriptors - -

DCS descriptors.

- -
- -
-
-
- - #boolean -AIRBASE.isAirdrome - -

Airbase is an airdrome.

- -
- -
-
-
- - #boolean -AIRBASE.isHelipad - -

Airbase is a helipad.

- -
- -
-
-
- - #boolean -AIRBASE.isShip - -

Airbase is a ship.

- -
- -
-
-
- - #table -AIRBASE.parking - -

Parking spot data.

- -
- -
-
-
- - #table -AIRBASE.parkingBlacklist - -

List of parking spot terminal IDs not considered for spawning.

- -
- -
-
-
- - #table -AIRBASE.parkingByID - -

Parking spot data table with ID as key.

- -
- -
-
-
- - #table -AIRBASE.parkingWhitelist - -

List of parking spot terminal IDs considered for spawning.

- -
- -
-
-
- - #AIRBASE.Runway -AIRBASE.runwayLanding - -

Runway used for landing.

- -
- -
-
-
- - #AIRBASE.Runway -AIRBASE.runwayTakeoff - -

Runway used for takeoff.

- -
- -
-
-
- - #table -AIRBASE.runways - -

Runways of airdromes.

- -
- -
-
-

Function(s)

-
-
- -
-

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

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

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

-
-
-

-
-
-
- -
-
- -
- -
-

AIRBASE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

-
- -

Creation of a Crash Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
-
-

- IniObjectCategory -

-
-
-

-
-
-
- -
-
- -
- -
-

AIRBASE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

-
- -

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.

- -
-
-
-
-

- IniObjectCategory -

-
-
-

-
-
-
- -
-
- -
- -
-

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

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

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

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

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

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

AIRBASE:CreateEventUnitLost(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.

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

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

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

AIRBASE:EventDispatcher()

-
- -

Returns the event dispatcher

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

Core.Event#EVENT:

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

AIRBASE:EventRemoveAll()

-
- -

Remove all subscribed events

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

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

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

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

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

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

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

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

AIRBASE:GetClassID()

-
- -

Get the ClassID of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassID of the class instance.

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

AIRBASE:GetClassName()

-
- -

Get the ClassName of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName of the class instance.

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

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

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

AIRBASE:GetEventPriority()

-
- -

Get the Class Core.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 Core.Event processing Priority.

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

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

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

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

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

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

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

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

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

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

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

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

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

AIRBASE:IsTrace()

-
- -

Enquires if tracing is on (for the class).

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#boolean:

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

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

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

AIRBASE:OnEvent(EventData)

-
- -

Occurs when an Event for an object is triggered.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that triggered the event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventBDA(EventData)

-
- -

BDA.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventBaseCaptured(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -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.

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

AIRBASE:OnEventBirth(EventData)

-
- -

Occurs when any object is spawned into the mission.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was spawned

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventCrash(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that has crashed

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventDead(EventData)

-
- -

Occurs when an object is dead.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is dead.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

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

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

AIRBASE:OnEventDiscardChairAfterEjection(EventData)

-
- -

Discard chair after ejection.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventEjection(EventData)

-
- -

Occurs when a pilot ejects from an aircraft -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- - -

initiator : The unit that has ejected

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventEngineShutdown(EventData)

-
- -

Occurs when any aircraft shuts down its engines.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is stopping its engines.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventEngineStartup(EventData)

-
- -

Occurs when any aircraft starts its engines.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is starting its engines.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventHit(EventData)

-
- -

Occurs whenever an object is hit by a weapon.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -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.

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

AIRBASE:OnEventHumanFailure(EventData)

-
- -

Occurs when any system fails on a human controlled aircraft.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that had the failure

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • 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.

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

AIRBASE:OnEventLand(EventData)

-
- -

Occurs when an aircraft lands at an airbase, farp or ship -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- - -

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.

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

AIRBASE: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • 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.

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

AIRBASE:OnEventLandingQualityMark(EventData)

-
- -

Landing quality mark.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventMarkAdded(EventData)

-
- -

Occurs when a new mark was added.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventMarkChange(EventData)

-
- -

Occurs when a mark text was changed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventMarkRemoved(EventData)

-
- -

Occurs when a mark was removed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventMissionEnd(EventData)

-
- -

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventMissionStart(EventData)

-
- -

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the pilot has died in.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventPlayerEnterAircraft(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -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.

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

AIRBASE:OnEventPlayerEnterUnit(EventData)

-
- -

Occurs when any player assumes direct control of a unit.

- - -

Note - not Mulitplayer safe. Use PlayerEnterAircraft. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is being taken control of.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventPlayerLeaveUnit(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the player left.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventRefueling(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventRefuelingStop(EventData)

-
- -

Occurs when an aircraft is finished taking fuel.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventShootingEnd(EventData)

-
- -

Occurs when any unit stops firing its weapon.

- - -

Event will always correspond with a shooting start event. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was doing the shooting.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventShootingStart(EventData)

-
- -

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

- - -

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -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.

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

AIRBASE:OnEventShot(EventData)

-
- -

Occurs whenever any unit in a mission fires a weapon.

- - -

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventTakeoff(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that tookoff -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.

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

AIRBASE:OnEventTriggerZone(EventData)

-
- -

Trigger zone.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

AIRBASE:OnEventUnitLost(EventData)

-
- -

Occurs when the game thinks an object is destroyed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

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

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

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

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

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

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

AIRBASE:ScheduleStop(SchedulerID)

-
- -

Stops the Schedule.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - SchedulerID -

-
-
- -

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

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

AIRBASE:SetEventPriority(EventPriority)

-
- -

Set the Class Core.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 Core.Event processing Priority.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- -

self

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

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

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

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

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

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

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

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

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

AIRBASE:TraceAll(TraceAll)

-
- -

Trace all methods in MOOSE

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceAll -

-
-
- -

true = trace all methods in MOOSE.

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

AIRBASE:TraceClass(Class)

-
- -

Set tracing for a class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - Class -

-
-
- -

Class name.

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

AIRBASE:TraceClassMethod(Class, Method)

-
- -

Set tracing for a specific method of class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #string - Class -

-
-
- -

Class name.

- -
-
-
-
-

- #string - Method -

-
-
- -

Method.

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

AIRBASE:TraceLevel(Level)

-
- -

Set trace level

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - Level -

-
-
-

-
-
-
- -
-
- -
- -
-

AIRBASE:TraceOff()

-
- -

Set trace off.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

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

AIRBASE:TraceOn()

-
- -

Set trace on.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

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

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

AIRBASE:UnHandleEvent(EventID)

-
- -

UnSubscribe to a DCS event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-

Return value:

-
-
-

#BASE:

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

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

-
-
-

-
-
-
- -
-
- -
- -
-

AIRBASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

AIRBASE:onEvent(event)

-
- -

The main event handling function...

- - -

This function captures all events generated for the class.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- DCS#Event - event -

-
-
-

-
-
-
- -
-
-
diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index c493f2799..5503e042a 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -5043,18 +5043,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-GROUP.InitRespawnRandomizePositionInner - - - -
- - -
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -9547,18 +9536,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -18797,18 +18775,7 @@ Note that when WayPointInitialize is called, the Mission of the controllable is
-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -22897,18 +22864,7 @@ Coordinates are dependent on the position of the maps origin.

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

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

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

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -3098,28 +3120,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 - - -
@@ -5160,6 +5160,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -5237,28 +5259,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 - - -
@@ -6770,6 +6770,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+ + + +
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -6847,28 +6869,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 - - -