summaryrefslogtreecommitdiff
path: root/library/proto
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-03-19 11:33:30 +0400
committerAlexander Gavrilov2012-03-19 11:33:30 +0400
commitbfb226b92ea9021c199d81e189c35d01c6f1f1a0 (patch)
treea66a1977c9b5d59fd00911b259441dadeeef3076 /library/proto
parent2bec9f6711146472fb1416e16aa8ee563029aa23 (diff)
downloaddfhack-bfb226b92ea9021c199d81e189c35d01c6f1f1a0.tar.gz
dfhack-bfb226b92ea9021c199d81e189c35d01c6f1f1a0.tar.bz2
dfhack-bfb226b92ea9021c199d81e189c35d01c6f1f1a0.tar.xz
Add a few comments.
Diffstat (limited to 'library/proto')
-rw-r--r--library/proto/BasicApi.proto8
-rw-r--r--library/proto/CoreProtocol.proto6
2 files changed, 13 insertions, 1 deletions
diff --git a/library/proto/BasicApi.proto b/library/proto/BasicApi.proto
index 7b105ee8..137f2572 100644
--- a/library/proto/BasicApi.proto
+++ b/library/proto/BasicApi.proto
@@ -4,6 +4,10 @@ option optimize_for = LITE_RUNTIME;
import "Basic.proto";
+// RPC GetVersion : EmptyMessage -> StringMessage
+// RPC GetDFVersion : EmptyMessage -> StringMessage
+
+// RPC GetWorldInfo : EmptyMessage -> GetWorldInfoOut
message GetWorldInfoOut {
enum Mode {
MODE_DWARF = 1;
@@ -27,6 +31,7 @@ message GetWorldInfoOut {
repeated int32 companion_histfig_ids = 10;
};
+// RPC ListEnums : EmptyMessage -> ListEnumsOut
message ListEnumsOut {
repeated EnumItemName material_flags = 1;
repeated EnumItemName inorganic_flags = 2;
@@ -46,6 +51,7 @@ message ListEnumsOut {
repeated EnumItemName profession = 11;
};
+// RPC ListMaterials : ListMaterialsIn -> ListMaterialsOut
message ListMaterialsIn {
optional BasicMaterialInfoMask mask = 1;
@@ -62,6 +68,7 @@ message ListMaterialsOut {
repeated BasicMaterialInfo value = 1;
};
+// RPC ListUnits : ListUnitsIn -> ListUnitsOut
message ListUnitsIn {
optional BasicUnitInfoMask mask = 1;
@@ -81,6 +88,7 @@ message ListUnitsOut {
repeated BasicUnitInfo value = 1;
};
+// RPC ListSquads : ListSquadsIn -> ListSquadsOut
message ListSquadsIn {}
message ListSquadsOut {
repeated BasicSquadInfo value = 1;
diff --git a/library/proto/CoreProtocol.proto b/library/proto/CoreProtocol.proto
index 6f3b8451..92d7c48d 100644
--- a/library/proto/CoreProtocol.proto
+++ b/library/proto/CoreProtocol.proto
@@ -62,18 +62,22 @@ message StringListMessage {
repeated string value = 1;
}
+// RPC BindMethod : CoreBindRequest -> CoreBindReply
message CoreBindRequest {
required string method = 1;
required string input_msg = 2;
required string output_msg = 3;
optional string plugin = 4;
}
-
message CoreBindReply {
required int32 assigned_id = 1;
}
+// RPC RunCommand : CoreRunCommandRequest -> EmptyMessage
message CoreRunCommandRequest {
required string command = 1;
repeated string arguments = 2;
}
+
+// RPC CoreSuspend : EmptyMessage -> IntMessage
+// RPC CoreResume : EmptyMessage -> IntMessage