Banner Image

Module Wrapper.Airbase

Wrapper -- AIRBASE is a wrapper class to handle the DCS Airbase objects.


Author: FlightControl

Contributions: funkyfranky


Global(s)

Global AIRBASE

Wrapper class to handle the DCS Airbase objects:

  • Support all DCS Airbase APIs.
#AIRBASE AIRBASE

Wrapper class to handle the DCS Airbase objects:

  • Support all DCS Airbase APIs.
  • Enhance with Airbase specific APIs not in the DCS Airbase API set.

AIRBASE reference methods

For each DCS Airbase object alive within a running mission, a AIRBASE wrapper object (instance) will be created within the _DATABASE object. This is done at the beginning of the mission (when the mission starts).

The AIRBASE class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference using the DCS Airbase or the DCS AirbaseName.

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

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

  • AIRBASE.Find(): Find a AIRBASE instance from the _DATABASE object using a DCS Airbase object.
  • AIRBASE.FindByName(): Find a AIRBASE instance from the _DATABASE object using a DCS Airbase name.

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

DCS Airbase APIs

The DCS Airbase APIs are used extensively within MOOSE. The AIRBASE class has for each DCS Airbase API a corresponding method. To be able to distinguish easily in your code the difference between a AIRBASE API call and a DCS Airbase API call, the first letter of the method is also capitalized. So, by example, the DCS Airbase method DCSWrapper.Airbase#Airbase.getName() is implemented in the AIRBASE class as AIRBASE.GetName().

Type(s)

Fields and Methods inherited from AIRBASE Description

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

Enumeration to identify the airbases in the Caucasus region.

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:Find(DCSAirbase)

Finds a AIRBASE from the _DATABASE using a DCSAirbase object.

AIRBASE:FindByID(id)

Find a AIRBASE in the _DATABASE by its ID.

AIRBASE:FindByName(AirbaseName)

Find a AIRBASE in the _DATABASE using the name of an existing DCS Airbase.

AIRBASE:FindFreeParkingSpotForAircraft(group, terminaltype, scanradius, scanunits, scanstatics, scanscenery, verysafe, nspots, parkingdata)

Seach unoccupied parking spots at the airbase for a specific group of aircraft.

AIRBASE:GetActiveRunway()

Get the active runways.

AIRBASE:GetActiveRunwayLanding()

Get the active runway for landing.

AIRBASE:GetActiveRunwayTakeoff()

Get the active runway for takeoff.

AIRBASE:GetAirbaseCategory()

Get category of airbase.

AIRBASE.GetAllAirbaseNames(coalition, category)

Get all airbase names of the current map.

AIRBASE.GetAllAirbases(coalition, category)

Get all airbases of the current map.

AIRBASE:GetDCSObject()

Get the DCS object of an airbase

AIRBASE:GetFreeParkingSpotsCoordinates(termtype, allowTOAC)

Get the coordinates of free parking spots at an airbase.

AIRBASE:GetFreeParkingSpotsNumber(termtype, allowTOAC)

Get number of free parking spots at an airbase.

AIRBASE:GetFreeParkingSpotsTable(termtype, allowTOAC)

Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

AIRBASE:GetID(unique)

Get ID of the airbase.

AIRBASE:GetParkingData(available)

Returns a table of parking data for a given airbase.

AIRBASE:GetParkingSpotData(TerminalID)

Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

AIRBASE:GetParkingSpotsCoordinates(termtype)

Get the coordinates of all parking spots at an airbase.

AIRBASE:GetParkingSpotsNumber(termtype)

Get number of parking spots at an airbase.

AIRBASE:GetParkingSpotsTable(termtype)

Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

AIRBASE:GetRadioSilentMode()

Check whether or not the airbase has been silenced.

AIRBASE:GetRunwayByName(Name)

Get runway by its name.

AIRBASE:GetRunwayData(magvar, mark)

Get runways data.

AIRBASE:GetRunwayIntoWind(PreferLeft)

Get the runway where aircraft would be taking of or landing into the direction of the wind.

AIRBASE:GetRunwayName(Runway, LongLeftRight)

Get name of a given runway, e.g.

AIRBASE:GetRunways()

Get runways.

AIRBASE:GetZone()

Get the airbase zone.

AIRBASE:IsAirdrome()

Check if airbase is an airdrome.

AIRBASE:IsHelipad()

Check if airbase is a helipad.

AIRBASE:IsShip()

Check if airbase is a ship.

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

AIRBASE:MarkParkingSpots(termtype, mark)

Place markers of parking spots on the F10 map.

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

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_AF

AIRBASE.NparkingTerminal

AIRBASE.NparkingTotal

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

AIRBASE:Register(AirbaseName)

Create a new AIRBASE from DCSAirbase.

AIRBASE:SetActiveRunway(Name, PreferLeft)

Set the active runway for landing and takeoff.

AIRBASE:SetActiveRunwayLanding(Name, PreferLeft)

