1 // =========================================================
2 // Server side networked commands code, reworked by Samual
3 // Last updated: December 28th, 2011
4 // =========================================================
6 float SV_ParseClientCommand_floodcheck()
8 if not(timeout_status) // not while paused
10 if(time <= (self.cmd_floodtime + autocvar_sv_clientcommand_antispam_time))
12 self.cmd_floodcount += 1;
13 if(self.cmd_floodcount > autocvar_sv_clientcommand_antispam_count) { return FALSE; } // too much spam, halt
17 self.cmd_floodtime = time;
18 self.cmd_floodcount = 1;
21 return TRUE; // continue, as we're not flooding yet
25 // =======================
26 // Command Sub-Functions
27 // =======================
29 void ClientCommand_autoswitch(float request, float argc)
33 case CMD_REQUEST_COMMAND:
35 self.autoswitch = InterpretBoolean(argv(1));
36 sprint(self, strcat("^1autoswitch is currently turned ", (self.autoswitch ? "on" : "off"), ".\n"));
37 return; // never fall through to usage
41 case CMD_REQUEST_USAGE:
43 sprint(self, "\nUsage:^3 cmd autoswitch selection\n");
44 sprint(self, " Where 'selection' controls if autoswitch is on or off.\n");
50 void ClientCommand_checkfail(float request, string command) // internal command, used only by code
54 case CMD_REQUEST_COMMAND:
56 print(sprintf("CHECKFAIL: %s (%s) epically failed check %s\n", self.netname, self.netaddress, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1))));
58 return; // never fall through to usage
62 case CMD_REQUEST_USAGE:
64 sprint(self, "\nUsage:^3 cmd checkfail <message>\n");
65 sprint(self, " Where 'message' is the message reported by client about the fail.\n");
71 void ClientCommand_clientversion(float request, float argc) // internal command, used only by code
75 case CMD_REQUEST_COMMAND:
77 if(self.flags & FL_CLIENT)
79 self.version = ((argv(1) == "$gameversion") ? 1 : stof(argv(1)));
81 if(self.version < autocvar_gameversion_min || self.version > autocvar_gameversion_max)
83 self.version_mismatch = 1;
84 ClientKill_TeamChange(-2); // observe
86 else if(autocvar_g_campaign || autocvar_g_balance_teams || autocvar_g_balance_teams_force)
88 //JoinBestTeam(self, FALSE, TRUE);
90 else if(teamplay && !autocvar_sv_spectate && !(self.team_forced > 0))
92 self.classname = "observer"; // really?
93 stuffcmd(self, "menu_showteamselect\n");
96 return; // never fall through to usage
100 case CMD_REQUEST_USAGE:
102 sprint(self, "\nUsage:^3 cmd clientversion version\n");
103 sprint(self, " Where 'version' is the game version reported by self.\n");
109 void ClientCommand_getmapvotepic(float request, float argc) // internal command, used only by code
113 case CMD_REQUEST_COMMAND:
115 if(intermission_running)
116 MapVote_SendPicture(stof(argv(1)));
118 return; // never fall through to usage
122 case CMD_REQUEST_USAGE:
124 sprint(self, "\nUsage:^3 cmd getmapvotepic mapid\n");
125 sprint(self, " Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.\n");
131 void ClientCommand_join(float request) // legacy
135 case CMD_REQUEST_COMMAND:
137 if(self.flags & FL_CLIENT)
139 if(self.classname != "player" && !lockteams && !g_arena)
143 if(g_ca) { self.caplayer = 1; }
144 if(autocvar_g_campaign) { campaign_bots_may_start = 1; }
146 self.classname = "player";
147 PlayerScore_Clear(self);
148 bprint ("^4", self.netname, "^4 is playing now\n");
153 //player may not join because of g_maxplayers is set
154 centerprint(self, PREVENT_JOIN_TEXT);
158 return; // never fall through to usage
162 case CMD_REQUEST_USAGE:
164 sprint(self, "\nUsage:^3 cmd join\n");
165 sprint(self, " No arguments required.\n");
171 void ClientCommand_ready(float request) // todo: anti-spam for toggling readyness
175 case CMD_REQUEST_COMMAND:
177 if(self.flags & FL_CLIENT)
179 if(inWarmupStage || autocvar_sv_ready_restart || g_race_qualifying == 2)
181 if(!readyrestart_happened || autocvar_sv_ready_restart_repeatable)
183 if (self.ready) // toggle
186 bprint(self.netname, "^2 is ^1NOT^2 ready\n");
191 bprint(self.netname, "^2 is ready\n");
194 // cannot reset the game while a timeout is active!
195 if not(timeout_status)
198 sprint(self, "^1Game has already been restarted\n");
202 return; // never fall through to usage
206 case CMD_REQUEST_USAGE:
208 sprint(self, "\nUsage:^3 cmd ready\n");
209 sprint(self, " No arguments required.\n");
215 void ClientCommand_reportcvar(float request, float argc, string command)
219 case CMD_REQUEST_COMMAND:
224 if(substring(argv(2), 0, 1) == "$") // undefined cvar: use the default value on the server then
226 s = strcat(substring(command, argv_start_index(0), argv_end_index(1) - argv_start_index(0)), " \"", cvar_defstring(argv(1)), "\"");
227 tokens = tokenize_console(s);
230 return; // never fall through to usage
234 case CMD_REQUEST_USAGE:
236 sprint(self, "\nUsage:^3 cmd reportcvar <cvar>\n");
237 sprint(self, " Where 'cvar' is the cvar plus arguments to send to the server.\n");
243 void ClientCommand_say(float request, float argc, string command)
247 case CMD_REQUEST_COMMAND:
249 if(argc >= 2) { Say(self, FALSE, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
250 return; // never fall through to usage
254 case CMD_REQUEST_USAGE:
256 sprint(self, "\nUsage:^3 cmd say <message>\n");
257 sprint(self, " Where 'message' is the string of text to say.\n");
263 void ClientCommand_say_team(float request, float argc, string command)
267 case CMD_REQUEST_COMMAND:
269 if(argc >= 2) { Say(self, TRUE, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
270 return; // never fall through to usage
274 case CMD_REQUEST_USAGE:
276 sprint(self, "\nUsage:^3 cmd say_team <message>\n");
277 sprint(self, " Where 'message' is the string of text to say.\n");
283 void ClientCommand_selectteam(float request, float argc)
287 case CMD_REQUEST_COMMAND:
291 if (self.flags & FL_CLIENT)
294 if not(self.team_forced > 0)
299 case "red": selection = COLOR_TEAM1; break;
300 case "blue": selection = COLOR_TEAM2; break;
301 case "yellow": selection = COLOR_TEAM3; break;
302 case "pink": selection = COLOR_TEAM4; break;
303 case "auto": selection = (-1); break;
310 if(self.team == selection && self.deadflag == DEAD_NO)
311 sprint(self, "^7You already are on that team.\n");
312 else if(self.wasplayer && autocvar_g_changeteam_banned)
313 sprint(self, "^1You cannot change team, forbidden by the server.\n");
315 ClientKill_TeamChange(selection);
319 sprint(self, "^7The game has already begun, you must wait until the next map to be able to join a team.\n");
321 sprint(self, "^7selectteam can not be used as your team is forced\n");
323 sprint(self, "^7selectteam can only be used in teamgames\n");
325 return; // never fall through to usage
329 case CMD_REQUEST_USAGE:
331 //sprint(self, strcat( "selectteam none/red/blue/yellow/pink/auto - \"", argv(1), "\" not recognised\n" ) );
332 sprint(self, "\nUsage:^3 cmd selectteam team\n");
333 sprint(self, " Where 'team' is the prefered team to try and join.\n");
334 sprint(self, " Full list of options here: \"red, blue, yellow, pink, auto\"\n");
340 void ClientCommand_selfstuff(float request, string command)
344 case CMD_REQUEST_COMMAND:
346 stuffcmd(self, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
347 return; // never fall through to usage
351 case CMD_REQUEST_USAGE:
353 sprint(self, "\nUsage:^3 cmd selfstuff <command>\n");
354 sprint(self, " Where 'command' is the string to be stuffed to your client.\n");
360 void ClientCommand_sentcvar(float request, float argc, string command)
364 case CMD_REQUEST_COMMAND:
369 if(argc == 2) // undefined cvar: use the default value on the server then
371 s = strcat(substring(command, argv_start_index(0), argv_end_index(1) - argv_start_index(0)), " \"", cvar_defstring(argv(1)), "\"");
372 tokens = tokenize_console(s);
375 return; // never fall through to usage
379 case CMD_REQUEST_USAGE:
381 sprint(self, "\nUsage:^3 cmd sentcvar <cvar>\n");
382 sprint(self, " Where 'cvar' is the cvar plus arguments to send to the server.\n");
388 void ClientCommand_spectate(float request) // legacy
392 case CMD_REQUEST_COMMAND:
394 if(self.flags & FL_CLIENT)
396 if(g_arena) { return; }
399 if(self.lms_spectate_warning)
401 // mark player as spectator
402 PlayerScore_Add(self, SP_LMS_RANK, 666 - PlayerScore_Add(self, SP_LMS_RANK, 0));
406 self.lms_spectate_warning = 1;
407 sprint(self, "WARNING: you won't be able to enter the game again after spectating in LMS. Use the same command again to spectate anyway.\n");
412 if(self.classname == "player" && autocvar_sv_spectate == 1)
413 ClientKill_TeamChange(-2); // observe
415 // in CA, allow a dead player to move to spectatators (without that, caplayer!=0 will be moved back to the player list)
416 // note: if arena game mode is ever done properly, this needs to be removed.
417 if(g_ca && self.caplayer && (self.classname == "spectator" || self.classname == "observer"))
419 sprint(self, "WARNING: you will spectate in the next round.\n");
423 return; // never fall through to usage
427 case CMD_REQUEST_USAGE:
429 sprint(self, "\nUsage:^3 cmd spectate\n");
430 sprint(self, " No arguments required.\n");
436 void ClientCommand_suggestmap(float request, float argc)
440 case CMD_REQUEST_COMMAND:
442 sprint(self, strcat(MapVote_Suggest(argv(1)), "\n"));
443 return; // never fall through to usage
447 case CMD_REQUEST_USAGE:
449 sprint(self, "\nUsage:^3 cmd suggestmap map\n");
450 sprint(self, " Where 'map' is the name of the map to suggest.\n");
456 void ClientCommand_tell(float request, float argc, string command)
460 case CMD_REQUEST_COMMAND:
464 entity tell_to = GetIndexedEntity(argc, 1);
465 float tell_accepted = VerifyClientEntity(tell_to, TRUE, FALSE);
467 if(tell_accepted > 0) // the target is a real client
469 if(tell_to != self) // and we're allowed to send to them :D
471 Say(self, FALSE, tell_to, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)), TRUE);
474 else { print_to(self, "You can't ^2tell^7 a message to yourself."); return; }
476 else if(strtolower(argv(1)) == "world")
478 trigger_magicear_processmessage_forallears(self, -1, world, substring(command, argv_start_index(ParseCommandPlayerSlotTarget_firsttoken), argv_end_index(-1) - argv_start_index(ParseCommandPlayerSlotTarget_firsttoken)));
481 else { print_to(self, strcat("tell: ", GetClientErrorString(tell_accepted, argv(1)), ".")); return; }
486 sprint(self, "Incorrect parameters for ^2tell^7\n");
487 case CMD_REQUEST_USAGE:
489 sprint(self, "\nUsage:^3 cmd tell client <message>\n");
490 sprint(self, " Where 'client' is the entity number or name of the player to send 'message' to.\n");
496 void ClientCommand_voice(float request, float argc, string command) // legacy
500 case CMD_REQUEST_COMMAND:
503 VoiceMessage(argv(1), substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
505 VoiceMessage(argv(1), "");
506 return; // never fall through to usage
510 case CMD_REQUEST_USAGE:
512 sprint(self, "\nUsage:^3 cmd voice messagetype <soundname>\n");
513 sprint(self, " 'messagetype' is the type of broadcast to do, like team only or such,\n");
514 sprint(self, " and 'soundname' is the string/filename of the sound/voice message to play.\n");
520 /* use this when creating a new command, making sure to place it in alphabetical order... also,
521 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
522 void ClientCommand_(float request)
526 case CMD_REQUEST_COMMAND:
529 return; // never fall through to usage
533 case CMD_REQUEST_USAGE:
535 sprint(self, "\nUsage:^3 cmd \n");
536 sprint(self, " No arguments required.\n");
544 // =====================================
545 // Macro system for networked commands
546 // =====================================
548 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
549 #define CLIENT_COMMANDS(request,arguments,command) \
550 CLIENT_COMMAND("autoswitch", ClientCommand_autoswitch(request, arguments), "Whether or not to switch automatically when getting a better weapon") \
551 CLIENT_COMMAND("checkfail", ClientCommand_checkfail(request, command), "Report if a client-side check failed") \
552 CLIENT_COMMAND("clientversion", ClientCommand_clientversion(request, arguments), "Release version of the game") \
553 CLIENT_COMMAND("getmapvotepic", ClientCommand_getmapvotepic(request, arguments), "Retrieve mapshot picture from the server") \
554 CLIENT_COMMAND("join", ClientCommand_join(request), "Become a player in the game") \
555 CLIENT_COMMAND("ready", ClientCommand_ready(request), "Qualify as ready to end warmup stage (or restart server if allowed)") \
556 CLIENT_COMMAND("reportcvar", ClientCommand_reportcvar(request, arguments, command), "Old system for sending a client cvar to the server") \
557 CLIENT_COMMAND("say", ClientCommand_say(request, arguments, command), "Print a message to chat to all players") \
558 CLIENT_COMMAND("say_team", ClientCommand_say_team(request, arguments, command), "Print a message to chat to all team mates") \
559 CLIENT_COMMAND("selectteam", ClientCommand_selectteam(request, arguments), "Attempt to choose a team to join into") \
560 CLIENT_COMMAND("selfstuff", ClientCommand_selfstuff(request, command), "Stuffcmd a command to your own client") \
561 CLIENT_COMMAND("sentcvar", ClientCommand_sentcvar(request, arguments, command), "New system for sending a client cvar to the server") \
562 CLIENT_COMMAND("spectate", ClientCommand_spectate(request), "Become an observer") \
563 CLIENT_COMMAND("suggestmap", ClientCommand_suggestmap(request, arguments), "Suggest a map to the mapvote at match end") \
564 CLIENT_COMMAND("tell", ClientCommand_tell(request, arguments, command), "Send a message directly to a player") \
565 CLIENT_COMMAND("voice", ClientCommand_voice(request, arguments, command), "Send voice message via sound") \
568 void ClientCommand_macro_help()
570 #define CLIENT_COMMAND(name,function,description) \
571 { sprint(self, " ^2", name, "^7: ", description, "\n"); }
573 CLIENT_COMMANDS(0, 0, "")
574 #undef CLIENT_COMMAND
579 float ClientCommand_macro_command(float argc, string command)
581 #define CLIENT_COMMAND(name,function,description) \
582 { if(name == strtolower(argv(0))) { function; return TRUE; } }
584 CLIENT_COMMANDS(CMD_REQUEST_COMMAND, argc, command)
585 #undef CLIENT_COMMAND
590 float ClientCommand_macro_usage(float argc)
592 #define CLIENT_COMMAND(name,function,description) \
593 { if(name == strtolower(argv(1))) { function; return TRUE; } }
595 CLIENT_COMMANDS(CMD_REQUEST_USAGE, argc, "")
596 #undef CLIENT_COMMAND
601 void ClientCommand_macro_write_aliases(float fh)
603 #define CLIENT_COMMAND(name,function,description) \
604 { CMD_Write_Alias("qc_cmd_cmd", name, description); }
606 CLIENT_COMMANDS(0, 0, "")
607 #undef CLIENT_COMMAND
612 // ======================================
613 // Main Function Called By Engine (cmd)
614 // ======================================
615 // If this function exists, server game code parses clientcommand before the engine code gets it.
617 void SV_ParseClientCommand(string command)
619 float argc = tokenize_console(command);
621 // Guide for working with argc arguments by example:
622 // argc: 1 - 2 - 3 - 4
623 // argv: 0 - 1 - 2 - 3
624 // cmd vote - master - login - password
627 switch(strtolower(argv(0)))
629 // exempt commands which are not subject to floodcheck
630 case "begin": break; // handled by engine in host_cmd.c
631 case "download": break; // handled by engine in cl_parse.c
632 case "getmapvotepic": break; // handled by server in this file
633 case "pause": break; // handled by engine in host_cmd.c
634 case "prespawn": break; // handled by engine in host_cmd.c
635 case "reportcvar": break; // handled by server in this file
636 case "sentcvar": break; // handled by server in this file
637 case "spawn": break; // handled by engine in host_cmd.c
640 if(SV_ParseClientCommand_floodcheck())
641 break; // "TRUE": continue, as we're not flooding yet
643 return print("^1ERROR: ^7ANTISPAM CAUGHT: ", command, ".\n"); // "FALSE": not allowed to continue, halt TODO
646 /* NOTE: should this be disabled? It can be spammy perhaps, but hopefully it's okay for now */
647 if(argv(0) == "help")
651 print("\nClient networked commands:\n");
652 ClientCommand_macro_help();
654 print("\nCommon networked commands:\n");
655 CommonCommand_macro_help(self);
657 sprint(self, "\nUsage:^3 cmd COMMAND...^7, where possible commands are listed above.\n");
658 sprint(self, "For help about a specific command, type cmd help COMMAND\n");
661 else if(CommonCommand_macro_usage(argc, self)) // Instead of trying to call a command, we're going to see detailed information about it
665 else if(ClientCommand_macro_usage(argc)) // same, but for normal commands now
670 else if(MUTATOR_CALLHOOK(SV_ParseClientCommand))
672 return; // handled by a mutator
674 else if(CheatCommand(argc))
676 return; // handled by server/cheats.qc
678 else if(CommonCommand_macro_command(argc, self, command))
680 return; // handled by server/command/common.qc
682 else if(ClientCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
684 return; // handled by one of the above ClientCommand_* functions
687 clientcommand(self, command);