Module Wrapper.Airbase

Parameter:

Core.Cargo#CARGO Cargo

Return value:

AIRBASE:CargoItemCount()

Get cargo item count.

Defined in:

Return value:

Core.Cargo#CARGO:

Cargo

AIRBASE:ClearCargo()

Clear all cargo.

Defined in:

AIRBASE:Destroy(GenerateEvent)

Destroys the POSITIONABLE.

Defined in:

Parameter:

#boolean GenerateEvent

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

Return value:

#nil:

The DCS Unit is not existing or alive.

Usages:

-- Air unit example: destroy the Helicopter and generate a S_EVENT_CRASH for each unit in the Helicopter group.
Helicopter = UNIT:FindByName( "Helicopter" )
Helicopter:Destroy( true )

-- Ground unit example: destroy the Tanks and generate a S_EVENT_DEAD for each unit in the Tanks group.
Tanks = UNIT:FindByName( "Tanks" )
Tanks:Destroy( true )

-- Ship unit example: destroy the Ship silently.
Ship = STATIC:FindByName( "Ship" )
Ship:Destroy()

-- Destroy without event generation example.
Ship = STATIC:FindByName( "Boat" )
Ship:Destroy( false ) -- Don't generate an event upon destruction.

AIRBASE:Flare(FlareColor)

Signal a flare at the position of the POSITIONABLE.

Defined in:

Parameter:

Utilities.Utils#FLARECOLOR FlareColor

AIRBASE:FlareGreen()

Signal a green flare at the position of the POSITIONABLE.

Defined in:

AIRBASE:FlareRed()

Signal a red flare at the position of the POSITIONABLE.

Defined in:

AIRBASE:FlareWhite()

Signal a white flare at the position of the POSITIONABLE.

Defined in:

AIRBASE:FlareYellow()

Signal a yellow flare at the position of the POSITIONABLE.

Defined in:

AIRBASE:GetAltitude()

Returns the altitude of the POSITIONABLE.

Defined in:

Return values:

DCS#Distance:

The altitude of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:GetAoA()

Returns the Angle of Attack of a positionable.

Defined in:

Return value:

#number:

Angle of attack in degrees.

AIRBASE:GetBeacon()

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

Defined in:

Return value:

Core.Radio#RADIO:

Radio

AIRBASE:GetBoundingBox()

Get the bounding box of the underlying POSITIONABLE DCS Object.

Defined in:

Return values:

DCS#Box3:

The bounding box of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:GetBoundingRadius(mindist)

Get the bounding radius of the underlying POSITIONABLE DCS Object.

Defined in:

Parameter:

#number mindist

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

Return value:

DCS#Distance:

The bounding radius of the POSITIONABLE or #nil if the POSITIONABLE is not existing or alive.

AIRBASE:GetCargo()

Get all contained cargo.

Defined in:

Return value:

AIRBASE:GetCargoBayFreeWeight()

Get Cargo Bay Free Weight in kg.

Defined in:

Return value:

#number:

CargoBayFreeWeight

AIRBASE:GetClimbAnge()

Returns the unit's climb or descent angle.

Defined in:

Return value:

#number:

Climb or descent angle in degrees.

AIRBASE:GetCoordinate()

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

Defined in:

Return value:

Core.Point#COORDINATE:

The COORDINATE of the POSITIONABLE.

AIRBASE:GetHeading()

Returns the POSITIONABLE heading in degrees.

Defined in:

Return values:

#number:

The POSITIONABLE heading

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:GetHeight()

Returns the POSITIONABLE height in meters.

Defined in:

Return values:

The height of the positionable.

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:GetLaserCode()

Get the last assigned laser code

Defined in:

Return value:

#number:

The laser code

AIRBASE:GetMessage(Message, Duration, Name)

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, the Name is the type of the Positionable.

Return value:

Core.Message#MESSAGE:

AIRBASE:GetMessageText(Message, Name)

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

Defined in:

Parameters:

#string Message

The message text

#string Name

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

Return value:

#string:

The message text

AIRBASE:GetMessageType(Message, MessageType, Name)

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, the Name is the type of the Positionable.

Return value:

Core.Message#MESSAGE:

AIRBASE:GetOrientation()

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

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

Defined in:

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.

AIRBASE:GetOrientationX()

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

along the direction of movement.

Defined in:

Return value:

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

AIRBASE:GetOrientationY()

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

vertical orientation.

Defined in:

Return value:

Y orientation, i.e. vertical.

AIRBASE:GetOrientationZ()

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

