Module DCS

Field(s)

#AI.Option AI.Option

#AI.Skill AI.Skill

#AI.Task AI.Task

Function(s)

Field(s)

#AI.Option.Air AI.Option.Air

#AI.Option.Ground AI.Option.Ground

#AI.Option.Naval AI.Option.Naval

Function(s)

Field(s)

#AI.Option.Air.id AI.Option.Air.id

#AI.Option.Air.val AI.Option.Air.val

Function(s)

Field(s)

Function(s)

Field(s)

#AI.Option.Air.val.FLARE_USING AI.Option.Air.val.FLARE_USING

#AI.Option.Air.val.RADAR_USING AI.Option.Air.val.RADAR_USING

#AI.Option.Air.val.REACTION_ON_THREAT AI.Option.Air.val.REACTION_ON_THREAT

#AI.Option.Air.val.ROE AI.Option.Air.val.ROE

Function(s)

Type AI.Option.Air.val.ECM_USING

Field(s)

Function(s)

Type AI.Option.Air.val.FLARE_USING

Field(s)

Function(s)

Type AI.Option.Air.val.MISSILE_ATTACK

Field(s)

Function(s)

Type AI.Option.Air.val.RADAR_USING

Field(s)

Function(s)

Type AI.Option.Air.val.REACTION_ON_THREAT

Field(s)

Function(s)

Field(s)

Function(s)

Field(s)

#AI.Option.Naval.id AI.Option.Ground.id

#AI.Option.Ground.mid AI.Option.Ground.mid

#AI.Option.Ground.mval AI.Option.Ground.mval

#AI.Option.Naval.val AI.Option.Ground.val

Function(s)

Field(s)

Function(s)

Field(s)

Function(s)

Field(s)

#AI.Option.Ground.mval.ENGAGE_TARGETS AI.Option.Ground.mval.ENGAGE_TARGETS

Function(s)

Type AI.Option.Ground.mval.ENGAGE_TARGETS

Field(s)

Function(s)

Field(s)

#AI.Option.Ground.val.ALARM_STATE AI.Option.Ground.val.ALARM_STATE

#AI.Option.Ground.val.ENGAGE_TARGETS AI.Option.Ground.val.RESTRICT_TARGETS

#AI.Option.Ground.val.ROE AI.Option.Ground.val.ROE

Function(s)

Type AI.Option.Ground.val.ALARM_STATE

Field(s)

Function(s)

Field(s)

Function(s)

Field(s)

Function(s)

Field(s)

#AI.Option.Naval.val.ROE AI.Option.Naval.val.ROE

Function(s)

Field(s)

Function(s)

Type AI.Skill

Field(s)

Function(s)

Type AI.Task

Field(s)

#AI.Task.AltitudeType AI.Task.AltitudeType

#AI.Task.Designation AI.Task.Designation

#AI.Task.OrbitPattern AI.Task.OrbitPattern

#AI.Task.TurnMethod AI.Task.TurnMethod

#AI.Task.VehicleFormation AI.Task.VehicleFormation

#AI.Task.WaypointType AI.Task.WaypointType

#AI.Task.WeaponExpend AI.Task.WeaponExpend

Function(s)

Field(s)

Function(s)

Type AI.Task.Designation

Field(s)

Function(s)

Type AI.Task.OrbitPattern

Field(s)

Function(s)

Field(s)

Function(s)

Field(s)

Function(s)

Field(s)

Function(s)

Type AI.Task.WeaponExpend

Field(s)

Function(s)

Type Airbase

DCS Class Airbase Represents airbases: airdromes, helipads and ships with flying decks or landing pads.

Field(s)

#Airbase.Category Airbase.Category

enum contains identifiers of airbase categories.

#Airbase.Desc Airbase.Desc

Airbase descriptor. Airdromes are unique and their types are unique, but helipads and ships are not always unique and may have the same type.

#Airbase.ID Airbase.ID

Identifier of an airbase. It assigned to an airbase by the Mission Editor automatically. This identifier is used in AI tasks to refer an airbase that exists (spawned and not dead) or not.

Function(s)

Airbase:autoCapture(setting)

