Server: Move Command Parser out of player.qc and revamp command system.

Commands are now stored in a table/struct that is referenced by
SV_ParseClientCommand, with a system for printing command information
and status codes. :^)
This commit is contained in:
Steam Deck User 2022-12-16 13:53:17 -05:00
parent 0d8da55cf2
commit d4fafff812
7 changed files with 137 additions and 51 deletions

View file

@ -15,6 +15,7 @@
../source/server/rounds.qc
../source/server/nzdparser.qc
../source/server/main.qc
../source/server/utilities/command_parser.qc
../source/server/player.qc
../source/server/damage.qc

View file

@ -10,6 +10,7 @@
../source/server/rounds.qc
../source/server/nzdparser.qc
../source/server/main.qc
../source/server/utilities/command_parser.qc
../source/server/player.qc
../source/server/damage.qc

View file

@ -13,7 +13,8 @@
../source/server/dummies/generic.qc
../source/server/rounds.qc
../source/server/nzdparser.qc
../source/server/main.qc
../source/server/main.qc
../source/server/utilities/command_parser.qc
../source/server/player.qc
../source/server/damage.qc

View file

@ -14,6 +14,7 @@
../source/server/rounds.qc
../source/server/nzdparser.qc
../source/server/main.qc
../source/server/utilities/command_parser.qc
../source/server/player.qc
../source/server/damage.qc

View file

@ -13,7 +13,8 @@
../source/server/dummies/generic.qc
../source/server/rounds.qc
../source/server/nzdparser.qc
../source/server/main.qc
../source/server/main.qc
../source/server/utilities/command_parser.qc
../source/server/player.qc
../source/server/damage.qc

View file

@ -1,5 +1,5 @@
/*
server/nzdparser.qc
server/player.qc
Various stuff done for the player, including per-frame functions
like PlayerPreThink and PlayerPostThink, also client specific
@ -678,54 +678,6 @@ void() SetChangeParms =
{
};
//
// SV_ParseClientCommand(command_string)
// Server-Side client command parser to add special
// gameplay commands that interact with QuakeC.
//
void(string command_string) SV_ParseClientCommand =
{
// If true, we will avoid sending the command info
// to the client.
float client_parse_override = true;
// Get the string ready for arg parsing
tokenize(command_string);
// Grab the command string
string command = argv(0);
// Check for 'say' prefix (`cl_chatmode 2` will append it
// to everything unregistered by the client). Re-tokenize
// if found.
if (command == "say") {
string fixed_command_string = argv(1);
tokenize(fixed_command_string);
command = argv(0);
}
// Now iterate over our commands
switch(command) {
// addmoney <point_value>:
// gives `point_value` amount of points to the client
// who requested it.
case "addmoney":
float point_value = stof(argv(1));
addmoney(self, point_value, 0);
break;
default:
client_parse_override = false;
break;
}
// Client override was disabled, so let the engine
// deal with whatever was sent.
#ifdef PC
if (client_parse_override == false)
clientcommand(self, command_string);
#endif // PC
};
#ifdef PC
void() SV_RunClientCommand =
{

View file

@ -0,0 +1,129 @@
/*
server/utilities/command_parser.qc
Contains SV_ParseClientCommand(), helper functions for server
commands, and a table storing command information. Modeled after
pr_cmds.
Copyright (C) 2021-2022 NZ:P Team
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to:
Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA
*/
// Needed to iterate through all of the command table.
#define NUMBER_OF_COMMANDS 1
// Success/Failure return codes
#define COMMAND_SUCCESS 0
#define COMMAND_FAILURE 1
//
// Command_addmoney(params)
// Usage: addmoney <point_value>
// Gives <point_value> amount of points to the client
// who requested it.
//
float(string params) Command_addmoney =
{
// Grab parameters.
tokenize(params);
float point_value = stof(argv(0));
// Safety checks
if (point_value == 0) {
sprint(self, 1, "Command_addmoney: <point_value> is either zero or blank string. Failing.\n");
return COMMAND_FAILURE;
}
// Assign points to the player.
addmoney(self, point_value, 0);
return COMMAND_SUCCESS;
}
//
// Server command table
// command_name : Command string entered into developer console.
// command_function : QuakeC function called when command is executed.
// Returns 0 for success, 1 for failure.
// requires_arguments : Whether or not to expect arguments to be passed
// with the command.
// command_description : Called when no params (when applicable) are given.
//
var struct {
string command_name;
float(string params) command_function;
float requires_arguments;
string command_description;
} server_commands[] = {
{"addmoney", Command_addmoney, true, "Usage: addmoney <point_value>\n Gives `point_value` amount of points to the client who requested it.\n"}
};
//
// SV_ParseClientCommand(command_string)
// Server-Side client command parser to add special
// gameplay commands that interact with QuakeC.
//
void(string command_string) SV_ParseClientCommand =
{
// If true, we will avoid sending the command info
// to the client.
float client_parse_override = false;
// Get the string ready for arg parsing
tokenize(command_string);
// Grab the command string
string command = argv(0);
// Check for 'say' prefix (`cl_chatmode 2` will append it
// to everything unregistered by the client). Re-tokenize
// if found.
if (command == "say") {
string fixed_command_string = argv(1);
tokenize(fixed_command_string);
command = argv(0);
}
// Now iterate over our commands
for (float i = 0; i < NUMBER_OF_COMMANDS; i++) {
// Command names match
if (command == server_commands[i].command_name) {
// Override Client Commands
client_parse_override = true;
// Return description if no params are given
if (argv(1) == "" && server_commands[i].requires_arguments == true) {
sprint(self, 1, server_commands[i].command_description);
} else {
if (server_commands[i].command_function(argv(1)) == COMMAND_FAILURE) {
sprint(self, 1, "Command executed but failed to complete.\n");
}
}
}
}
// Client override was disabled, so let the engine
// deal with whatever was sent.
#ifdef PC
if (client_parse_override == false)
clientcommand(self, command_string);
#endif // PC
};