perpendicular to direction of movement.

Defined in:

Return value:

Z orientation, i.e. perpendicular to movement.

AIRBASE:GetPitch()

Returns the pitch angle of a unit.

Defined in:

Return value:

#number:

Pitch ange in degrees.

AIRBASE:GetPointVec2()

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

Defined in:

Return values:

Core.Point#POINT_VEC2:

The 2D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:GetPointVec3()

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

Defined in:

Return values:

Core.Point#POINT_VEC3:

The 3D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:GetPosition()

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

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

Defined in:

Return value:

DCS#Position:

Table consisting of the point and orientation tables.

AIRBASE:GetPositionVec3()

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

Defined in:

Return values:

DCS#Position:

The 3D position vectors of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:GetRadio()

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

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

Defined in:

Return value:

Core.Radio#RADIO:

Radio

AIRBASE:GetRandomVec3(Radius)

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

Defined in:

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

AIRBASE:GetRoll()

Returns the roll angle of a unit.

Defined in:

Return value:

#number:

Pitch ange in degrees.

AIRBASE:GetSize()

Defined in:

AIRBASE:GetSpot()

Get the Spot

Defined in:

Return value:

Core.Spot#SPOT:

The Spot

AIRBASE:GetVec2()

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

Defined in:

Return values:

DCS#Vec2:

The 2D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:GetVec3()

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

Defined in:

Return values:

The 3D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:GetVelocity()

Returns the a Velocity object from the positionable.

Defined in:

Return values:

Core.Velocity#VELOCITY:

Velocity The Velocity object.

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:GetVelocityKMH()

Returns the POSITIONABLE velocity in km/h.

Defined in:

Return value:

#number:

The velocity in km/h

AIRBASE:GetVelocityMPS()

Returns the POSITIONABLE velocity in meters per second.

Defined in:

Return value:

#number:

The velocity in meters per second.

AIRBASE:GetVelocityVec3()

Returns the POSITIONABLE velocity Vec3 vector.

Defined in:

Return values:

The velocity Vec3 vector

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:GetYaw()

Returns the yaw angle of a unit.

Defined in:

Return value:

#number:

Yaw ange in degrees.

AIRBASE:HasCargo(Cargo)

Returns if carrier has given cargo.

Defined in:

Parameter:

Cargo

Return value:

Core.Cargo#CARGO:

Cargo

AIRBASE:InAir()

Returns true if the POSITIONABLE is in the air.

Polymorphic, is overridden in GROUP and UNIT.

Defined in:

Return values:

#boolean:

true if in the air.

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:IsAboveRunway()

Returns if the Positionable is located above a runway.

Defined in:

Return values:

#boolean:

true if Positionable is above a runway.

#nil:

The POSITIONABLE is not existing or alive.

AIRBASE:IsAir()

Returns if the unit is of an air category.

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

Defined in:

Return value:

#boolean:

Air category evaluation result.

AIRBASE:IsCargoEmpty()

Is cargo bay empty.

Defined in:

AIRBASE:IsGround()

Returns if the unit is of an ground category.

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

Defined in:

Return value:

#boolean:

Ground category evaluation result.

AIRBASE:IsLasing()

Check if the POSITIONABLE is lasing a target

Defined in:

Return value:

#boolean:

true if it is lasing a target

AIRBASE:LaseOff()

Stop Lasing a POSITIONABLE

Defined in:

Return value:

AIRBASE:LaseUnit(Target, LaserCode, Duration)

Start Lasing a POSITIONABLE

Defined in:

Parameters:

#POSITIONABLE Target

#number LaserCode

#number Duration

Return value:

Core.Spot#SPOT:

AIRBASE:Message(Message, Duration, Name)

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

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

Defined in:

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, the Name is the type of the Positionable.

AIRBASE:MessageToAll(Message, Duration, Name)

Send a message to all coalitions.

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

Defined in:

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, the Name is the type of the Positionable.

AIRBASE:MessageToBlue(Message, Duration, Name)

Send a message to the blue coalition.

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

Defined in:

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, the Name is the type of the Positionable.

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

Send a message to a client.

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

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

Wrapper.Client#CLIENT Client

The client object receiving the message.

#string Name

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

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

Send a message to a coalition.

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

Defined in:

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, the Name is the type of the Positionable.

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

Send a message to a Wrapper.Group.

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

Defined in:

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, the Name is the type of the Positionable.

AIRBASE:MessageToRed(Message, Duration, Name)

Send a message to the red coalition.

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

Defined in:

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, the Name is the type of the Positionable.

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

