package dcs.common.v0

Get desktop application:
View/edit binary Protocol Buffers messages

* An instance of a DCS Airfield

optional Unit unit = 1
Information about the unit, if the airbase is one (e.g. in case of a carrier).
string name = 2
TODO: Fill this in
string callsign = 3
TODO: Fill this in
Coalition coalition = 4
The coalition the unit belongs to. This can change mid-mission if an airfield is captured
optional Position position = 6
The position of the center point of the airfield.
AirbaseCategory category = 7
What category the airfield belongs to.
string display_name = 8
TODO: Fill this in

* The category the object belongs to Some of these are less than obvious. For example an oilrig counts as a HELIPAD airfield.

Used in: Airbase

AIRBASE_CATEGORY_UNSPECIFIED = 0
AIRBASE_CATEGORY_AIRDROME = 1
AIRBASE_CATEGORY_HELIPAD = 2
AIRBASE_CATEGORY_SHIP = 3

* An instance of a DCS Cargo object

Used in: Initiator, Target

(message has no fields)

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

Used in: coalition.v0.GetBullseyeRequest, coalition.v0.GetGroupsRequest, coalition.v0.GetPlayerUnitsRequest, coalition.v0.GetStaticObjectsRequest, Airbase, Group, MarkPanel, Static, Unit, mission.v0.AddCoalitionCommandRequest, mission.v0.AddCoalitionCommandSubMenuRequest, mission.v0.RemoveCoalitionCommandItemRequest, mission.v0.StreamEventsResponse.CoalitionCommandEvent, mission.v0.StreamEventsResponse.MarkAddEvent, mission.v0.StreamEventsResponse.MarkChangeEvent, mission.v0.StreamEventsResponse.MarkRemoveEvent, mission.v0.StreamEventsResponse.PlayerChangeSlotEvent, mission.v0.StreamEventsResponse.PlayerSendChatEvent, mission.v0.StreamEventsResponse.TtsEvent, net.v0.ForcePlayerSlotRequest, net.v0.GetPlayersResponse.GetPlayerInfo, net.v0.SendChatRequest, srs.v0.TransmitRequest, trigger.v0.MarkToCoalitionRequest, trigger.v0.MarkupToCoalitionRequest, trigger.v0.OutTextForCoalitionRequest, world.v0.GetAirbasesRequest

COALITION_ALL = 0
protolint:disable:next ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH
COALITION_NEUTRAL = 1
COALITION_RED = 2
COALITION_BLUE = 3

* An instance of a contact in a DCS AI controller's detection table This is a target that the AI controller has detected and is actively tracking

Used in: controller.v0.GetDetectedTargetsResponse

uint32 id = 1
The DCS generated ID
bool visible = 2
Can the sensor see the contact
bool distance = 3
Does the controller know the distance to the contact?
oneof target
Either the basic information, or Unit or Weapon export object
- Unknown object = 4
- Unit unit = 5
- Weapon weapon = 6

* Countries in DCS Every country belongs to a coalition and this association is set per mission. The values of these enums are correct such that they will work with DCS however the text names have been Made to follow gRPC conventions to to aid in language bindings and acronyms have been replaced with their full english names to aid in recognition. In some cases this can be a big change (e.g. USSR -> Soviet Union). We have also added a dummy value for the missing enum value 14 to prevent possible issues in the various language bindings See https://wiki.hoggitworld.com/view/DCS_enum_country for more information

Used in: coalition.v0.AddGroupRequest, coalition.v0.AddLinkedStaticRequest, coalition.v0.AddStaticObjectRequest

