1 // =========================================================
2 // Server side networked commands code, reworked by Samual
3 // Last updated: December 28th, 2011
4 // =========================================================
6 float SV_ParseClientCommand_floodcheck()
8 if (!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:
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:
153 if(!IS_PLAYER(self) && !lockteams)
155 if(nJoinAllowed(self))
157 if(autocvar_g_campaign) { campaign_bots_may_start = 1; }
159 self.classname = "player";
160 PlayerScore_Clear(self);
161 Kill_Notification(NOTIF_ONE_ONLY, self, MSG_CENTER_CPID, CPID_PREVENT_JOIN);
162 Send_Notification(NOTIF_ALL, world, MSG_INFO, INFO_JOIN_PLAY, self.netname);
167 //player may not join because of g_maxplayers is set
168 Send_Notification(NOTIF_ONE_ONLY, self, MSG_CENTER, CENTER_JOIN_PREVENT);
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_mobedit(float request, float argc)
189 case CMD_REQUEST_COMMAND:
191 if(argv(1) && argv(2))
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(!(trace_ent.flags & FL_MONSTER)) { sprint(self, "You need to aim at your monster to edit its properties.\n"); }
197 else if(trace_ent.realowner != self) { sprint(self, "That monster does not belong to you.\n"); }
198 else // all went well, continue
204 if(trace_ent.monsterid != MON_MAGE)
205 trace_ent.skin = stof(argv(2));
210 trace_ent.monster_moveflags = stof(argv(2));
220 sprint(self, "Incorrect parameters for ^2mobedit^7\n");
221 case CMD_REQUEST_USAGE:
223 sprint(self, "\nUsage:^3 cmd mobedit [argument]\n");
224 sprint(self, " Where 'argument' can be skin or movetarget.\n");
230 void ClientCommand_mobkill(float request)
234 case CMD_REQUEST_COMMAND:
236 makevectors(self.v_angle);
237 WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * 100, MOVE_NORMAL, self);
239 if(trace_ent.flags & FL_MONSTER)
241 if(trace_ent.realowner != self)
243 sprint(self, "That monster does not belong to you.\n");
246 sprint(self, strcat("Your pet '", trace_ent.monster_name, "' has been brutally mutilated.\n"));
247 Damage (trace_ent, world, world, trace_ent.health + trace_ent.max_health + 200, DEATH_KILL, trace_ent.origin, '0 0 0');
251 sprint(self, "You need to aim at your monster to kill it.\n");
257 sprint(self, "Incorrect parameters for ^2mobkill^7\n");
258 case CMD_REQUEST_USAGE:
260 sprint(self, "\nUsage:^3 cmd mobkill\n");
261 sprint(self, " Aim at your monster to kill it.\n");
267 void ClientCommand_mobspawn(float request, float argc)
271 case CMD_REQUEST_COMMAND:
277 moveflag = (argv(2) ? stof(argv(2)) : 1); // follow owner if not defined
278 tospawn = strtolower(argv(1));
280 if(tospawn == "list")
282 sprint(self, monsterlist_reply);
286 if(autocvar_g_monsters_max <= 0 || autocvar_g_monsters_max_perplayer <= 0) { sprint(self, "Monster spawning is disabled.\n"); }
287 else if(!IS_PLAYER(self)) { sprint(self, "You can't spawn monsters while spectating.\n"); }
288 else if(tospawn == "") { sprint(self, "No argument specified.\n"); }
289 else if(g_invasion) { sprint(self, "You can't spawn monsters during an invasion!\n"); }
290 else if(!autocvar_g_monsters) { Send_Notification(NOTIF_ONE, self, MSG_INFO, INFO_MONSTERS_DISABLED); }
291 else if(self.vehicle) { sprint(self, "You can't spawn monsters while driving a vehicle.\n"); }
292 else if(autocvar_g_campaign) { sprint(self, "You can't spawn monsters in campaign mode.\n"); }
293 else if(self.deadflag != DEAD_NO) { sprint(self, "You can't spawn monsters while dead.\n"); }
294 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"); }
295 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"); }
296 else // all worked out, so continue
298 self.monstercount += 1;
301 makevectors(self.v_angle);
302 WarpZone_TraceBox (CENTER_OR_VIEWOFS(self), PL_MIN, PL_MAX, CENTER_OR_VIEWOFS(self) + v_forward * 150, TRUE, self);
303 //WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * 150, MOVE_NORMAL, self);
305 e = spawnmonster(tospawn, 0, self, self, trace_endpos, FALSE, moveflag);
307 sprint(self, strcat("Spawned ", e.monster_name, "\n"));
314 sprint(self, "Incorrect parameters for ^2mobspawn^7\n");
315 case CMD_REQUEST_USAGE:
317 sprint(self, "\nUsage:^3 cmd mobspawn <random> <monster> [movetype]\n");
318 sprint(self, " See 'cmd mobspawn list' for available arguments.\n");
319 sprint(self, " Argument 'random' spawns a random monster.\n");
320 sprint(self, " Monster will follow the owner if second argument is not defined.\n");
326 void ClientCommand_ready(float request) // todo: anti-spam for toggling readyness
330 case CMD_REQUEST_COMMAND:
334 if(warmup_stage || autocvar_sv_ready_restart || g_race_qualifying == 2)
336 if(!readyrestart_happened || autocvar_sv_ready_restart_repeatable)
338 if(time < game_starttime) // game is already restarting
340 if (self.ready) // toggle
343 bprint(self.netname, "^2 is ^1NOT^2 ready\n");
348 bprint(self.netname, "^2 is ready\n");
351 // cannot reset the game while a timeout is active!
355 sprint(self, "^1Game has already been restarted\n");
359 return; // never fall through to usage
363 case CMD_REQUEST_USAGE:
365 sprint(self, "\nUsage:^3 cmd ready\n");
366 sprint(self, " No arguments required.\n");
372 void ClientCommand_say(float request, float argc, string command)
376 case CMD_REQUEST_COMMAND:
378 if(argc >= 2) { Say(self, FALSE, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
379 return; // never fall through to usage
383 case CMD_REQUEST_USAGE:
385 sprint(self, "\nUsage:^3 cmd say <message>\n");
386 sprint(self, " Where 'message' is the string of text to say.\n");
392 void ClientCommand_say_team(float request, float argc, string command)
396 case CMD_REQUEST_COMMAND:
398 if(argc >= 2) { Say(self, TRUE, world, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1); }
399 return; // never fall through to usage
403 case CMD_REQUEST_USAGE:
405 sprint(self, "\nUsage:^3 cmd say_team <message>\n");
406 sprint(self, " Where 'message' is the string of text to say.\n");
412 void ClientCommand_selectteam(float request, float argc)
416 case CMD_REQUEST_COMMAND:
423 if(self.team_forced <= 0)
430 case "red": selection = NUM_TEAM_1; break;
431 case "blue": selection = NUM_TEAM_2; break;
432 case "yellow": selection = NUM_TEAM_3; break;
433 case "pink": selection = NUM_TEAM_4; break;
434 case "auto": selection = (-1); break;
436 default: selection = 0; break;
441 if(self.team == selection && self.deadflag == DEAD_NO)
442 sprint(self, "^7You already are on that team.\n");
443 else if(self.wasplayer && autocvar_g_changeteam_banned)
444 sprint(self, "^1You cannot change team, forbidden by the server.\n");
446 ClientKill_TeamChange(selection);
450 sprint(self, "^7The game has already begun, you must wait until the next map to be able to join a team.\n");
452 sprint(self, "^7selectteam can not be used as your team is forced\n");
454 sprint(self, "^7selectteam can only be used in teamgames\n");
461 sprint(self, "Incorrect parameters for ^2selectteam^7\n");
462 case CMD_REQUEST_USAGE:
464 sprint(self, "\nUsage:^3 cmd selectteam team\n");
465 sprint(self, " Where 'team' is the prefered team to try and join.\n");
466 sprint(self, " Full list of options here: \"red, blue, yellow, pink, auto\"\n");
472 void ClientCommand_selfstuff(float request, string command)
476 case CMD_REQUEST_COMMAND:
480 stuffcmd(self, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
486 sprint(self, "Incorrect parameters for ^2selectteam^7\n");
487 case CMD_REQUEST_USAGE:
489 sprint(self, "\nUsage:^3 cmd selfstuff <command>\n");
490 sprint(self, " Where 'command' is the string to be stuffed to your client.\n");
496 void ClientCommand_sentcvar(float request, float argc, string command)
500 case CMD_REQUEST_COMMAND:
507 if(argc == 2) // undefined cvar: use the default value on the server then
509 s = strcat(substring(command, argv_start_index(0), argv_end_index(1) - argv_start_index(0)), " \"", cvar_defstring(argv(1)), "\"");
520 sprint(self, "Incorrect parameters for ^2sentcvar^7\n");
521 case CMD_REQUEST_USAGE:
523 sprint(self, "\nUsage:^3 cmd sentcvar <cvar>\n");
524 sprint(self, " Where 'cvar' is the cvar plus arguments to send to the server.\n");
530 void ClientCommand_spectate(float request)
534 case CMD_REQUEST_COMMAND:
540 if(self.lms_spectate_warning)
542 // for the forfeit message...
543 self.lms_spectate_warning = 2;
544 // mark player as spectator
545 PlayerScore_Add(self, SP_LMS_RANK, 666 - PlayerScore_Add(self, SP_LMS_RANK, 0));
549 self.lms_spectate_warning = 1;
550 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");
555 if(IS_PLAYER(self) && autocvar_sv_spectate == 1)
556 ClientKill_TeamChange(-2); // observe
558 // in CA, allow a dead player to move to spectators (without that, caplayer!=0 will be moved back to the player list)
559 // note: if arena game mode is ever done properly, this needs to be removed.
560 if(self.caplayer && (IS_SPEC(self) || IS_OBSERVER(self)))
562 sprint(self, "WARNING: you will spectate in the next round.\n");
566 return; // never fall through to usage
570 case CMD_REQUEST_USAGE:
572 sprint(self, "\nUsage:^3 cmd spectate\n");
573 sprint(self, " No arguments required.\n");
579 void ClientCommand_suggestmap(float request, float argc)
583 case CMD_REQUEST_COMMAND:
587 sprint(self, strcat(MapVote_Suggest(argv(1)), "\n"));
593 sprint(self, "Incorrect parameters for ^2suggestmap^7\n");
594 case CMD_REQUEST_USAGE:
596 sprint(self, "\nUsage:^3 cmd suggestmap map\n");
597 sprint(self, " Where 'map' is the name of the map to suggest.\n");
603 void ClientCommand_tell(float request, float argc, string command)
607 case CMD_REQUEST_COMMAND:
611 entity tell_to = GetIndexedEntity(argc, 1);
612 float tell_accepted = VerifyClientEntity(tell_to, TRUE, FALSE);
614 if(tell_accepted > 0) // the target is a real client
616 if(tell_to != self) // and we're allowed to send to them :D
618 Say(self, FALSE, tell_to, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)), TRUE);
621 else { print_to(self, "You can't ^2tell^7 a message to yourself."); return; }
623 else if(argv(1) == "#0")
625 trigger_magicear_processmessage_forallears(self, -1, world, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)));
628 else { print_to(self, strcat("tell: ", GetClientErrorString(tell_accepted, argv(1)), ".")); return; }
633 sprint(self, "Incorrect parameters for ^2tell^7\n");
634 case CMD_REQUEST_USAGE:
636 sprint(self, "\nUsage:^3 cmd tell client <message>\n");
637 sprint(self, " Where 'client' is the entity number or name of the player to send 'message' to.\n");
643 void ClientCommand_voice(float request, float argc, string command)
647 case CMD_REQUEST_COMMAND:
652 VoiceMessage(argv(1), substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
654 VoiceMessage(argv(1), "");
661 sprint(self, "Incorrect parameters for ^2voice^7\n");
662 case CMD_REQUEST_USAGE:
664 sprint(self, "\nUsage:^3 cmd voice messagetype <soundname>\n");
665 sprint(self, " 'messagetype' is the type of broadcast to do, like team only or such,\n");
666 sprint(self, " and 'soundname' is the string/filename of the sound/voice message to play.\n");
672 /* use this when creating a new command, making sure to place it in alphabetical order... also,
673 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
674 void ClientCommand_(float request)
678 case CMD_REQUEST_COMMAND:
681 return; // never fall through to usage
685 case CMD_REQUEST_USAGE:
687 sprint(self, "\nUsage:^3 cmd \n");
688 sprint(self, " No arguments required.\n");
696 // =====================================
697 // Macro system for networked commands
698 // =====================================
700 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
701 #define CLIENT_COMMANDS(request,arguments,command) \
702 CLIENT_COMMAND("autoswitch", ClientCommand_autoswitch(request, arguments), "Whether or not to switch automatically when getting a better weapon") \
703 CLIENT_COMMAND("checkfail", ClientCommand_checkfail(request, command), "Report if a client-side check failed") \
704 CLIENT_COMMAND("clientversion", ClientCommand_clientversion(request, arguments), "Release version of the game") \
705 CLIENT_COMMAND("mv_getpicture", ClientCommand_mv_getpicture(request, arguments), "Retrieve mapshot picture from the server") \
706 CLIENT_COMMAND("join", ClientCommand_join(request), "Become a player in the game") \
707 CLIENT_COMMAND("mobedit", ClientCommand_mobedit(request, arguments), "Edit your monster's properties") \
708 CLIENT_COMMAND("mobkill", ClientCommand_mobkill(request), "Kills your monster") \
709 CLIENT_COMMAND("mobspawn", ClientCommand_mobspawn(request, arguments), "Spawn monsters infront of yourself") \
710 CLIENT_COMMAND("ready", ClientCommand_ready(request), "Qualify as ready to end warmup stage (or restart server if allowed)") \
711 CLIENT_COMMAND("say", ClientCommand_say(request, arguments, command), "Print a message to chat to all players") \
712 CLIENT_COMMAND("say_team", ClientCommand_say_team(request, arguments, command), "Print a message to chat to all team mates") \
713 CLIENT_COMMAND("selectteam", ClientCommand_selectteam(request, arguments), "Attempt to choose a team to join into") \
714 CLIENT_COMMAND("selfstuff", ClientCommand_selfstuff(request, command), "Stuffcmd a command to your own client") \
715 CLIENT_COMMAND("sentcvar", ClientCommand_sentcvar(request, arguments, command), "New system for sending a client cvar to the server") \
716 CLIENT_COMMAND("spectate", ClientCommand_spectate(request), "Become an observer") \
717 CLIENT_COMMAND("suggestmap", ClientCommand_suggestmap(request, arguments), "Suggest a map to the mapvote at match end") \
718 CLIENT_COMMAND("tell", ClientCommand_tell(request, arguments, command), "Send a message directly to a player") \
719 CLIENT_COMMAND("voice", ClientCommand_voice(request, arguments, command), "Send voice message via sound") \
722 void ClientCommand_macro_help()
724 #define CLIENT_COMMAND(name,function,description) \
725 { sprint(self, " ^2", name, "^7: ", description, "\n"); }
727 CLIENT_COMMANDS(0, 0, "")
728 #undef CLIENT_COMMAND
733 float ClientCommand_macro_command(float argc, string command)
735 #define CLIENT_COMMAND(name,function,description) \
736 { if(name == strtolower(argv(0))) { function; return TRUE; } }
738 CLIENT_COMMANDS(CMD_REQUEST_COMMAND, argc, command)
739 #undef CLIENT_COMMAND
744 float ClientCommand_macro_usage(float argc)
746 #define CLIENT_COMMAND(name,function,description) \
747 { if(name == strtolower(argv(1))) { function; return TRUE; } }
749 CLIENT_COMMANDS(CMD_REQUEST_USAGE, argc, "")
750 #undef CLIENT_COMMAND
755 void ClientCommand_macro_write_aliases(float fh)
757 #define CLIENT_COMMAND(name,function,description) \
758 { CMD_Write_Alias("qc_cmd_cmd", name, description); }
760 CLIENT_COMMANDS(0, 0, "")
761 #undef CLIENT_COMMAND
766 // ======================================
767 // Main Function Called By Engine (cmd)
768 // ======================================
769 // If this function exists, server game code parses clientcommand before the engine code gets it.
771 void SV_ParseClientCommand(string command)
773 // if we're banned, don't even parse the command
774 if(Ban_MaybeEnforceBanOnce(self))
777 float argc = tokenize_console(command);
779 // for the mutator hook system
780 cmd_name = strtolower(argv(0));
782 cmd_string = command;
784 // Guide for working with argc arguments by example:
785 // argc: 1 - 2 - 3 - 4
786 // argv: 0 - 1 - 2 - 3
787 // cmd vote - master - login - password
790 switch(strtolower(argv(0)))
792 // exempt commands which are not subject to floodcheck
793 case "begin": break; // handled by engine in host_cmd.c
794 case "download": break; // handled by engine in cl_parse.c
795 case "mv_getpicture": break; // handled by server in this file
796 case "pause": break; // handled by engine in host_cmd.c
797 case "prespawn": break; // handled by engine in host_cmd.c
798 case "sentcvar": break; // handled by server in this file
799 case "spawn": break; // handled by engine in host_cmd.c
802 if(SV_ParseClientCommand_floodcheck())
803 break; // "TRUE": continue, as we're not flooding yet
805 return; // "FALSE": not allowed to continue, halt // print("^1ERROR: ^7ANTISPAM CAUGHT: ", command, ".\n");
808 /* NOTE: should this be disabled? It can be spammy perhaps, but hopefully it's okay for now */
809 if(argv(0) == "help")
813 sprint(self, "\nClient networked commands:\n");
814 ClientCommand_macro_help();
816 sprint(self, "\nCommon networked commands:\n");
817 CommonCommand_macro_help(self);
819 sprint(self, "\nUsage:^3 cmd COMMAND...^7, where possible commands are listed above.\n");
820 sprint(self, "For help about a specific command, type cmd help COMMAND\n");
823 else if(CommonCommand_macro_usage(argc, self)) // Instead of trying to call a command, we're going to see detailed information about it
827 else if(ClientCommand_macro_usage(argc)) // same, but for normal commands now
832 else if(MUTATOR_CALLHOOK(SV_ParseClientCommand))
834 return; // handled by a mutator
836 else if(CheatCommand(argc))
838 return; // handled by server/cheats.qc
840 else if(CommonCommand_macro_command(argc, self, command))
842 return; // handled by server/command/common.qc
844 else if(ClientCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
846 return; // handled by one of the above ClientCommand_* functions
849 clientcommand(self, command);