From df9150f30211e040c5322479d349eae11a190025 Mon Sep 17 00:00:00 2001
From: Ben Lubar <ben.lubar@gmail.com>
Date: Tue, 3 Jul 2018 15:36:41 -0500
Subject: [PATCH] Add documentation for RPC functions supported by
 RemoteFortressReader and ISOWorldRemote.

---
 plugins/proto/RemoteFortressReader.proto | 36 ++++++++++++++++++++++++
 plugins/proto/isoworldremote.proto       |  3 ++
 2 files changed, 39 insertions(+)

diff --git a/plugins/proto/RemoteFortressReader.proto b/plugins/proto/RemoteFortressReader.proto
index 3298d42fb..21233ae62 100644
--- a/plugins/proto/RemoteFortressReader.proto
+++ b/plugins/proto/RemoteFortressReader.proto
@@ -5,6 +5,42 @@ option optimize_for = LITE_RUNTIME;
 
 import "ItemdefInstrument.proto";
 
+// RPC GetMaterialList : EmptyMessage -> MaterialList
+// RPC GetGrowthList : EmptyMessage -> MaterialList
+// RPC GetBlockList : BlockRequest -> BlockList
+// RPC CheckHashes : EmptyMessage -> EmptyMessage
+// RPC GetTiletypeList : EmptyList -> TiletypeList
+// RPC GetPlantList : BlockRequest -> PlantList
+// RPC GetUnitList : EmptyMessage -> UnitList
+// RPC GetUnitListInside : BlockRequest -> UnitList
+// RPC GetViewInfo : EmptyMessage -> ViewInfo
+// RPC GetMapInfo : EmptyMessage -> MapInfo
+// RPC ResetMapHashes : EmptyMessage -> EmptyMessage
+// RPC GetItemList : EmptyMessage -> MaterialList
+// RPC GetBuildingDefList : EmptyMessage -> BuildingList
+// RPC GetWorldMap : EmptyMessage -> WorldMap
+// RPC GetWorldMapNew : EmptyMessage -> WorldMap
+// RPC GetRegionMaps : EmptyMessage -> RegionMaps
+// RPC GetRegionMapsNew : EmptyMessage -> RegionMaps
+// RPC GetCreatureRaws : EmptyMessage -> CreatureRawList
+// RPC GetPartialCreatureRaws : ListRequest -> CreatureRawList
+// RPC GetWorldMapCenter : EmptyMessage -> WorldMap
+// RPC GetPlantRaws : EmptyMessage -> PlantRawList
+// RPC GetPartialPlantRaws : ListRequest -> PlantRawList
+// RPC CopyScreen : EmptyMessage -> ScreenCapture
+// RPC PassKeyboardEvent : KeyboardEvent -> EmptyMessage
+// RPC SendDigCommand : DigCommand -> EmptyMessage
+// RPC SetPauseState : SingleBool -> EmptyMessage
+// RPC GetPauseState : EmptyMessage -> SingleBool
+// RPC GetVersionInfo : EmptyMessage -> VersionInfo
+// RPC GetReports : EmptyMessage -> Status
+// RPC MoveCommand : MoveCommandParams -> EmptyMessage
+// RPC JumpCommand : MoveCommandParams -> EmptyMessage
+// RPC MenuQuery : EmptyMessage -> MenuContents
+// RPC MovementSelectCommand : IntMessage -> EmptyMessage
+// RPC MiscMoveCommand : MiscMoveParams -> EmptyMessage
+// RPC GetLanguage : EmptyMessage -> Language
+
 //We use shapes, etc, because the actual tiletypes may differ between DF versions.
 enum TiletypeShape
 {
diff --git a/plugins/proto/isoworldremote.proto b/plugins/proto/isoworldremote.proto
index d160d9968..3bbe27042 100644
--- a/plugins/proto/isoworldremote.proto
+++ b/plugins/proto/isoworldremote.proto
@@ -50,6 +50,7 @@ message EmbarkTile {
     optional bool is_valid = 7;
 }
 
+// RPC GetEmbarkTile : TileRequest -> EmbarkTile
 message TileRequest {
     optional int32 want_x = 1;
     optional int32 want_y = 2;
@@ -59,6 +60,7 @@ message MapRequest {
     optional string save_folder = 1;
 }
 
+// RPC GetEmbarkInfo : MapRequest -> MapReply
 message MapReply {
     required bool available = 1;
     optional int32 region_x = 2;
@@ -69,6 +71,7 @@ message MapReply {
     optional int32 current_season = 7;
 }
 
+// RPC GetRawNames : MapRequest -> RawNames
 message RawNames {
     required bool available = 1;
     repeated string inorganic = 2;