1 #include "../../common/command/command.qh"
7 #include "../campaign.qh"
8 #include "../cheats.qh"
9 #include "../cl_player.qh"
10 #include "../ipban.qh"
11 #include "../mapvoting.qh"
12 #include "../scores.qh"
13 #include "../teamplay.qh"
15 #include "../mutators/mutators_include.qh"
18 #include "../../common/vehicles/all.qh"
21 #include "../../common/constants.qh"
22 #include "../../common/deathtypes/all.qh"
23 #include "../../common/mapinfo.qh"
24 #include "../../common/notifications.qh"
25 #include "../../common/physics.qh"
26 #include "../../common/teams.qh"
27 #include "../../common/util.qh"
28 #include "../../common/triggers/triggers.qh"
30 #include "../../common/minigames/sv_minigames.qh"
32 #include "../../common/monsters/all.qc"
33 #include "../../common/monsters/spawn.qh"
34 #include "../../common/monsters/sv_monsters.qh"
36 #include "../../lib/warpzone/common.qh"
38 void ClientKill_TeamChange (float targetteam); // 0 = don't change, -1 = auto, -2 = spec
40 // =========================================================
41 // Server side networked commands code, reworked by Samual
42 // Last updated: December 28th, 2011
43 // =========================================================
45 float SV_ParseClientCommand_floodcheck()
47 if (!timeout_status) // not while paused
49 if(time <= (self.cmd_floodtime + autocvar_sv_clientcommand_antispam_time))
51 self.cmd_floodcount += 1;
52 if(self.cmd_floodcount > autocvar_sv_clientcommand_antispam_count) { return false; } // too much spam, halt
56 self.cmd_floodtime = time;
57 self.cmd_floodcount = 1;
60 return true; // continue, as we're not flooding yet
64 // =======================
65 // Command Sub-Functions
66 // =======================
68 void ClientCommand_autoswitch(float request, float argc)
72 case CMD_REQUEST_COMMAND:
76 self.autoswitch = InterpretBoolean(argv(1));
77 sprint(self, strcat("^1autoswitch is currently turned ", (self.autoswitch ? "on" : "off"), ".\n"));
83 sprint(self, "Incorrect parameters for ^2autoswitch^7\n");
84 case CMD_REQUEST_USAGE:
86 sprint(self, "\nUsage:^3 cmd autoswitch selection\n");
87 sprint(self, " Where 'selection' controls if autoswitch is on or off.\n");
93 void ClientCommand_clientversion(float request, float argc) // internal command, used only by code
97 case CMD_REQUEST_COMMAND:
103 self.version = ((argv(1) == "$gameversion") ? 1 : stof(argv(1)));
105 if(self.version < autocvar_gameversion_min || self.version > autocvar_gameversion_max)
107 self.version_mismatch = 1;
108 ClientKill_TeamChange(-2); // observe
110 else if(autocvar_g_campaign || autocvar_g_balance_teams)
112 //JoinBestTeam(self, false, true);
114 else if(teamplay && !autocvar_sv_spectate && !(self.team_forced > 0))
116 self.classname = "observer"; // really?
117 stuffcmd(self, "menu_showteamselect\n");
126 sprint(self, "Incorrect parameters for ^2clientversion^7\n");
127 case CMD_REQUEST_USAGE:
129 sprint(self, "\nUsage:^3 cmd clientversion version\n");
130 sprint(self, " Where 'version' is the game version reported by self.\n");
136 void ClientCommand_mv_getpicture(float request, float argc) // internal command, used only by code
140 case CMD_REQUEST_COMMAND:
144 if(intermission_running)
145 MapVote_SendPicture(stof(argv(1)));
152 sprint(self, "Incorrect parameters for ^2mv_getpicture^7\n");
153 case CMD_REQUEST_USAGE:
155 sprint(self, "\nUsage:^3 cmd mv_getpicture mapid\n");
156 sprint(self, " Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.\n");
162 void ClientCommand_join(float request)
166 case CMD_REQUEST_COMMAND:
170 if(!IS_PLAYER(self) && !lockteams && !gameover)
174 if(nJoinAllowed(self))
176 if(autocvar_g_campaign) { campaign_bots_may_start = 1; }
178 self.classname = "player";
179 PlayerScore_Clear(self);
180 Kill_Notification(NOTIF_ONE_ONLY, self, MSG_CENTER_CPID, CPID_PREVENT_JOIN);
181 Send_Notification(NOTIF_ALL, world, MSG_INFO, INFO_JOIN_PLAY, self.netname);
186 //player may not join because of g_maxplayers is set
187 Send_Notification(NOTIF_ONE_ONLY, self, MSG_CENTER, CENTER_JOIN_PREVENT);
191 return; // never fall through to usage
195 case CMD_REQUEST_USAGE:
197 sprint(self, "\nUsage:^3 cmd join\n");
198 sprint(self, " No arguments required.\n");
204 void ClientCommand_physics(float request, float argc)
208 case CMD_REQUEST_COMMAND:
210 string command = strtolower(argv(1));
212 if(!autocvar_g_physics_clientselect)
214 sprint(self, "Client physics selection is currently disabled.\n");
218 if(command == "list" || command == "help")
220 sprint(self, strcat("Available physics sets: \n\n", autocvar_g_physics_clientselect_options, " default\n"));
224 if(Physics_Valid(command) || command == "default")
226 stuffcmd(self, strcat("\nseta cl_physics ", command, "\nsendcvar cl_physics\n"));
227 sprint(self, strcat("^2Physics set successfully changed to ^3", command, "\n"));
233 sprint(self, strcat("Current physics set: ^3", self.cvar_cl_physics, "\n"));
234 case CMD_REQUEST_USAGE:
236 sprint(self, "\nUsage:^3 cmd physics <physics>\n");
237 sprint(self, " See 'cmd physics list' for available physics sets.\n");
238 sprint(self, " Argument 'default' resets to standard physics.\n");
244 void ClientCommand_ready(float request) // todo: anti-spam for toggling readyness
248 case CMD_REQUEST_COMMAND:
252 if(warmup_stage || autocvar_sv_ready_restart || g_race_qualifying == 2)
254 if(!readyrestart_happened || autocvar_sv_ready_restart_repeatable)
256 if(time < game_starttime) // game is already restarting
258 if (self.ready) // toggle
261 bprint(self.netname, "^2 is ^1NOT^2 ready\n");
266 bprint(self.netname, "^2 is ready\n");
269 // cannot reset the game while a timeout is active!
273 sprint(self, "^1Game has already been restarted\n");
277 return; // never fall through to usage
281 case CMD_REQUEST_USAGE:
283 sprint(self, "\nUsage:^3 cmd ready\n");
284 sprint(self, " No arguments required.\n");
290 void ClientCommand_say(float request, float argc, string command)
294 case CMD_REQUEST_COMMAND:
296 if(argc >= 2) { Say(self, false, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
297 return; // never fall through to usage
301 case CMD_REQUEST_USAGE:
303 sprint(self, "\nUsage:^3 cmd say <message>\n");
304 sprint(self, " Where 'message' is the string of text to say.\n");
310 void ClientCommand_say_team(float request, float argc, string command)
314 case CMD_REQUEST_COMMAND:
316 if(argc >= 2) { Say(self, true, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
317 return; // never fall through to usage
321 case CMD_REQUEST_USAGE:
323 sprint(self, "\nUsage:^3 cmd say_team <message>\n");
324 sprint(self, " Where 'message' is the string of text to say.\n");
330 void ClientCommand_selectteam(float request, float argc)
334 case CMD_REQUEST_COMMAND:
341 if(self.team_forced <= 0)
348 case "red": selection = NUM_TEAM_1; break;
349 case "blue": selection = NUM_TEAM_2; break;
350 case "yellow": selection = NUM_TEAM_3; break;
351 case "pink": selection = NUM_TEAM_4; break;
352 case "auto": selection = (-1); break;
354 default: selection = 0; break;
359 if(self.team == selection && self.deadflag == DEAD_NO)
360 sprint(self, "^7You already are on that team.\n");
361 else if(self.wasplayer && autocvar_g_changeteam_banned)
362 sprint(self, "^1You cannot change team, forbidden by the server.\n");
365 if(autocvar_g_balance_teams && autocvar_g_balance_teams_prevent_imbalance)
367 CheckAllowedTeams(self);
369 if(!TeamSmallerEqThanTeam(Team_TeamToNumber(selection), Team_TeamToNumber(self.team), self))
371 Send_Notification(NOTIF_ONE, self, MSG_INFO, INFO_TEAMCHANGE_LARGERTEAM);
375 ClientKill_TeamChange(selection);
380 sprint(self, "^7The game has already begun, you must wait until the next map to be able to join a team.\n");
382 sprint(self, "^7selectteam can not be used as your team is forced\n");
384 sprint(self, "^7selectteam can only be used in teamgames\n");
391 sprint(self, "Incorrect parameters for ^2selectteam^7\n");
392 case CMD_REQUEST_USAGE:
394 sprint(self, "\nUsage:^3 cmd selectteam team\n");
395 sprint(self, " Where 'team' is the prefered team to try and join.\n");
396 sprint(self, " Full list of options here: \"red, blue, yellow, pink, auto\"\n");
402 void ClientCommand_selfstuff(float request, string command)
406 case CMD_REQUEST_COMMAND:
410 stuffcmd(self, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
416 sprint(self, "Incorrect parameters for ^2selectteam^7\n");
417 case CMD_REQUEST_USAGE:
419 sprint(self, "\nUsage:^3 cmd selfstuff <command>\n");
420 sprint(self, " Where 'command' is the string to be stuffed to your client.\n");
426 void ClientCommand_sentcvar(float request, float argc, string command)
430 case CMD_REQUEST_COMMAND:
437 if(argc == 2) // undefined cvar: use the default value on the server then
439 s = strcat(substring(command, argv_start_index(0), argv_end_index(1) - argv_start_index(0)), " \"", cvar_defstring(argv(1)), "\"");
450 sprint(self, "Incorrect parameters for ^2sentcvar^7\n");
451 case CMD_REQUEST_USAGE:
453 sprint(self, "\nUsage:^3 cmd sentcvar <cvar>\n");
454 sprint(self, " Where 'cvar' is the cvar plus arguments to send to the server.\n");
460 void ClientCommand_spectate(float request)
464 case CMD_REQUEST_COMMAND:
468 int mutator_returnvalue = MUTATOR_CALLHOOK(ClientCommand_Spectate, self);
470 if(mutator_returnvalue == MUT_SPECCMD_RETURN)
473 if((IS_PLAYER(self) || mutator_returnvalue == MUT_SPECCMD_FORCE) && autocvar_sv_spectate == 1)
474 ClientKill_TeamChange(-2); // observe
476 return; // never fall through to usage
480 case CMD_REQUEST_USAGE:
482 sprint(self, "\nUsage:^3 cmd spectate\n");
483 sprint(self, " No arguments required.\n");
489 void ClientCommand_suggestmap(float request, float argc)
493 case CMD_REQUEST_COMMAND:
497 sprint(self, strcat(MapVote_Suggest(argv(1)), "\n"));
503 sprint(self, "Incorrect parameters for ^2suggestmap^7\n");
504 case CMD_REQUEST_USAGE:
506 sprint(self, "\nUsage:^3 cmd suggestmap map\n");
507 sprint(self, " Where 'map' is the name of the map to suggest.\n");
513 void ClientCommand_tell(float request, float argc, string command)
517 case CMD_REQUEST_COMMAND:
521 entity tell_to = GetIndexedEntity(argc, 1);
522 float tell_accepted = VerifyClientEntity(tell_to, true, false);
524 if(tell_accepted > 0) // the target is a real client
526 if(tell_to != self) // and we're allowed to send to them :D
528 // workaround for argv indexes indexing ascii chars instead of utf8 chars
529 // In this case when the player name contains utf8 chars
530 // the message gets partially trimmed in the beginning.
531 // Potentially this bug affects any substring call that uses
532 // argv_start_index and argv_end_index.
534 string utf8_enable_save = cvar_string("utf8_enable");
535 cvar_set("utf8_enable", "0");
536 string msg = substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token));
537 cvar_set("utf8_enable", utf8_enable_save);
539 Say(self, false, tell_to, msg, true);
542 else { print_to(self, "You can't ^2tell^7 a message to yourself."); return; }
544 else if(argv(1) == "#0")
546 trigger_magicear_processmessage_forallears(self, -1, world, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)));
549 else { print_to(self, strcat("tell: ", GetClientErrorString(tell_accepted, argv(1)), ".")); return; }
554 sprint(self, "Incorrect parameters for ^2tell^7\n");
555 case CMD_REQUEST_USAGE:
557 sprint(self, "\nUsage:^3 cmd tell client <message>\n");
558 sprint(self, " Where 'client' is the entity number or name of the player to send 'message' to.\n");
564 void ClientCommand_voice(float request, float argc, string command)
568 case CMD_REQUEST_COMMAND:
573 VoiceMessage(argv(1), substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
575 VoiceMessage(argv(1), "");
582 sprint(self, "Incorrect parameters for ^2voice^7\n");
583 case CMD_REQUEST_USAGE:
585 sprint(self, "\nUsage:^3 cmd voice messagetype <soundname>\n");
586 sprint(self, " 'messagetype' is the type of broadcast to do, like team only or such,\n");
587 sprint(self, " and 'soundname' is the string/filename of the sound/voice message to play.\n");
593 /* use this when creating a new command, making sure to place it in alphabetical order... also,
594 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
595 void ClientCommand_(float request)
599 case CMD_REQUEST_COMMAND:
602 return; // never fall through to usage
606 case CMD_REQUEST_USAGE:
608 sprint(self, "\nUsage:^3 cmd \n");
609 sprint(self, " No arguments required.\n");
617 // =====================================
618 // Macro system for networked commands
619 // =====================================
621 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
622 #define CLIENT_COMMANDS(request,arguments,command) \
623 CLIENT_COMMAND("autoswitch", ClientCommand_autoswitch(request, arguments), "Whether or not to switch automatically when getting a better weapon") \
624 CLIENT_COMMAND("clientversion", ClientCommand_clientversion(request, arguments), "Release version of the game") \
625 CLIENT_COMMAND("mv_getpicture", ClientCommand_mv_getpicture(request, arguments), "Retrieve mapshot picture from the server") \
626 CLIENT_COMMAND("join", ClientCommand_join(request), "Become a player in the game") \
627 CLIENT_COMMAND("physics", ClientCommand_physics(request, arguments), "Change physics set") \
628 CLIENT_COMMAND("ready", ClientCommand_ready(request), "Qualify as ready to end warmup stage (or restart server if allowed)") \
629 CLIENT_COMMAND("say", ClientCommand_say(request, arguments, command), "Print a message to chat to all players") \
630 CLIENT_COMMAND("say_team", ClientCommand_say_team(request, arguments, command), "Print a message to chat to all team mates") \
631 CLIENT_COMMAND("selectteam", ClientCommand_selectteam(request, arguments), "Attempt to choose a team to join into") \
632 CLIENT_COMMAND("selfstuff", ClientCommand_selfstuff(request, command), "Stuffcmd a command to your own client") \
633 CLIENT_COMMAND("sentcvar", ClientCommand_sentcvar(request, arguments, command), "New system for sending a client cvar to the server") \
634 CLIENT_COMMAND("spectate", ClientCommand_spectate(request), "Become an observer") \
635 CLIENT_COMMAND("suggestmap", ClientCommand_suggestmap(request, arguments), "Suggest a map to the mapvote at match end") \
636 CLIENT_COMMAND("tell", ClientCommand_tell(request, arguments, command), "Send a message directly to a player") \
637 CLIENT_COMMAND("voice", ClientCommand_voice(request, arguments, command), "Send voice message via sound") \
638 CLIENT_COMMAND("minigame", ClientCommand_minigame(request, arguments, command), "Start a minigame") \
641 void ClientCommand_macro_help()
643 #define CLIENT_COMMAND(name,function,description) \
644 { sprint(self, " ^2", name, "^7: ", description, "\n"); }
646 CLIENT_COMMANDS(0, 0, "");
647 #undef CLIENT_COMMAND
652 float ClientCommand_macro_command(float argc, string command)
654 #define CLIENT_COMMAND(name,function,description) \
655 { if(name == strtolower(argv(0))) { function; return true; } }
657 CLIENT_COMMANDS(CMD_REQUEST_COMMAND, argc, command);
658 #undef CLIENT_COMMAND
663 float ClientCommand_macro_usage(float argc)
665 #define CLIENT_COMMAND(name,function,description) \
666 { if(name == strtolower(argv(1))) { function; return true; } }
668 CLIENT_COMMANDS(CMD_REQUEST_USAGE, argc, "");
669 #undef CLIENT_COMMAND
674 void ClientCommand_macro_write_aliases(float fh)
676 #define CLIENT_COMMAND(name,function,description) \
677 { CMD_Write_Alias("qc_cmd_cmd", name, description); }
679 CLIENT_COMMANDS(0, 0, "");
680 #undef CLIENT_COMMAND
685 // ======================================
686 // Main Function Called By Engine (cmd)
687 // ======================================
688 // If this function exists, server game code parses clientcommand before the engine code gets it.
690 void SV_ParseClientCommand(string command)
692 // If invalid UTF-8, don't even parse it
693 string command2 = "";
694 float len = strlen(command);
696 for (i = 0; i < len; ++i)
697 command2 = strcat(command2, chr2str(str2chr(command, i)));
698 if (command != command2)
701 // if we're banned, don't even parse the command
702 if(Ban_MaybeEnforceBanOnce(self))
705 float argc = tokenize_console(command);
707 // Guide for working with argc arguments by example:
708 // argc: 1 - 2 - 3 - 4
709 // argv: 0 - 1 - 2 - 3
710 // cmd vote - master - login - password
713 switch(strtolower(argv(0)))
715 // exempt commands which are not subject to floodcheck
716 case "begin": break; // handled by engine in host_cmd.c
717 case "download": break; // handled by engine in cl_parse.c
718 case "mv_getpicture": break; // handled by server in this file
719 case "pause": break; // handled by engine in host_cmd.c
720 case "prespawn": break; // handled by engine in host_cmd.c
721 case "sentcvar": break; // handled by server in this file
722 case "spawn": break; // handled by engine in host_cmd.c
725 if(SV_ParseClientCommand_floodcheck())
726 break; // "true": continue, as we're not flooding yet
728 return; // "false": not allowed to continue, halt // print("^1ERROR: ^7ANTISPAM CAUGHT: ", command, ".\n");
731 /* NOTE: should this be disabled? It can be spammy perhaps, but hopefully it's okay for now */
732 if(argv(0) == "help")
736 sprint(self, "\nClient networked commands:\n");
737 ClientCommand_macro_help();
739 sprint(self, "\nCommon networked commands:\n");
740 CommonCommand_macro_help(self);
742 sprint(self, "\nUsage:^3 cmd COMMAND...^7, where possible commands are listed above.\n");
743 sprint(self, "For help about a specific command, type cmd help COMMAND\n");
746 else if(CommonCommand_macro_usage(argc, self)) // Instead of trying to call a command, we're going to see detailed information about it
750 else if(ClientCommand_macro_usage(argc)) // same, but for normal commands now
755 else if(MUTATOR_CALLHOOK(SV_ParseClientCommand, strtolower(argv(0)), argc, command))
757 return; // handled by a mutator
759 else if(CheatCommand(argc))
761 return; // handled by server/cheats.qc
763 else if(CommonCommand_macro_command(argc, self, command))
765 return; // handled by server/command/common.qc
767 else if(ClientCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
769 return; // handled by one of the above ClientCommand_* functions
772 clientcommand(self, command);