Server/py: Undummify build_fov_map().

[plomrogue] / src / client / command_db.h

diff --git a/src/client/command_db.h b/src/client/command_db.h
index 0d4ffbae8e3653a5748b4de3b07bd257ca41215d..ff56984807e219e4c413079d4991e7b51d03ed66 100644 (file)
--- a/src/client/command_db.h
+++ b/src/client/command_db.h
@@ -1,7 +1,12 @@
 /* src/client/command_db.h
  *
- * The Command DB collects identifiers and verbal descriptions of all commands
- * the user can give.
+ * This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
+ * or any later version. For details on its copyright, license, and warranties,
+ * see the file NOTICE in the root directory of the PlomRogue source package.
+ *
+ * The Command DB collects the commands available to the user by internal name,
+ * description and, optionally, components of a message to send to the server
+ * when calling it.
  */
 
 #ifndef COMMAND_DB_H
@@ -13,9 +18,10 @@
 
 struct Command
 {
-    char * dsc_short; /* short string name of command to be used internally */
-    char * dsc_long;  /* long string description of command for the user */
-    uint8_t id;       /* unique identifier of command */
+    char * dsc_short; /* short name of command to be used internally */
+    char * dsc_long; /* long description of command to be shown to the user */
+    char * server_msg; /* optionally start string of message to send to server*/
+    char arg; /* defines server message suffix by try_server_commands() rules */
 };
 
 struct CommandDB
@@ -26,13 +32,12 @@ struct CommandDB
 
 
 
-/* Give short description of command ("dsc_short"), get its ID. */
-extern uint8_t get_command_id(char * dsc_short);
-
-/* Give short description of command ("dsc_short"), get long description. */
-extern char * get_command_longdsc(char * dsc_short);
+/* Return Command struct for command described by its "dsc_short" member. Return
+ * NULL if no such command is found.
+ */
+extern struct Command * get_command(char * dsc_short);
 
-/* Reads CommandDB from CommandDB file, line by line, until first empty line. */
+/* Read in CommandDB config file. */
 extern void init_command_db();
 
 /* Free all memory allocated with init_command_db. */