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:
37 self.autoswitch = InterpretBoolean(argv(1));
38 sprint(self, strcat("^1autoswitch is currently turned ", (self.autoswitch ? "on" : "off"), ".\n"));
44 sprint(self, "Incorrect parameters for ^2autoswitch^7\n");
45 case CMD_REQUEST_USAGE:
47 sprint(self, "\nUsage:^3 cmd autoswitch selection\n");
48 sprint(self, " Where 'selection' controls if autoswitch is on or off.\n");
54 void ClientCommand_checkfail(float request, string command) // internal command, used only by code
58 case CMD_REQUEST_COMMAND:
60 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))));
62 return; // never fall through to usage
66 sprint(self, "Incorrect parameters for ^2checkfail^7\n");
67 case CMD_REQUEST_USAGE:
69 sprint(self, "\nUsage:^3 cmd checkfail <message>\n");
70 sprint(self, " Where 'message' is the message reported by client about the fail.\n");
76 void ClientCommand_clientversion(float request, float argc) // internal command, used only by code
80 case CMD_REQUEST_COMMAND:
84 if(self.flags & FL_CLIENT)
86 self.version = ((argv(1) == "$gameversion") ? 1 : stof(argv(1)));
88 if(self.version < autocvar_gameversion_min || self.version > autocvar_gameversion_max)
90 self.version_mismatch = 1;
91 ClientKill_TeamChange(-2); // observe
93 else if(autocvar_g_campaign || autocvar_g_balance_teams)
95 //JoinBestTeam(self, FALSE, TRUE);
97 else if(teamplay && !autocvar_sv_spectate && !(self.team_forced > 0))
99 self.classname = "observer"; // really?
100 stuffcmd(self, "menu_showteamselect\n");
109 sprint(self, "Incorrect parameters for ^2clientversion^7\n");
110 case CMD_REQUEST_USAGE:
112 sprint(self, "\nUsage:^3 cmd clientversion version\n");
113 sprint(self, " Where 'version' is the game version reported by self.\n");
119 void ClientCommand_mv_getpicture(float request, float argc) // internal command, used only by code
123 case CMD_REQUEST_COMMAND:
127 if(intermission_running)
128 MapVote_SendPicture(stof(argv(1)));
135 sprint(self, "Incorrect parameters for ^2mv_getpicture^7\n");
136 case CMD_REQUEST_USAGE:
138 sprint(self, "\nUsage:^3 cmd mv_getpicture mapid\n");
139 sprint(self, " Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.\n");
145 void ClientCommand_join(float request)
149 case CMD_REQUEST_COMMAND:
151 if(self.flags & FL_CLIENT)
153 if(self.classname != "player" && !lockteams && !g_arena)
155 if(nJoinAllowed(self))
157 if(g_ca) { self.caplayer = 1; }
158 if(autocvar_g_campaign) { campaign_bots_may_start = 1; }
160 self.classname = "player";
161 PlayerScore_Clear(self);
162 bprint ("^4", self.netname, "^4 is playing now\n");
167 //player may not join because of g_maxplayers is set
168 centerprint(self, PREVENT_JOIN_TEXT);
172 return; // never fall through to usage
176 case CMD_REQUEST_USAGE:
178 sprint(self, "\nUsage:^3 cmd join\n");
179 sprint(self, " No arguments required.\n");
185 void ClientCommand_mobspawn(float request, float argc)
189 case CMD_REQUEST_COMMAND:
192 string tospawn, mname, s;
193 float spawncount = 0, moveflag, max_global, max_perplayer, i;
195 max_global = autocvar_g_monsters_max;
196 max_perplayer = autocvar_g_monsters_max_perplayer;
197 moveflag = (argv(3) ? stof(argv(3)) : 1); // follow owner if not defined
198 spawncount = ((argv(2)) ? stof(argv(2)) : 1);
201 s = ((spawncount == 1) ? "" : "s");
203 if(tospawn == "list")
205 sprint(self, "Available monsters:\n");
206 sprint(self, strcat(monsterlist(), "\n"));
210 if(self.classname != STR_PLAYER) { sprint(self, "You can't spawn monsters while spectating.\n"); return; }
211 else if(self.deadflag) { sprint(self, "You can't spawn monsters while dead.\n"); return; }
212 else if(self.monstercount > max_perplayer) { sprint(self, "You have spawned too many monsters, kill some before trying to spawn any more.\n"); return; }
213 else if(totalspawned > max_global) { sprint(self, "The global maximum monster count has been reached, kill some before trying to spawn any more.\n"); return; }
214 else if(spawncount == 0) { sprint(self, "No monsters to spawn.\n"); return; }
216 makevectors(self.v_angle);
217 WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * 100, MOVE_NORMAL, self);
219 for(i = 0; i < spawncount; i++)
222 if(self.monstercount > max_perplayer) break; // FIXME: check for these properly
223 e = spawnmonster(tospawn, self, self, trace_endpos, FALSE, moveflag);
224 if(e == world) { self.monstercount -= 1; break; } // take back the 1 that was lost
225 if(mname != "") e.netname = mname;
229 sprint(self, sprintf("Spawned %d %s%s\n", spawncount, tospawn, s));
235 sprint(self, "Incorrect parameters for ^2mobspawn^7\n");
236 case CMD_REQUEST_USAGE:
238 sprint(self, "\nUsage:^3 cmd mobspawn monster\n");
239 sprint(self, " See 'cmd mobspawn list' for available arguments.\n");
245 void ClientCommand_ready(float request) // todo: anti-spam for toggling readyness
249 case CMD_REQUEST_COMMAND:
251 if(self.flags & FL_CLIENT)
253 if(inWarmupStage || autocvar_sv_ready_restart || g_race_qualifying == 2)
255 if(!readyrestart_happened || autocvar_sv_ready_restart_repeatable)
257 if (self.ready) // toggle
260 bprint(self.netname, "^2 is ^1NOT^2 ready\n");
265 bprint(self.netname, "^2 is ready\n");
268 // cannot reset the game while a timeout is active!
269 if not(timeout_status)
272 sprint(self, "^1Game has already been restarted\n");
276 return; // never fall through to usage
280 case CMD_REQUEST_USAGE:
282 sprint(self, "\nUsage:^3 cmd ready\n");
283 sprint(self, " No arguments required.\n");
289 void ClientCommand_say(float request, float argc, string command)
293 case CMD_REQUEST_COMMAND:
295 if(argc >= 2) { Say(self, FALSE, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
296 return; // never fall through to usage
300 case CMD_REQUEST_USAGE:
302 sprint(self, "\nUsage:^3 cmd say <message>\n");
303 sprint(self, " Where 'message' is the string of text to say.\n");
309 void ClientCommand_say_team(float request, float argc, string command)
313 case CMD_REQUEST_COMMAND:
315 if(argc >= 2) { Say(self, TRUE, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
316 return; // never fall through to usage
320 case CMD_REQUEST_USAGE:
322 sprint(self, "\nUsage:^3 cmd say_team <message>\n");
323 sprint(self, " Where 'message' is the string of text to say.\n");
329 void ClientCommand_selectteam(float request, float argc)
333 case CMD_REQUEST_COMMAND:
337 if(self.flags & FL_CLIENT)
340 if not(self.team_forced > 0)
347 case "red": selection = COLOR_TEAM1; break;
348 case "blue": selection = COLOR_TEAM2; break;
349 case "yellow": selection = COLOR_TEAM3; break;
350 case "pink": selection = COLOR_TEAM4; break;
351 case "auto": selection = (-1); break;
353 default: selection = 0; break;
358 if(self.team == selection && self.deadflag == DEAD_NO)
359 sprint(self, "^7You already are on that team.\n");
360 else if(self.wasplayer && autocvar_g_changeteam_banned)
361 sprint(self, "^1You cannot change team, forbidden by the server.\n");
363 ClientKill_TeamChange(selection);
367 sprint(self, "^7The game has already begun, you must wait until the next map to be able to join a team.\n");
369 sprint(self, "^7selectteam can not be used as your team is forced\n");
371 sprint(self, "^7selectteam can only be used in teamgames\n");
378 sprint(self, "Incorrect parameters for ^2selectteam^7\n");
379 case CMD_REQUEST_USAGE:
381 sprint(self, "\nUsage:^3 cmd selectteam team\n");
382 sprint(self, " Where 'team' is the prefered team to try and join.\n");
383 sprint(self, " Full list of options here: \"red, blue, yellow, pink, auto\"\n");
389 void ClientCommand_selfstuff(float request, string command)
393 case CMD_REQUEST_COMMAND:
397 stuffcmd(self, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
403 sprint(self, "Incorrect parameters for ^2selectteam^7\n");
404 case CMD_REQUEST_USAGE:
406 sprint(self, "\nUsage:^3 cmd selfstuff <command>\n");
407 sprint(self, " Where 'command' is the string to be stuffed to your client.\n");
413 void ClientCommand_sentcvar(float request, float argc, string command)
417 case CMD_REQUEST_COMMAND:
424 if(argc == 2) // undefined cvar: use the default value on the server then
426 s = strcat(substring(command, argv_start_index(0), argv_end_index(1) - argv_start_index(0)), " \"", cvar_defstring(argv(1)), "\"");
437 sprint(self, "Incorrect parameters for ^2sentcvar^7\n");
438 case CMD_REQUEST_USAGE:
440 sprint(self, "\nUsage:^3 cmd sentcvar <cvar>\n");
441 sprint(self, " Where 'cvar' is the cvar plus arguments to send to the server.\n");
447 void ClientCommand_spectate(float request)
451 case CMD_REQUEST_COMMAND:
453 if(self.flags & FL_CLIENT)
455 if(g_arena) { return; }
458 if(self.lms_spectate_warning)
460 // mark player as spectator
461 PlayerScore_Add(self, SP_LMS_RANK, 666 - PlayerScore_Add(self, SP_LMS_RANK, 0));
465 self.lms_spectate_warning = 1;
466 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");
471 if(self.classname == "player" && autocvar_sv_spectate == 1)
472 ClientKill_TeamChange(-2); // observe
474 // in CA, allow a dead player to move to spectators (without that, caplayer!=0 will be moved back to the player list)
475 // note: if arena game mode is ever done properly, this needs to be removed.
476 if(g_ca && self.caplayer && (self.classname == "spectator" || self.classname == "observer"))
478 sprint(self, "WARNING: you will spectate in the next round.\n");
482 return; // never fall through to usage
486 case CMD_REQUEST_USAGE:
488 sprint(self, "\nUsage:^3 cmd spectate\n");
489 sprint(self, " No arguments required.\n");
495 void ClientCommand_suggestmap(float request, float argc)
499 case CMD_REQUEST_COMMAND:
503 sprint(self, strcat(MapVote_Suggest(argv(1)), "\n"));
509 sprint(self, "Incorrect parameters for ^2suggestmap^7\n");
510 case CMD_REQUEST_USAGE:
512 sprint(self, "\nUsage:^3 cmd suggestmap map\n");
513 sprint(self, " Where 'map' is the name of the map to suggest.\n");
519 void ClientCommand_tell(float request, float argc, string command)
523 case CMD_REQUEST_COMMAND:
527 entity tell_to = GetIndexedEntity(argc, 1);
528 float tell_accepted = VerifyClientEntity(tell_to, TRUE, FALSE);
530 if(tell_accepted > 0) // the target is a real client
532 if(tell_to != self) // and we're allowed to send to them :D
534 Say(self, FALSE, tell_to, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)), TRUE);
537 else { print_to(self, "You can't ^2tell^7 a message to yourself."); return; }
539 else if(argv(1) == "#0")
541 trigger_magicear_processmessage_forallears(self, -1, world, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)));
544 else { print_to(self, strcat("tell: ", GetClientErrorString(tell_accepted, argv(1)), ".")); return; }
549 sprint(self, "Incorrect parameters for ^2tell^7\n");
550 case CMD_REQUEST_USAGE:
552 sprint(self, "\nUsage:^3 cmd tell client <message>\n");
553 sprint(self, " Where 'client' is the entity number or name of the player to send 'message' to.\n");
559 void ClientCommand_voice(float request, float argc, string command)
563 case CMD_REQUEST_COMMAND:
568 VoiceMessage(argv(1), substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
570 VoiceMessage(argv(1), "");
577 sprint(self, "Incorrect parameters for ^2voice^7\n");
578 case CMD_REQUEST_USAGE:
580 sprint(self, "\nUsage:^3 cmd voice messagetype <soundname>\n");
581 sprint(self, " 'messagetype' is the type of broadcast to do, like team only or such,\n");
582 sprint(self, " and 'soundname' is the string/filename of the sound/voice message to play.\n");
588 /* use this when creating a new command, making sure to place it in alphabetical order... also,
589 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
590 void ClientCommand_(float request)
594 case CMD_REQUEST_COMMAND:
597 return; // never fall through to usage
601 case CMD_REQUEST_USAGE:
603 sprint(self, "\nUsage:^3 cmd \n");
604 sprint(self, " No arguments required.\n");
612 // =====================================
613 // Macro system for networked commands
614 // =====================================
616 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
617 #define CLIENT_COMMANDS(request,arguments,command) \
618 CLIENT_COMMAND("autoswitch", ClientCommand_autoswitch(request, arguments), "Whether or not to switch automatically when getting a better weapon") \
619 CLIENT_COMMAND("checkfail", ClientCommand_checkfail(request, command), "Report if a client-side check failed") \
620 CLIENT_COMMAND("clientversion", ClientCommand_clientversion(request, arguments), "Release version of the game") \
621 CLIENT_COMMAND("mv_getpicture", ClientCommand_mv_getpicture(request, arguments), "Retrieve mapshot picture from the server") \
622 CLIENT_COMMAND("join", ClientCommand_join(request), "Become a player in the game") \
623 CLIENT_COMMAND("mobspawn", ClientCommand_mobspawn(request, arguments), "Spawn monsters infront of yourself") \
624 CLIENT_COMMAND("ready", ClientCommand_ready(request), "Qualify as ready to end warmup stage (or restart server if allowed)") \
625 CLIENT_COMMAND("say", ClientCommand_say(request, arguments, command), "Print a message to chat to all players") \
626 CLIENT_COMMAND("say_team", ClientCommand_say_team(request, arguments, command), "Print a message to chat to all team mates") \
627 CLIENT_COMMAND("selectteam", ClientCommand_selectteam(request, arguments), "Attempt to choose a team to join into") \
628 CLIENT_COMMAND("selfstuff", ClientCommand_selfstuff(request, command), "Stuffcmd a command to your own client") \
629 CLIENT_COMMAND("sentcvar", ClientCommand_sentcvar(request, arguments, command), "New system for sending a client cvar to the server") \
630 CLIENT_COMMAND("spectate", ClientCommand_spectate(request), "Become an observer") \
631 CLIENT_COMMAND("suggestmap", ClientCommand_suggestmap(request, arguments), "Suggest a map to the mapvote at match end") \
632 CLIENT_COMMAND("tell", ClientCommand_tell(request, arguments, command), "Send a message directly to a player") \
633 CLIENT_COMMAND("voice", ClientCommand_voice(request, arguments, command), "Send voice message via sound") \
636 void ClientCommand_macro_help()
638 #define CLIENT_COMMAND(name,function,description) \
639 { sprint(self, " ^2", name, "^7: ", description, "\n"); }
641 CLIENT_COMMANDS(0, 0, "")
642 #undef CLIENT_COMMAND
647 float ClientCommand_macro_command(float argc, string command)
649 #define CLIENT_COMMAND(name,function,description) \
650 { if(name == strtolower(argv(0))) { function; return TRUE; } }
652 CLIENT_COMMANDS(CMD_REQUEST_COMMAND, argc, command)
653 #undef CLIENT_COMMAND
658 float ClientCommand_macro_usage(float argc)
660 #define CLIENT_COMMAND(name,function,description) \
661 { if(name == strtolower(argv(1))) { function; return TRUE; } }
663 CLIENT_COMMANDS(CMD_REQUEST_USAGE, argc, "")
664 #undef CLIENT_COMMAND
669 void ClientCommand_macro_write_aliases(float fh)
671 #define CLIENT_COMMAND(name,function,description) \
672 { CMD_Write_Alias("qc_cmd_cmd", name, description); }
674 CLIENT_COMMANDS(0, 0, "")
675 #undef CLIENT_COMMAND
680 // ======================================
681 // Main Function Called By Engine (cmd)
682 // ======================================
683 // If this function exists, server game code parses clientcommand before the engine code gets it.
685 void SV_ParseClientCommand(string command)
687 // if we're banned, don't even parse the command
688 if(Ban_MaybeEnforceBanOnce(self))
691 float argc = tokenize_console(command);
693 // for the mutator hook system
694 cmd_name = strtolower(argv(0));
696 cmd_string = command;
698 // Guide for working with argc arguments by example:
699 // argc: 1 - 2 - 3 - 4
700 // argv: 0 - 1 - 2 - 3
701 // cmd vote - master - login - password
704 switch(strtolower(argv(0)))
706 // exempt commands which are not subject to floodcheck
707 case "begin": break; // handled by engine in host_cmd.c
708 case "download": break; // handled by engine in cl_parse.c
709 case "mv_getpicture": break; // handled by server in this file
710 case "pause": break; // handled by engine in host_cmd.c
711 case "prespawn": break; // handled by engine in host_cmd.c
712 case "sentcvar": break; // handled by server in this file
713 case "spawn": break; // handled by engine in host_cmd.c
716 if(SV_ParseClientCommand_floodcheck())
717 break; // "TRUE": continue, as we're not flooding yet
719 return; // "FALSE": not allowed to continue, halt // print("^1ERROR: ^7ANTISPAM CAUGHT: ", command, ".\n");
722 /* NOTE: should this be disabled? It can be spammy perhaps, but hopefully it's okay for now */
723 if(argv(0) == "help")
727 sprint(self, "\nClient networked commands:\n");
728 ClientCommand_macro_help();
730 sprint(self, "\nCommon networked commands:\n");
731 CommonCommand_macro_help(self);
733 sprint(self, "\nUsage:^3 cmd COMMAND...^7, where possible commands are listed above.\n");
734 sprint(self, "For help about a specific command, type cmd help COMMAND\n");
737 else if(CommonCommand_macro_usage(argc, self)) // Instead of trying to call a command, we're going to see detailed information about it
741 else if(ClientCommand_macro_usage(argc)) // same, but for normal commands now
746 else if(MUTATOR_CALLHOOK(SV_ParseClientCommand))
748 return; // handled by a mutator
750 else if(CheatCommand(argc))
752 return; // handled by server/cheats.qc
754 else if(CommonCommand_macro_command(argc, self, command))
756 return; // handled by server/command/common.qc
758 else if(ClientCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
760 return; // handled by one of the above ClientCommand_* functions
763 clientcommand(self, command);