X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fclient%2Fcommand_db.h;h=ff56984807e219e4c413079d4991e7b51d03ed66;hb=20da835cb5f85fc3416caef6e70bd74711bd75d0;hp=0f2ef77678ff9e39fa2eb52c1087c6b99a5d352d;hpb=c53b1488c5a53e8b12cb3a631763f98010420690;p=plomrogue diff --git a/src/client/command_db.h b/src/client/command_db.h index 0f2ef77..ff56984 100644 --- a/src/client/command_db.h +++ b/src/client/command_db.h @@ -1,4 +1,8 @@ /* src/client/command_db.h + * + * 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 @@ -16,8 +20,8 @@ struct 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 player_control() convention */ + 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 @@ -28,10 +32,12 @@ struct CommandDB -/* Return Command struct for command described by its "dsc_short" member. */ -extern struct Command * get_command_data(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. */