1 // ==============================================
2 // CSQC client commands code, written by Samual
3 // Last updated: December 28th, 2011
4 // ==============================================
6 #include "../../common/command/command.qh"
9 #include "../autocvars.qh"
12 #include "../hud_config.qh"
14 #include "../mapvoting.qh"
15 #include "../miscfunctions.qh"
17 #include "../mutators/events.qh"
19 #include "../../common/mapinfo.qh"
21 #include "../../common/command/generic.qh"
23 void DrawDebugModel(entity this)
25 if (time - floor(time) > 0.5)
33 self.drawmask = MASK_NORMAL;
38 // =======================
39 // Command Sub-Functions
40 // =======================
42 void LocalCommand_blurtest(int request)
44 // Simple command to work with postprocessing temporarily... possibly completely pointless, the glsl shader is used for a real feature now...
45 // Anyway, to enable it, just compile the client with -DBLURTEST and then you can use the command.
50 case CMD_REQUEST_COMMAND:
52 blurtest_time0 = time;
53 blurtest_time1 = time + stof(argv(1));
54 blurtest_radius = stof(argv(2));
55 blurtest_power = stof(argv(3));
56 LOG_INFO("Enabled blurtest\n");
61 case CMD_REQUEST_USAGE:
63 LOG_INFO("\nUsage:^3 cl_cmd blurtest\n");
64 LOG_INFO(" No arguments required.\n");
71 LOG_INFO("Blurtest is not enabled on this client.\n");
77 void LocalCommand_boxparticles(int request, int argc)
81 case CMD_REQUEST_COMMAND:
85 int effect = _particleeffectnum(argv(1));
88 int index = stoi(argv(2));
91 own = entitybyindex(-index);
93 own = findfloat(world, entnum, index);
94 vector org_from = stov(argv(3));
95 vector org_to = stov(argv(4));
96 vector dir_from = stov(argv(5));
97 vector dir_to = stov(argv(6));
98 int countmultiplier = stoi(argv(7));
99 int flags = stoi(argv(8));
100 boxparticles(effect, own, org_from, org_to, dir_from, dir_to, countmultiplier, flags);
108 LOG_INFO("Incorrect parameters for ^2boxparticles^7\n");
110 case CMD_REQUEST_USAGE:
112 LOG_INFO("\nUsage:^3 lv_cmd boxparticles effectname own org_from org_to, dir_from, dir_to, countmultiplier, flags\n");
113 LOG_INFO(" 'effectname' is the name of a particle effect in effectinfo.txt\n");
114 LOG_INFO(" 'own' is the entity number of the owner (negative for csqc ent, positive for svqc ent)\n");
115 LOG_INFO(" 'org_from' is the starting origin of the box\n");
116 LOG_INFO(" 'org_to' is the ending origin of the box\n");
117 LOG_INFO(" 'dir_from' is the minimum velocity\n");
118 LOG_INFO(" 'dir_to' is the maximum velocity\n");
119 LOG_INFO(" 'countmultiplier' defines a multiplier for the particle count (affects count only, not countabsolute or trailspacing)\n");
120 LOG_INFO(" 'flags' can contain:\n");
121 LOG_INFO(" 1 to respect globals particles_alphamin, particles_alphamax (set right before via prvm_globalset client)\n");
122 LOG_INFO(" 2 to respect globals particles_colormin, particles_colormax (set right before via prvm_globalset client)\n");
123 LOG_INFO(" 4 to respect globals particles_fade (set right before via prvm_globalset client)\n");
124 LOG_INFO(" 128 to draw a trail, not a box\n");
130 void LocalCommand_create_scrshot_ent(int request)
134 case CMD_REQUEST_COMMAND:
136 string filename = strcat(MapInfo_Map_bspname, "_scrshot_ent.txt");
137 int fh = fopen(filename, FILE_WRITE);
142 fputs(fh, strcat("\"classname\" \"info_autoscreenshot\"\n"));
143 fputs(fh, strcat("\"origin\" \"", strcat(ftos(view_origin.x), " ", ftos(view_origin.y), " ", ftos(view_origin.z)), "\"\n"));
144 fputs(fh, strcat("\"angles\" \"", strcat(ftos(view_angles.x), " ", ftos(view_angles.y), " ", ftos(view_angles.z)), "\"\n"));
147 LOG_INFO("Completed screenshot entity dump in ^2data/data/", MapInfo_Map_bspname, "_scrshot_ent.txt^7.\n");
153 LOG_INFO("^1Error: ^7Could not dump to file!\n");
159 case CMD_REQUEST_USAGE:
161 LOG_INFO("\nUsage:^3 cl_cmd create_scrshot_ent\n");
162 LOG_INFO(" No arguments required.\n");
168 void LocalCommand_debugmodel(int request, int argc)
172 case CMD_REQUEST_COMMAND:
174 string modelname = argv(1);
175 entity debugmodel_entity;
177 debugmodel_entity = spawn();
178 precache_model(modelname);
179 _setmodel(debugmodel_entity, modelname);
180 setorigin(debugmodel_entity, view_origin);
181 debugmodel_entity.angles = view_angles;
182 debugmodel_entity.draw = DrawDebugModel;
183 debugmodel_entity.classname = "debugmodel";
189 case CMD_REQUEST_USAGE:
191 LOG_INFO("\nUsage:^3 cl_cmd debugmodel model\n");
192 LOG_INFO(" Where 'model' is a string of the model name to use for the debug model.\n");
198 void LocalCommand_handlevote(int request, int argc)
202 case CMD_REQUEST_COMMAND:
207 if (InterpretBoolean(argv(1)))
220 if (uid2name_dialog) // handled by "uid2name" option
225 localcmd(strcat("setreport cl_allow_uid2name ", ftos(vote_selection - 1), "\n"));
228 else { localcmd(strcat("cmd vote ", vote_string, "\n")); }
236 LOG_INFO("Incorrect parameters for ^2handlevote^7\n");
238 case CMD_REQUEST_USAGE:
240 LOG_INFO("\nUsage:^3 cl_cmd handlevote vote\n");
241 LOG_INFO(" Where 'vote' is the selection for either the current poll or uid2name.\n");
247 bool QuickMenu_IsOpened();
248 void QuickMenu_Close();
249 bool QuickMenu_Open(string mode, string submenu);
251 bool HUD_MinigameMenu_IsOpened();
252 void HUD_MinigameMenu_Close();
253 void HUD_MinigameMenu_Open();
255 void HUD_Radar_Show_Maximized(bool doshow, bool clickable);
257 void LocalCommand_hud(int request, int argc)
261 case CMD_REQUEST_COMMAND:
267 cvar_set("_hud_configure", ftos(!autocvar__hud_configure));
273 if (argv(2) == "help")
275 LOG_INFO(" quickmenu [[default | file | \"\"] submenu]\n");
276 LOG_INFO("Called without options (or with \"\") loads either the default quickmenu or a quickmenu file if hud_panel_quickmenu_file is set to a valid filename.\n");
277 LOG_INFO("A submenu name can be given to open the quickmenu directly in a submenu; it requires to specify 'default', 'file' or '\"\"' option.\n");
280 if (QuickMenu_IsOpened())
283 QuickMenu_Open(argv(2), argv(3)); // mode, submenu
289 if (HUD_MinigameMenu_IsOpened())
290 HUD_MinigameMenu_Close();
292 HUD_MinigameMenu_Open();
300 HUD_Panel_ExportCfg(argv(2));
305 break; // go to usage, we're missing the paramater needed here.
309 case "scoreboard_columns_set":
311 Cmd_HUD_SetFields(argc);
315 case "scoreboard_columns_help":
324 HUD_Radar_Show_Maximized(InterpretBoolean(argv(2)), 0);
326 HUD_Radar_Show_Maximized(!hud_panel_radar_maximized, 0);
332 HUD_Radar_Show_Maximized(!hud_panel_radar_mouse, 1);
340 LOG_INFO("Incorrect parameters for ^2hud^7\n");
342 case CMD_REQUEST_USAGE:
344 LOG_INFO("\nUsage:^3 cl_cmd hud action [configname | radartoggle | layout]\n");
345 LOG_INFO(" Where 'action' is the command to complete,\n");
346 LOG_INFO(" 'configname' is the name to save to for \"save\" action,\n");
347 LOG_INFO(" 'radartoggle' is to control hud_panel_radar_maximized for \"radar\" action,\n");
348 LOG_INFO(" and 'layout' is how to organize the scoreboard columns for the set action.\n");
349 LOG_INFO(" Full list of commands here: \"configure, quickmenu, minigame, save, scoreboard_columns_help, scoreboard_columns_set, radar.\"\n");
355 void LocalCommand_localprint(int request, int argc)
359 case CMD_REQUEST_COMMAND:
363 centerprint_hud(argv(1));
370 LOG_INFO("Incorrect parameters for ^2localprint^7\n");
372 case CMD_REQUEST_USAGE:
374 LOG_INFO("\nUsage:^3 cl_cmd localprint \"message\"\n");
375 LOG_INFO(" 'message' is the centerprint message to send to yourself.\n");
381 void LocalCommand_mv_download(int request, int argc)
385 case CMD_REQUEST_COMMAND:
389 Cmd_MapVote_MapDownload(argc);
396 LOG_INFO("Incorrect parameters for ^2mv_download^7\n");
398 case CMD_REQUEST_USAGE:
400 LOG_INFO("\nUsage:^3 cl_cmd mv_download mapid\n");
401 LOG_INFO(" Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.\n");
407 void LocalCommand_find(int request, int argc)
411 case CMD_REQUEST_COMMAND:
415 for (client = world; (client = find(client, classname, argv(1))); )
416 LOG_INFO(etos(client), "\n");
423 LOG_INFO("Incorrect parameters for ^2find^7\n");
425 case CMD_REQUEST_USAGE:
427 LOG_INFO("\nUsage:^3 cl_cmd find classname\n");
428 LOG_INFO(" Where 'classname' is the classname to search for.\n");
434 void LocalCommand_sendcvar(int request, int argc)
438 case CMD_REQUEST_COMMAND:
442 // W_FixWeaponOrder will trash argv, so save what we need.
443 string thiscvar = strzone(argv(1));
444 string s = cvar_string(thiscvar);
446 if (thiscvar == "cl_weaponpriority")
447 s = W_FixWeaponOrder(W_NumberWeaponOrder(s), 1);
448 else if (substring(thiscvar, 0, 17) == "cl_weaponpriority" && strlen(thiscvar) == 18)
449 s = W_FixWeaponOrder(W_NumberWeaponOrder(s), 0);
451 localcmd("cmd sentcvar ", thiscvar, " \"", s, "\"\n");
459 LOG_INFO("Incorrect parameters for ^2sendcvar^7\n");
461 case CMD_REQUEST_USAGE:
463 LOG_INFO("\nUsage:^3 cl_cmd sendcvar <cvar>\n");
464 LOG_INFO(" Where 'cvar' is the cvar plus arguments to send to the server.\n");
470 /* use this when creating a new command, making sure to place it in alphabetical order... also,
471 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
472 void LocalCommand_(int request)
476 case CMD_REQUEST_COMMAND:
483 case CMD_REQUEST_USAGE:
485 print("\nUsage:^3 cl_cmd \n");
486 print(" No arguments required.\n");
494 // ==================================
495 // Macro system for client commands
496 // ==================================
498 // Normally do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
499 #define CLIENT_COMMANDS(request, arguments) \
500 CLIENT_COMMAND("blurtest", LocalCommand_blurtest(request), "Feature for testing blur postprocessing") \
501 CLIENT_COMMAND("boxparticles", LocalCommand_boxparticles(request, arguments), "Spawn particles manually") \
502 CLIENT_COMMAND("create_scrshot_ent", LocalCommand_create_scrshot_ent(request), "Create an entity at this location for automatic screenshots") \
503 CLIENT_COMMAND("debugmodel", LocalCommand_debugmodel(request, arguments), "Spawn a debug model manually") \
504 CLIENT_COMMAND("handlevote", LocalCommand_handlevote(request, arguments), "System to handle selecting a vote or option") \
505 CLIENT_COMMAND("hud", LocalCommand_hud(request, arguments), "Commands regarding/controlling the HUD system") \
506 CLIENT_COMMAND("localprint", LocalCommand_localprint(request, arguments), "Create your own centerprint sent to yourself") \
507 CLIENT_COMMAND("find", LocalCommand_find(request, arguments), "Search through entities for matching classname") \
508 CLIENT_COMMAND("mv_download", LocalCommand_mv_download(request, arguments), "Retrieve mapshot picture from the server") \
509 CLIENT_COMMAND("sendcvar", LocalCommand_sendcvar(request, arguments), "Send a cvar to the server (like weaponpriority)") \
512 void LocalCommand_macro_help()
514 #define CLIENT_COMMAND(name, function, description) \
515 { if (strtolower(description) != "") { LOG_INFO(" ^2", name, "^7: ", description, "\n"); } }
517 CLIENT_COMMANDS(0, 0);
518 #undef CLIENT_COMMAND
521 bool LocalCommand_macro_command(int argc)
523 #define CLIENT_COMMAND(name, function, description) \
524 { if (name == strtolower(argv(0))) { function; return true; } }
526 CLIENT_COMMANDS(CMD_REQUEST_COMMAND, argc);
527 #undef CLIENT_COMMAND
532 bool LocalCommand_macro_usage(int argc)
534 #define CLIENT_COMMAND(name, function, description) \
535 { if (name == strtolower(argv(1))) { function; return true; } }
537 CLIENT_COMMANDS(CMD_REQUEST_USAGE, argc);
538 #undef CLIENT_COMMAND
543 void LocalCommand_macro_write_aliases(int fh)
545 #define CLIENT_COMMAND(name, function, description) \
546 { if (strtolower(description) != "") { CMD_Write_Alias("qc_cmd_cl", name, description); } }
548 CLIENT_COMMANDS(0, 0);
549 #undef CLIENT_COMMAND
553 // =========================================
554 // Main Function Called By Engine (cl_cmd)
555 // =========================================
556 // If this function exists, client code handles gamecommand instead of the engine code.
558 void GameCommand(string command)
560 int argc = tokenize_console(command);
562 // Guide for working with argc arguments by example:
563 // argc: 1 - 2 - 3 - 4
564 // argv: 0 - 1 - 2 - 3
565 // cmd vote - master - login - password
566 string s = strtolower(argv(0));
571 LOG_INFO("\nClient console commands:\n");
572 LocalCommand_macro_help();
574 LOG_INFO("\nGeneric commands shared by all programs:\n");
575 GenericCommand_macro_help();
577 LOG_INFO("\nUsage:^3 cl_cmd COMMAND...^7, where possible commands are listed above.\n");
578 LOG_INFO("For help about a specific command, type cl_cmd help COMMAND\n");
582 else if (GenericCommand_macro_usage(argc)) // Instead of trying to call a command, we're going to see detailed information about it
586 else if (LocalCommand_macro_usage(argc)) // now try for normal commands too
591 // continue as usual and scan for normal commands
592 if (GenericCommand(command) // handled by common/command/generic.qc
593 || LocalCommand_macro_command(argc) // handled by one of the above LocalCommand_* functions
594 || MUTATOR_CALLHOOK(CSQC_ConsoleCommand, s, argc, command) // handled by a mutator
597 // nothing above caught the command, must be invalid
598 LOG_INFO(((command != "") ? strcat("Unknown client command \"", command, "\"") : "No command provided"), ". For a list of supported commands, try cl_cmd help.\n");
602 // ===================================
603 // Macro system for console commands
604 // ===================================
606 // These functions are here specifically to add special + - commands to the game, and are not really normal commands.
607 // Please add client commands to the function above this, as this is only for special reasons.
608 #define CONSOLE_COMMANDS_NORMAL() \
609 CONSOLE_COMMAND("+showscores", { scoreboard_showscores = true; }) \
610 CONSOLE_COMMAND("-showscores", { scoreboard_showscores = false; }) \
611 CONSOLE_COMMAND("+showaccuracy", { scoreboard_showaccuracy = true; }) \
612 CONSOLE_COMMAND("-showaccuracy", { scoreboard_showaccuracy = false; }) \
615 #define CONSOLE_COMMANDS_MOVEMENT() \
616 CONSOLE_COMMAND("+forward", { ++camera_direction.x; }) \
617 CONSOLE_COMMAND("-forward", { --camera_direction.x; }) \
618 CONSOLE_COMMAND("+back", { --camera_direction.x; }) \
619 CONSOLE_COMMAND("-back", { ++camera_direction.x; }) \
620 CONSOLE_COMMAND("+moveup", { ++camera_direction.z; }) \
621 CONSOLE_COMMAND("-moveup", { --camera_direction.z; }) \
622 CONSOLE_COMMAND("+movedown", { --camera_direction.z; }) \
623 CONSOLE_COMMAND("-movedown", { ++camera_direction.z; }) \
624 CONSOLE_COMMAND("+moveright", { --camera_direction.y; }) \
625 CONSOLE_COMMAND("-moveright", { ++camera_direction.y; }) \
626 CONSOLE_COMMAND("+moveleft", { ++camera_direction.y; }) \
627 CONSOLE_COMMAND("-moveleft", { --camera_direction.y; }) \
628 CONSOLE_COMMAND("+roll_right", { ++camera_roll; }) \
629 CONSOLE_COMMAND("-roll_right", { --camera_roll; }) \
630 CONSOLE_COMMAND("+roll_left", { --camera_roll; }) \
631 CONSOLE_COMMAND("-roll_left", { ++camera_roll; }) \
634 void ConsoleCommand_macro_init()
636 // first init normal commands
637 #define CONSOLE_COMMAND(name, execution) \
638 { registercommand(name); }
640 CONSOLE_COMMANDS_NORMAL();
641 #undef CONSOLE_COMMAND
643 // then init movement commands
648 #define CONSOLE_COMMAND(name, execution) \
649 registercommand(name);
651 CONSOLE_COMMANDS_MOVEMENT();
652 #undef CONSOLE_COMMAND
658 bool ConsoleCommand_macro_normal(string s, int argc)
660 #define CONSOLE_COMMAND(name, execution) \
661 { if (name == s) { { execution } return true; } }
663 CONSOLE_COMMANDS_NORMAL();
664 #undef CONSOLE_COMMAND
669 bool ConsoleCommand_macro_movement(string s, int argc)
673 #define CONSOLE_COMMAND(name, execution) \
674 { if (name == s) { { execution } return true; } }
676 CONSOLE_COMMANDS_MOVEMENT();
677 #undef CONSOLE_COMMAND
684 // ======================================================
685 // Main Function Called By Engine (registered commands)
686 // ======================================================
687 // Used to parse commands in the console that have been registered with the "registercommand" function
689 bool CSQC_ConsoleCommand(string command)
691 int argc = tokenize_console(command);
692 string s = strtolower(argv(0));
693 // Return value should be true if CSQC handled the command, otherwise return false to have the engine handle it.
694 return ConsoleCommand_macro_normal(s, argc)
695 || ConsoleCommand_macro_movement(s, argc)