2 #include <common/command/_all.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/_all.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/all.qc>
34 #include <common/monsters/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 void ClientCommand_join(entity caller, float request)
166 case CMD_REQUEST_COMMAND:
168 if (IS_CLIENT(caller))
170 if (!IS_PLAYER(caller) && !lockteams && !gameover)
172 if (caller.caplayer) return;
173 if (nJoinAllowed(caller, caller))
175 if (autocvar_g_campaign) campaign_bots_may_start = true;
176 TRANSMUTE(Player, caller);
177 PlayerScore_Clear(caller);
178 Kill_Notification(NOTIF_ONE_ONLY, caller, MSG_CENTER, CPID_PREVENT_JOIN);
179 Send_Notification(NOTIF_ALL, NULL, MSG_INFO, ((teamplay && caller.team != -1) ? APP_TEAM_ENT(caller, INFO_JOIN_PLAY_TEAM) : INFO_JOIN_PLAY), caller.netname);
180 PutClientInServer(caller);
184 // player may not join because of g_maxplayers is set
185 Send_Notification(NOTIF_ONE_ONLY, caller, MSG_CENTER, CENTER_JOIN_PREVENT);
189 return; // never fall through to usage
193 case CMD_REQUEST_USAGE:
195 sprint(caller, "\nUsage:^3 cmd join\n");
196 sprint(caller, " No arguments required.\n");
202 void ClientCommand_physics(entity caller, float request, float argc)
206 case CMD_REQUEST_COMMAND:
208 string command = strtolower(argv(1));
210 if (!autocvar_g_physics_clientselect)
212 sprint(caller, "Client physics selection is currently disabled.\n");
216 if (command == "list" || command == "help")
218 sprint(caller, strcat("Available physics sets: \n\n", autocvar_g_physics_clientselect_options, " default\n"));
222 if (Physics_Valid(command) || command == "default")
224 stuffcmd(caller, strcat("\nseta cl_physics ", command, "\nsendcvar cl_physics\n"));
225 sprint(caller, strcat("^2Physics set successfully changed to ^3", command, "\n"));
231 sprint(caller, strcat("Current physics set: ^3", caller.cvar_cl_physics, "\n"));
232 case CMD_REQUEST_USAGE:
234 sprint(caller, "\nUsage:^3 cmd physics <physics>\n");
235 sprint(caller, " See 'cmd physics list' for available physics sets.\n");
236 sprint(caller, " Argument 'default' resets to standard physics.\n");
242 void ClientCommand_ready(entity caller, float request) // todo: anti-spam for toggling readyness
246 case CMD_REQUEST_COMMAND:
248 if (IS_CLIENT(caller))
250 if (warmup_stage || autocvar_sv_ready_restart || g_race_qualifying == 2)
252 if (!readyrestart_happened || autocvar_sv_ready_restart_repeatable)
254 if (time < game_starttime) // game is already restarting
256 if (caller.ready) // toggle
258 caller.ready = false;
259 bprint(caller.netname, "^2 is ^1NOT^2 ready\n");
264 bprint(caller.netname, "^2 is ready\n");
267 // cannot reset the game while a timeout is active!
268 if (!timeout_status) ReadyCount();
272 sprint(caller, "^1Game has already been restarted\n");
276 return; // never fall through to usage
280 case CMD_REQUEST_USAGE:
282 sprint(caller, "\nUsage:^3 cmd ready\n");
283 sprint(caller, " No arguments required.\n");
289 void ClientCommand_say(entity caller, float request, float argc, string command)
293 case CMD_REQUEST_COMMAND:
295 if (argc >= 2) Say(caller, false, NULL, 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(caller, "\nUsage:^3 cmd say <message>\n");
303 sprint(caller, " Where 'message' is the string of text to say.\n");
309 void ClientCommand_say_team(entity caller, float request, float argc, string command)
313 case CMD_REQUEST_COMMAND:
315 if (argc >= 2) Say(caller, true, NULL, 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(caller, "\nUsage:^3 cmd say_team <message>\n");
323 sprint(caller, " Where 'message' is the string of text to say.\n");
329 void ClientCommand_selectteam(entity caller, float request, float argc)
333 case CMD_REQUEST_COMMAND:
337 if (IS_CLIENT(caller))
341 if (caller.team_forced <= 0)
349 case "red": selection = NUM_TEAM_1;
351 case "blue": selection = NUM_TEAM_2;
353 case "yellow": selection = NUM_TEAM_3;
355 case "pink": selection = NUM_TEAM_4;
357 case "auto": selection = (-1);
360 default: selection = 0;
366 if (caller.team == selection && !IS_DEAD(caller))
368 sprint(caller, "^7You already are on that team.\n");
370 else if (caller.wasplayer && autocvar_g_changeteam_banned)
372 sprint(caller, "^1You cannot change team, forbidden by the server.\n");
376 if (autocvar_g_balance_teams && autocvar_g_balance_teams_prevent_imbalance)
378 CheckAllowedTeams(caller);
379 GetTeamCounts(caller);
380 if (!TeamSmallerEqThanTeam(Team_TeamToNumber(selection), Team_TeamToNumber(caller.team), caller))
382 Send_Notification(NOTIF_ONE, caller, MSG_INFO, INFO_TEAMCHANGE_LARGERTEAM);
386 ClientKill_TeamChange(caller, selection);
392 sprint(caller, "^7The game has already begun, you must wait until the next map to be able to join a team.\n");
397 sprint(caller, "^7selectteam can not be used as your team is forced\n");
402 sprint(caller, "^7selectteam can only be used in teamgames\n");
410 sprint(caller, "Incorrect parameters for ^2selectteam^7\n");
411 case CMD_REQUEST_USAGE:
413 sprint(caller, "\nUsage:^3 cmd selectteam team\n");
414 sprint(caller, " Where 'team' is the prefered team to try and join.\n");
415 sprint(caller, " Full list of options here: \"red, blue, yellow, pink, auto\"\n");
421 void ClientCommand_selfstuff(entity caller, float request, string command)
425 case CMD_REQUEST_COMMAND:
429 stuffcmd(caller, substring(command, argv_start_index(1), argv_end_index(-1) - argv_start_index(1)));
435 sprint(caller, "Incorrect parameters for ^2selfstuff^7\n");
436 case CMD_REQUEST_USAGE:
438 sprint(caller, "\nUsage:^3 cmd selfstuff <command>\n");
439 sprint(caller, " Where 'command' is the string to be stuffed to your client.\n");
445 void ClientCommand_sentcvar(entity caller, float request, float argc, string command)
449 case CMD_REQUEST_COMMAND:
456 if (argc == 2) // undefined cvar: use the default value on the server then
458 s = strcat(substring(command, argv_start_index(0), argv_end_index(1) - argv_start_index(0)), " \"", cvar_defstring(argv(1)), "\"");
469 sprint(caller, "Incorrect parameters for ^2sentcvar^7\n");
470 case CMD_REQUEST_USAGE:
472 sprint(caller, "\nUsage:^3 cmd sentcvar <cvar>\n");
473 sprint(caller, " Where 'cvar' is the cvar plus arguments to send to the server.\n");
479 void ClientCommand_spectate(entity caller, float request)
483 case CMD_REQUEST_COMMAND:
485 if (IS_CLIENT(caller))
487 int mutator_returnvalue = MUTATOR_CALLHOOK(ClientCommand_Spectate, caller);
489 if (mutator_returnvalue == MUT_SPECCMD_RETURN) return;
491 if ((IS_PLAYER(caller) || mutator_returnvalue == MUT_SPECCMD_FORCE) && autocvar_sv_spectate == 1) ClientKill_TeamChange(caller, -2); // observe
493 return; // never fall through to usage
497 case CMD_REQUEST_USAGE:
499 sprint(caller, "\nUsage:^3 cmd spectate\n");
500 sprint(caller, " No arguments required.\n");
506 void ClientCommand_suggestmap(entity caller, float request, float argc)
510 case CMD_REQUEST_COMMAND:
514 sprint(caller, strcat(MapVote_Suggest(caller, argv(1)), "\n"));
520 sprint(caller, "Incorrect parameters for ^2suggestmap^7\n");
521 case CMD_REQUEST_USAGE:
523 sprint(caller, "\nUsage:^3 cmd suggestmap map\n");
524 sprint(caller, " Where 'map' is the name of the map to suggest.\n");
530 void ClientCommand_tell(entity caller, float request, float argc, string command)
534 case CMD_REQUEST_COMMAND:
538 entity tell_to = GetIndexedEntity(argc, 1);
539 float tell_accepted = VerifyClientEntity(tell_to, true, false);
541 if (tell_accepted > 0) // the target is a real client
543 if (tell_to != caller) // and we're allowed to send to them :D
545 // workaround for argv indexes indexing ascii chars instead of utf8 chars
546 // In this case when the player name contains utf8 chars
547 // the message gets partially trimmed in the beginning.
548 // Potentially this bug affects any substring call that uses
549 // argv_start_index and argv_end_index.
551 string utf8_enable_save = cvar_string("utf8_enable");
552 cvar_set("utf8_enable", "0");
553 string msg = substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token));
554 cvar_set("utf8_enable", utf8_enable_save);
556 Say(caller, false, tell_to, msg, true);
559 else { print_to(caller, "You can't ^2tell^7 a message to yourself."); return; }
561 else if (argv(1) == "#0")
563 trigger_magicear_processmessage_forallears(caller, -1, NULL, substring(command, argv_start_index(next_token), argv_end_index(-1) - argv_start_index(next_token)));
566 else { print_to(caller, strcat("tell: ", GetClientErrorString(tell_accepted, argv(1)), ".")); return; }
571 sprint(caller, "Incorrect parameters for ^2tell^7\n");
572 case CMD_REQUEST_USAGE:
574 sprint(caller, "\nUsage:^3 cmd tell client <message>\n");
575 sprint(caller, " Where 'client' is the entity number or name of the player to send 'message' to.\n");
581 void ClientCommand_voice(entity caller, float request, float argc, string command)
585 case CMD_REQUEST_COMMAND:
589 entity e = GetVoiceMessage(argv(1));
592 sprint(caller, sprintf("Invalid voice. Use one of: %s\n", allvoicesamples));
595 if (argc >= 3) VoiceMessage(caller, e, substring(command, argv_start_index(2), argv_end_index(-1) - argv_start_index(2)));
596 else VoiceMessage(caller, e, "");
603 sprint(caller, "Incorrect parameters for ^2voice^7\n");
604 case CMD_REQUEST_USAGE:
606 sprint(caller, "\nUsage:^3 cmd voice messagetype <soundname>\n");
607 sprint(caller, " 'messagetype' is the type of broadcast to do, like team only or such,\n");
608 sprint(caller, " and 'soundname' is the string/filename of the sound/voice message to play.\n");
614 /* use this when creating a new command, making sure to place it in alphabetical order... also,
615 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
616 void ClientCommand_(entity caller, float request)
620 case CMD_REQUEST_COMMAND:
623 return; // never fall through to usage
627 case CMD_REQUEST_USAGE:
629 sprint(caller, "\nUsage:^3 cmd \n");
630 sprint(caller, " No arguments required.\n");
638 // =====================================
639 // Macro system for networked commands
640 // =====================================
642 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
643 #define CLIENT_COMMANDS(ent, request, arguments, command) \
644 CLIENT_COMMAND("autoswitch", ClientCommand_autoswitch(ent, request, arguments), "Whether or not to switch automatically when getting a better weapon") \
645 CLIENT_COMMAND("clientversion", ClientCommand_clientversion(ent, request, arguments), "Release version of the game") \
646 CLIENT_COMMAND("mv_getpicture", ClientCommand_mv_getpicture(ent, request, arguments), "Retrieve mapshot picture from the server") \
647 CLIENT_COMMAND("join", ClientCommand_join(ent, request), "Become a player in the game") \
648 CLIENT_COMMAND("physics", ClientCommand_physics(ent, request, arguments), "Change physics set") \
649 CLIENT_COMMAND("ready", ClientCommand_ready(ent, request), "Qualify as ready to end warmup stage (or restart server if allowed)") \
650 CLIENT_COMMAND("say", ClientCommand_say(ent, request, arguments, command), "Print a message to chat to all players") \
651 CLIENT_COMMAND("say_team", ClientCommand_say_team(ent, request, arguments, command), "Print a message to chat to all team mates") \
652 CLIENT_COMMAND("selectteam", ClientCommand_selectteam(ent, request, arguments), "Attempt to choose a team to join into") \
653 CLIENT_COMMAND("selfstuff", ClientCommand_selfstuff(ent, request, command), "Stuffcmd a command to your own client") \
654 CLIENT_COMMAND("sentcvar", ClientCommand_sentcvar(ent, request, arguments, command), "New system for sending a client cvar to the server") \
655 CLIENT_COMMAND("spectate", ClientCommand_spectate(ent, request), "Become an observer") \
656 CLIENT_COMMAND("suggestmap", ClientCommand_suggestmap(ent, request, arguments), "Suggest a map to the mapvote at match end") \
657 CLIENT_COMMAND("tell", ClientCommand_tell(ent, request, arguments, command), "Send a message directly to a player") \
658 CLIENT_COMMAND("voice", ClientCommand_voice(ent, request, arguments, command), "Send voice message via sound") \
659 CLIENT_COMMAND("minigame", ClientCommand_minigame(ent, request, arguments, command), "Start a minigame") \
662 void ClientCommand_macro_help(entity caller)
664 #define CLIENT_COMMAND(name, function, description) \
665 { sprint(caller, " ^2", name, "^7: ", description, "\n"); }
667 CLIENT_COMMANDS(NULL, 0, 0, "");
668 #undef CLIENT_COMMAND
671 float ClientCommand_macro_command(float argc, entity caller, string command)
673 #define CLIENT_COMMAND(name, function, description) \
674 { if (name == strtolower(argv(0))) { function; return true; } }
676 CLIENT_COMMANDS(caller, CMD_REQUEST_COMMAND, argc, command);
677 #undef CLIENT_COMMAND
682 float ClientCommand_macro_usage(float argc, entity caller)
684 #define CLIENT_COMMAND(name, function, description) \
685 { if (name == strtolower(argv(1))) { function; return true; } }
687 CLIENT_COMMANDS(caller, CMD_REQUEST_USAGE, argc, "");
688 #undef CLIENT_COMMAND
693 void ClientCommand_macro_write_aliases(float fh)
695 #define CLIENT_COMMAND(name, function, description) \
696 { CMD_Write_Alias("qc_cmd_cmd", name, description); }
698 CLIENT_COMMANDS(NULL, 0, 0, "");
699 #undef CLIENT_COMMAND
702 // ======================================
703 // Main Function Called By Engine (cmd)
704 // ======================================
705 // If this function exists, server game code parses clientcommand before the engine code gets it.
707 void SV_ParseClientCommand(entity this, string command)
709 // If invalid UTF-8, don't even parse it
710 string command2 = "";
711 float len = strlen(command);
713 for (i = 0; i < len; ++i)
714 command2 = strcat(command2, chr2str(str2chr(command, i)));
715 if (command != command2) return;
717 // if we're banned, don't even parse the command
718 if (Ban_MaybeEnforceBanOnce(this)) return;
720 float argc = tokenize_console(command);
722 // Guide for working with argc arguments by example:
723 // argc: 1 - 2 - 3 - 4
724 // argv: 0 - 1 - 2 - 3
725 // cmd vote - master - login - password
728 switch (strtolower(argv(0)))
730 // exempt commands which are not subject to floodcheck
731 case "begin": break; // handled by engine in host_cmd.c
732 case "download": break; // handled by engine in cl_parse.c
733 case "mv_getpicture": break; // handled by server in this file
734 case "pause": break; // handled by engine in host_cmd.c
735 case "prespawn": break; // handled by engine in host_cmd.c
736 case "sentcvar": break; // handled by server in this file
737 case "spawn": break; // handled by engine in host_cmd.c
738 case "c2s": Net_ClientCommand(this, command); return; // handled by net.qh
741 if (SV_ParseClientCommand_floodcheck(this)) break; // "true": continue, as we're not flooding yet
742 else return; // "false": not allowed to continue, halt // print("^1ERROR: ^7ANTISPAM CAUGHT: ", command, ".\n");
745 /* NOTE: should this be disabled? It can be spammy perhaps, but hopefully it's okay for now */
746 if (argv(0) == "help")
750 sprint(this, "\nClient networked commands:\n");
751 ClientCommand_macro_help(this);
753 sprint(this, "\nCommon networked commands:\n");
754 CommonCommand_macro_help(this);
756 sprint(this, "\nUsage:^3 cmd COMMAND...^7, where possible commands are listed above.\n");
757 sprint(this, "For help about a specific command, type cmd help COMMAND\n");
760 else if (CommonCommand_macro_usage(argc, this)) // Instead of trying to call a command, we're going to see detailed information about it
764 else if (ClientCommand_macro_usage(argc, this)) // same, but for normal commands now
769 else if (MUTATOR_CALLHOOK(SV_ParseClientCommand, this, strtolower(argv(0)), argc, command))
771 return; // handled by a mutator
773 else if (CheatCommand(this, argc))
775 return; // handled by server/cheats.qc
777 else if (CommonCommand_macro_command(argc, this, command))
779 return; // handled by server/command/common.qc
781 else if (ClientCommand_macro_command(argc, this, command)) // continue as usual and scan for normal commands
783 return; // handled by one of the above ClientCommand_* functions
787 clientcommand(this, command);