2 #include <common/command/_mod.qh>
7 #include "../campaign.qh"
8 #include "../cheats.qh"
9 #include "../player.qh"
10 #include "../ipban.qh"
11 #include "../mapvoting.qh"
12 #include "../scores.qh"
13 #include "../teamplay.qh"
15 #include "../mutators/_mod.qh"
18 #include <common/vehicles/all.qh>
21 #include <common/constants.qh>
22 #include <common/deathtypes/all.qh>
23 #include <common/effects/all.qh>
24 #include <common/mapinfo.qh>
25 #include <common/notifications/all.qh>
26 #include <common/physics/player.qh>
27 #include <common/teams.qh>
28 #include <common/util.qh>
29 #include <common/triggers/triggers.qh>
31 #include <common/minigames/sv_minigames.qh>
33 #include <common/monsters/_mod.qh>
34 #include <common/monsters/sv_spawn.qh>
35 #include <common/monsters/sv_monsters.qh>
37 #include <lib/warpzone/common.qh>
39 void ClientKill_TeamChange(entity this, float targetteam); // 0 = don't change, -1 = auto, -2 = spec
41 // =========================================================
42 // Server side networked commands code, reworked by Samual
43 // Last updated: December 28th, 2011
44 // =========================================================
46 bool SV_ParseClientCommand_floodcheck(entity this)
48 if (!timeout_status) // not while paused
50 if (time <= (this.cmd_floodtime + autocvar_sv_clientcommand_antispam_time))
52 this.cmd_floodcount += 1;
53 if (this.cmd_floodcount > autocvar_sv_clientcommand_antispam_count) return false; // too much spam, halt
57 this.cmd_floodtime = time;
58 this.cmd_floodcount = 1;
61 return true; // continue, as we're not flooding yet
65 // =======================
66 // Command Sub-Functions
67 // =======================
69 void ClientCommand_autoswitch(entity caller, float request, float argc)
73 case CMD_REQUEST_COMMAND:
77 caller.autoswitch = InterpretBoolean(argv(1));
78 sprint(caller, strcat("^1autoswitch is currently turned ", (caller.autoswitch ? "on" : "off"), ".\n"));
84 sprint(caller, "Incorrect parameters for ^2autoswitch^7\n");
85 case CMD_REQUEST_USAGE:
87 sprint(caller, "\nUsage:^3 cmd autoswitch selection\n");
88 sprint(caller, " Where 'selection' controls if autoswitch is on or off.\n");
94 void ClientCommand_clientversion(entity caller, float request, float argc) // internal command, used only by code
98 case CMD_REQUEST_COMMAND:
102 if (IS_CLIENT(caller))
104 caller.version = ((argv(1) == "$gameversion") ? 1 : stof(argv(1)));
106 if (caller.version < autocvar_gameversion_min || caller.version > autocvar_gameversion_max)
108 caller.version_mismatch = 1;
109 ClientKill_TeamChange(caller, -2); // observe
111 else if (autocvar_g_campaign || autocvar_g_balance_teams)
113 // JoinBestTeam(caller, false, true);
115 else if (teamplay && !autocvar_sv_spectate && !(caller.team_forced > 0))
117 TRANSMUTE(Observer, caller); // really?
118 stuffcmd(caller, "menu_showteamselect\n");
127 sprint(caller, "Incorrect parameters for ^2clientversion^7\n");
128 case CMD_REQUEST_USAGE:
130 sprint(caller, "\nUsage:^3 cmd clientversion version\n");
131 sprint(caller, " Where 'version' is the game version reported by caller.\n");
137 void ClientCommand_mv_getpicture(entity caller, float request, float argc) // internal command, used only by code
141 case CMD_REQUEST_COMMAND:
145 if (intermission_running) MapVote_SendPicture(caller, stof(argv(1)));
152 sprint(caller, "Incorrect parameters for ^2mv_getpicture^7\n");
153 case CMD_REQUEST_USAGE:
155 sprint(caller, "\nUsage:^3 cmd mv_getpicture mapid\n");
156 sprint(caller, " Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.\n");
162 bool joinAllowed(entity this);
163 void Join(entity this);
164 void ClientCommand_join(entity caller, float request)
168 case CMD_REQUEST_COMMAND:
171 if (IS_CLIENT(caller) && !IS_PLAYER(caller))
172 if (joinAllowed(caller))
175 return; // never fall through to usage
179 case CMD_REQUEST_USAGE:
181 sprint(caller, "\nUsage:^3 cmd join\n");
182 sprint(caller, " No arguments required.\n");
188 void ClientCommand_physics(entity caller, float request, float argc)
192 case CMD_REQUEST_COMMAND:
194 string command = strtolower(argv(1));
196 if (!autocvar_g_physics_clientselect)
198 sprint(caller, "Client physics selection is currently disabled.\n");
202 if (command == "list" || command == "help")
204 sprint(caller, strcat("Available physics sets: \n\n", autocvar_g_physics_clientselect_options, " default\n"));
208 if (Physics_Valid(command) || command == "default")
210 stuffcmd(caller, strcat("\nseta cl_physics ", command, "\nsendcvar cl_physics\n"));
211 sprint(caller, strcat("^2Physics set successfully changed to ^3", command, "\n"));
217 sprint(caller, strcat("Current physics set: ^3", caller.cvar_cl_physics, "\n"));
218 case CMD_REQUEST_USAGE:
220 sprint(caller, "\nUsage:^3 cmd physics <physics>\n");
221 sprint(caller, " See 'cmd physics list' for available physics sets.\n");
222 sprint(caller, " Argument 'default' resets to standard physics.\n");
228 void ClientCommand_ready(entity caller, float request) // todo: anti-spam for toggling readyness
232 case CMD_REQUEST_COMMAND:
234 if (IS_CLIENT(caller))
236 if (warmup_stage || autocvar_sv_ready_restart || g_race_qualifying == 2)
238 if (!readyrestart_happened || autocvar_sv_ready_restart_repeatable)
240 if (time < game_starttime) // game is already restarting
242 if (caller.ready) // toggle
244 caller.ready = false;
245 bprint(playername(caller, false), "^2 is ^1NOT^2 ready\n");
250 bprint(playername(caller, false), "^2 is ready\n");
253 // cannot reset the game while a timeout is active!
254 if (!timeout_status) ReadyCount();
258 sprint(caller, "^1Game has already been restarted\n");
262 return; // never fall through to usage
266 case CMD_REQUEST_USAGE:
268 sprint(caller, "\nUsage:^3 cmd ready\n");
269 sprint(caller, " No arguments required.\n");
275 void ClientCommand_say(entity caller, float request, float argc, string command)
279 case CMD_REQUEST_COMMAND:
281 if (argc >= 2) Say(caller, false, NULL, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1);
282 return; // never fall through to usage
286 case CMD_REQUEST_USAGE:
288 sprint(caller, "\nUsage:^3 cmd say <message>\n");
289 sprint(caller, " Where 'message' is the string of text to say.\n");
295 void ClientCommand_say_team(entity caller, float request, float argc, string command)
299 case CMD_REQUEST_COMMAND:
301 if (argc >= 2) Say(caller, true, NULL, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)), 1);
302 return; // never fall through to usage
306 case CMD_REQUEST_USAGE:
308 sprint(caller, "\nUsage:^3 cmd say_team <message>\n");
309 sprint(caller, " Where 'message' is the string of text to say.\n");
316 void ClientCommand_selectteam(entity caller, float request, float argc)
320 case CMD_REQUEST_COMMAND:
326 if (!IS_CLIENT(caller))
332 sprint(caller, "^7selectteam can only be used in teamgames\n");
335 if (caller.team_forced > 0)
337 sprint(caller, "^7selectteam can not be used as your team is forced\n");
342 sprint(caller, "^7The game has already begun, you must wait until the next map to be able to join a team.\n");
350 selection = NUM_TEAM_1;
355 selection = NUM_TEAM_2;
360 selection = NUM_TEAM_3;
365 selection = NUM_TEAM_4;
378 if (caller.team == selection && selection != -1 && !IS_DEAD(caller))
380 sprint(caller, "^7You already are on that team.\n");
383 if (caller.wasplayer && autocvar_g_changeteam_banned)
385 sprint(caller, "^1You cannot change team, forbidden by the server.\n");
390 ClientKill_TeamChange(caller, selection);
391 if (!IS_PLAYER(caller))
393 caller.team_selected = true; // avoids asking again for team selection on join
397 if (autocvar_g_balance_teams && autocvar_g_balance_teams_prevent_imbalance)
399 CheckAllowedTeams(caller);
400 GetTeamCounts(caller);
401 if ((BIT(Team_TeamToNumber(selection) - 1) & FindBestTeams(caller, false)) == 0)
403 Send_Notification(NOTIF_ONE, caller, MSG_INFO, INFO_TEAMCHANGE_LARGERTEAM);
407 ClientKill_TeamChange(caller, selection);
408 if (!IS_PLAYER(caller))
410 caller.team_selected = true; // avoids asking again for team selection on join
415 sprint(caller, "Incorrect parameters for ^2selectteam^7\n");
416 case CMD_REQUEST_USAGE:
418 sprint(caller, "\nUsage:^3 cmd selectteam team\n");
419 sprint(caller, " Where 'team' is the prefered team to try and join.\n");
420 sprint(caller, " Full list of options here: \"red, blue, yellow, pink, auto\"\n");
426 void ClientCommand_selfstuff(entity caller, float request, string command)
430 case CMD_REQUEST_COMMAND:
434 stuffcmd(caller, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
440 sprint(caller, "Incorrect parameters for ^2selfstuff^7\n");
441 case CMD_REQUEST_USAGE:
443 sprint(caller, "\nUsage:^3 cmd selfstuff <command>\n");
444 sprint(caller, " Where 'command' is the string to be stuffed to your client.\n");
450 void ClientCommand_sentcvar(entity caller, float request, float argc, string command)
454 case CMD_REQUEST_COMMAND:
461 if (argc == 2) // undefined cvar: use the default value on the server then
463 s = strcat(substring(command, argv_start_index(0), argv_end_index(1) - argv_start_index(0)), " \"", cvar_defstring(argv(1)), "\"");
474 sprint(caller, "Incorrect parameters for ^2sentcvar^7\n");
475 case CMD_REQUEST_USAGE:
477 sprint(caller, "\nUsage:^3 cmd sentcvar <cvar>\n");
478 sprint(caller, " Where 'cvar' is the cvar plus arguments to send to the server.\n");
484 void ClientCommand_spectate(entity caller, float request)
488 case CMD_REQUEST_COMMAND:
490 if (!intermission_running && IS_CLIENT(caller))
492 if((IS_SPEC(caller) || IS_OBSERVER(caller)) && argv(1) != "")
494 entity client = GetFilteredEntity(argv(1));
495 int spec_accepted = VerifyClientEntity(client, false, false);
496 if(spec_accepted > 0 && IS_PLAYER(client))
498 if(Spectate(caller, client))
499 return; // fall back to regular handling
503 int mutator_returnvalue = MUTATOR_CALLHOOK(ClientCommand_Spectate, caller);
505 if (mutator_returnvalue == MUT_SPECCMD_RETURN) return;
507 if ((IS_PLAYER(caller) || mutator_returnvalue == MUT_SPECCMD_FORCE))
508 if (autocvar_sv_spectate == 1)
509 ClientKill_TeamChange(caller, -2); // observe
511 return; // never fall through to usage
515 case CMD_REQUEST_USAGE:
517 sprint(caller, "\nUsage:^3 cmd spectate <client>\n");
518 sprint(caller, " Where 'client' can be the player to spectate.\n");
524 void ClientCommand_suggestmap(entity caller, float request, float argc)
528 case CMD_REQUEST_COMMAND:
532 sprint(caller, strcat(MapVote_Suggest(caller, argv(1)), "\n"));
538 sprint(caller, "Incorrect parameters for ^2suggestmap^7\n");
539 case CMD_REQUEST_USAGE:
541 sprint(caller, "\nUsage:^3 cmd suggestmap map\n");
542 sprint(caller, " Where 'map' is the name of the map to suggest.\n");
548 void ClientCommand_tell(entity caller, float request, float argc, string command)
552 case CMD_REQUEST_COMMAND:
556 if(!IS_CLIENT(caller) && IS_REAL_CLIENT(caller)) // connecting
558 print_to(caller, "You can't ^2tell^7 a message while connecting.");
562 entity tell_to = GetIndexedEntity(argc, 1);
563 float tell_accepted = VerifyClientEntity(tell_to, true, false);
565 if (tell_accepted > 0) // the target is a real client
567 if (tell_to != caller) // and we're allowed to send to them :D
569 // workaround for argv indexes indexing ascii chars instead of utf8 chars
570 // In this case when the player name contains utf8 chars
571 // the message gets partially trimmed in the beginning.
572 // Potentially this bug affects any substring call that uses
573 // argv_start_index and argv_end_index.
575 string utf8_enable_save = cvar_string("utf8_enable");
576 cvar_set("utf8_enable", "0");
577 string msg = substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token));
578 cvar_set("utf8_enable", utf8_enable_save);
580 Say(caller, false, tell_to, msg, true);
583 else { print_to(caller, "You can't ^2tell^7 a message to yourself."); return; }
585 else if (argv(1) == "#0")
587 trigger_magicear_processmessage_forallears(caller, -1, NULL, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)));
590 else { print_to(caller, strcat("tell: ", GetClientErrorString(tell_accepted, argv(1)), ".")); return; }
595 sprint(caller, "Incorrect parameters for ^2tell^7\n");
596 case CMD_REQUEST_USAGE:
598 sprint(caller, "\nUsage:^3 cmd tell client <message>\n");
599 sprint(caller, " Where 'client' is the entity number or name of the player to send 'message' to.\n");
605 void ClientCommand_voice(entity caller, float request, float argc, string command)
609 case CMD_REQUEST_COMMAND:
613 entity e = GetVoiceMessage(argv(1));
616 sprint(caller, sprintf("Invalid voice. Use one of: %s\n", allvoicesamples));
619 if (argc >= 3) VoiceMessage(caller, e, substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
620 else VoiceMessage(caller, e, "");
627 sprint(caller, "Incorrect parameters for ^2voice^7\n");
628 case CMD_REQUEST_USAGE:
630 sprint(caller, "\nUsage:^3 cmd voice messagetype <soundname>\n");
631 sprint(caller, " 'messagetype' is the type of broadcast to do, like team only or such,\n");
632 sprint(caller, " and 'soundname' is the string/filename of the sound/voice message to play.\n");
638 /* use this when creating a new command, making sure to place it in alphabetical order... also,
639 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
640 void ClientCommand_(entity caller, float request)
644 case CMD_REQUEST_COMMAND:
647 return; // never fall through to usage
651 case CMD_REQUEST_USAGE:
653 sprint(caller, "\nUsage:^3 cmd \n");
654 sprint(caller, " No arguments required.\n");
662 // =====================================
663 // Macro system for networked commands
664 // =====================================
666 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
667 #define CLIENT_COMMANDS(ent, request, arguments, command) \
668 CLIENT_COMMAND("autoswitch", ClientCommand_autoswitch(ent, request, arguments), "Whether or not to switch automatically when getting a better weapon") \
669 CLIENT_COMMAND("clientversion", ClientCommand_clientversion(ent, request, arguments), "Release version of the game") \
670 CLIENT_COMMAND("mv_getpicture", ClientCommand_mv_getpicture(ent, request, arguments), "Retrieve mapshot picture from the server") \
671 CLIENT_COMMAND("join", ClientCommand_join(ent, request), "Become a player in the game") \
672 CLIENT_COMMAND("physics", ClientCommand_physics(ent, request, arguments), "Change physics set") \
673 CLIENT_COMMAND("ready", ClientCommand_ready(ent, request), "Qualify as ready to end warmup stage (or restart server if allowed)") \
674 CLIENT_COMMAND("say", ClientCommand_say(ent, request, arguments, command), "Print a message to chat to all players") \
675 CLIENT_COMMAND("say_team", ClientCommand_say_team(ent, request, arguments, command), "Print a message to chat to all team mates") \
676 CLIENT_COMMAND("selectteam", ClientCommand_selectteam(ent, request, arguments), "Attempt to choose a team to join into") \
677 CLIENT_COMMAND("selfstuff", ClientCommand_selfstuff(ent, request, command), "Stuffcmd a command to your own client") \
678 CLIENT_COMMAND("sentcvar", ClientCommand_sentcvar(ent, request, arguments, command), "New system for sending a client cvar to the server") \
679 CLIENT_COMMAND("spectate", ClientCommand_spectate(ent, request), "Become an observer") \
680 CLIENT_COMMAND("suggestmap", ClientCommand_suggestmap(ent, request, arguments), "Suggest a map to the mapvote at match end") \
681 CLIENT_COMMAND("tell", ClientCommand_tell(ent, request, arguments, command), "Send a message directly to a player") \
682 CLIENT_COMMAND("voice", ClientCommand_voice(ent, request, arguments, command), "Send voice message via sound") \
683 CLIENT_COMMAND("minigame", ClientCommand_minigame(ent, request, arguments, command), "Start a minigame") \
686 void ClientCommand_macro_help(entity caller)
688 #define CLIENT_COMMAND(name, function, description) \
689 { sprint(caller, " ^2", name, "^7: ", description, "\n"); }
691 CLIENT_COMMANDS(NULL, 0, 0, "");
692 #undef CLIENT_COMMAND
695 float ClientCommand_macro_command(float argc, entity caller, string command)
697 #define CLIENT_COMMAND(name, function, description) \
698 { if (name == strtolower(argv(0))) { function; return true; } }
700 CLIENT_COMMANDS(caller, CMD_REQUEST_COMMAND, argc, command);
701 #undef CLIENT_COMMAND
706 float ClientCommand_macro_usage(float argc, entity caller)
708 #define CLIENT_COMMAND(name, function, description) \
709 { if (name == strtolower(argv(1))) { function; return true; } }
711 CLIENT_COMMANDS(caller, CMD_REQUEST_USAGE, argc, "");
712 #undef CLIENT_COMMAND
717 void ClientCommand_macro_write_aliases(float fh)
719 #define CLIENT_COMMAND(name, function, description) \
720 { CMD_Write_Alias("qc_cmd_cmd", name, description); }
722 CLIENT_COMMANDS(NULL, 0, 0, "");
723 #undef CLIENT_COMMAND
726 // ======================================
727 // Main Function Called By Engine (cmd)
728 // ======================================
729 // If this function exists, server game code parses clientcommand before the engine code gets it.
731 void SV_ParseClientCommand(entity this, string command)
733 // If invalid UTF-8, don't even parse it
734 string command2 = "";
735 float len = strlen(command);
737 for (i = 0; i < len; ++i)
738 command2 = strcat(command2, chr2str(str2chr(command, i)));
739 if (command != command2) return;
741 // if we're banned, don't even parse the command
742 if (Ban_MaybeEnforceBanOnce(this)) return;
744 float argc = tokenize_console(command);
746 // Guide for working with argc arguments by example:
747 // argc: 1 - 2 - 3 - 4
748 // argv: 0 - 1 - 2 - 3
749 // cmd vote - master - login - password
752 switch (strtolower(argv(0)))
754 // exempt commands which are not subject to floodcheck
755 case "begin": break; // handled by engine in host_cmd.c
756 case "download": break; // handled by engine in cl_parse.c
757 case "mv_getpicture": break; // handled by server in this file
758 case "pause": break; // handled by engine in host_cmd.c
759 case "prespawn": break; // handled by engine in host_cmd.c
760 case "sentcvar": break; // handled by server in this file
761 case "spawn": break; // handled by engine in host_cmd.c
762 case "c2s": Net_ClientCommand(this, command); return; // handled by net.qh
765 if (SV_ParseClientCommand_floodcheck(this)) break; // "true": continue, as we're not flooding yet
766 else return; // "false": not allowed to continue, halt // print("^1ERROR: ^7ANTISPAM CAUGHT: ", command, ".\n");
769 /* NOTE: should this be disabled? It can be spammy perhaps, but hopefully it's okay for now */
770 if (argv(0) == "help")
774 sprint(this, "\nClient networked commands:\n");
775 ClientCommand_macro_help(this);
777 sprint(this, "\nCommon networked commands:\n");
778 CommonCommand_macro_help(this);
780 sprint(this, "\nUsage:^3 cmd COMMAND...^7, where possible commands are listed above.\n");
781 sprint(this, "For help about a specific command, type cmd help COMMAND\n");
784 else if (CommonCommand_macro_usage(argc, this)) // Instead of trying to call a command, we're going to see detailed information about it
788 else if (ClientCommand_macro_usage(argc, this)) // same, but for normal commands now
793 else if (MUTATOR_CALLHOOK(SV_ParseClientCommand, this, strtolower(argv(0)), argc, command))
795 return; // handled by a mutator
797 else if (CheatCommand(this, argc))
799 return; // handled by server/cheats.qc
801 else if (CommonCommand_macro_command(argc, this, command))
803 return; // handled by server/command/common.qc
805 else if (ClientCommand_macro_command(argc, this, command)) // continue as usual and scan for normal commands
807 return; // handled by one of the above ClientCommand_* functions
811 clientcommand(this, command);