COUNTRY_UNSPECIFIED = 0
COUNTRY_RUSSIA = 1
COUNTRY_UKRAINE = 2
COUNTRY_UNITED_STATES_OF_AMERICA = 3
COUNTRY_TURKEY = 4
COUNTRY_UNITED_KINGDOM = 5
COUNTRY_FRANCE = 6
COUNTRY_GERMANY = 7
COUNTRY_AGGRESSORS = 8
COUNTRY_CANADA = 9
COUNTRY_SPAIN = 10
COUNTRY_THE_NETHERLANDS = 11
COUNTRY_BELGIUM = 12
COUNTRY_NORWAY = 13
COUNTRY_DENMARK = 14
COUNTRY_UNUSED = 15
COUNTRY_ISRAEL = 16
COUNTRY_GEORGIA = 17
COUNTRY_INSURGENTS = 18
COUNTRY_ABKHAZIA = 19
COUNTRY_SOUTH_OSETIA = 20
COUNTRY_ITALY = 21
COUNTRY_AUSTRALIA = 22
COUNTRY_SWITZERLAND = 23
COUNTRY_AUSTRIA = 24
COUNTRY_BELARUS = 25
COUNTRY_BULGARIA = 26
COUNTRY_CZECH_REPUBLIC = 27
COUNTRY_CHINA = 28
COUNTRY_CROATIA = 29
COUNTRY_EGYPT = 30
COUNTRY_FINLAND = 31
COUNTRY_GREECE = 32
COUNTRY_HUNGARY = 33
COUNTRY_INDIA = 34
COUNTRY_IRAN = 35
COUNTRY_IRAQ = 36
COUNTRY_JAPAN = 37
COUNTRY_KAZAKHSTAN = 38
COUNTRY_NORTH_KOREA = 39
COUNTRY_PAKISTAN = 40
COUNTRY_POLAND = 41
COUNTRY_ROMANIA = 42
COUNTRY_SAUDI_ARABIA = 43
COUNTRY_SERBIA = 44
COUNTRY_SLOVAKIA = 45
COUNTRY_SOUTH_KOREA = 46
COUNTRY_SWEDEN = 47
COUNTRY_SYRIA = 48
COUNTRY_YEMEN = 49
COUNTRY_VIETNAM = 50
COUNTRY_VENEZUELA = 51
COUNTRY_TUNISIA = 52
COUNTRY_THAILAND = 53
COUNTRY_SUDAN = 54
COUNTRY_PHILIPPINES = 55
COUNTRY_MOROCCO = 56
COUNTRY_MEXICO = 57
COUNTRY_MALAYSIA = 58
COUNTRY_LIBYA = 59
COUNTRY_JORDAN = 60
COUNTRY_INDONESIA = 61
COUNTRY_HONDURAS = 62
COUNTRY_ETHIOPIA = 63
COUNTRY_CHILE = 64
COUNTRY_BRAZIL = 65
COUNTRY_BAHRAIN = 66
COUNTRY_THIRDREICH = 67
COUNTRY_YUGOSLAVIA = 68
COUNTRY_SOVIET_UNION = 69
COUNTRY_ITALIAN_SOCIAL_REPUBLIC = 70
COUNTRY_ALGERIA = 71
COUNTRY_KUWAIT = 72
COUNTRY_QATAR = 73
COUNTRY_OMAN = 74
COUNTRY_UNITED_ARAB_EMIRATES = 75
COUNTRY_SOUTH_AFRICA = 76
COUNTRY_CUBA = 77
COUNTRY_PORTUGAL = 78
COUNTRY_GERMAN_DEMOCRATIC_REPUBLIC = 79
COUNTRY_LEBANON = 80
COUNTRY_COMBINED_JOINT_TASK_FORCE_BLUE = 81
COUNTRY_COMBINED_JOINT_TASK_FORCE_RED = 82
COUNTRY_UNITED_NATIONS_PEACEKEEPERS = 83
COUNTRY_ARGENTINA = 84
COUNTRY_CYPRUS = 85
COUNTRY_SLOVENIA = 86

* An instance of a DCS group

Used in: coalition.v0.AddGroupResponse, coalition.v0.GetGroupsResponse, Unit, mission.v0.StreamEventsResponse.GroupCommandEvent

uint32 id = 1
The DCS generated ID
string name = 2
The name of the group as assigned in the mission editor
Coalition coalition = 3
The coalition of the group
GroupCategory category = 4
The group category.

* Group category enumerator.

Used in: coalition.v0.AddGroupRequest, coalition.v0.GetGroupsRequest, Group, mission.v0.StreamUnitsRequest

GROUP_CATEGORY_UNSPECIFIED = 0
GROUP_CATEGORY_AIRPLANE = 1
GROUP_CATEGORY_HELICOPTER = 2
GROUP_CATEGORY_GROUND = 3
GROUP_CATEGORY_SHIP = 4
GROUP_CATEGORY_TRAIN = 5

The initiator of an event The initiator of an event. For things like shooting events it is usually a vehicle but it can be almost anything depending on the event

oneof initiator
- Unknown unknown = 1
- Unit unit = 2
- Weapon weapon = 3
- Static static = 4
- Scenery scenery = 5
- Airbase airbase = 6
- Cargo cargo = 7

* Position used in requests to DCS-gRPC. 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.

Used in: atmosphere.v0.GetTemperatureAndPressureRequest, atmosphere.v0.GetWindRequest, atmosphere.v0.GetWindWithTurbulenceRequest, coalition.v0.AddGroupRequest.GroundGroupTemplate, coalition.v0.AddGroupRequest.GroundUnitTemplate, coalition.v0.AddGroupRequest.Point, coalition.v0.AddStaticObjectRequest, srs.v0.TransmitRequest, trigger.v0.ExplosionRequest, trigger.v0.IlluminationBombRequest, trigger.v0.MarkToAllRequest, trigger.v0.MarkToCoalitionRequest, trigger.v0.MarkToGroupRequest, trigger.v0.MarkupToAllRequest, trigger.v0.MarkupToCoalitionRequest, trigger.v0.SignalFlareRequest, trigger.v0.SmokeRequest, world.v0.BoxVolume, world.v0.PyramidVolume, world.v0.SegmentVolume, world.v0.SphereVolume

double lat = 1
Latitude in Decimal Degrees format
double lon = 2
Longitude in Decimal Degrees format
double alt = 3
Altitude in Meters above Mean Sea Level (MSL)

A MarkPanel A MarkPanel visible on the F10 map. These can be used for reference by players but can also be used by things like Jester for setting waypoints

Used in: world.v0.GetMarkPanelsResponse

uint32 id = 1
The id of the mark panel.
double time = 2
The time in seconds relative to the mission start the mark got created.
optional Unit initiator = 3
The unit of the player that created the mark. Not set if the player isn't controlling any unit anymore (disconnected, spectator, game master, ...).
optional Coalition coalition = 4
If set, the mark is only visible for the specified coalition.
optional uint32 group_id = 5
The ID of the group the player was in when creating the mark panel. This will still be set even if the player isn't controlling the unit in that group anymore.
optional string text = 6
The text content of the mark.
optional Position position = 7
The position of the mark.

* The category the object belongs to All DCS objects are one of the following categories. Unlike many other enums created by DCS, this one is not 0 indexed. Therefore we do not need to do any modification of the value by incrementing it by one to make it work with gRPC and DCS. See https://wiki.hoggitworld.com/view/DCS_Class_Object for more information

Used in: world.v0.SearchObjectsRequest

OBJECT_CATEGORY_UNSPECIFIED = 0
OBJECT_CATEGORY_UNIT = 1
OBJECT_CATEGORY_WEAPON = 2
OBJECT_CATEGORY_STATIC = 3
OBJECT_CATEGORY_SCENERY = 4
OBJECT_CATEGORY_BASE = 5
OBJECT_CATEGORY_CARGO = 6

* The orientation of an object in 3D space.

Used in: Unit, Weapon, unit.v0.GetTransformResponse

double heading = 1
The heading the nose of the object points to on a flat world.
double yaw = 2
Yaw in degrees - clockwise relative to the true north (this is similar to the heading, just corrected by the projection error when going from a flat to a spherical world).
double pitch = 3
Pitch in degrees - positive when taking-off.
double roll = 4
Roll in degrees - positive when rolling the aircraft to the right.
optional Vector forward = 5
The normalized direction the object is pointing to.
optional Vector right = 6
The normalized direction the three line (right wing) is pointing to.
optional Vector up = 7
The normalized up vector (orthogonal to forward and right).

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

Used in: coalition.v0.GetBullseyeResponse, Airbase, MarkPanel, Scenery, Static, Unit, Weapon, mission.v0.StreamEventsResponse.LandingAfterEjectionEvent, mission.v0.StreamEventsResponse.MarkAddEvent, mission.v0.StreamEventsResponse.MarkChangeEvent, mission.v0.StreamEventsResponse.MarkRemoveEvent, unit.v0.GetPositionResponse, unit.v0.GetTransformResponse

double lat = 1
Latitude in Decimal Degrees format
double lon = 2
Longitude in Decimal Degrees format
double alt = 3
Altitude in Meters above Mean Sea Level (MSL)
double u = 4
Distance between DCS' map origin to object in meters on west-east axis.
double v = 5
Distance between DCS' map origin to object in meters on north-south axis.

* An instance of a DCS scenery object

Used in: Initiator, Target

uint32 id = 1
The id of the scenery
string type = 2
The DCS type-name of the scenery
optional Position position = 3
The position of the scenery

* An instance of a DCS static object These objects are often buildings but can also be vehicles that have no AI or other game behaviour aside from being destroyable

Used in: coalition.v0.GetStaticObjectsResponse, Initiator, Target

uint32 id = 1
The DCS generated ID
optional string type = 2
The DCS type-name of the static
string name = 3
The name of the static
Coalition coalition = 4
The coalition the static belongs to
optional Position position = 5
The position of the static

The target of an event The target of an event. For things like shooting events it is usually a vehicle but it can be almost anything depending on the event

Used in: mission.v0.StreamEventsResponse.DetailedFailureEvent, mission.v0.StreamEventsResponse.DiscardChairAfterEjectionEvent, mission.v0.StreamEventsResponse.EjectionEvent, mission.v0.StreamEventsResponse.HitEvent, mission.v0.StreamEventsResponse.KillEvent, unit.v0.GetRadarResponse, world.v0.SearchObjectsResponse

oneof target
- Unknown unknown = 1
- Unit unit = 2
- Weapon weapon = 3
- Static static = 4
- Scenery scenery = 5
- Airbase airbase = 6
- Cargo cargo = 7

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

Used in: coalition.v0.GetPlayerUnitsResponse, Airbase, Contact, Initiator, MarkPanel, Target, group.v0.GetUnitsResponse, mission.v0.StreamEventsResponse.SrsConnectEvent, mission.v0.StreamEventsResponse.SrsDisconnectEvent, mission.v0.StreamUnitsResponse, srs.v0.GetClientsResponse.Client, unit.v0.GetResponse

uint32 id = 1
The DCS generated ID
string name = 2
The name of the unit as assigned in the mission editor
string callsign = 3
The DCS assigned callsign if one exists. e.g. "Enfield 11"
Coalition coalition = 4
The coalition the unit belongs to
optional string type = 5
The DCS type-name of the unit. e.g "MiG-29A", "ZSU_57_2" or "Hawk ln"
optional Position position = 6
The position of the unit
optional Orientation orientation = 7
The orientation of the unit in both 2D and 3D space
optional Velocity velocity = 8
The velocity of the unit in both 2D and 3D space
optional string player_name = 9
The name of the player if one is in control of the unit
optional Group group = 10
The group that the unit belongs to
uint32 number_in_group = 11
The number of this unit in the group. Does not change as units are destroyed

* 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

Used in: Contact, Initiator, Target

string name = 1

* A vector in a right-handed coordinate system where +x is north, -x south, +z is east, -z west, +y up and -y down.

Used in: Orientation, Velocity, world.v0.PyramidVolume

double x = 1
double y = 2
double z = 3

* The orientation of an object in 3D space.

Used in: Unit, Weapon, unit.v0.GetTransformResponse

double heading = 1
The heading the object is moving to (use `orientation.heading` to get the heading the nose is pointing to).
double speed = 2
The horizontal speed of the unit. If it is doing mach one straight up then the speed will be 0
optional Vector velocity = 3
The direction the object is traveling to, and speed (magnitude of the vector) the object is traveling with.

* An instance of a DCS weapon These weapons include everything from autocannon HE shells up to massive ship-killer missiles

Used in: Contact, Initiator, Target, mission.v0.StreamEventsResponse.HitEvent, mission.v0.StreamEventsResponse.KillEvent, mission.v0.StreamEventsResponse.ShotEvent

uint32 id = 1
The DCS generated ID
optional string type = 2
The DCS type-name of the weapon. e.g "Matra_S530D", "HAWK_RAKETA" or "weapons.shells.53-UOR-281U"
optional Position position = 3
The position of the Weapon
optional Orientation orientation = 4
The orientation of the unit in both 2D and 3D space
optional Velocity velocity = 5
The velocity of the unit in both 2D and 3D space

package dcs.common.v0

message Airbase

optional Unit unit = 1

string name = 2

string callsign = 3

Coalition coalition = 4

optional Position position = 6

AirbaseCategory category = 7

string display_name = 8

enum AirbaseCategory

AIRBASE_CATEGORY_UNSPECIFIED = 0

AIRBASE_CATEGORY_AIRDROME = 1

AIRBASE_CATEGORY_HELIPAD = 2

AIRBASE_CATEGORY_SHIP = 3

message Cargo

enum Coalition

COALITION_ALL = 0

COALITION_NEUTRAL = 1

COALITION_RED = 2

COALITION_BLUE = 3

message Contact

uint32 id = 1

bool visible = 2

bool distance = 3

oneof target

Unknown object = 4

Unit unit = 5

Weapon weapon = 6

enum Country

COUNTRY_UNSPECIFIED = 0

COUNTRY_RUSSIA = 1

COUNTRY_UKRAINE = 2

COUNTRY_UNITED_STATES_OF_AMERICA = 3

COUNTRY_TURKEY = 4

COUNTRY_UNITED_KINGDOM = 5

COUNTRY_FRANCE = 6

COUNTRY_GERMANY = 7

COUNTRY_AGGRESSORS = 8

COUNTRY_CANADA = 9

COUNTRY_SPAIN = 10

COUNTRY_THE_NETHERLANDS = 11

COUNTRY_BELGIUM = 12

COUNTRY_NORWAY = 13

COUNTRY_DENMARK = 14

COUNTRY_UNUSED = 15

COUNTRY_ISRAEL = 16

COUNTRY_GEORGIA = 17

COUNTRY_INSURGENTS = 18

COUNTRY_ABKHAZIA = 19

COUNTRY_SOUTH_OSETIA = 20

COUNTRY_ITALY = 21

COUNTRY_AUSTRALIA = 22

COUNTRY_SWITZERLAND = 23

COUNTRY_AUSTRIA = 24

COUNTRY_BELARUS = 25

COUNTRY_BULGARIA = 26

COUNTRY_CZECH_REPUBLIC = 27

COUNTRY_CHINA = 28

COUNTRY_CROATIA = 29

COUNTRY_EGYPT = 30

COUNTRY_FINLAND = 31

COUNTRY_GREECE = 32

COUNTRY_HUNGARY = 33

COUNTRY_INDIA = 34

COUNTRY_IRAN = 35

COUNTRY_IRAQ = 36

COUNTRY_JAPAN = 37

COUNTRY_KAZAKHSTAN = 38

COUNTRY_NORTH_KOREA = 39

COUNTRY_PAKISTAN = 40

COUNTRY_POLAND = 41

COUNTRY_ROMANIA = 42

COUNTRY_SAUDI_ARABIA = 43

COUNTRY_SERBIA = 44

COUNTRY_SLOVAKIA = 45

COUNTRY_SOUTH_KOREA = 46

COUNTRY_SWEDEN = 47

COUNTRY_SYRIA = 48

COUNTRY_YEMEN = 49

COUNTRY_VIETNAM = 50