Set the active runway for landing.

AIRBASE:SetActiveRunwayTakeoff(Name, PreferLeft)

Set the active runway for takeoff.

AIRBASE:SetParkingSpotBlacklist(TerminalIdBlacklist)

Set parking spot blacklist.

AIRBASE:SetParkingSpotWhitelist(TerminalIdBlacklist, TerminalIdWhitelist)

Set parking spot whitelist.

AIRBASE:SetRadioSilentMode(Silent)

Sets the ATC belonging to an airbase object to be silent and unresponsive.

AIRBASE.SouthAtlantic

AIRBASE.SpotStatus

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
  • 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
  • AIRBASE.Syria.Raj_al_Issa_West
  • AIRBASE.Syria.Ruwayshid
  • AIRBASE.Syria.Sanliurfa
  • AIRBASE.Syria.Tal_Siman
  • AIRBASE.Syria.Deir_ez_Zor

AIRBASE.TerminalType

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

AIRBASE:_CheckParkingLists(TerminalID)

Check black and white lists.

AIRBASE._CheckTerminalType(Term_Type, termtype)

Helper function to check for the correct terminal type including "artificial" ones.

AIRBASE:_GetParkingSpotByID(TerminalID)

Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

AIRBASE:_InitParkingSpots()

Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

AIRBASE:_InitRunways(IncludeInverse)

Init runways.

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 POSITIONABLE Description

AIRBASE:AddCargo(Cargo)

Add cargo.

AIRBASE:CargoItemCount()

Get cargo item count.

AIRBASE:ClearCargo()

Clear all cargo.

AIRBASE:Destroy(GenerateEvent)

Destroys 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: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.Radio#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: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 Core.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: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 a 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 Zone.

AIRBASE:IsLasing()

Check if the POSITIONABLE is lasing a target

AIRBASE:IsNotInZone(Zone)

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

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 OBJECT Description

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 BASE Description

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

Fields and Methods inherited from AIRBASE.ParkingSpot Description

AIRBASE.ParkingSpot.AirbaseName

Name of the airbase.

AIRBASE.ParkingSpot.ClientName

Client unit name of this spot.

AIRBASE.ParkingSpot.ClientSpot

If true, this is a parking spot of a client aircraft.

AIRBASE.ParkingSpot.Coordinate

Coordinate of the parking spot.

AIRBASE.ParkingSpot.DistToRwy

Distance to runway in meters. Currently bugged and giving the same number as the TerminalID.

AIRBASE.ParkingSpot.Free

This spot is currently free, i.e. there is no alive aircraft on it at the present moment.

AIRBASE.ParkingSpot.Marker

The marker on the F10 map.

AIRBASE.ParkingSpot.MarkerID

Numerical ID of marker placed at parking spot.

AIRBASE.ParkingSpot.OccupiedBy

Name of the aircraft occupying the spot or "unknown". Can be nil if spot is not occupied.

AIRBASE.ParkingSpot.ReservedBy

Name of the aircraft for which this spot is reserved. Can be nil if spot is not reserved.

AIRBASE.ParkingSpot.Status

Status of spot e.g. AIRBASE.SpotStatus.FREE.

AIRBASE.ParkingSpot.TOAC

Takeoff or landing aircarft. I.e. this stop is occupied currently by an aircraft until it took of or until it landed.

AIRBASE.ParkingSpot.TerminalID

Terminal ID of the spot. Generally, this is not the same number as displayed in the mission editor.

AIRBASE.ParkingSpot.TerminalID0

Unknown what this means. If you know, please tell us!

AIRBASE.ParkingSpot.TerminalType

Type of the spot, i.e. for which type of aircraft it can be used.

AIRBASE.ParkingSpot.Vec3

Fields and Methods inherited from AIRBASE.Runway Description

AIRBASE.Runway.center

Center of the runway.

AIRBASE.Runway.endpoint

End point of runway.

AIRBASE.Runway.heading

True heading of the runway in degrees.

AIRBASE.Runway.idx

Runway ID: heading 070° ==> idx="07".

AIRBASE.Runway.isLeft

If true, this is the left of two parallel runways. If false, this is the right of two runways. If nil, no parallel runway exists.

AIRBASE.Runway.length

Length of runway in meters.

AIRBASE.Runway.magheading

Magnetic heading of the runway in degrees. This is what is marked on the runway.

AIRBASE.Runway.name

Runway name.

AIRBASE.Runway.position

Position of runway start.

AIRBASE.Runway.width

Width of runway in meters.

AIRBASE.Runway.zone

Runway zone.

Fields and Methods inherited from AIRBASE.SpotStatus Description

AIRBASE.SpotStatus.FREE

Spot is free.

AIRBASE.SpotStatus.OCCUPIED

Spot is occupied.

AIRBASE.SpotStatus.RESERVED

Spot is reserved.

Fields and Methods inherited from AIRBASE.TerminalType Description

AIRBASE.TerminalType.FighterAircraft

244: Combines Shelter. OpenMed and OpenBig spots. So effectively all spots usable by fixed wing aircraft.

AIRBASE.TerminalType.HelicopterOnly

40: Special spots for Helicopers.

AIRBASE.TerminalType.HelicopterUsable

216: Combines HelicopterOnly, OpenMed and OpenBig.

AIRBASE.TerminalType.OpenBig

104: Open air spawn points. Generally larger but does not guarantee large aircraft are capable of spawning there.

AIRBASE.TerminalType.OpenMed

72: Open/Shelter air airplane only.

AIRBASE.TerminalType.OpenMedOrBig

176: Combines OpenMed and OpenBig spots.

AIRBASE.TerminalType.Runway

16: Valid spawn points on runway.

AIRBASE.TerminalType.Shelter

68: Hardened Air Shelter. Currently only on Caucaus map.

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_AF
#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_International_Airport
  • 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.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
  • 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
  • AIRBASE.Syria.Raj_al_Issa_West
  • AIRBASE.Syria.Ruwayshid
  • AIRBASE.Syria.Sanliurfa
  • AIRBASE.Syria.Tal_Siman
  • AIRBASE.Syria.Deir_ez_Zor
#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)

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

Defined in:

AIRBASE

Parameters:

Group to be checked.

#number radius

Radius around the spawn point to be checked. Default is 50 m.

#boolean despawn

If true, the group is destroyed.

Return value:

#boolean:

True if group is within radius around spawn points on runway.

Finds a AIRBASE from the _DATABASE using a DCSAirbase object.

Defined in:

AIRBASE

Parameter:

DCS#Airbase DCSAirbase

An existing DCS Airbase object reference.

Return value:

Find a AIRBASE in the _DATABASE by its ID.

Defined in:

AIRBASE

Parameter:

#number id

Airbase ID.

Return value:

self

Find a AIRBASE in the _DATABASE using the name of an existing DCS Airbase.

Defined in:

AIRBASE

Parameter:

#string AirbaseName

The Airbase Name.

Return value:

self

Seach unoccupied parking spots at the airbase for a specific group of aircraft.

The routine also optionally checks for other unit, static and scenery options in a certain radius around the parking spot. The dimension of the spawned aircraft and of the potential obstacle are taken into account. Note that the routine can only return so many spots that are free.

Defined in:

AIRBASE

Parameters:

Aircraft group for which the parking spots are requested.

#AIRBASE.TerminalType terminaltype

(Optional) Only search spots at a specific terminal type. Default is all types execpt on runway.

#number scanradius

(Optional) Radius in meters around parking spot to scan for obstacles. Default 50 m.

#boolean scanunits

(Optional) Scan for units as obstacles. Default true.

#boolean scanstatics

(Optional) Scan for statics as obstacles. Default true.

#boolean scanscenery

(Optional) Scan for scenery as obstacles. Default false. Can cause problems with e.g. shelters.

#boolean verysafe

(Optional) If true, wait until an aircraft has taken off until the parking spot is considered to be free. Defaul false.

#number nspots

(Optional) Number of freeparking spots requested. Default is the number of aircraft in the group.

#table parkingdata

(Optional) Parking spots data table. If not given it is automatically derived from the GetParkingSpotsTable() function.

Return value:

#table:

Table of coordinates and terminal IDs of free parking spots. Each table entry has the elements .Coordinate and .TerminalID.

Get the active runways.

Defined in:

AIRBASE

Return values:

The active runway for landing.

The active runway for takeoff.

Get the active runway for landing.

Defined in:

AIRBASE

Return value:

The active runway for landing.

Get the active runway for takeoff.

Defined in:

AIRBASE

Return value:

The active runway for takeoff.

Get category of airbase.

Defined in:

AIRBASE

Return value:

#number:

Category of airbase from GetDesc().category.

Get all airbase names of the current map.

This includes ships and FARPS.

Defined in:

AIRBASE

Parameters:

DCS#Coalition coalition

(Optional) Return only airbases belonging to the specified coalition. By default, all airbases of the map are returned.

#number category

(Optional) Return only airbases of a certain category, e.g. Airbase.Category.HELIPAD.

Return value:

#table:

Table containing all airbase names of the current map.

Get all airbases of the current map.

This includes ships and FARPS.

Defined in:

AIRBASE

Parameters:

DCS#Coalition coalition

(Optional) Return only airbases belonging to the specified coalition. By default, all airbases of the map are returned.

#number category

(Optional) Return only airbases of a certain category, e.g. Airbase.Category.FARP

Return value:

#table:

Table containing all airbase objects of the current map.

Get the DCS object of an airbase

Defined in:

AIRBASE

Return value:

DCS airbase object.

Get the coordinates of free parking spots at an airbase.

Defined in:

AIRBASE

Parameters:

Terminal type.

#boolean allowTOAC

If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.

Return value:

#table:

Table of coordinates of the free parking spots.

Get number of free parking spots at an airbase.

Defined in:

AIRBASE

Parameters:

Terminal type.

#boolean allowTOAC

If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.

Return value:

#number:

Number of free parking spots at this airbase.

Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

Defined in:

AIRBASE

Parameters:

Terminal type.

#boolean allowTOAC

If true, spots are considered free even though TO_AC is true. Default is off which is saver to avoid spawning aircraft on top of each other. Option might be enabled for FARPS and ships.

Return value:

#table:

Table free parking spots. Table has the elements ".Coordinate, ".TerminalID", ".TerminalType", ".TOAC", ".Free", ".TerminalID0", ".DistToRwy".

Get ID of the airbase.

Defined in:

AIRBASE

Parameter:

#boolean unique

(Optional) If true, ships will get a negative sign as the unit ID might be the same as an airbase ID. Default off!

Return value:

#number:

The airbase ID.

Returns a table of parking data for a given airbase.

If the optional parameter available is true only available parking will be returned, otherwise all parking at the base is returned. Term types have the following enumerated values:

  • 16 : Valid spawn points on runway
  • 40 : Helicopter only spawn
  • 68 : Hardened Air Shelter
  • 72 : Open/Shelter air airplane only
  • 104: Open air spawn

Note that only Caucuses will return 68 as it is the only map currently with hardened air shelters. 104 are also generally larger, but does not guarantee a large aircraft like the B-52 or a C-130 are capable of spawning there.

Table entries:

  • Term_index is the id for the parking
  • vTerminal pos is its vec3 position in the world
  • fDistToRW is the distance to the take-off position for the active runway from the parking.

Defined in:

AIRBASE

Parameter:

#boolean available

If true, only available parking spots will be returned.

Return value:

#table:

Table with parking data. See https://wiki.hoggitworld.com/view/DCS_func_getParking

Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

Defined in:

AIRBASE

Parameter:

#number TerminalID

The terminal ID of the parking spot.

Return value:

Table free parking spots. Table has the elements ".Coordinate, ".TerminalID", ".TerminalType", ".TOAC", ".Free", ".TerminalID0", ".DistToRwy".

Get the coordinates of all parking spots at an airbase.

Optionally only those of a specific terminal type. Spots on runways are excluded if not explicitly requested by terminal type.

Defined in:

AIRBASE

Parameter:

(Optional) Terminal type. Default all.

Return value:

#table:

Table of coordinates of parking spots.

Get number of parking spots at an airbase.

Optionally, a specific terminal type can be requested.

Defined in:

AIRBASE

Parameter:

Terminal type of which the number of spots is counted. Default all spots but spawn points on runway.

Return value:

#number:

Number of parking spots at this airbase.

Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

Defined in:

AIRBASE

Parameter:

Terminal type.

Return value:

#table:

Table free parking spots. Table has the elements ".Coordinate, ".TerminalID", ".TerminalType", ".TOAC", ".Free", ".TerminalID0", ".DistToRwy".

Check whether or not the airbase has been silenced.

Defined in:

AIRBASE

Return value:

#boolean:

If true, silent mode is enabled.

Get runway by its name.

Defined in:

AIRBASE

Parameter:

#string Name

Name of the runway, e.g. "31" or "21L".

Return value:

Runway data.

Get runways data.

Only for airdromes!

Defined in:

AIRBASE

Parameters:

#number magvar

(Optional) Magnetic variation in degrees.

#boolean mark

(Optional) Place markers with runway data on F10 map.

Return value:

#table:

Runway data.

Get the runway where aircraft would be taking of or landing into the direction of the wind.

NOTE that this requires the wind to be non-zero as set in the mission editor.

Defined in:

AIRBASE

Parameter:

#boolean PreferLeft

If true, perfer the left runway. If false, prefer the right runway. If nil (default), do not care about left or right.

Return value:

Active runway data table.

Get name of a given runway, e.g.

"31L".

Defined in:

AIRBASE

Parameters:

The runway. Default is the active runway.

#boolean LongLeftRight

If true, return "Left" or "Right" instead of "L" or "R".

Return value:

#string:

Name of the runway or "XX" if it could not be found.

Get runways.

Defined in:

AIRBASE

Return value:

#table:

Runway data.

Get the airbase zone.

Defined in:

AIRBASE

Return value:

The zone radius of the airbase.

Check if airbase is an airdrome.

Defined in:

AIRBASE

Return value:

#boolean:

If true, airbase is an airdrome.

Check if airbase is a helipad.

Defined in:

AIRBASE

Return value:

#boolean:

If true, airbase is a helipad.

Check if airbase is a ship.

Defined in:

AIRBASE

Return value:

#boolean:

If true, airbase is a ship.

Place markers of parking spots on the F10 map.

Defined in:

AIRBASE

Parameters:

Terminal type for which marks should be placed.

#boolean mark

If false, do not place markers but only give output to DCS.log file. Default true.

