package dcs.hook.v0

Get desktop application:
View/edit binary Protocol Buffers messages

APis that are part of the hook environment

• rpc BanPlayer (BanPlayerRequest, BanPlayerResponse)

  hook.proto:57

  Bans a player that is currently connected to the server

  message BanPlayerRequest

  hook.proto:170

  • uint32 id = 1

    The session ID of the player

  • uint32 period = 2

    The period of the ban in seconds

  • string reason = 3

    The reason for the ban

  message BanPlayerResponse

  hook.proto:179

  • bool banned = 1

    Was the player successfully banned

• rpc Eval (EvalRequest, EvalResponse)

  hook.proto:45

  Evaluate some Lua inside of the hook environment and return the result as a JSON string. Disabled by default.

  message EvalRequest

  hook.proto:142

  • string lua = 1

  message EvalResponse

  hook.proto:146

  • string json = 1

• rpc ExitProcess (ExitProcessRequest, ExitProcessResponse)

  hook.proto:48

  https://wiki.hoggitworld.com/view/DCS_func_exitProcess

  message ExitProcessRequest

  hook.proto:150

  (message has no fields)

  message ExitProcessResponse

  hook.proto:153

  (message has no fields)

• rpc GetBallisticsCount (GetBallisticsCountRequest, GetBallisticsCountResponse)

  hook.proto:73

  Get a count of ballistics objects

  message GetBallisticsCountRequest

  hook.proto:234

  (message has no fields)

  message GetBallisticsCountResponse

  hook.proto:237

  • uint32 count = 1

• rpc GetBannedPlayers (GetBannedPlayersRequest, GetBannedPlayersResponse)

  hook.proto:63

  Get a list of all the banned players

  message GetBannedPlayersRequest

  hook.proto:194

  (message has no fields)

  message GetBannedPlayersResponse

  hook.proto:197

  • repeated BanDetails bans = 1

• rpc GetMissionDescription (GetMissionDescriptionRequest, GetMissionDescriptionResponse)

  hook.proto:16

  https://wiki.hoggitworld.com/view/DCS_func_getMissionDescription

  message GetMissionDescriptionRequest

  hook.proto:91

  (message has no fields)

  message GetMissionDescriptionResponse

  hook.proto:94

  • string description = 1

• rpc GetMissionFilename (GetMissionFilenameRequest, GetMissionFilenameResponse)

  hook.proto:12

  https://wiki.hoggitworld.com/view/DCS_func_getMissionFilename

  message GetMissionFilenameRequest

  hook.proto:84

  (message has no fields)

  message GetMissionFilenameResponse

  hook.proto:87

  • string name = 1

• rpc GetMissionName (GetMissionNameRequest, GetMissionNameResponse)

  hook.proto:9

  https://wiki.hoggitworld.com/view/DCS_func_getMissionName

  message GetMissionNameRequest

  hook.proto:77

  (message has no fields)

  message GetMissionNameResponse

  hook.proto:80

  • string name = 1

• rpc GetPaused (GetPausedRequest, GetPausedResponse)

  hook.proto:20

  https://wiki.hoggitworld.com/view/DCS_func_getPause

  message GetPausedRequest

  hook.proto:98

  (message has no fields)

  message GetPausedResponse

  hook.proto:101

  • bool paused = 1

• rpc GetRealTime (GetRealTimeRequest, GetRealTimeResponse)

  hook.proto:70

  https://wiki.hoggitworld.com/view/DCS_func_getRealTime

  message GetRealTimeRequest

  hook.proto:226

  (message has no fields)

  message GetRealTimeResponse

  hook.proto:229

  • double time = 1

    The current time in a mission relative to the DCS start time

• rpc GetUnitType (GetUnitTypeRequest, GetUnitTypeResponse)

  hook.proto:67

  https://wiki.hoggitworld.com/view/DCS_func_getUnitType

  message GetUnitTypeRequest

  hook.proto:216

  • string id = 1

    The slot or unit ID of the unit to retrieve the type of

  message GetUnitTypeResponse

  hook.proto:221

  • string type = 1

    Type of unit (e.g. "F-14B")

• rpc IsMultiplayer (IsMultiplayerRequest, IsMultiplayerResponse)

  hook.proto:51

  https://wiki.hoggitworld.com/view/DCS_func_isMultiplayer

  message IsMultiplayerRequest

  hook.proto:156

  (message has no fields)

  message IsMultiplayerResponse

  hook.proto:159

  • bool multiplayer = 1

• rpc IsServer (IsServerRequest, IsServerResponse)

  hook.proto:54

  https://wiki.hoggitworld.com/view/DCS_func_isServer

  message IsServerRequest

  hook.proto:163

  (message has no fields)

  message IsServerResponse

  hook.proto:166

  • bool server = 1

• rpc LoadMission (LoadMissionRequest, LoadMissionResponse)

  hook.proto:40

  Load a specific mission file. This does not need to be in the mission list.

  message LoadMissionRequest

  hook.proto:128

  • string file_name = 1

    The full path to the .miz file to be loaded

  message LoadMissionResponse

  hook.proto:133

  (message has no fields)

• rpc LoadNextMission (LoadNextMissionRequest, LoadNextMissionResponse)

  hook.proto:35

  Load the next mission in the server mission list. Note that it does not loop back to the first mission once the end of the mission list has been reached

  message LoadNextMissionRequest

  hook.proto:118

  (message has no fields)

  message LoadNextMissionResponse

  hook.proto:121

  • bool loaded = 1

    Was the next mission successfully loaded. SHOULD return false when the end of the mission list has been reached but DCS appears to always return true

• rpc ReloadCurrentMission (ReloadCurrentMissionRequest, ReloadCurrentMissionResponse)

  hook.proto:29

  Reload the currently running mission

  message ReloadCurrentMissionRequest

  hook.proto:112

  (message has no fields)

  message ReloadCurrentMissionResponse

  hook.proto:115

  (message has no fields)

• rpc SetPaused (SetPausedRequest, SetPausedResponse)

  hook.proto:23

  https://wiki.hoggitworld.com/view/DCS_func_setPause

  message SetPausedRequest

  hook.proto:105

  • bool paused = 1

  message SetPausedResponse

  hook.proto:109

  (message has no fields)

• rpc StopMission (StopMissionRequest, StopMissionResponse)

  hook.proto:26

  https://wiki.hoggitworld.com/view/DCS_func_stopMission

  message StopMissionRequest

  hook.proto:136

  (message has no fields)

  message StopMissionResponse

  hook.proto:139

  (message has no fields)

• rpc UnbanPlayer (UnbanPlayerRequest, UnbanPlayerResponse)

  hook.proto:60

  Unbans a player via their globally unique ID

  message UnbanPlayerRequest

  hook.proto:184

  • string ucid = 1

    The globally unique ID of the player

  message UnbanPlayerResponse

  hook.proto:189

  • bool unbanned = 1

    Was the player successfully unbanned

Used in: GetBannedPlayersResponse

• string ucid = 1

  The globally unique ID of the player

• string ip_address = 2

  The IP address the user had when they were banned

• string player_name = 3

  The Name of the player at the time of the ban

• string reason = 4

  The reason given for the ban

• uint64 banned_from = 5

  When the ban was issued in unixtime

• uint64 banned_until = 6

  When the ban will expire in unixtime