Send a message to a Core.Set#SET_GROUP.

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

Defined in:

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, the Name is the type of the Positionable.

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

Send a message to a coalition.

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

Defined in:

Parameters:

#string Message

The message text

Core.Message#MESSAGE.Type MessageType

The message type that determines the duration.

DCS#coalition MessageCoalition

The Coalition receiving the message.

#string Name

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

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

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

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

Defined in:

Parameters:

#string Message

The message text

Core.Message#MESSAGE.Type MessageType

The message type that determines the duration.

Wrapper.Group#GROUP MessageGroup

The GROUP object receiving the message.

#string Name

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

AIRBASE:New(PositionableName)

Create a new POSITIONABLE from a DCSPositionable

Defined in:

Parameter:

#string PositionableName

The POSITIONABLE name

Return value:

self

AIRBASE:RemoveCargo(Cargo)

Remove cargo.

Defined in:

Parameter:

Core.Cargo#CARGO Cargo

Return value:

AIRBASE:SetCargoBayWeightLimit(WeightLimit)

Set Cargo Bay Weight Limit in kg.

Defined in:

Parameter:

#number WeightLimit

AIRBASE:Smoke(SmokeColor, Range, AddHeight)

Smoke the POSITIONABLE.

Defined in:

Parameters:

Utilities.Utils#SMOKECOLOR SmokeColor

The color to smoke to positionable.

#number Range

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

#number AddHeight

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

AIRBASE:SmokeBlue()

Smoke the POSITIONABLE Blue.

Defined in:

AIRBASE:SmokeGreen()

Smoke the POSITIONABLE Green.

Defined in:

AIRBASE:SmokeOrange()

Smoke the POSITIONABLE Orange.

Defined in:

AIRBASE:SmokeRed()

Smoke the POSITIONABLE Red.

Defined in:

AIRBASE:SmokeWhite()

Smoke the POSITIONABLE White.

Defined in:

Field(s)

#table AIRBASE.Caucasus

Enumeration to identify the airbases in the Caucasus region.

These are all airbases of Caucasus:

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

#table AIRBASE.Nevada

These are all airbases of Nevada:

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.Mellan_Airstrip
AIRBASE.Nevada.Mesquite
AIRBASE.Nevada.Mina_Airport_3Q0
AIRBASE.Nevada.North_Las_Vegas
AIRBASE.Nevada.Pahute_Mesa_Airstrip
AIRBASE.Nevada.Tonopah_Airport
AIRBASE.Nevada.Tonopah_Test_Range_Airfield

#table AIRBASE.Normandy

These are all airbases of Normandy:

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

#table AIRBASE.PersianGulf

These are all airbases of the Persion Gulf Map:

AIRBASE.PersianGulf.Fujairah_Intl
AIRBASE.PersianGulf.Qeshm_Island
AIRBASE.PersianGulf.Sir_Abu_Nuayr
AIRBASE.PersianGulf.Abu_Musa_Island_Airport
AIRBASE.PersianGulf.Bandar_Abbas_Intl
AIRBASE.PersianGulf.Bandar_Lengeh
AIRBASE.PersianGulf.Tunb_Island_AFB
AIRBASE.PersianGulf.Havadarya
AIRBASE.PersianGulf.Lar_Airbase
AIRBASE.PersianGulf.Sirri_Island
AIRBASE.PersianGulf.Tunb_Kochak
AIRBASE.PersianGulf.Al_Dhafra_AB
AIRBASE.PersianGulf.Dubai_Intl
AIRBASE.PersianGulf.Al_Maktoum_Intl
AIRBASE.PersianGulf.Khasab
AIRBASE.PersianGulf.Al_Minhad_AB
AIRBASE.PersianGulf.Sharjah_Intl
AIRBASE.PersianGulf.Shiraz_International_Airport
AIRBASE.PersianGulf.Kerman_Airport

#AIRBASE.TerminalType AIRBASE.TerminalType

Function(s)

AIRBASE:GetCallsign()

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

Defined in:

Return value:

#string:

The CallSign of the IDENTIFIABLE.

AIRBASE:GetCategory()

Returns category of the DCS Identifiable.

Defined in:

Return value:

DCS#Object.Category:

The category ID

AIRBASE:GetCategoryName()

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

Defined in:

Return value:

#string:

The DCS Identifiable Category Name

AIRBASE:GetCoalition()

Returns coalition of the Identifiable.

Defined in:

Return values:

DCS#coalition.side:

The side of the coalition.

#nil:

The DCS Identifiable is not existing or alive.