Create a new AIRBASE from DCSAirbase.

Defined in:

AIRBASE

Parameter:

#string AirbaseName

The name of the airbase.

Return value:

self

Set the active runway for landing and takeoff.

Defined in:

AIRBASE

Parameters:

#string Name

Name of the runway, e.g. "31" or "02L" or "90R". If not given, the runway is determined from the wind direction.

#boolean PreferLeft

If true, perfer the left runway. If false, prefer the right runway. If nil (default), do not care about left or right.

Set the active runway for landing.

Defined in:

AIRBASE

Parameters:

#string Name

Name of the runway, e.g. "31" or "02L" or "90R". If not given, the runway is determined from the wind direction.

#boolean PreferLeft

If true, perfer the left runway. If false, prefer the right runway. If nil (default), do not care about left or right.

Return value:

The active runway for landing.

Set the active runway for takeoff.

Defined in:

AIRBASE

Parameters:

#string Name

Name of the runway, e.g. "31" or "02L" or "90R". If not given, the runway is determined from the wind direction.

#boolean PreferLeft

If true, perfer the left runway. If false, prefer the right runway. If nil (default), do not care about left or right.

Return value:

The active runway for landing.

Set parking spot blacklist.

These parking spots will not be used for spawning. Black listed spots overrule white listed spots. NOTE that terminal IDs are not necessarily the same as those displayed in the mission editor!

Defined in:

AIRBASE

Parameter:

#table TerminalIdBlacklist

Table of black listed terminal IDs.

Return value:

self

Usage:

AIRBASE:FindByName("Batumi"):SetParkingSpotBlacklist({2, 3, 4}) --Forbit terminal IDs 2, 3, 4

Set parking spot whitelist.

Only these spots will be considered for spawning. Black listed spots overrule white listed spots. NOTE that terminal IDs are not necessarily the same as those displayed in the mission editor!

Defined in:

AIRBASE

Parameters:

#table TerminalIdBlacklist

Table of white listed terminal IDs.

TerminalIdWhitelist

Return value:

self

Usage:

AIRBASE:FindByName("Batumi"):SetParkingSpotWhitelist({2, 3, 4}) --Only allow terminal IDs 2, 3, 4

Sets the ATC belonging to an airbase object to be silent and unresponsive.

This is useful for disabling the award winning ATC behavior in DCS. Note that this DOES NOT remove the airbase from the list. It just makes it unresponsive and silent to any radio calls to it.

Defined in:

AIRBASE

Parameter:

#boolean Silent

If true, enable silent mode. If false or nil, disable silent mode.

Return value:

self

Check black and white lists.

Defined in:

AIRBASE

Parameter:

#number TerminalID

Terminal ID to check.

Return value:

#boolean:

true if this is a valid spot.

Helper function to check for the correct terminal type including "artificial" ones.

Defined in:

AIRBASE

Parameters:

#number Term_Type

Termial type from getParking routine.

Terminal type from AIRBASE.TerminalType enumerator.

Return value:

#boolean:

True if terminal types match.

Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

Defined in:

AIRBASE

Parameter:

#number TerminalID

Terminal ID.

Return value:

Parking spot.

Get a table containing the coordinates, terminal index and terminal type of free parking spots at an airbase.

Defined in:

AIRBASE

Return value:

self

Init runways.

Defined in:

AIRBASE

Parameter:

#boolean IncludeInverse

If true or nil, include inverse runways.

Return value:

#table:

Runway data.

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_AF
#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_International_Airport
  • 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.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
  • 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
  • AIRBASE.Syria.Raj_al_Issa_West
  • AIRBASE.Syria.Ruwayshid
  • AIRBASE.Syria.Sanliurfa
  • AIRBASE.Syria.Tal_Siman
  • AIRBASE.Syria.Deir_ez_Zor
#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)

Add cargo.

Defined in:

Parameter:

Return value:

Get cargo item count.

Defined in:

Return value:

Destroys the POSITIONABLE.

Defined in:

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.
    

Signal a flare at the position of the POSITIONABLE.

Signal a green flare at the position of the POSITIONABLE.

Signal a red flare at the position of the POSITIONABLE.

Signal a white flare at the position of the POSITIONABLE.

Signal a yellow flare at the position of the POSITIONABLE.

Returns the altitude above sea level of the POSITIONABLE.

Defined in:

Return values:

The altitude of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

Returns the Angle of Attack of a POSITIONABLE.

Defined in:

Return values:

#number:

Angle of attack in degrees.

#nil:

The POSITIONABLE is not existing or alive.

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

Defined in:

Return value:

Get the bounding box of the underlying POSITIONABLE DCS Object.

Defined in:

Return values:

The bounding box of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

Get the bounding radius of the underlying POSITIONABLE DCS Object.

Defined in:

Parameter:

#number MinDist

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

Return values:

The bounding radius of the POSITIONABLE

#nil:

The POSITIONABLE is not existing or alive.

Get all contained cargo.

Get Cargo Bay Free Weight in kg.

Defined in:

Return value:

#number:

CargoBayFreeWeight

Get Cargo Bay Weight Limit in kg.

Defined in:

Return value:

#number:

Max cargo weight in kg.

Returns the climb or descent angle of the POSITIONABLE.

Defined in:

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.

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:

Return value:

A reference to the COORDINATE object of the POSITIONABLE.

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

Defined in:

Return value:

A new COORDINATE object of the POSITIONABLE.

Returns the DCS object.

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

Defined in:

Return value:

The DCS object.

Returns the POSITIONABLE heading in degrees.

Defined in:

Return values:

#number:

The POSITIONABLE heading in degrees.

#nil:

The POSITIONABLE is not existing or alive.

Returns the POSITIONABLE height above sea level in meters.

Defined in:

Return value:

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

Get the last assigned laser code

Defined in:

Return value:

#number:

The laser code

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

Defined in:

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:

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

Defined in:

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.

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

Defined in:

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:

Get the object size.

Defined in:

Return values:

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

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

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

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

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

Defined in:

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:

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

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:

Return values:

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

Y orientation, i.e. vertical.

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

#nil:

The POSITIONABLE is not existing or alive.

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

along the direction of movement.

Defined in:

Return values:

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

#nil:

The POSITIONABLE is not existing or alive.

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

vertical orientation.

Defined in:

Return values:

Y orientation, i.e. vertical.

#nil:

The POSITIONABLE is not existing or alive.

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

perpendicular to direction of movement.

Defined in:

Return values:

Z orientation, i.e. perpendicular to movement.

#nil:

The POSITIONABLE is not existing or alive.

Returns the pitch angle of a POSITIONABLE.

Defined in:

Return values:

#number:

Pitch angle in degrees.

#nil:

The POSITIONABLE is not existing or alive.

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

Defined in:

Return values:

The 2D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

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

Defined in:

Return values:

The 3D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

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:

Return value:

Table consisting of the point and orientation tables.

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

Defined in:

Return values:

The 3D position vectors of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

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

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

Defined in:

Return value:

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

Defined in:

Parameter:

#number Radius

Return values:

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

Get relative velocity with respect to another POSITIONABLE.

Defined in:

Parameter:

#POSITIONABLE Positionable

Other POSITIONABLE.

Return value:

#number:

Relative velocity in m/s.

Returns the roll angle of a unit.

Defined in:

Return values:

#number:

Pitch angle in degrees.

#nil:

The POSITIONABLE is not existing or alive.

Get the Spot

Defined in:

Return value:

The Spot

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:

Return value:

#number:

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

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

Defined in:

Return values:

The 2D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

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

Defined in:

Return values:

The 3D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

Returns the a Velocity object from the POSITIONABLE.

Defined in:

Return values:

Velocity The Velocity object.

#nil:

The POSITIONABLE is not existing or alive.

Returns the POSITIONABLE velocity in km/h.

Defined in:

Return value:

#number:

The velocity in km/h.

Returns the POSITIONABLE velocity in knots.

Defined in:

Return value:

#number:

The velocity in knots.

Returns the POSITIONABLE velocity in meters per second.

Defined in:

Return value:

#number:

The velocity in meters per second.

Returns the POSITIONABLE velocity Vec3 vector.

Defined in:

Return values:

The velocity Vec3 vector

#nil:

The POSITIONABLE is not existing or alive.

Returns the yaw angle of a POSITIONABLE.

Defined in:

Return values:

#number:

Yaw angle in degrees.

#nil:

The POSITIONABLE is not existing or alive.

Returns if carrier has given cargo.

Defined in:

Parameter:

Cargo

Return value:

Returns true if the POSITIONABLE is in the air.

Polymorphic, is overridden in GROUP and UNIT.

Defined in:

Return values:

#boolean:

true if in the air.

#nil:

The POSITIONABLE is not existing or alive.

Returns if the Positionable is located above a runway.

Defined in:

Return values:

#boolean:

true if Positionable is above a runway.

#nil:

The POSITIONABLE is not existing or alive.

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:

Return values:

#boolean:

Air category evaluation result.

#nil:

The POSITIONABLE is not existing or alive.

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:

Return values:

#boolean:

Ground category evaluation result.

#nil:

The POSITIONABLE is not existing or alive.

Returns true if the unit is within a Zone.

Defined in:

Parameter:

The zone to test.

Return value:

#boolean:

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

Check if the POSITIONABLE is lasing a target

Defined in:

Return value:

#boolean:

true if it is lasing a target

Returns true if the unit is not within a Zone.

Defined in:

Parameter:

The zone to test.

Return value:

#boolean:

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

Returns if the unit is of ship category.

Defined in:

Return values:

#boolean:

Ship category evaluation result.

#nil:

The POSITIONABLE is not existing or alive.