Enables or disables the airbase and FARP auto capture game mechanic where ownership of a base can change based on the presence of ground forces or the default setting assigned in the editor.

Defined in:

Airbase

Parameter:

#boolean setting

true : enables autoCapture behavior, false : disables autoCapture behavior

Airbase:autoCaptureIsOn()

Returns the current autoCapture setting for the passed base.

Defined in:

Airbase

Return value:

#boolean:

true if autoCapture behavior is enabled and false otherwise.

Airbase.getByName(name)

Returns airbase by its name.

If no airbase found the function will return nil.

Defined in:

Airbase

Parameter:

#string name

Return value:

#Airbase:

Airbase:getCallsign()

Returns the airbase's callsign - the localized string.

Defined in:

Airbase

Return value:

#string:

Defined in:

Airbase

Return value:

#Airbase.Desc:

Airbase.getDescByName(typeName)

Returns airbase descriptor by type name.

If no descriptor is found the function will return nil.

Defined in:

Airbase

Parameter:

#TypeName typeName

Airbase type name.

Return value:

#Airbase.Desc:

Defined in:

Airbase

Return value:

#Airbase.ID:

Airbase:getResourceMap()

Returns the wsType of every object that exists in DCS.

A wsType is a table consisting of 4 entries indexed numerically. It can be used to broadly categorize object types. The table can be broken down as: {mainCategory, subCat1, subCat2, index}

Defined in:

Airbase

Return value:

#table:

wsType of every object that exists in DCS.

Airbase:getUnit()

Returns Unit that is corresponded to the airbase.

Works only for ships.

Defined in:

Airbase

Return value:

Airbase:getWarehouse()

Returns the warehouse object associated with the airbase object.

Can then be used to call the warehouse class functions to modify the contents of the warehouse.

Defined in:

Airbase

Return value:

#Warehouse:

The DCS warehouse object of this airbase.

Airbase:setCoalition(coa)

Changes the passed airbase object's coalition to the set value.

Must be used with Airbase.autoCapture to disable auto capturing of the base, otherwise the base can revert back to a different coalition depending on the situation and built in game capture rules.

Defined in:

Airbase

Parameter:

#number coa

The new owner coalition: 0=neutra, 1=red, 2=blue.

Type Airbase.Category

Enum contains identifiers of airbase categories.

Field(s)

Function(s)

Type Airbase.Desc

Airbase descriptor.

Airdromes are unique and their types are unique, but helipads and ships are not always unique and may have the same type.

Field(s)

#Airbase.Category Airbase.Desc.category

Category of the airbase type.

Function(s)

Field(s)

#Vec3 Box3.max

Max

#Vec3 Box3.min

Min.

Function(s)

Field(s)

Function(s)

CoalitionObject:getCoalition()

Returns coalition of the object.

Defined in:

CoalitionObject

Return value:

#coalition.side:

Defined in:

CoalitionObject

Return value:

#country.id:

Field(s)

Function(s)

Controller:getDetectedTargets(detection)

Returns list of detected targets.

If one or more detection method is specified the function will return targets which were detected by at least one of these methods. If no detection methods are specified the function will return targets which were detected by any method.

Defined in:

Controller

Parameter:

#Controller.Detection detection

Controller.Detection detection1, Controller.Detection detection2, ... Controller.Detection detectionN

Return value:

#list<#DetectedTarget>:

array of DetectedTarget

Controller:hasTask()

Returns true if the controller has a task.

Defined in:

Controller

Return value:

#boolean:

Controller:isTargetDetected(target, detection)

Checks if the target is detected or not.

If one or more detection method is specified the function will return true if the target is detected by at least one of these methods. If no detection methods are specified the function will return true if the target is detected by any method.

Defined in:

Controller

Parameters:

Wrapper.Object#Object target

Target to check

#Controller.Detection detection

Controller.Detection detection1, Controller.Detection detection2, ... Controller.Detection detectionN

Return values:

#boolean:

detected True if the target is detected.

#boolean:

visible Has effect only if detected is true. True if the target is visible now.

#ModelTime:

lastTime Has effect only if visible is false. Last time when target was seen.

#boolean:

type Has effect only if detected is true. True if the target type is known.

#boolean:

distance Has effect only if detected is true. True if the distance to the target is known.

lastPos Has effect only if visible is false. Last position of the target when it was seen.

lastVel Has effect only if visible is false. Last velocity of the target when it was seen.

Controller:knowTarget(object, type, distance)

Know a target.

Defined in:

Controller

Parameters:

Wrapper.Object#Object object

The target.

#boolean type

Target type is known.

#boolean distance

Distance to target is known.

Controller:popTask()

Pops current (front) task from the queue and makes active next task in the queue (if exists).

If no more tasks in the queue the function works like function Controller.resetTask() function. Does nothing if the queue is empty.

Defined in:

Controller

Controller:pushTask(task)

Pushes the task to the front of the queue and makes the task active.

Further call of function Controller.setTask() function will stop current task, clear the queue and set the new task active. If the task queue is empty the function will work like function Controller.setTask() function.

Defined in:

Controller

Parameter:

#Task task

Controller:resetTask()

Resets current task of the controller.

Defined in:

Controller

Controller:setOnOff(value)

Enables and disables the controller.

Note: Now it works only for ground / naval groups!

Defined in:

Controller

Parameter:

#boolean value

Enable / Disable.

Controller:setOption(optionId, optionValue)

Sets the option to the controller.

Option is a pair of identifier and value. Behavior options are global parameters those affect controller behavior in all tasks it performs. Option identifiers and values are stored in table AI.Option in subtables Air, Ground and Naval.

OptionId = AI.Option.Air.id or AI.Option.Ground.id or AI.Option.Naval.id OptionValue = AI.Option.Air.val[optionName] or AI.Option.Ground.val[optionName] or AI.Option.Naval.val[optionName]

Defined in:

Controller

Parameters:

#OptionId optionId

Option identifier.

#OptionValue optionValue

Value of the option.

Controller:setTask(task)

Resets current task and then sets the task to the controller.

Task is a table that contains task identifier and task parameters.

Defined in:

Controller

Parameter:

#Task task

Type Controller.Detection

Enum contains identifiers of surface types.

Field(s)

Function(s)

Type DetectedTarget

Detected target.

Field(s)

#boolean DetectedTarget.distance

Distance to the target is known

Wrapper.Object#Object DetectedTarget.object

The target

#boolean DetectedTarget.type

The target type is known

#boolean DetectedTarget.visible

The target is visible

Function(s)

Type Event

Event structure.

Note that present fields depend on type of event.

Field(s)

#number Event.coalition

Coalition ID.

#string Event.comment

Comment, e.g. LSO score.

#number Event.groupID

Group ID, e.g. of group that added mark point.

#number Event.id

Event ID.

#number Event.idx

Mark ID.

DCS#Unit Event.initiator

Unit initiating the event.

DCS#Airbase Event.place

Airbase.

DCS#Vec3 Event.pos

Position vector, e.g. of mark point.

DCS#Unit Event.target

Target unit.

#string Event.text

Text, e.g. of mark point.

#number Event.time

Mission time in seconds.

#string Event.weapon_name

Weapoin name.

Function(s)

Type Group

Represents group of Units.

Field(s)

#Group.Category Group.Category

Enum contains identifiers of group types.

#ID Group.ID

Identifier of a group. It is assigned to a group by Mission Editor automatically.

Function(s)

Group:destroy()

Destroys the group and all of its units.

Defined in:

Group

Group:enableEmission(switch)

GROUND - Switch on/off radar emissions

Defined in:

Group

Parameter:

#boolean switch

Group.getByName(name)

Returns group by the name assigned to the group in Mission Editor.

Defined in:

Group

Parameter:

#string name

Return value:

#Group:

Group:getCategory()

Returns category of the group.

Defined in:

Group

Return value:

#Group.Category:

Group:getCoalition()

Returns the coalition of the group.

Defined in:

Group

Return value:

#coalition.side:

Group:getController()

Returns controller of the group.

Defined in:

Group

Return value:

#Controller:

Group:getID()

Returns the group identifier.

Defined in:

Group

Return value:

#ID:

Group:getInitialSize()

Returns initial size of the group.

If some of the units will be destroyed, initial size of the group will not be changed; Initial size limits the unitNumber parameter for Group.getUnit() function.

Defined in:

Group

Return value:

#number:

Group:getName()

Returns the group's name.

This is the same name assigned to the group in Mission Editor.

Defined in:

Group

Return value:

#string:

Group:getSize()

Returns current size of the group.

If some of the units will be destroyed, As units are destroyed the size of the group will be changed.

Defined in:

Group

Return value:

#number:

Group:getUnit(unitNumber)

Returns the unit with number unitNumber.

If the unit is not exists the function will return nil.

Defined in:

Group

Parameter:

#number unitNumber

Return value:

Group:getUnits()

Returns array of the units present in the group now.

Destroyed units will not be enlisted at all.

Defined in:

Group

Return value:

#list<#Unit>:

array of Units

Group:isExist()

returns true if the group exist or false otherwise.

Defined in:

Group

Return value:

#boolean:

Type Group.Category

Enum contains identifiers of group types.

Field(s)

Function(s)

Type Object

DCS Class Object

Field(s)

#Object.Category Object.Category

#Object.Desc Object.Desc

Function(s)

Object:destroy()

Defined in:

Object

Object:getCategory()

Defined in:

Object

Return value:

#Object.Category:

Object:getDesc()

Returns object descriptor.

Defined in:

Object

Return value:

#Object.Desc:

Object:getName()

Returns name of the object.

This is the name that is assigned to the object in the Mission Editor.

Defined in:

Object

Return value:

#string:

Object:getPoint()

Returns object coordinates for current time.

Defined in:

Object

Return value:

3D position vector with x,y,z components.

Object:getPosition()

Returns object position for current time.

Defined in:

Object

Return value:

#Position3:

Object:getTypeName()

Returns type name of the Object.

Defined in:

Object

Return value:

#string:

Object:getVelocity()

Returns the unit's velocity vector.

Defined in:

Object

Return value:

3D velocity vector.

Object:hasAttribute(attributeName)

Returns true if the object belongs to the category.

Defined in:

Object

Parameter:

#AttributeName attributeName

Attribute name to check.

Return value:

#boolean:

Object:inAir()

Returns true if the unit is in air.

Defined in:

Object

Return value:

#boolean:

Object:isActive()

Defined in:

Object

Return value:

#boolean:

Object:isExist()

Defined in:

Object

Return value:

#boolean:

Type Object.Category

DCS Enum Object.Category

Field(s)

Function(s)

Type Position3

Position is a composite structure.

It consists of both coordinate vector and orientation matrix. Position3 (also known as "Pos3" for short) is a table that has following format:

Field(s)

#Vec3 Position3.p

3D position vector.

#Vec3 Position3.x

Orientation component of vector pointing East.

#Vec3 Position3.y

Orientation component of vector pointing up.

#Vec3 Position3.z

Orientation component of vector pointing North.

Function(s)

Type Spot

DCS Class Spot Represents a spot from laser or IR-pointer.

Field(s)

#Spot.Category Spot.Category

enum that stores spot categories.

Function(s)

Spot.createInfraRed(Source, LocalRef, Vec3)

Creates an infrared ray emanating from the given object to a point in 3d space.

Can be seen with night vision goggles.

Defined in:

Spot

Parameters:

DCS#Object Source

Source position of the IR ray.

DCS#Vec3 LocalRef

An optional 3D offset for the source.

DCS#Vec3 Vec3

Target coordinate where the ray is pointing at.

Return value:

#Spot:

Spot.createLaser(Source, LocalRef, Vec3, LaserCode)

Creates a laser ray emanating from the given object to a point in 3d space.

Defined in:

Spot

Parameters:

DCS#Object Source

The source object of the laser.

DCS#Vec3 LocalRef

An optional 3D offset for the source.

DCS#Vec3 Vec3

Target coordinate where the ray is pointing at.

#number LaserCode

Any 4 digit number between 1111 and 1788.

Return value:

#Spot:

