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 Kill_Notification(NOTIF_ONE_ONLY, self, MSG_CENTER_CPID, CPID_MOTD);
163 Kill_Notification(NOTIF_ONE_ONLY, self, MSG_CENTER_CPID, CPID_PREVENT_JOIN);
164 Send_Notification(NOTIF_ALL, world, MSG_INFO, INFO_JOIN_PLAY, self.netname);
169 //player may not join because of g_maxplayers is set
170 Send_Notification(NOTIF_ONE_ONLY, self, MSG_CENTER_CPID, CPID_PREVENT_JOIN);
174 return; // never fall through to usage
178 case CMD_REQUEST_USAGE:
180 sprint(self, "\nUsage:^3 cmd join\n");
181 sprint(self, " No arguments required.\n");
187 void ClientCommand_mobedit(float request, float argc)
191 case CMD_REQUEST_COMMAND:
193 makevectors(self.v_angle);
194 WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * 100, MOVE_NORMAL, self);
196 if not(trace_ent.flags & FL_MONSTER) { sprint(self, "You need to aim at your monster to edit its properties.\n"); return; }
197 if(trace_ent.realowner != self) { sprint(self, "That monster does not belong to you.\n"); return; }
201 case "name": trace_ent.netname = strzone(strdecolorize(argv(2))); WaypointSprite_UpdateSprites(trace_ent.sprite, trace_ent.netname, "", ""); break;
202 case "skin": trace_ent.skin = stof(argv(2)); break;
203 case "color": trace_ent.colormod = stov(argv(2)); break;
204 case "movetarget": trace_ent.monster_moveflags = stof(argv(2)); break;
205 default: sprint(self, "Unknown parameter\n"); break;
208 return; // never fall through to usage
211 sprint(self, "Incorrect parameters for ^2mobedit^7\n");
212 case CMD_REQUEST_USAGE:
214 sprint(self, "\nUsage:^3 cmd mobedit [argument]\n");
215 sprint(self, " Where 'argument' can be name, skin, color or movetarget.\n");
221 void ClientCommand_mobkill(float request)
225 case CMD_REQUEST_COMMAND:
227 makevectors(self.v_angle);
228 WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * 100, MOVE_NORMAL, self);
230 if(trace_ent.flags & FL_MONSTER)
232 if(trace_ent.realowner != self)
234 sprint(self, "That monster does not belong to you.\n");
237 sprint(self, strcat("Your pet '", trace_ent.netname, "' has been brutally mutilated.\n"));
238 Damage (trace_ent, world, world, trace_ent.health + trace_ent.max_health, DEATH_KILL, trace_ent.origin, '0 0 0');
242 sprint(self, "You need to aim at your monster to kill it.\n");
248 sprint(self, "Incorrect parameters for ^2mobkill^7\n");
249 case CMD_REQUEST_USAGE:
251 sprint(self, "\nUsage:^3 cmd mobkill\n");
252 sprint(self, " Aim at your monster to kill it.\n");
258 void ClientCommand_mobspawn(float request, float argc)
262 case CMD_REQUEST_COMMAND:
265 string tospawn, mname;
268 moveflag = (argv(2) ? stof(argv(2)) : 1); // follow owner if not defined
272 if(tospawn == "list")
274 sprint(self, "Available monsters:\n");
275 sprint(self, strcat(autocvar_g_monsters_spawn_list, "\n"));
279 if(self.classname != STR_PLAYER) { sprint(self, "You can't spawn monsters while spectating.\n"); }
280 else if not(autocvar_g_monsters) { sprint(self, "Monsters aren't enabled.\n"); }
281 else if(g_td) { sprint(self, "You can't spawn monsters in Tower Defense mode.\n"); }
282 else if(self.deadflag) { sprint(self, "You can't spawn monsters while dead.\n"); }
283 else if(self.monstercount >= autocvar_g_monsters_max_perplayer) { sprint(self, "You have spawned too many monsters, kill some before trying to spawn any more.\n"); }
284 else if(totalspawned >= autocvar_g_monsters_max) { sprint(self, "The global maximum monster count has been reached, kill some before trying to spawn any more.\n"); }
285 else // all worked out, so continue
287 self.monstercount += 1;
290 makevectors(self.v_angle);
291 WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * 150, MOVE_NORMAL, self);
293 e = spawnmonster(tospawn, self, self, trace_endpos, FALSE, moveflag);
294 if(mname) e.netname = strzone(mname);
296 sprint(self, strcat("Spawned 1 ", tospawn, "\n"));
303 sprint(self, "Incorrect parameters for ^2mobspawn^7\n");
304 case CMD_REQUEST_USAGE:
306 sprint(self, "\nUsage:^3 cmd mobspawn monster\n");
307 sprint(self, " See 'cmd mobspawn list' for available arguments.\n");
313 void ClientCommand_ready(float request) // todo: anti-spam for toggling readyness
317 case CMD_REQUEST_COMMAND:
319 if(self.flags & FL_CLIENT)
321 if(inWarmupStage || autocvar_sv_ready_restart || g_race_qualifying == 2)
323 if(!readyrestart_happened || autocvar_sv_ready_restart_repeatable)
325 if (self.ready) // toggle
328 bprint(self.netname, "^2 is ^1NOT^2 ready\n");
333 bprint(self.netname, "^2 is ready\n");
336 // cannot reset the game while a timeout is active!
337 if not(timeout_status)
340 sprint(self, "^1Game has already been restarted\n");
344 return; // never fall through to usage
348 case CMD_REQUEST_USAGE:
350 sprint(self, "\nUsage:^3 cmd ready\n");
351 sprint(self, " No arguments required.\n");
357 void ClientCommand_say(float request, float argc, string command)
361 case CMD_REQUEST_COMMAND:
363 if(argc >= 2) { Say(self, FALSE, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
364 return; // never fall through to usage
368 case CMD_REQUEST_USAGE:
370 sprint(self, "\nUsage:^3 cmd say <message>\n");
371 sprint(self, " Where 'message' is the string of text to say.\n");
377 void ClientCommand_say_team(float request, float argc, string command)
381 case CMD_REQUEST_COMMAND:
383 if(argc >= 2) { Say(self, TRUE, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
384 return; // never fall through to usage
388 case CMD_REQUEST_USAGE:
390 sprint(self, "\nUsage:^3 cmd say_team <message>\n");
391 sprint(self, " Where 'message' is the string of text to say.\n");
397 void ClientCommand_selectteam(float request, float argc)
401 case CMD_REQUEST_COMMAND:
405 if(self.flags & FL_CLIENT)
408 if not(self.team_forced > 0)
415 case "red": selection = NUM_TEAM_1; break;
416 case "blue": selection = NUM_TEAM_2; break;
417 case "yellow": selection = NUM_TEAM_3; break;
418 case "pink": selection = NUM_TEAM_4; break;
419 case "auto": selection = (-1); break;
421 default: selection = 0; break;
426 if(self.team == selection && self.deadflag == DEAD_NO)
427 sprint(self, "^7You already are on that team.\n");
428 else if(self.wasplayer && autocvar_g_changeteam_banned)
429 sprint(self, "^1You cannot change team, forbidden by the server.\n");
431 ClientKill_TeamChange(selection);
435 sprint(self, "^7The game has already begun, you must wait until the next map to be able to join a team.\n");
437 sprint(self, "^7selectteam can not be used as your team is forced\n");
439 sprint(self, "^7selectteam can only be used in teamgames\n");
446 sprint(self, "Incorrect parameters for ^2selectteam^7\n");
447 case CMD_REQUEST_USAGE:
449 sprint(self, "\nUsage:^3 cmd selectteam team\n");
450 sprint(self, " Where 'team' is the prefered team to try and join.\n");
451 sprint(self, " Full list of options here: \"red, blue, yellow, pink, auto\"\n");
457 void ClientCommand_selfstuff(float request, string command)
461 case CMD_REQUEST_COMMAND:
465 stuffcmd(self, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
471 sprint(self, "Incorrect parameters for ^2selectteam^7\n");
472 case CMD_REQUEST_USAGE:
474 sprint(self, "\nUsage:^3 cmd selfstuff <command>\n");
475 sprint(self, " Where 'command' is the string to be stuffed to your client.\n");
481 void ClientCommand_sentcvar(float request, float argc, string command)
485 case CMD_REQUEST_COMMAND:
492 if(argc == 2) // undefined cvar: use the default value on the server then
494 s = strcat(substring(command, argv_start_index(0), argv_end_index(1) - argv_start_index(0)), " \"", cvar_defstring(argv(1)), "\"");
505 sprint(self, "Incorrect parameters for ^2sentcvar^7\n");
506 case CMD_REQUEST_USAGE:
508 sprint(self, "\nUsage:^3 cmd sentcvar <cvar>\n");
509 sprint(self, " Where 'cvar' is the cvar plus arguments to send to the server.\n");
515 void ClientCommand_spectate(float request)
519 case CMD_REQUEST_COMMAND:
521 if(self.flags & FL_CLIENT)
523 if(g_arena) { return; }
526 if(self.lms_spectate_warning)
528 // for the forfeit message...
529 self.lms_spectate_warning = 2;
530 // mark player as spectator
531 PlayerScore_Add(self, SP_LMS_RANK, 666 - PlayerScore_Add(self, SP_LMS_RANK, 0));
535 self.lms_spectate_warning = 1;
536 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");
541 if(self.classname == "player" && autocvar_sv_spectate == 1)
542 ClientKill_TeamChange(-2); // observe
544 // in CA, allow a dead player to move to spectators (without that, caplayer!=0 will be moved back to the player list)
545 // note: if arena game mode is ever done properly, this needs to be removed.
546 if(g_ca && self.caplayer && (self.classname == "spectator" || self.classname == "observer"))
548 sprint(self, "WARNING: you will spectate in the next round.\n");
552 return; // never fall through to usage
556 case CMD_REQUEST_USAGE:
558 sprint(self, "\nUsage:^3 cmd spectate\n");
559 sprint(self, " No arguments required.\n");
565 void ClientCommand_suggestmap(float request, float argc)
569 case CMD_REQUEST_COMMAND:
573 sprint(self, strcat(MapVote_Suggest(argv(1)), "\n"));
579 sprint(self, "Incorrect parameters for ^2suggestmap^7\n");
580 case CMD_REQUEST_USAGE:
582 sprint(self, "\nUsage:^3 cmd suggestmap map\n");
583 sprint(self, " Where 'map' is the name of the map to suggest.\n");
589 void ClientCommand_tell(float request, float argc, string command)
593 case CMD_REQUEST_COMMAND:
597 entity tell_to = GetIndexedEntity(argc, 1);
598 float tell_accepted = VerifyClientEntity(tell_to, TRUE, FALSE);
600 if(tell_accepted > 0) // the target is a real client
602 if(tell_to != self) // and we're allowed to send to them :D
604 Say(self, FALSE, tell_to, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)), TRUE);
607 else { print_to(self, "You can't ^2tell^7 a message to yourself."); return; }
609 else if(argv(1) == "#0")
611 trigger_magicear_processmessage_forallears(self, -1, world, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)));
614 else { print_to(self, strcat("tell: ", GetClientErrorString(tell_accepted, argv(1)), ".")); return; }
619 sprint(self, "Incorrect parameters for ^2tell^7\n");
620 case CMD_REQUEST_USAGE:
622 sprint(self, "\nUsage:^3 cmd tell client <message>\n");
623 sprint(self, " Where 'client' is the entity number or name of the player to send 'message' to.\n");
629 void ClientCommand_voice(float request, float argc, string command)
633 case CMD_REQUEST_COMMAND:
638 VoiceMessage(argv(1), substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
640 VoiceMessage(argv(1), "");
647 sprint(self, "Incorrect parameters for ^2voice^7\n");
648 case CMD_REQUEST_USAGE:
650 sprint(self, "\nUsage:^3 cmd voice messagetype <soundname>\n");
651 sprint(self, " 'messagetype' is the type of broadcast to do, like team only or such,\n");
652 sprint(self, " and 'soundname' is the string/filename of the sound/voice message to play.\n");
658 /* use this when creating a new command, making sure to place it in alphabetical order... also,
659 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
660 void ClientCommand_(float request)
664 case CMD_REQUEST_COMMAND:
667 return; // never fall through to usage
671 case CMD_REQUEST_USAGE:
673 sprint(self, "\nUsage:^3 cmd \n");
674 sprint(self, " No arguments required.\n");
682 // =====================================
683 // Macro system for networked commands
684 // =====================================
686 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
687 #define CLIENT_COMMANDS(request,arguments,command) \
688 CLIENT_COMMAND("autoswitch", ClientCommand_autoswitch(request, arguments), "Whether or not to switch automatically when getting a better weapon") \
689 CLIENT_COMMAND("checkfail", ClientCommand_checkfail(request, command), "Report if a client-side check failed") \
690 CLIENT_COMMAND("clientversion", ClientCommand_clientversion(request, arguments), "Release version of the game") \
691 CLIENT_COMMAND("mv_getpicture", ClientCommand_mv_getpicture(request, arguments), "Retrieve mapshot picture from the server") \
692 CLIENT_COMMAND("join", ClientCommand_join(request), "Become a player in the game") \
693 CLIENT_COMMAND("mobedit", ClientCommand_mobedit(request, arguments), "Edit your monster's properties") \
694 CLIENT_COMMAND("mobkill", ClientCommand_mobkill(request), "Kills your monster") \
695 CLIENT_COMMAND("mobspawn", ClientCommand_mobspawn(request, arguments), "Spawn monsters infront of yourself") \
696 CLIENT_COMMAND("ready", ClientCommand_ready(request), "Qualify as ready to end warmup stage (or restart server if allowed)") \
697 CLIENT_COMMAND("say", ClientCommand_say(request, arguments, command), "Print a message to chat to all players") \
698 CLIENT_COMMAND("say_team", ClientCommand_say_team(request, arguments, command), "Print a message to chat to all team mates") \
699 CLIENT_COMMAND("selectteam", ClientCommand_selectteam(request, arguments), "Attempt to choose a team to join into") \
700 CLIENT_COMMAND("selfstuff", ClientCommand_selfstuff(request, command), "Stuffcmd a command to your own client") \
701 CLIENT_COMMAND("sentcvar", ClientCommand_sentcvar(request, arguments, command), "New system for sending a client cvar to the server") \
702 CLIENT_COMMAND("spectate", ClientCommand_spectate(request), "Become an observer") \
703 CLIENT_COMMAND("suggestmap", ClientCommand_suggestmap(request, arguments), "Suggest a map to the mapvote at match end") \
704 CLIENT_COMMAND("tell", ClientCommand_tell(request, arguments, command), "Send a message directly to a player") \
705 CLIENT_COMMAND("voice", ClientCommand_voice(request, arguments, command), "Send voice message via sound") \
708 void ClientCommand_macro_help()
710 #define CLIENT_COMMAND(name,function,description) \
711 { sprint(self, " ^2", name, "^7: ", description, "\n"); }
713 CLIENT_COMMANDS(0, 0, "")
714 #undef CLIENT_COMMAND
719 float ClientCommand_macro_command(float argc, string command)
721 #define CLIENT_COMMAND(name,function,description) \
722 { if(name == strtolower(argv(0))) { function; return TRUE; } }
724 CLIENT_COMMANDS(CMD_REQUEST_COMMAND, argc, command)
725 #undef CLIENT_COMMAND
730 float ClientCommand_macro_usage(float argc)
732 #define CLIENT_COMMAND(name,function,description) \
733 { if(name == strtolower(argv(1))) { function; return TRUE; } }
735 CLIENT_COMMANDS(CMD_REQUEST_USAGE, argc, "")
736 #undef CLIENT_COMMAND
741 void ClientCommand_macro_write_aliases(float fh)
743 #define CLIENT_COMMAND(name,function,description) \
744 { CMD_Write_Alias("qc_cmd_cmd", name, description); }
746 CLIENT_COMMANDS(0, 0, "")
747 #undef CLIENT_COMMAND
752 // ======================================
753 // Main Function Called By Engine (cmd)
754 // ======================================
755 // If this function exists, server game code parses clientcommand before the engine code gets it.
757 void SV_ParseClientCommand(string command)
759 // if we're banned, don't even parse the command
760 if(Ban_MaybeEnforceBanOnce(self))
763 float argc = tokenize_console(command);
765 // for the mutator hook system
766 cmd_name = strtolower(argv(0));
768 cmd_string = command;
770 // Guide for working with argc arguments by example:
771 // argc: 1 - 2 - 3 - 4
772 // argv: 0 - 1 - 2 - 3
773 // cmd vote - master - login - password
776 switch(strtolower(argv(0)))
778 // exempt commands which are not subject to floodcheck
779 case "begin": break; // handled by engine in host_cmd.c
780 case "download": break; // handled by engine in cl_parse.c
781 case "mv_getpicture": break; // handled by server in this file
782 case "pause": break; // handled by engine in host_cmd.c
783 case "prespawn": break; // handled by engine in host_cmd.c
784 case "sentcvar": break; // handled by server in this file
785 case "spawn": break; // handled by engine in host_cmd.c
788 if(SV_ParseClientCommand_floodcheck())
789 break; // "TRUE": continue, as we're not flooding yet
791 return; // "FALSE": not allowed to continue, halt // print("^1ERROR: ^7ANTISPAM CAUGHT: ", command, ".\n");
794 /* NOTE: should this be disabled? It can be spammy perhaps, but hopefully it's okay for now */
795 if(argv(0) == "help")
799 sprint(self, "\nClient networked commands:\n");
800 ClientCommand_macro_help();
802 sprint(self, "\nCommon networked commands:\n");
803 CommonCommand_macro_help(self);
805 sprint(self, "\nUsage:^3 cmd COMMAND...^7, where possible commands are listed above.\n");
806 sprint(self, "For help about a specific command, type cmd help COMMAND\n");
809 else if(CommonCommand_macro_usage(argc, self)) // Instead of trying to call a command, we're going to see detailed information about it
813 else if(ClientCommand_macro_usage(argc)) // same, but for normal commands now
818 else if(MUTATOR_CALLHOOK(SV_ParseClientCommand))
820 return; // handled by a mutator
822 else if(CheatCommand(argc))
824 return; // handled by server/cheats.qc
826 else if(CommonCommand_macro_command(argc, self, command))
828 return; // handled by server/command/common.qc
830 else if(ClientCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
832 return; // handled by one of the above ClientCommand_* functions
835 clientcommand(self, command);