package dcs.mission.v0
Get desktop application:
View/edit binary Protocol Buffers messages
service MissionService
mission.proto:14Contains the streaming APIs that streaming information out of the DCS server.
rpc AddCoalitionCommand (, )
mission.proto:52Adds a new coalition command See https://wiki.hoggitworld.com/view/DCS_func_addCommandForCoalition
message
mission.proto:691Adds an F10 radio command visible to all players in the specified coalition. When the player activates the command then a `coalitionCommand` event will be emitted to all connected DCS-gRPC clients for processing as they see fit. The emitted event will include the coalition.
common.v0.Coalition coalition = 1
The coalition whose players will be able to see and run the command
string name = 2
The name of the command that is displayed to the player. It will form the last entry in the returned path.
repeated string path = 3
The menu path the command will appear under. This can be empty if you want the command to be on the first level under the F10 menu. This path must already have been created.
optional details = 4
A struct containing data that will be included in the emitted event to the DCS-gRPC clients
message
mission.proto:706repeated string path = 1
The full path to the command, including the command name. Use this path to delete the command.
Adds a new coalition command sub menu See https://wiki.hoggitworld.com/view/DCS_func_addSubMenuForCoalition
message
mission.proto:712common.v0.Coalition coalition = 1
The coalition whose players will be able to see the submenu
string name = 2
The name of the submenu that is displayed to the player. It will form the last entry in the returned path.
repeated string path = 3
The menu path the submenu will appear under. This can be empty if you want the submenu to be on the first level under the F10 menu. This path must already have been created using this command. you cannot create a nested submenu tree in one command.
message
mission.proto:725repeated string path = 1
The full path to the submenu, including the submenu name. Use this path to add another submenu or command underneath it or delete the submenu.
rpc AddGroupCommand (, )
mission.proto:67Adds a new group command See https://wiki.hoggitworld.com/view/DCS_func_addCommandForGroup
message
mission.proto:748Adds an F10 radio command visible to all players in the specified group. When the player activates the command then a `groupCommand` event will be emitted to all connected DCS-gRPC clients for processing as they see fit. The emitted event will include the group name.
string group_name = 1
The name of the group whose players will be able to see and execute the command. TODO (Figure out if this persists across spawns)
string name = 2
The name of the command that is displayed to the player. It will form the last entry in the returned path.
repeated string path = 3
The menu path the command will appear under. This can be empty if you want the command to be on the first level under the F10 menu. This path must already have been created.
optional details = 4
A struct containing data that will be included in the emitted event to the DCS-gRPC clients
message
mission.proto:764repeated string path = 1
The full path to the command, including the command name. Use this path to delete the command.
Adds a new group command sub menu See https://wiki.hoggitworld.com/view/DCS_func_addSubMenuForGroup
message
mission.proto:770string group_name = 1
The name of the group whose players will be able to see the submenu
string name = 2
The name of the submenu that is displayed to the player. It will form the last entry in the returned path.
repeated string path = 3
The menu path the submenu will appear under. This can be empty if you want the submenu to be on the first level under the F10 menu. This path must already have been created using this command. you cannot create a nested submenu tree in one command.
message
mission.proto:783repeated string path = 1
The full path to the submenu, including the submenu name. Use this path to add another submenu or command underneath it or delete the submenu.
rpc AddMissionCommand (, )
mission.proto:37Adds a new mission command See https://wiki.hoggitworld.com/view/DCS_func_addCommand
message
mission.proto:640Adds an F10 radio command visible to all players in all coalitions. When the player activates the command then a `missionCommand` event will be emitted to all connected DCS-gRPC clients for processing as they see fit.
string name = 1
The name of the command that is displayed to the player. It will form the last entry in the returned path.
repeated string path = 2
The menu path the command will appear under. This can be empty if you want the command to be on the first level under the F10 menu. This path must already have been created.
optional details = 3
A struct containing data that will be included in the emitted event to the DCS-gRPC clients
message
mission.proto:653repeated string path = 1
The full path to the command, including the command name. Use this path to delete the command.
Adds a new command sub menu See https://wiki.hoggitworld.com/view/DCS_func_addSubMenu
message
mission.proto:659string name = 1
The name of the submenu that is displayed to the player. It will form the last entry in the returned path.
repeated string path = 2
The menu path the submenu will appear under. This can be empty if you want the submenu to be on the first level under the F10 menu. This path must already have been created using this command. you cannot create a nested submenu tree in one command.
message
mission.proto:670repeated string path = 1
The full path to the submenu, including the submenu name. Use this path to add another submenu or command underneath it or delete the submenu.
Returns the mission's in-game current time as an ISO 8601 formatted datetime string.
message
mission.proto:627(message has no fields)
message
mission.proto:630string datetime = 1
rpc GetScenarioStartTime (, )
mission.proto:27Returns the mission's in-game starttime as an ISO 8601 formatted datetime string.
message
mission.proto:620(message has no fields)
message
mission.proto:623string datetime = 1
rpc GetSessionId (, )
mission.proto:82Returns an ID for the current session. The ID will change upon mission change or server restart.
message
mission.proto:800(message has no fields)
message
mission.proto:803int64 session_id = 1
Removes a registered coalition command. See https://wiki.hoggitworld.com/view/DCS_func_removeItemForCoalition
message
mission.proto:731common.v0.Coalition coalition = 1
The coalition whose players will have the menu item removed
repeated string path = 2
The full path to the menu item, which can be a submenu or a command, to be removed. Deleting a menu item will delete all children it may have.
message
mission.proto:739(message has no fields)
Removes a group coalition command. See https://wiki.hoggitworld.com/view/DCS_func_removeItemForGroup
message
mission.proto:789string group_name = 1
The group whose players will have the menu item removed
repeated string path = 2
The full path to the menu item, which can be a submenu or a command, to be removed. Deleting a menu item will delete all children it may have.
message
mission.proto:797(message has no fields)
Removes a registered mission command. See https://wiki.hoggitworld.com/view/DCS_func_removeItem
message
mission.proto:676repeated string path = 1
The full path to the menu item, which can be a submenu or a command, to be removed. Deleting a menu item will delete all children it may have.
message
mission.proto:682(message has no fields)
rpc StreamEvents (, stream )
mission.proto:17Streams DCS game generated Events. See https://wiki.hoggitworld.com/view/Category:Events
message
mission.proto:86(message has no fields)
message
mission.proto:90The DCS Event information. Contains event information and a timestamp.
double time = 1
The event's mission time.
oneof event
shot = 4
hit = 5
takeoff = 6
land = 7
crash = 8
ejection = 9
refueling = 10
dead = 11
pilot_dead = 12
base_capture = 13
mission_start = 14
mission_end = 15
refueling_stop = 17
@exclude 16 reserved for S_EVENT_TOOK_CONTROL
birth = 18
human_failure = 19
detailed_failure = 20
engine_startup = 21
engine_shutdown = 22
player_enter_unit = 23
player_leave_unit = 24
shooting_start = 26
@exclude 25 reserved for S_EVENT_PLAYER_COMMENT
shooting_end = 27
mark_add = 28
mark_change = 29
mark_remove = 30
kill = 31
score = 32
unit_lost = 33
landing_after_ejection = 34
discard_chair_after_ejection = 36
@exclude 35 reserved for S_EVENT_PARATROOPER_LENDING
weapon_add = 37
landing_quality_mark = 39
@exclude 38 reserved for S_EVENT_TRIGGER_ZONE
@exclude 40 reserved for S_EVENT_BDA
runway_takeoff = 54
runway_touch = 55
connect = 8192
The following events are additions on top of DCS's own event enum, which is why they start at 8192 to give DCS plenty of space for new built-in events.
disconnect = 8193
player_send_chat = 8194
player_change_slot = 8195
mission_command = 8196
coalition_command = 8197
group_command = 8198
simulation_fps = 8199
tts = 8200
srs_connect = 8201
srs_disconnect = 8202
rpc StreamUnits (, stream )
mission.proto:23Streams unit updates Provides similar functionality as Tacview but at a much lower update rate so puts less load on the server. Suitable for things like online maps but not as a Tacview replacement.
message
mission.proto:584optional uint32 poll_rate = 1
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
optional uint32 max_backoff = 2
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
common.v0.GroupCategory category = 3
The type of the unit to stream movements. Different categories of units would move at different speeds, which allows the stream to be configured with the appropriate polling rates. `GROUP_CATEGORY_UNSPECIFIED` would return all the units.
message
mission.proto:603double time = 1
oneof update
unit = 2
The unit is either new or its position or attitude changed.
gone = 3
The unit does not exist anymore.
message
mission.proto:183Occurs when a ground unit captures either an airbase or a farp.
Used in:
optional initiator = 1
The object that captured the base.
optional place = 2
The airbase that was captured, can be a FARP or Airbase
message
mission.proto:205Occurs when any object is spawned into the mission.
Used in:
optional initiator = 1
The object that was spawned.
optional place = 2
The airbase, farp or ship the unit took off from.
message
mission.proto:459Used in:
common.v0.Coalition coalition = 1
The coalition of the player who ran the command
optional details = 2
A struct containing details of the command that was run by a player
message
mission.proto:411* Fired when a player connected to the server.
Used in:
string addr = 1
The player's IP and port.
string name = 2
The name of the player.
string ucid = 3
The player's unique client identifier (used to ban a player).
uint32 id = 4
The player's id in the current server session (used to for name/slot/... changes).
message
mission.proto:148Occurs when an aircraft crashes into the ground and is completely destroyed.
Used in:
optional initiator = 1
The object that crashed.
message
mission.proto:168Occurs when an object is completely destroyed.
Used in:
optional initiator = 1
The object that has been destroyed.
message
mission.proto:220Occurs when a system on an aircraft fails. This can be due to damage or due to random failures set up in the mission editor.
Used in:
optional target = 1
The target the failure occurred for.
message
mission.proto:358A pilot detached from their ejection seat.
Used in:
optional initiator = 1
The ejection seat.
optional target = 2
The pilot.
message
mission.proto:447* Fired when a player disconnected from the server (not fired for the server's player).
Used in:
uint32 id = 1
The player's id in the current server session.
DisconnectReason reason = 2
The reason a player disconnected for.
* The reason a player disconnected for.
Used in:
DISCONNECT_REASON_UNSPECIFIED = 0
DISCONNECT_REASON_THATS_OKAY = 1
DISCONNECT_REASON_INVALID_ADDRESS = 2
DISCONNECT_REASON_CONNECT_FAILED = 3
DISCONNECT_REASON_WRONG_VERSION = 4
DISCONNECT_REASON_PROTOCOL_ERROR = 5
DISCONNECT_REASON_TIMEOUT = 6
DISCONNECT_REASON_INVALID_PASSWORD = 101
DISCONNECT_REASON_BANNED = 102
DISCONNECT_REASON_BAD_CALLSIGN = 103
DISCONNECT_REASON_TAINTED_CLIENT = 104
DISCONNECT_REASON_KICKED = 105
DISCONNECT_REASON_REFUSED = 106
DISCONNECT_REASON_DENIED_TRIAL_ONLY = 107
message
mission.proto:154Occurs when a pilot ejects from its aircraft.
Used in:
optional initiator = 1
The unit a pilot ejected from.
optional target = 3
The ejection seat.
message
mission.proto:233Used in:
optional initiator = 1
Occurs when any aircraft shuts down its engines.
optional place = 2
The airbase, farp or ship the unit shut down their engine at.
message
mission.proto:226Occurs when any aircraft starts its engines.
Used in:
optional initiator = 1
The object that starts its engines.
optional place = 2
The airbase, farp or ship the unit started their engine at.
message
mission.proto:466Used in:
optional group = 1
Details of the group to which the player who ran the command is a unit of
optional details = 2
A struct containing details of the command that was run by a player
message
mission.proto:101Occurs when an object is hit by a weapon.
Used in:
optional initiator = 1
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).
optional weapon = 2
The weapon that the target has been hit with.
optional target = 3
The object that has been hit.
optional string weapon_name = 4
The weapon the target got hit by.
message
mission.proto:213Occurs e.g. when a player controlled aircraft blacks out.
Used in:
optional initiator = 1
The unit the system failure occurred in.
message
mission.proto:327Occurs when an object is killed by a weapon.
Used in:
optional initiator = 1
The object that fired the weapon.
optional weapon = 2
The weapon that the target has been killed with.
optional target = 3
The object that has been killed.
optional string weapon_name = 4
The name of the weapon that killed the target (exists instead of weapon for weapons that trigger the shooting start and end events).
message
mission.proto:131Occurs when an aircraft lands at an airbase, farp or ship.
Used in:
optional initiator = 1
The object that landed.
optional place = 2
The airbase, farp or ship the unit landed at.
message
mission.proto:350A pilot detached from their ejection seat.
Used in:
optional initiator = 1
The ejected pilot.
optional place = 2
The position the pilot landed at.
message
mission.proto:375Occurs when an aircraft receives an LSO rating after recovering on an aircraft carrier.
Used in:
optional initiator = 1
The aircraft that received the rating.
string comment = 2
The rating.
optional place = 3
The ship the unit landed at.
message
mission.proto:273Occurs when marks get added to the mission by players or scripting functions.
Used in:
optional initiator = 1
The object that added the mark.
oneof visibility
uint64 group_id = 2
The group the mark's visibility is restricted for.
common.v0.Coalition coalition = 3
The coalition the mark's visibility is restricted for.
uint32 id = 4
The mark's id.
optional position = 5
The position the mark has been added at.
string text = 6
The mark's label.
message
mission.proto:291Occurs when marks got changed.
Used in:
optional initiator = 1
The object that changed the mark.
oneof visibility
uint64 group_id = 2
The group the mark's visibility is restricted for.
common.v0.Coalition coalition = 3
The coalition the mark's visibility is restricted for.
uint32 id = 4
The mark's id.
optional position = 5
The position of the changed mark.
string text = 6
The mark's label.
message
mission.proto:309Occurs when marks get removed.
Used in:
optional initiator = 1
The object that removed the mark.
oneof visibility
uint64 group_id = 2
The group the mark's visibility is restricted for.
common.v0.Coalition coalition = 3
The coalition the mark's visibility is restricted for.
uint32 id = 4
The mark's id.
optional position = 5
The position the mark has been removed from.
string text = 6
The mark's label.
message
mission.proto:454Used in:
optional details = 1
A struct containing details of the command that was run by a player
message
mission.proto:195Occurs when the mission stops.
Used in:
(message has no fields)
message
mission.proto:191Occurs when the mission starts.
Used in:
(message has no fields)
message
mission.proto:177Occurs 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.
Used in:
optional initiator = 1
The unit the pilot has died in.
message
mission.proto:399fired when the player changes across to a slot
Used in:
uint32 player_id = 1
The player's id in the current server session.
common.v0.Coalition coalition = 2
The slot's coalition
string slot_id = 3
The slot's identifier
message
mission.proto:241Occurs when a player takes direct control of a unit.
Used in:
optional initiator = 1
The unit the player took control of.
message
mission.proto:247Occurs when a player relieves direct control of a unit.
Used in:
optional initiator = 1
The unit the player relieves control of.
message
mission.proto:385Occurs when a chat message is sent on the server
Used in:
uint32 player_id = 1
The player's id in the current server session.
string message = 2
what was typed
common.v0.Coalition coalition = 3
player's coalition
string player_name = 4
player's name
bool to_all = 5
sent to all chat
message
mission.proto:162Occurs when an aircraft connects with a tanker and begins taking on fuel.
Used in:
optional initiator = 1
The object that is receiving fuel.
message
mission.proto:199Occurs when an aircraft is finished taking fuel.
Used in:
optional initiator = 1
he unit that was receiving fuel.
message
mission.proto:123Occurs when an aircraft takes off from an airbase, farp, or ship.
Used in:
optional initiator = 1
The object that took off.
optional place = 2
The airbase, farp or ship the unit took off from.
message
mission.proto:139Occurs when an aircraft lands at an airbase, farp or ship.
Used in:
optional initiator = 1
The object that landed.
optional place = 2
The airbase, farp or ship the unit landed at.
message
mission.proto:340A score change (doesn't contain any useful information)
Used in:
(message has no fields)
message
mission.proto:264Occurs when a unit stops firing a machine gun- or autocannon-based weapon. Event will always correspond with a [ShootingStartEvent] event.
Used in:
optional initiator = 1
The object that was shooting and has no stopped firing.
string weapon_name = 2
The name of the shoot weapon.
message
mission.proto:255Occurs 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].
Used in:
optional initiator = 1
The object that started firing.
string weapon_name = 2
The name of the shoot weapon.
message
mission.proto:93Occurs when a unit fires a weapon (but no machine gun- or autocannon-based weapons - those are handled by [ShootingStartEvent]).
Used in:
optional initiator = 1
The object that fired the weapon.
optional weapon = 2
The weapon that has been fired.
message
mission.proto:477* Fired every second containing simulation FPS information since the previous event.
Used in:
double average = 1
The average FPS since the last event.
message
mission.proto:503* Fired every time a player occuping a unit connects to a frequency on SRS.
Used in:
optional unit = 1
The unit that connected to a frequency in SRS.
uint64 frequency = 2
The radio frequency in Hz the unit connected to.
message
mission.proto:515* Fired every time a player occuping a unit disconnects from a frequency on SRS. It is not fired when the player leaves the unit or the unit dies.
Used in:
optional unit = 1
The unit that disconnected from a frequency in SRS.
uint64 frequency = 2
The radio frequency in Hz the unit disconnected from.
message
mission.proto:115Occurs when an aircraft takes off from an airbase, farp, or ship.
Used in:
optional initiator = 1
The object that took off.
optional place = 2
The airbase, farp or ship the unit took off from.
message
mission.proto:486* Fired for every TTS request that contains the `text_plain` field, for other clients to use e.g. for accessibility use-cases.
Used in:
string text = 1
The plain text that got transmitted.
uint64 frequency = 2
The radio frequency in Hz the transmission got send to.
common.v0.Coalition coalition = 3
The coalition of the transmission.
optional string srs_client_name = 4
Custom name of the SRS client used for the transmission.
message
mission.proto:344A unit got destroyed.
Used in:
optional initiator = 1
The object that got destroyed weapon.
message
mission.proto:366Fired for each payload of an aircraft spawened midair.
Used in:
optional initiator = 1
The object that got spawned.
string weapon_name = 2
The name of the payload.
message
mission.proto:604Used in:
uint32 id = 1
string name = 2