Returns if the unit is a submarine.

Defined in:

Return value:

#boolean:

Submarines attributes result.

Start Lasing a COORDINATE.

Defined in:

Parameters:

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:

Stop Lasing a POSITIONABLE

Start Lasing a POSITIONABLE

Defined in:

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:

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:

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.

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:

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.

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:

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.

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:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

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.

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:

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.

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:

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.

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:

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.

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:

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.

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:

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.

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:

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.

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:

Parameters:

#string Message

The message text

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.

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:

Parameters:

#string Message

The message text

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.

Create a new POSITIONABLE from a DCSPositionable

Defined in:

Parameter:

#string PositionableName

The POSITIONABLE name

Return value:

Remove cargo.

Defined in:

Parameter:

Return value:

Set Cargo Bay Weight Limit in kg.

Defined in:

Parameter:

#number WeightLimit

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

Smoke the POSITIONABLE.

Defined in:

Parameters:

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.

Smoke the POSITIONABLE Blue.

Smoke the POSITIONABLE Green.

Smoke the POSITIONABLE Orange.

Smoke the POSITIONABLE Red.

Smoke the POSITIONABLE White.

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_AF
#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_International_Airport
  • 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.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
  • 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
  • AIRBASE.Syria.Raj_al_Issa_West
  • AIRBASE.Syria.Ruwayshid
  • AIRBASE.Syria.Sanliurfa
  • AIRBASE.Syria.Tal_Siman
  • AIRBASE.Syria.Deir_ez_Zor
#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)

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

Defined in:

Return value:

#string:

The CallSign of the IDENTIFIABLE.

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:

Return value:

The category ID, i.e. a number.

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

Defined in:

Return value:

#string:

The DCS Identifiable Category Name

Returns coalition of the Identifiable.

Defined in:

Return value:

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

Returns the name of the coalition of the Identifiable.

Defined in:

Return values:

#string:

The name of the coalition.

#nil:

The DCS Identifiable is not existing or alive.

Returns country of the Identifiable.

Defined in:

Return value:

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

Returns country name of the Identifiable.

Defined in:

Return value:

#string:

Name of the country.

Returns Identifiable descriptor.

Descriptor type depends on Identifiable category.

Defined in:

Return value:

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

Returns DCS Identifiable object name.

The function provides access to non-activated objects too.

Defined in:

Return value:

#string:

The name of the DCS Identifiable or #nil.

Gets the threat level.

Defined in:

Return values:

#number:

Threat level.

#string:

Type.

Returns the type name of the DCS Identifiable.

Defined in:

Return value:

#string:

The type name of the DCS Identifiable.

Check if the Object has the attribute.

Defined in:

Parameter:

#string AttributeName

The attribute name.

Return value:

#boolean:

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

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:

Return value:

#boolean:

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

Create a new IDENTIFIABLE from a DCSIdentifiable

Defined in:

Parameter:

#string IdentifiableName

The DCS Identifiable name

Return value:

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_AF
#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_International_Airport
  • 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.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
  • 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
  • AIRBASE.Syria.Raj_al_Issa_West
  • AIRBASE.Syria.Ruwayshid
  • AIRBASE.Syria.Sanliurfa
  • AIRBASE.Syria.Tal_Siman
  • AIRBASE.Syria.Deir_ez_Zor
#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)

Destroys the OBJECT.

Defined in:

Return values:

#boolean:

true if the object is destroyed.

#nil:

The DCS Unit is not existing or alive.

Returns the unit's unique identifier.

Defined in:

Return value:

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.

Create a new OBJECT from a DCSObject

Defined in:

Parameters:

DCS#Object ObjectName

The Object name

Test

Return value:

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_AF
#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_International_Airport
  • 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.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
  • 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
  • AIRBASE.Syria.Raj_al_Issa_West
  • AIRBASE.Syria.Ruwayshid
  • AIRBASE.Syria.Sanliurfa
  • AIRBASE.Syria.Tal_Siman
  • AIRBASE.Syria.Deir_ez_Zor
#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)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

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

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

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

Defined in:

Return value:

#number:

The Event processing Priority.

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:

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:

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:

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.

Subscribe to a DCS Event.

Defined in:

Parameters:

Event ID.

#function EventFunction

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

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

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:

Parameter:

ClassName

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

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

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:

Return value:

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:

Parameter:

The EventData structure.

BDA.

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

Defined in:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

Discard chair after ejection.

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

Defined in:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

Landing quality mark.

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

Defined in:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

Trigger zone.

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

Defined in:

Parameter:

The EventData structure.

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:

Parameter:

The EventData structure.

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:

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.

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:

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.

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

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

Set the Class Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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:

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.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:


  -- Switch the tracing On
  BASE:TraceOnOff( true )

  -- Switch the tracing Off
  BASE:TraceOnOff( false )

UnSubscribe to a DCS event.

Defined in:

Parameter:

Event ID.

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event

AIRBASE.ParkingSpot ".Coordinate, ".TerminalID", ".TerminalType", ".TOAC", ".Free", ".TerminalID0", ".DistToRwy".

Field(s)

#string AIRBASE.ParkingSpot.AirbaseName

Name of the airbase.

#string AIRBASE.ParkingSpot.ClientName

Client unit name of this spot.

#string AIRBASE.ParkingSpot.ClientSpot

If true, this is a parking spot of a client aircraft.

Core.Point#COORDINATE AIRBASE.ParkingSpot.Coordinate

Coordinate of the parking spot.

#number AIRBASE.ParkingSpot.DistToRwy

Distance to runway in meters. Currently bugged and giving the same number as the TerminalID.

#boolean AIRBASE.ParkingSpot.Free

This spot is currently free, i.e. there is no alive aircraft on it at the present moment.

#number AIRBASE.ParkingSpot.MarkerID

Numerical ID of marker placed at parking spot.

#string AIRBASE.ParkingSpot.OccupiedBy

Name of the aircraft occupying the spot or "unknown". Can be nil if spot is not occupied.

#string AIRBASE.ParkingSpot.ReservedBy

Name of the aircraft for which this spot is reserved. Can be nil if spot is not reserved.

#string AIRBASE.ParkingSpot.Status

Status of spot e.g. AIRBASE.SpotStatus.FREE.

#boolean AIRBASE.ParkingSpot.TOAC

Takeoff or landing aircarft. I.e. this stop is occupied currently by an aircraft until it took of or until it landed.

#number AIRBASE.ParkingSpot.TerminalID

Terminal ID of the spot. Generally, this is not the same number as displayed in the mission editor.

#number AIRBASE.ParkingSpot.TerminalID0

Unknown what this means. If you know, please tell us!

#AIRBASE.TerminalType AIRBASE.ParkingSpot.TerminalType

Type of the spot, i.e. for which type of aircraft it can be used.

Function(s)

Runway data.

Field(s)

#number AIRBASE.Runway.heading

True heading of the runway in degrees.

#string AIRBASE.Runway.idx

Runway ID: heading 070° ==> idx="07".

#boolean AIRBASE.Runway.isLeft

If true, this is the left of two parallel runways. If false, this is the right of two runways. If nil, no parallel runway exists.

#number AIRBASE.Runway.length

Length of runway in meters.

#number AIRBASE.Runway.magheading

Magnetic heading of the runway in degrees. This is what is marked on the runway.

#string AIRBASE.Runway.name

Runway name.

#number AIRBASE.Runway.width

Width of runway in meters.

Function(s)

Status of a parking spot.

Field(s)

#string AIRBASE.SpotStatus.FREE

Spot is free.

#string AIRBASE.SpotStatus.OCCUPIED

Spot is occupied.

#string AIRBASE.SpotStatus.RESERVED

Spot is reserved.

Function(s)

Terminal Types of parking spots.

See also https://wiki.hoggitworld.com/view/DCS_func_getParking

Supported types are:

  • AIRBASE.TerminalType.Runway = 16: Valid spawn points on runway.
  • AIRBASE.TerminalType.HelicopterOnly = 40: Special spots for Helicopers.
  • AIRBASE.TerminalType.Shelter = 68: Hardened Air Shelter. Currently only on Caucaus map.
  • AIRBASE.TerminalType.OpenMed = 72: Open/Shelter air airplane only.
  • AIRBASE.TerminalType.OpenBig = 104: Open air spawn points. Generally larger but does not guarantee large aircraft are capable of spawning there.
  • AIRBASE.TerminalType.OpenMedOrBig = 176: Combines OpenMed and OpenBig spots.
  • AIRBASE.TerminalType.HelicopterUsable = 216: Combines HelicopterOnly, OpenMed and OpenBig.
  • AIRBASE.TerminalType.FighterAircraft = 244: Combines Shelter. OpenMed and OpenBig spots. So effectively all spots usable by fixed wing aircraft.

Field(s)

#number AIRBASE.TerminalType.FighterAircraft

244: Combines Shelter. OpenMed and OpenBig spots. So effectively all spots usable by fixed wing aircraft.

#number AIRBASE.TerminalType.HelicopterOnly

40: Special spots for Helicopers.

#number AIRBASE.TerminalType.HelicopterUsable

216: Combines HelicopterOnly, OpenMed and OpenBig.

#number AIRBASE.TerminalType.OpenBig

104: Open air spawn points. Generally larger but does not guarantee large aircraft are capable of spawning there.

#number AIRBASE.TerminalType.OpenMed

72: Open/Shelter air airplane only.

#number AIRBASE.TerminalType.OpenMedOrBig

176: Combines OpenMed and OpenBig spots.

#number AIRBASE.TerminalType.Runway

16: Valid spawn points on runway.

#number AIRBASE.TerminalType.Shelter

68: Hardened Air Shelter. Currently only on Caucaus map.

Function(s)