AIRBASE:GetCoalitionName()

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.

AIRBASE:GetCountry()

Returns country of the Identifiable.

Defined in:

Return values:

DCS#country.id:

The country identifier.

#nil:

The DCS Identifiable is not existing or alive.

AIRBASE:GetCountryName()

Returns country name of the Identifiable.

Defined in:

Return value:

#string:

Name of the country.

AIRBASE:GetDesc()

Returns Identifiable descriptor.

Descriptor type depends on Identifiable category.

Defined in:

Return values:

DCS#Object.Desc:

The Identifiable descriptor.

#nil:

The DCS Identifiable is not existing or alive.

AIRBASE:GetName()

Returns DCS Identifiable object name.

The function provides access to non-activated objects too.

Defined in:

Return values:

#string:

The name of the DCS Identifiable.

#nil:

The DCS Identifiable is not existing or alive.

AIRBASE:GetThreatLevel()

Defined in:

AIRBASE:GetTypeName()

Returns the type name of the DCS Identifiable.

Defined in:

Return values:

#string:

The type name of the DCS Identifiable.

#nil:

The DCS Identifiable is not existing or alive.

AIRBASE:HasAttribute(AttributeName)

Check if the Object has the attribute.

Defined in:

Parameter:

#string AttributeName

The attribute name.

Return values:

#boolean:

true if the attribute exists.

#nil:

The DCS Identifiable is not existing or alive.

AIRBASE:IsAlive()

Returns if the Identifiable is alive.

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

Defined in:

Return values:

#boolean:

true if Identifiable is alive.

#nil:

if the Identifiable is not existing or is not alive.

AIRBASE:New(IdentifiableName)

Create a new IDENTIFIABLE from a DCSIdentifiable

Defined in:

Parameter:

#string IdentifiableName

The DCS Identifiable name

Return value:

#IDENTIFIABLE:

self

Field(s)

#table AIRBASE.Caucasus

Enumeration to identify the airbases in the Caucasus region.

These are all airbases of Caucasus:

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

#table AIRBASE.Nevada

These are all airbases of Nevada:

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.Mellan_Airstrip
AIRBASE.Nevada.Mesquite
AIRBASE.Nevada.Mina_Airport_3Q0
AIRBASE.Nevada.North_Las_Vegas
AIRBASE.Nevada.Pahute_Mesa_Airstrip
AIRBASE.Nevada.Tonopah_Airport
AIRBASE.Nevada.Tonopah_Test_Range_Airfield

#table AIRBASE.Normandy

These are all airbases of Normandy:

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

#table AIRBASE.PersianGulf

These are all airbases of the Persion Gulf Map:

AIRBASE.PersianGulf.Fujairah_Intl
AIRBASE.PersianGulf.Qeshm_Island
AIRBASE.PersianGulf.Sir_Abu_Nuayr
AIRBASE.PersianGulf.Abu_Musa_Island_Airport
AIRBASE.PersianGulf.Bandar_Abbas_Intl
AIRBASE.PersianGulf.Bandar_Lengeh
AIRBASE.PersianGulf.Tunb_Island_AFB
AIRBASE.PersianGulf.Havadarya
AIRBASE.PersianGulf.Lar_Airbase
AIRBASE.PersianGulf.Sirri_Island
AIRBASE.PersianGulf.Tunb_Kochak
AIRBASE.PersianGulf.Al_Dhafra_AB
AIRBASE.PersianGulf.Dubai_Intl
AIRBASE.PersianGulf.Al_Maktoum_Intl
AIRBASE.PersianGulf.Khasab
AIRBASE.PersianGulf.Al_Minhad_AB
AIRBASE.PersianGulf.Sharjah_Intl
AIRBASE.PersianGulf.Shiraz_International_Airport
AIRBASE.PersianGulf.Kerman_Airport

#AIRBASE.TerminalType AIRBASE.TerminalType

Function(s)

AIRBASE:Destroy()

Destroys the OBJECT.

Defined in:

Wrapper.Object#OBJECT

Return values:

#boolean:

true if the object is destroyed.

#nil:

The DCS Unit is not existing or alive.

AIRBASE:GetID()

Returns the unit's unique identifier.

Defined in:

Wrapper.Object#OBJECT

Return value:

DCS#Object.ID:

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

AIRBASE:New(ObjectName, Test)

Create a new OBJECT from a DCSObject

Defined in:

Wrapper.Object#OBJECT

Parameters:

DCS#Object ObjectName

The Object name

Test

Return value:

#OBJECT:

self

Field(s)

#table AIRBASE.Caucasus

Enumeration to identify the airbases in the Caucasus region.

These are all airbases of Caucasus:

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

#table AIRBASE.Nevada

These are all airbases of Nevada:

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.Mellan_Airstrip
AIRBASE.Nevada.Mesquite
AIRBASE.Nevada.Mina_Airport_3Q0
AIRBASE.Nevada.North_Las_Vegas
AIRBASE.Nevada.Pahute_Mesa_Airstrip
AIRBASE.Nevada.Tonopah_Airport
AIRBASE.Nevada.Tonopah_Test_Range_Airfield

#table AIRBASE.Normandy

These are all airbases of Normandy:

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

#table AIRBASE.PersianGulf

These are all airbases of the Persion Gulf Map:

AIRBASE.PersianGulf.Fujairah_Intl
AIRBASE.PersianGulf.Qeshm_Island
AIRBASE.PersianGulf.Sir_Abu_Nuayr
AIRBASE.PersianGulf.Abu_Musa_Island_Airport
AIRBASE.PersianGulf.Bandar_Abbas_Intl
AIRBASE.PersianGulf.Bandar_Lengeh
AIRBASE.PersianGulf.Tunb_Island_AFB
AIRBASE.PersianGulf.Havadarya
AIRBASE.PersianGulf.Lar_Airbase
AIRBASE.PersianGulf.Sirri_Island
AIRBASE.PersianGulf.Tunb_Kochak
AIRBASE.PersianGulf.Al_Dhafra_AB
AIRBASE.PersianGulf.Dubai_Intl
AIRBASE.PersianGulf.Al_Maktoum_Intl
AIRBASE.PersianGulf.Khasab
AIRBASE.PersianGulf.Al_Minhad_AB
AIRBASE.PersianGulf.Sharjah_Intl
AIRBASE.PersianGulf.Shiraz_International_Airport
AIRBASE.PersianGulf.Kerman_Airport

#AIRBASE.TerminalType AIRBASE.TerminalType

Function(s)

AIRBASE:ClearState(Object, StateName)

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.

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

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

AIRBASE:CreateEventCrash(EventTime, Initiator)

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.

AIRBASE:CreateEventDead(EventTime, Initiator)

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.

AIRBASE:CreateEventRemoveUnit(EventTime, Initiator)

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.

AIRBASE:CreateEventTakeoff(EventTime, Initiator)

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.

AIRBASE:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AIRBASE:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

AIRBASE:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

AIRBASE:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AIRBASE:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AIRBASE:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AIRBASE:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

AIRBASE:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

AIRBASE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

AIRBASE:GetEventPriority()

Get the Class Event processing Priority.

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

Defined in:

Return value:

#number:

The Event processing Priority.

AIRBASE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()

Defined in:

Parameters:

#BASE Child

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

FromClass

Return value:

AIRBASE:GetState(Object, Key)

Get a Value given a Key from the Object.

Note that if the Object is destroyed, nillified 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.

AIRBASE:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS Event

#function EventFunction

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

Return value:

AIRBASE:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AIRBASE:Inherit(Child, Parent)

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

AIRBASE:IsInstanceOf(ClassName)

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

Examples:

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

AIRBASE:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

AIRBASE:New()

BASE constructor.

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

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

Defined in:

Return value:

AIRBASE:OnEvent(EventData)

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventBaseCaptured(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventCrash(EventData)

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

initiator : The unit that has crashed

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventDead(EventData)

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventEjection(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventMissionEnd(EventData)

Occurs when a mission ends

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventMissionStart(EventData)

Occurs when a mission starts

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventPlayerLeaveUnit(EventData)

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

initiator : The unit that the player left.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventRefueling(EventData)

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventShootingStart(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AIRBASE:OnEventTakeoff(EventData)

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

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:

Core.Event#EVENTDATA EventData

The EventData structure.

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

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

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

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

AIRBASE:ScheduleStop(SchedulerFunction)

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

AIRBASE:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

AIRBASE:SetState(Object, Key, Value)

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

Note that if the Object is destroyed, nillified 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.

AIRBASE:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AIRBASE:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AIRBASE:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AIRBASE:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

AIRBASE:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

AIRBASE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

AIRBASE:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

AIRBASE:TraceOnOff(TraceOnOff)

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

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

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

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

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

AIRBASE:UnHandleEvent(Event)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS Event

Return value:

AIRBASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

AIRBASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

AIRBASE:onEvent(event)

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

Defined in: