https://wiki.hoggitworld.com/view/DCS_singleton_atmosphere
https://wiki.hoggitworld.com/view/DCS_singleton_coalition
The Custom service is for APIs that do not map to the "standard library" of DCS APIs provided
by Eagle Dynamics.
Expect to find APIs here that may be useful for mission frameworks etc.
https://wiki.hoggitworld.com/view/DCS_Class_Group
APis that are part of the hook environment
Contains the streaming APIs that streaming information out of the DCS server.
https://wiki.hoggitworld.com/view/DCS_singleton_timer
https://wiki.hoggitworld.com/view/DCS_singleton_trigger
https://wiki.hoggitworld.com/view/DCS_Class_Unit
https://wiki.hoggitworld.com/view/DCS_singleton_world
Top
GetTemperatureAndPressureRequest
Field
Type
Label
Description
position
Position The position on the map we want the wind information for. Requires lat/lon/alt fields to be populated, there are no default values
GetTemperatureAndPressureResponse
Field
Type
Label
Description
temperature
float The temperature in Kelvin
pressure
float The pressure in Pascals
Field
Type
Label
Description
position
Position The position on the map we want the wind information for. Requires lat/lon/alt fields to be populated, there are no default values
Field
Type
Label
Description
heading
float The heading the wind is coming from.
strength
float The strength of the wind in meters per second
GetWindWithTurbulenceRequest
Field
Type
Label
Description
position
Position The position on the map we want the wind information for. Requires lat/lon/alt fields to be populated, there are no default values
GetWindWithTurbulenceResponse
Field
Type
Label
Description
heading
float The heading the wind is coming from.
strength
float The strength of the wind in meters per second
Top
Field
Type
Label
Description
groups
Group repeated
Field
Type
Label
Description
coalition
Coalition
Field
Type
Label
Description
units
Unit repeated
Top
An instance of a DCS Airfield
Field
Type
Label
Description
id
uint32 optional
The DCS generated ID. Only used when the airfield is also a unit (e.g. an Aicraft Carrier)
name
string TODO: Fill this in
callsign
string TODO: Fill this in
coalition
Coalition The coalition the unit belongs to. This can change mid-mission if an airfield is captured
position
Position The position of the center point of the airfield.
category
AirbaseCategory What category the airfield belongs to.
display_name
string TODO: Fill this in
A generic empty response
A generic empty response used in APIs that do not return any values to the client
An instance of a DCS group
Field
Type
Label
Description
id
uint32 The DCS generated ID
name
string The name of the group as assigned in the mission editor
Position of an object in DCS
Latitude and Longitude are in Decimal Degrees format (e.g. 41.33 / 37.21). Negative values are used for West of the
meridian and south of the equator
Altitude is given in meters above Mean Sea Level (MSL) and can be a decimal value.
Field
Type
Label
Description
lat
double Latitude in Decimal Degrees format
lon
double Longitude in Decimal Degrees format
alt
double Altitude in Meters above Mean Sea Level (MSL)
An instance of a DCS Unit
A unit is an "active" unit in a DCS mission. This means it has an attached AI that moves and shoots. Units include
aircraft, ground units, ships, weapons etc.
Field
Type
Label
Description
id
uint32 The DCS generated ID
name
string The name of the unit as assigned in the mission editor
callsign
string The DCS assigned callsign if one exists. e.g. "Enfield 11"
coalition
Coalition The coalition the unit belongs to
type
string The DCS type-name of the unit. e.g "MiG-29A", "ZSU_57_2" or "Hawk ln"
position
Position The position of the unit
player_name
string optional
The name of the player if one is in control of the unit
group_name
string The name of the group that the unit belongs to
number_in_group
uint32 The number of this unit in the group. Does not change as units are destroyed
speed
double The horizontal speed of the unit. If it is doing mach one straight up then the speed will be 0
heading
double The heading of the unit
This type is returned if an object category cannot be determined
The base object includes the getName() function so even for an unknown type we should be able to get the name
Field
Type
Label
Description
name
string
An instance of a DCS weapon
These weapons include everything from autocannon HE shells up to massive ship-killer missiles
Field
Type
Label
Description
id
uint32 The DCS generated ID
type
string The DCS type-name of the weapon. e.g "Matra_S530D", "HAWK_RAKETA" or "weapons.shells.53-UOR-281U"
position
Position The position of the Weapon
The category the object belongs to
Some of these are less than obvious. For example an oilrig counts as a HELIPAD airfield.
Name
Number
Description
AIRDROME
0
HELIPAD
1
SHIP
2
Coalitions in DCS
The coalitions supported by DCS. The NEUTRAL coalition is a relatively new one and may not be as supported as
the belligerant ones.
Name
Number
Description
NEUTRAL
0
RED
1
BLUE
2
The category the object belongs to
All DCS objects are one of the following categories. DCS itself does not use the UNKNOWN enum value but we use it
in GRPC as a fallback in case of issues determining the category.
See https://wiki.hoggitworld.com/view/DCS_Class_Object for more information
Name
Number
Description
UNKNOWN
0
UNIT
1
WEAPON
2
STATIC
3
SCENERY
4
BASE
5
CARGO
6
Top
SetAlarmStateRequest.AlarmState
Name
Number
Description
AUTO
0
GREEN
1
RED
2
Top
Field
Type
Label
Description
lua
string
Field
Type
Label
Description
json
string
Field
Type
Label
Description
unit_name
string
mission_type
string
MissionAssignmentResponse
Field
Type
Label
Description
unit_name
string
mission_code
int32
Top
Field
Type
Label
Description
group_name
string
active
bool optional
Whether the response should include only active units (true), only inactive units (false), or all units (nil).
Field
Type
Label
Description
units
dcs.Unit repeated
Name
Number
Description
AIRPLANE
0
HELICOPTER
1
GROUND
2
SHIP
3
TRAIN
4
Top
Field
Type
Label
Description
player_id
uint32 The ID of the player sending the chat messaage.
message
string The chat message.
all
bool Whether the message was send to all or only to allies.
Field
Type
Label
Description
name
string
Top
The DCS Event information. Contains event information and a timestamp.
Occurs when a ground unit captures either an airbase or a farp.
Field
Type
Label
Description
initiator
Initiator The object that captured the base.
place
Airbase The airbase that was captured, can be a FARP or Airbase
Occurs when any object is spawned into the mission.
Field
Type
Label
Description
initiator
Initiator The object that was spawned.
place
Airbase optional
The airbase, farp or ship the unit took off from.
Occurs when an aircraft crashes into the ground and is completely
destroyed.
Field
Type
Label
Description
initiator
Initiator The object that crashed.
Occurs when an object is completely destroyed.
Field
Type
Label
Description
initiator
Initiator The object that has been destroyed.
Event.DetailedFailureEvent Occurs when a system on an aircraft fails. This can be due to damage or due to random failures
set up in the mission editor.
Field
Type
Label
Description
target
Target The target the failure occurred for.
Event.DiscardChairAfterEjectionEvent A pilot detached from their ejection seat.
Field
Type
Label
Description
initiator
Initiator The ejection seat.
target
Target The pilot.
Occurs when a pilot ejects from its aircraft.
Field
Type
Label
Description
initiator
Initiator The unit a pilot ejected from.
target
Target The ejection seat.
Event.EngineShutdownEvent
Field
Type
Label
Description
initiator
Initiator Occurs when any aircraft shuts down its engines.
place
Airbase The airbase, farp or ship the unit shut down their engine at.
Occurs when any aircraft starts its engines.
Field
Type
Label
Description
initiator
Initiator The object that starts its engines.
place
Airbase The airbase, farp or ship the unit started their engine at.
Occurs when an object is hit by a weapon.
Field
Type
Label
Description
initiator
Initiator optional
The object that fired the weapon. Not set when for example fyling an aircraft into a building (building will be the target and weapon_name the name of the aircraft).
weapon
Weapon The weapon that the target has been hit with.
target
Target The object that has been hit.
weapon_name
string The weapon the target got hit by.
Occurs e.g. when a player controlled aircraft blacks out.
Field
Type
Label
Description
initiator
Initiator The unit the system failure occurred in.
Occurs when an object is killed by a weapon.
Field
Type
Label
Description
initiator
Initiator The object that fired the weapon.
weapon
Weapon The weapon that the target has been killed with.
target
Target The object that has been killed.
weapon_name
string The name of the weapon that killed the target (exists instead of weapon for weapons that trigger the shooting start and end events).
Occurs when an aircraft lands at an airbase, farp or ship.
Field
Type
Label
Description
initiator
Initiator The object that landed.
place
Airbase The airbase, farp or ship the unit landed at.
Event.LandingAfterEjectionEvent A pilot detached from their ejection seat.
Field
Type
Label
Description
initiator
Initiator The ejected pilot.
place
Position The position the pilot landed at.
Event.LandingQualityMarkEvent Occurs when an aircraft receives an LSO rating after recovering on an aircraft carrier.
Field
Type
Label
Description
initiator
Initiator The aircraft that received the rating.
comment
string The rating.
Occurs when marks get added to the mission by players or scripting
functions.
Field
Type
Label
Description
initiator
Initiator The object that added the mark.
group_id
uint64 The group the mark's visibility is restricted for.
coalition
Coalition The coalition the mark's visibility is restricted for.
id
uint32 The mark's id.
pos
Position The position the mark has been added at.
text
string The mark's label.
Occurs when marks got changed.
Field
Type
Label
Description
initiator
Initiator The object that changed the mark.
group_id
uint64 The group the mark's visibility is restricted for.
coalition
Coalition The coalition the mark's visibility is restricted for.
id
uint32 The mark's id.
pos
Position The position of the changed mark.
text
string The mark's label.
Occurs when marks get removed.
Field
Type
Label
Description
initiator
Initiator The object that removed the mark.
group_id
uint64 The group the mark's visibility is restricted for.
coalition
Coalition The coalition the mark's visibility is restricted for.
id
uint32 The mark's id.
pos
Position The position the mark has been removed from.
text
string The mark's label.
Occurs when the mission stops.
Occurs when the mission starts.
Occurs when a pilot of an aircraft is killed. Can occur either if the
player is alive and crashes (in this case both this and the [CrashEvent]
event will be fired) or if a weapon kills the pilot without completely
destroying the plane.
Field
Type
Label
Description
initiator
Initiator The unit the pilot has died in.
Event.PlayerEnterUnitEvent Occurs when a player takes direct control of a unit.
Field
Type
Label
Description
initiator
Initiator The unit the player took control of.
Event.PlayerLeaveUnitEvent Occurs when a player relieves direct control of a unit.
Field
Type
Label
Description
initiator
Initiator The unit the player relieves control of.
Occurs when an aircraft connects with a tanker and begins taking on fuel.
Field
Type
Label
Description
initiator
Initiator The object that is receiving fuel.
Occurs when an aircraft is finished taking fuel.
Field
Type
Label
Description
initiator
Initiator he unit that was receiving fuel.
A score change (doesn't contain any useful information)
Occurs when a unit stops firing a machine gun- or autocannon-based weapon.
Event will always correspond with a [ShootingStartEvent] event.
Field
Type
Label
Description
initiator
Initiator The object that was shooting and has no stopped firing.
weapon_name
string The name of the shoot weapon.
Occurs when a unit begins firing a machine gun- or autocannon-based weapon
(weapons with a high rate of fire). Other weapons are handled by
[ShotEvent].
Field
Type
Label
Description
initiator
Initiator The object that started firing.
weapon_name
string The name of the shoot weapon.
Occurs when a unit fires a weapon (but no machine gun- or autocannon-based
weapons - those are handled by [ShootingStartEvent]).
Field
Type
Label
Description
initiator
Initiator The object that fired the weapon.
weapon
Weapon The weapon that has been fired.
Occurs when an aircraft takes off from an airbase, farp, or ship.
Field
Type
Label
Description
initiator
Initiator The object that took off.
place
Airbase The airbase, farp or ship the unit took off from.
A unit got destroyed.
Field
Type
Label
Description
initiator
Initiator The object that got destroyed weapon.
Fired for each payload of an aircraft spawened midair.
Field
Type
Label
Description
initiator
Initiator The object that got spawned.
weapon_name
string The name of the payload.
Field
Type
Label
Description
poll_rate
uint32 optional
The poll rate in seconds at which the gRPC server communicates with the DCS mission to retrieve the latest unit positions. The lower the poll_rate the higher the amount of requests send to to the DCS mission. Default: 5
max_backoff
uint32 optional
The maximum backoff in seconds which the gRPC postpones polling units that haven't moved recently. This is an optimization to dynamically reduce the poll rate for stationary units. Set it to the same value as poll_rate to disable the backoff. Default: 30
Field
Type
Label
Description
unit
Unit The unit is either new or its position changed.
gone
UnitUpdate.UnitGone The unit does not exist anymore.
Top
Field
Type
Label
Description
time
double
Field
Type
Label
Description
time
double
Field
Type
Label
Description
time
double
Top
Field
Type
Label
Description
flag
string
Field
Type
Label
Description
value
uint32
Field
Type
Label
Description
position
Position The altitude of Illumination Bombs is meters above ground. Ground level will be calculated server-side
power
uint32
Field
Type
Label
Description
id
uint32
Field
Type
Label
Description
id
uint32
Field
Type
Label
Description
id
uint32
OutTextForCoalitionRequest
Field
Type
Label
Description
text
string
display_time
int32
clear_view
bool
Field
Type
Label
Description
id
uint32
Field
Type
Label
Description
position
Position Altitude paramter will be ignored. Smoke always eminated from ground level which will be calculated server-side
color
SmokeRequest.SmokeColor
SignalFlareRequest.FlareColor Putting this inside the request because we cannot
have the same enum value in the same package.
Name
Number
Description
GREEN
0
RED
1
WHITE
2
YELLOW
3
Putting this inside the request because we cannot
have the same enum value in the same package.
Name
Number
Description
GREEN
0
RED
1
WHITE
2
ORANGE
3
BLUE
4
Top
Field
Type
Label
Description
name
string
Field
Type
Label
Description
active
bool
target
Target
Field
Type
Label
Description
name
string
GetUnitDescriptorResponse TODO fill these in as and when we need em
Field
Type
Label
Description
attributes
string repeated
Field
Type
Label
Description
name
string
GetUnitPlayerNameResponse
Field
Type
Label
Description
player_name
string optional
Field
Type
Label
Description
name
string
Field
Type
Label
Description
position
Position
Top
Field
Type
Label
Description
coalition
Coalition optional
Field
Type
Label
Description
airbases
Airbase repeated
Field
Type
Label
Description
mark_panels
MarkPanel repeated
.proto Type
Notes
C++
Java
Python
Go
C#
PHP
Ruby
double
double
float
float64
double
float
Float
float
float
float
float32
float
float
Float
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.
int32
int
int
int32
int
integer
Bignum or Fixnum (as required)
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.
int64
long
int/long
int64
long
integer/string
Bignum
Uses variable-length encoding.
uint32
int
int/long
uint32
uint
integer
Bignum or Fixnum (as required)
Uses variable-length encoding.
uint64
long
int/long
uint64
ulong
integer/string
Bignum or Fixnum (as required)
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.
int32
int
int
int32
int
integer
Bignum or Fixnum (as required)
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.
int64
long
int/long
int64
long
integer/string
Bignum
Always four bytes. More efficient than uint32 if values are often greater than 2^28.
uint32
int
int
uint32
uint
integer
Bignum or Fixnum (as required)
Always eight bytes. More efficient than uint64 if values are often greater than 2^56.
uint64
long
int/long
uint64
ulong
integer/string
Bignum
Always four bytes.
int32
int
int
int32
int
integer
Bignum or Fixnum (as required)
Always eight bytes.
int64
long
int/long
int64
long
integer/string
Bignum
bool
boolean
boolean
bool
bool
boolean
TrueClass/FalseClass
A string must always contain UTF-8 encoded or 7-bit ASCII text.
string
String
str/unicode
string
string
string
String (UTF-8)
May contain any arbitrary sequence of bytes.
string
ByteString
str
[]byte
ByteString
string
String (ASCII-8BIT)