Spot:destroy()

Destroys the spot.

Defined in:

Spot

Spot:getCategory()

Gets the category of the spot (laser or IR).

Defined in:

Spot

Return value:

#string:

Category.

Spot:getCode()

Returns the number that is used to define the laser code for which laser designation can track.

Defined in:

Spot

Return value:

#number:

Code The laser code used.

Spot:getPoint()

Returns a vec3 table of the x, y, and z coordinates for the position of the given object in 3D space.

Coordinates are dependent on the position of the maps origin.

Defined in:

Spot

Return value:

DCS#Vec3:

Point in 3D, where the beam is pointing at.

Spot:setCode(Code)

Sets the number that is used to define the laser code for which laser designation can track.

Defined in:

Spot

Parameter:

#number Code

The laser code. Default value is 1688.

Spot:setPoint(Vec3)

Sets the destination point from which the source of the spot is drawn toward.

Defined in:

Spot

Parameter:

DCS#Vec3 Vec3

Point in 3D, where the beam is pointing at.

Type Spot.Category

Enum that stores spot categories.

Field(s)

#string Spot.Category.INFRA_RED

#string Spot.Category.LASER

Function(s)

Type StaticObject

Represents a static object.

Field(s)

Function(s)

StaticObject.getByName(name)

Returns the static object.

Defined in:

StaticObject

Parameter:

#string name

Name of the static object.

Return value:

#StaticObject:

Field(s)

Function(s)

StaticObject:destroy()

Defined in:

StaticObject:getCategory()

Defined in:

Return value:

#Object.Category:

StaticObject:getDesc()

Returns object descriptor.

Defined in:

Return value:

#Object.Desc:

StaticObject:getName()

Returns name of the object.

This is the name that is assigned to the object in the Mission Editor.

Defined in:

Return value:

#string:

StaticObject:getPoint()

Returns object coordinates for current time.

Defined in:

Return value:

3D position vector with x,y,z components.

StaticObject:getPosition()

Returns object position for current time.

Defined in:

Return value:

#Position3:

StaticObject:getTypeName()

Returns type name of the Object.

Defined in:

Return value:

#string:

StaticObject:getVelocity()

Returns the unit's velocity vector.

Defined in:

Return value:

3D velocity vector.

StaticObject:hasAttribute(attributeName)

Returns true if the object belongs to the category.

Defined in:

Parameter:

#AttributeName attributeName

Attribute name to check.

Return value:

#boolean:

StaticObject:inAir()

Returns true if the unit is in air.

Defined in:

Return value:

#boolean:

StaticObject:isActive()

Defined in:

Return value:

#boolean:

StaticObject:isExist()

Defined in:

Return value:

#boolean:

Type Task

A task descriptor (internal structure for DCS World).

See https://wiki.hoggitworld.com/view/Category:Tasks. In MOOSE, these tasks can be accessed via Wrapper.Controllable#CONTROLLABLE.

Field(s)

#string Task.id

#Task.param Task.param

Function(s)

Type Template

DCS template data structure.

Field(s)

#boolean Template.lateActivation

Group is late activated.

#boolean Template.uncontrolled

Aircraft is uncontrolled.

#table Template.units

Unit list.

#number Template.x

2D Position on x-axis in meters.

#number Template.y

2D Position on y-axis in meters.

Function(s)

Type Template.Unit

Unit data structure.

Field(s)

#number Template.Unit.alt

#string Template.Unit.name

Name of the unit.

#number Template.Unit.x

#number Template.Unit.y

Function(s)

Type Unit

Field(s)

Function(s)

Unit:enableEmission(switch)

GROUND - Switch on/off radar emissions

Defined in:

Unit

Parameter:

#boolean switch

Unit:getAmmo()

Returns the unit ammunition.

Defined in:

Unit

Return value:

#Unit.Ammo:

Unit.getByName(name)

Returns unit object by the name assigned to the unit in Mission Editor.

If there is unit with such name or the unit is destroyed the function will return nil. The function provides access to non-activated units too.

Defined in:

Unit

Parameter:

#string name

Return value:

Unit:getCallsign()

Returns the unit's callsign - the localized string.

Defined in:

Unit

Return value:

#string:

Unit:getController()

Returns controller of the unit if it exist and nil otherwise

Defined in:

Unit

Return value:

#Controller:

Unit:getDesc()

Returns unit descriptor.

Descriptor type depends on unit category.

Defined in:

Unit

Return value:

#Unit.Desc:

Unit:getDescentCapacity()

Returns the number of infantry that can be embark onto the aircraft.

Only returns a value if run on airplanes or helicopters. Returns nil if run on ground or ship units.

Defined in:

Unit

Return value:

#number:

Number of soldiers that embark.

Unit:getFuel()

Returns relative amount of fuel (from 0.0 to 1.0) the unit has in its internal tanks.

If there are additional fuel tanks the value may be greater than 1.0.

Defined in:

Unit

Return value:

#number:

Unit:getGroup()

Returns the unit's group if it exist and nil otherwise

Defined in:

Unit

Return value:

#Group:

Unit:getID()

returns the unit's unique identifier.

Defined in:

Unit

Return value:

#Unit.ID:

Unit:getLife()

Returns the unit's health.

Dead units has health <= 1.0

Defined in:

Unit

Return value:

#number:

Unit:getLife0()

returns the unit's initial health.

Defined in:

Unit

Return value:

#number:

Unit:getNumber()

Returns the unit's number in the group.

The number is the same number the unit has in ME. It may not be changed during the mission. If any unit in the group is destroyed, the numbers of another units will not be changed.

Defined in:

Unit

Return value:

#number:

Unit:getPlayerName()

Returns name of the player that control the unit or nil if the unit is controlled by A.I.

Defined in:

Unit

Return value:

#string:

Unit:getRadar()

returns two values: First value indicates if at least one of the unit's radar(s) is on.

Second value is the object of the radar's interest. Not nil only if at least one radar of the unit is tracking a target.

Defined in:

Unit

Return value:

#boolean, Wrapper.Object#Object:

Unit:getSensors()

Returns the unit sensors.

Defined in:

Unit

Return value:

#Unit.Sensors:

Unit:hasSensors(sensorType, ...)

Returns true if the unit has specified types of sensors.

This function is more preferable than Unit.getSensors() if you don't want to get information about all the unit's sensors, and just want to check if the unit has specified types of sensors.

Defined in:

Unit

Parameters:

#Unit.SensorType sensorType

(= nil) Sensor type.

...

Additional parameters.

Return value:

#boolean:

Usage:

If sensorType is Unit.SensorType.OPTIC, additional parameters are optic sensor types. Following example checks if the unit has LLTV or IR optics:
unit:hasSensors(Unit.SensorType.OPTIC, Unit.OpticType.LLTV, Unit.OpticType.IR)
If sensorType is Unit.SensorType.RADAR, additional parameters are radar types. Following example checks if the unit has air search radars:
unit:hasSensors(Unit.SensorType.RADAR, Unit.RadarType.AS)
If no additional parameters are specified the function returns true if the unit has at least one sensor of specified type.
If sensor type is not specified the function returns true if the unit has at least one sensor of any type.

Unit:isActive()

Returns if the unit is activated.

Defined in:

Unit

Return value:

#boolean:

Type Unit.AmmoItem

ammunition item: "type-count" pair.

Field(s)

#number Unit.AmmoItem.count

ammunition count

#Weapon.Desc Unit.AmmoItem.desc

ammunition descriptor

Function(s)

Type Unit.Category

Enum that stores unit categories.

Field(s)

Function(s)

Type Unit.Desc

A unit descriptor.

Field(s)

#Unit.Category Unit.Desc.category

Unit Category

#Mass Unit.Desc.massEmpty

mass of empty unit

#number Unit.Desc.speedMax

istance / Time, --maximal velocity

Function(s)

Type Unit.DescAircraft

An aircraft descriptor.

Field(s)

#Distance Unit.DescAircraft.Hmax

Ceiling

#number Unit.DescAircraft.NyMax

maximal safe acceleration

#number Unit.DescAircraft.NyMin

minimal safe acceleration

#number Unit.DescAircraft.VyMax

#Distance / #Time, --maximal climb rate

#Mass Unit.DescAircraft.fuelMassMax

maximal inner fuel mass

#Distance Unit.DescAircraft.range

Operational range

#Unit.RefuelingSystem Unit.DescAircraft.tankerType

refueling system type

Function(s)

Type Unit.DescAirplane

An airplane descriptor.

Field(s)

#number Unit.DescAirplane.speedMax0

Distance / Time maximal TAS at ground level

#number Unit.DescAirplane.speedMax10K

Distance / Time maximal TAS at altitude of 10 km

Function(s)

Type Unit.DescHelicopter

A helicopter descriptor.

Field(s)

#Distance Unit.DescHelicopter.HmaxStat

static ceiling

Function(s)

Type Unit.DescVehicle

A vehicle descriptor.

Field(s)

#Angle Unit.DescVehicle.maxSlopeAngle

maximal slope angle

#boolean Unit.DescVehicle.riverCrossing

can the vehicle cross a rivers

Function(s)

Type Unit.IRST

An IRST.

Field(s)

#Distance Unit.IRST.detectionDistanceAfterburner

..., engines are in afterburner mode

#Distance Unit.IRST.detectionDistanceIdle

detection of tail-on target with heat signature = 1 in upper hemisphere, engines are in idle

#Distance Unit.IRST.detectionDistanceMaximal

..., engines are in maximal mode

Function(s)

Type Unit.Optic

An optic sensor.

Field(s)

#Unit.OpticType Unit.Optic.opticType

Function(s)

Type Unit.OpticType

Enum that stores types of optic sensors.

Field(s)

Function(s)

Type Unit.Radar

A radar.

Field(s)

#Unit.Radar.detectionDistanceAir Unit.Radar.detectionDistanceAir

detection distance for RCS=1m^2 airborne target, nil if radar doesn't support air search

#Distance Unit.Radar.detectionDistanceHRM

detection distance for RCS=1m^2 in high-resolution mapping mode, nil if radar has no HRM

#Distance Unit.Radar.detectionDistanceRBM

detection distance for RCS=1m^2 in real-beam mapping mode, nil if radar doesn't support surface/land search

Function(s)

Type Unit.Radar.detectionDistanceAir

A radar.

Field(s)

#Unit.Radar.detectionDistanceAir.lowerHemisphere Unit.Radar.detectionDistanceAir.lowerHemisphere

#Unit.Radar.detectionDistanceAir.upperHemisphere Unit.Radar.detectionDistanceAir.upperHemisphere

Function(s)

Type Unit.Radar.detectionDistanceAir.lowerHemisphere

A radar.

Field(s)

#Distance Unit.Radar.detectionDistanceAir.lowerHemisphere.headOn

#Distance Unit.Radar.detectionDistanceAir.lowerHemisphere.tailOn

Function(s)

Type Unit.Radar.detectionDistanceAir.upperHemisphere

A radar.

Field(s)

#Distance Unit.Radar.detectionDistanceAir.upperHemisphere.headOn

#Distance Unit.Radar.detectionDistanceAir.upperHemisphere.tailOn

Function(s)

Type Unit.RadarType

Enum that stores radar types.

Field(s)

Function(s)

Type Unit.RefuelingSystem

Enum that stores aircraft refueling system types.

Field(s)

Function(s)

Type Unit.Sensor

A unit sensor.

Field(s)

#Unit.SensorType Unit.Sensor.type

#TypeName Unit.Sensor.typeName

Function(s)

Type Unit.SensorType

Enum that stores sensor types.

Field(s)

Function(s)

Type Vec2

Vec2 is a 2D-vector for the ground plane as a reference plane.

Field(s)

#Distance Vec2.x

Vec2.x = Vec3.x

#Distance Vec2.y

Vec2.y = Vec3.z

Function(s)

Type Vec3

Vec3 type is a 3D-vector.

DCS world has 3-dimensional coordinate system. DCS ground is an infinite plain.

Field(s)

#Distance Vec3.x

is directed to the North

#Distance Vec3.y

is directed up

#Distance Vec3.z

is directed to the East

Function(s)

Type Warehouse

DCS Class Warehouse The warehouse class gives control over warehouses that exist in airbase objects.

These warehouses can limit the aircraft, munitions, and fuel available to coalition aircraft.

Field(s)

Function(s)

Warehouse:addItem(itemName, count)

Adds the passed amount of a given item to the warehouse.

itemName is the typeName associated with the item: "weapons.missiles.AIM_54C_Mk47" A wsType table can also be used, however the last digit with wsTypes has been known to change. {4, 4, 7, 322}

Defined in:

Warehouse

Parameters:

#string itemName

Name of the item.

#number count

Number of items to add.

Warehouse:addLiquid(liquidType, count)

Adds the passed amount of a liquid fuel into the warehouse inventory.

Defined in:

Warehouse

Parameters:

#number liquidType

Type of liquid to add: 0=jetfuel, 1=aviation gasoline, 2=MW50, 3=Diesel.

#number count

Amount of liquid to add.

Warehouse.getByName(Name)

Get a warehouse by passing its name.

Defined in:

Warehouse

Parameter:

#string Name

Name of the warehouse.

Return value:

#Warehouse:

The warehouse object.

Warehouse:getInventory(itemName)

Returns a full itemized list of everything currently in a warehouse.

If a category is set to unlimited then the table will be returned empty. Aircraft and weapons are indexed by strings. Liquids are indexed by number.

Defined in:

Warehouse

Parameter:

#string itemName

Name of the item.

Return value:

#table:

Itemized list of everything currently in a warehouse

Warehouse:getItemCount(itemName)

Returns the number of the passed type of item currently in a warehouse object.

Defined in:

Warehouse

Parameter:

#string itemName

Name of the item.

Warehouse:getLiquidAmount(liquidType)

Returns the amount of the passed liquid type within a given warehouse.

Defined in:

Warehouse

Parameter:

#number liquidType

Type of liquid to add: 0=jetfuel, 1=aviation gasoline, 2=MW50, 3=Diesel.

Return value:

#number:

Amount of liquid.

Warehouse:getOwner()

Returns the airbase object associated with the warehouse object.

Defined in:

Warehouse

Return value:

#Airbase:

The airbase object owning this warehouse.

Warehouse:removeItem(itemName, count)

Removes the amount of the passed item from the warehouse.

Defined in:

Warehouse

Parameters:

#string itemName

Name of the item.

#number count

Number of items to be removed.

Warehouse:setItem(itemName, count)

Sets the passed amount of a given item to the warehouse.

Defined in:

Warehouse

Parameters:

#string itemName

Name of the item.

#number count

Number of items to add.

Warehouse:setLiquidAmount(liquidType, count)

Removes the set amount of liquid from the inventory in a warehouse.

Defined in:

Warehouse

Parameters:

#number liquidType

Type of liquid to add: 0=jetfuel, 1=aviation gasoline, 2=MW50, 3=Diesel.

#number count

Amount of liquid.

Type WaypointAir

Field(s)

#boolean WaypointAir.lateActivated

#boolean WaypointAir.uncontrolled

Function(s)

Type Weapon

DCS Class Weapon

Field(s)

#Weapon.Category Weapon.Category

enum that stores weapon categories.

#Weapon.Desc Weapon.Desc

The descriptor of a weapon.

#Weapon.GuidanceType Weapon.GuidanceType

enum that stores guidance methods. Available only for guided weapon (Weapon.Category.MISSILE and some Weapon.Category.BOMB).

#Weapon.MissileCategory Weapon.MissileCategory

enum that stores missile category. Available only for missiles (Weapon.Category.MISSILE).

#Weapon.WarheadType Weapon.WarheadType

enum that stores warhead types.

#Weapon.flag Weapon.flag

enum stores weapon flags. Some of them are combination of another flags.

Function(s)

Weapon:getDesc()

returns weapon descriptor.

Descriptor type depends on weapon category.

Defined in:

Weapon

Return value:

#Weapon.Desc:

Weapon:getLauncher()

Returns the unit that launched the weapon.

Defined in:

Weapon

Return value: