2 // ==============================================
3 // CSQC client commands code, written by Samual
4 // Last updated: December 28th, 2011
5 // ==============================================
7 #include <common/command/_mod.qh>
10 #include "../autocvars.qh"
12 #include <client/hud/_mod.qh>
14 #include "../mapvoting.qh"
15 #include "../miscfunctions.qh"
17 #include <client/mutators/_mod.qh>
19 #include <common/mapinfo.qh>
21 void DrawDebugModel(entity this)
23 if (time - floor(time) > 0.5)
31 this.drawmask = MASK_NORMAL;
36 // =======================
37 // Command Sub-Functions
38 // =======================
40 void LocalCommand_blurtest(int request)
43 // Simple command to work with postprocessing temporarily... possibly completely pointless, the glsl shader is used for a real feature now...
44 // Anyway, to enable it, just compile the client with -DBLURTEST and then you can use the command.
49 case CMD_REQUEST_COMMAND:
51 blurtest_time0 = time;
52 blurtest_time1 = time + stof(argv(1));
53 blurtest_radius = stof(argv(2));
54 blurtest_power = stof(argv(3));
55 LOG_INFO("Enabled blurtest");
60 case CMD_REQUEST_USAGE:
62 LOG_INFO("Usage:^3 cl_cmd blurtest");
63 LOG_INFO(" No arguments required.");
70 LOG_INFO("Blurtest is not enabled on this client.");
76 void LocalCommand_boxparticles(int request, int argc)
78 TC(int, request); TC(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(NULL, 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");
110 case CMD_REQUEST_USAGE:
113 "Usage:^3 lv_cmd boxparticles effectname own org_from org_to, dir_from, dir_to, countmultiplier, flags\n"
114 " 'effectname' is the name of a particle effect in effectinfo.txt\n"
115 " 'own' is the entity number of the owner (negative for csqc ent, positive for svqc ent)\n"
116 " 'org_from' is the starting origin of the box\n"
117 " 'org_to' is the ending origin of the box\n"
118 " 'dir_from' is the minimum velocity\n"
119 " 'dir_to' is the maximum velocity\n"
120 " 'countmultiplier' defines a multiplier for the particle count (affects count only, not countabsolute or trailspacing)\n"
121 " 'flags' can contain:\n"
122 " 1 to respect globals particles_alphamin, particles_alphamax (set right before via prvm_globalset client)\n"
123 " 2 to respect globals particles_colormin, particles_colormax (set right before via prvm_globalset client)\n"
124 " 4 to respect globals particles_fade (set right before via prvm_globalset client)\n"
125 " 128 to draw a trail, not a box\n"
132 void LocalCommand_create_scrshot_ent(int request)
137 case CMD_REQUEST_COMMAND:
139 string path = ((argv(1) == "") ? "" : strcat(argv(1), "/"));
140 string filename = strcat(path, MapInfo_Map_bspname, "_scrshot_ent.txt");
141 int fh = fopen(filename, FILE_APPEND);
146 fputs(fh, strcat("\"classname\" \"info_autoscreenshot\"\n"));
147 fputs(fh, strcat("\"origin\" \"", strcat(ftos(view_origin.x), " ", ftos(view_origin.y), " ", ftos(view_origin.z)), "\"\n"));
148 fputs(fh, strcat("\"angles\" \"", strcat(ftos(view_angles.x), " ", ftos(view_angles.y), " ", ftos(view_angles.z)), "\"\n"));
151 LOG_INFO("Completed screenshot entity dump in ^2data/data/", path, MapInfo_Map_bspname, "_scrshot_ent.txt^7.");
157 LOG_INFO("^1Error: ^7Could not dump to file!");
163 case CMD_REQUEST_USAGE:
165 LOG_INFO("Usage:^3 cl_cmd create_scrshot_ent [path]");
166 LOG_INFO(" Where 'path' can be the subdirectory of data/data in which the file is saved.");
172 void LocalCommand_debugmodel(int request, int argc)
174 TC(int, request); TC(int, argc);
177 case CMD_REQUEST_COMMAND:
179 string modelname = argv(1);
181 entity debugmodel_entity = new(debugmodel);
182 precache_model(modelname);
183 _setmodel(debugmodel_entity, modelname);
184 setorigin(debugmodel_entity, view_origin);
185 debugmodel_entity.angles = view_angles;
186 debugmodel_entity.draw = DrawDebugModel;
187 IL_PUSH(g_drawables, debugmodel_entity);
193 case CMD_REQUEST_USAGE:
195 LOG_INFO("Usage:^3 cl_cmd debugmodel model");
196 LOG_INFO(" Where 'model' is a string of the model name to use for the debug model.");
202 void LocalCommand_handlevote(int request, int argc)
204 TC(int, request); TC(int, argc);
207 case CMD_REQUEST_COMMAND:
212 if (InterpretBoolean(argv(1)))
225 if (uid2name_dialog) // handled by "uid2name" option
230 localcmd(strcat("setreport cl_allow_uid2name ", ftos(vote_selection - 1), "\n"));
233 else { localcmd(strcat("cmd vote ", vote_string, "\n")); }
241 LOG_INFO("Incorrect parameters for ^2handlevote^7");
243 case CMD_REQUEST_USAGE:
245 LOG_INFO("Usage:^3 cl_cmd handlevote vote");
246 LOG_INFO(" Where 'vote' is the selection for either the current poll or uid2name.");
252 bool QuickMenu_IsOpened();
253 void QuickMenu_Close();
254 bool QuickMenu_Open(string mode, string submenu, string file);
256 bool HUD_MinigameMenu_IsOpened();
257 void HUD_MinigameMenu_Close(entity this, entity actor, entity trigger);
258 void HUD_MinigameMenu_Open();
260 void HUD_Radar_Show_Maximized(bool doshow, bool clickable);
262 void LocalCommand_hud(int request, int argc)
264 TC(int, request); TC(int, argc);
267 case CMD_REQUEST_COMMAND:
269 if(MUTATOR_CALLHOOK(HUD_Command, argc))
276 cvar_set("_hud_configure", ftos(!autocvar__hud_configure));
282 if (argv(2) == "help")
284 LOG_INFO(" quickmenu [[default | file | \"\"] submenu file]");
285 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.");
286 LOG_INFO("A submenu name can be given to open the quickmenu directly in a submenu; it requires to specify 'default', 'file' or '\"\"' option.");
287 LOG_INFO("A file name can also be given to open a different quickmenu");
290 string file = ((argv(4) == "") ? autocvar_hud_panel_quickmenu_file : argv(4));
291 if (QuickMenu_IsOpened())
294 QuickMenu_Open(argv(2), argv(3), file); // mode, submenu
302 HUD_Panel_ExportCfg(argv(2));
307 break; // go to usage, we're missing the paramater needed here.
311 case "scoreboard_columns_set":
313 Cmd_Scoreboard_SetFields(argc);
317 case "scoreboard_columns_help":
319 Cmd_Scoreboard_Help();
326 HUD_Radar_Show_Maximized(InterpretBoolean(argv(2)), 0);
328 HUD_Radar_Show_Maximized(!hud_panel_radar_maximized, 0);
334 HUD_Radar_Show_Maximized(!hud_panel_radar_mouse, 1);
342 LOG_INFO("Incorrect parameters for ^2hud^7");
344 case CMD_REQUEST_USAGE:
346 LOG_INFO("Usage:^3 cl_cmd hud action [configname | radartoggle | layout]");
347 LOG_INFO(" Where 'action' is the command to complete,");
348 LOG_INFO(" 'configname' is the name to save to for \"save\" action,");
349 LOG_INFO(" 'radartoggle' is to control hud_panel_radar_maximized for \"radar\" action,");
350 LOG_INFO(" and 'layout' is how to organize the scoreboard columns for the set action.");
351 LOG_INFO(" Full list of commands here: \"configure, quickmenu, minigame, save, scoreboard_columns_help, scoreboard_columns_set, radar.\"");
357 void LocalCommand_localprint(int request, int argc)
359 TC(int, request); TC(int, argc);
362 case CMD_REQUEST_COMMAND:
366 centerprint_hud(argv(1));
373 LOG_INFO("Incorrect parameters for ^2localprint^7");
375 case CMD_REQUEST_USAGE:
377 LOG_INFO("Usage:^3 cl_cmd localprint \"message\"");
378 LOG_INFO(" 'message' is the centerprint message to send to yourself.");
384 void LocalCommand_mv_download(int request, int argc)
386 TC(int, request); TC(int, argc);
389 case CMD_REQUEST_COMMAND:
393 Cmd_MapVote_MapDownload(argc);
400 LOG_INFO("Incorrect parameters for ^2mv_download^7");
402 case CMD_REQUEST_USAGE:
404 LOG_INFO("Usage:^3 cl_cmd mv_download mapid");
405 LOG_INFO(" Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.");
411 void LocalCommand_sendcvar(int request, int argc)
413 TC(int, request); TC(int, argc);
416 case CMD_REQUEST_COMMAND:
420 // W_FixWeaponOrder will trash argv, so save what we need.
421 string thiscvar = string_null; strcpy(thiscvar, argv(1));
422 string s = cvar_string(thiscvar);
424 if (thiscvar == "cl_weaponpriority")
425 s = W_FixWeaponOrder(W_NumberWeaponOrder(s), 1);
426 else if (substring(thiscvar, 0, 17) == "cl_weaponpriority" && strlen(thiscvar) == 18)
427 s = W_FixWeaponOrder(W_NumberWeaponOrder(s), 0);
429 localcmd("cmd sentcvar ", thiscvar, " \"", s, "\"\n");
437 LOG_INFO("Incorrect parameters for ^2sendcvar^7");
439 case CMD_REQUEST_USAGE:
441 LOG_INFO("Usage:^3 cl_cmd sendcvar <cvar>");
442 LOG_INFO(" Where 'cvar' is the cvar plus arguments to send to the server.");
448 /* use this when creating a new command, making sure to place it in alphabetical order... also,
449 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
450 void LocalCommand_(int request)
454 case CMD_REQUEST_COMMAND:
461 case CMD_REQUEST_USAGE:
463 print("\nUsage:^3 cl_cmd \n");
464 print(" No arguments required.\n");
472 // ==================================
473 // Macro system for client commands
474 // ==================================
476 // Normally do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
477 CLIENT_COMMAND(blurtest, "Feature for testing blur postprocessing") { LocalCommand_blurtest(request); }
478 CLIENT_COMMAND(boxparticles, "Spawn particles manually") { LocalCommand_boxparticles(request, arguments); }
479 CLIENT_COMMAND(create_scrshot_ent, "Create an entity at this location for automatic screenshots") { LocalCommand_create_scrshot_ent(request); }
480 CLIENT_COMMAND(debugmodel, "Spawn a debug model manually") { LocalCommand_debugmodel(request, arguments); }
481 CLIENT_COMMAND(handlevote, "System to handle selecting a vote or option") { LocalCommand_handlevote(request, arguments); }
482 CLIENT_COMMAND(hud, "Commands regarding/controlling the HUD system") { LocalCommand_hud(request, arguments); }
483 CLIENT_COMMAND(localprint, "Create your own centerprint sent to yourself") { LocalCommand_localprint(request, arguments); }
484 CLIENT_COMMAND(mv_download, "Retrieve mapshot picture from the server") { LocalCommand_mv_download(request, arguments); }
485 CLIENT_COMMAND(sendcvar, "Send a cvar to the server (like weaponpriority)") { LocalCommand_sendcvar(request, arguments); }
487 void LocalCommand_macro_help()
489 FOREACH(CLIENT_COMMANDS, true, LOG_INFOF(" ^2%s^7: %s", it.m_name, it.m_description));
492 bool LocalCommand_macro_command(int argc, string command)
494 string c = strtolower(argv(0));
495 FOREACH(CLIENT_COMMANDS, it.m_name == c, {
496 it.m_invokecmd(it, CMD_REQUEST_COMMAND, NULL, argc, command);
502 bool LocalCommand_macro_usage(int argc)
504 string c = strtolower(argv(1));
505 FOREACH(CLIENT_COMMANDS, it.m_name == c, {
506 it.m_invokecmd(it, CMD_REQUEST_USAGE, NULL, argc, "");
512 void LocalCommand_macro_write_aliases(int fh)
514 FOREACH(CLIENT_COMMANDS, true, CMD_Write_Alias("qc_cmd_cl", it.m_name, it.m_description));
518 // =========================================
519 // Main Function Called By Engine (cl_cmd)
520 // =========================================
521 // If this function exists, client code handles gamecommand instead of the engine code.
523 void GameCommand(string command)
525 int argc = tokenize_console(command);
527 // Guide for working with argc arguments by example:
528 // argc: 1 - 2 - 3 - 4
529 // argv: 0 - 1 - 2 - 3
530 // cmd vote - master - login - password
531 string s = strtolower(argv(0));
536 LOG_INFO("Client console commands:");
537 LocalCommand_macro_help();
539 LOG_INFO("\nGeneric commands shared by all programs:");
540 GenericCommand_macro_help();
542 LOG_INFO("\nUsage:^3 cl_cmd COMMAND...^7, where possible commands are listed above.");
543 LOG_INFO("For help about a specific command, type cl_cmd help COMMAND");
547 else if (GenericCommand_macro_usage(argc)) // Instead of trying to call a command, we're going to see detailed information about it
551 else if (LocalCommand_macro_usage(argc)) // now try for normal commands too
556 // continue as usual and scan for normal commands
557 if (GenericCommand(command) // handled by common/command/generic.qc
558 || LocalCommand_macro_command(argc, command) // handled by one of the above LocalCommand_* functions
559 || MUTATOR_CALLHOOK(CSQC_ConsoleCommand, s, argc, command) // handled by a mutator
562 // nothing above caught the command, must be invalid
563 LOG_INFO(((command != "") ? strcat("Unknown client command \"", command, "\"") : "No command provided"), ". For a list of supported commands, try cl_cmd help.");
567 // ===================================
568 // Macro system for console commands
569 // ===================================
571 // These functions are here specifically to add special + - commands to the game, and are not really normal commands.
572 // Please add client commands to the function above this, as this is only for special reasons.
573 #define CONSOLE_COMMANDS_NORMAL() \
574 CONSOLE_COMMAND("+showscores", { scoreboard_showscores = true; }) \
575 CONSOLE_COMMAND("-showscores", { scoreboard_showscores = false; }) \
576 CONSOLE_COMMAND("+showaccuracy", { scoreboard_showaccuracy = true; }) \
577 CONSOLE_COMMAND("-showaccuracy", { scoreboard_showaccuracy = false; }) \
580 #define CONSOLE_COMMANDS_MOVEMENT() \
581 CONSOLE_COMMAND("+forward", { ++camera_direction.x; }) \
582 CONSOLE_COMMAND("-forward", { --camera_direction.x; }) \
583 CONSOLE_COMMAND("+back", { --camera_direction.x; }) \
584 CONSOLE_COMMAND("-back", { ++camera_direction.x; }) \
585 CONSOLE_COMMAND("+moveup", { ++camera_direction.z; }) \
586 CONSOLE_COMMAND("-moveup", { --camera_direction.z; }) \
587 CONSOLE_COMMAND("+movedown", { --camera_direction.z; }) \
588 CONSOLE_COMMAND("-movedown", { ++camera_direction.z; }) \
589 CONSOLE_COMMAND("+moveright", { --camera_direction.y; }) \
590 CONSOLE_COMMAND("-moveright", { ++camera_direction.y; }) \
591 CONSOLE_COMMAND("+moveleft", { ++camera_direction.y; }) \
592 CONSOLE_COMMAND("-moveleft", { --camera_direction.y; }) \
593 CONSOLE_COMMAND("+roll_right", { ++camera_roll; }) \
594 CONSOLE_COMMAND("-roll_right", { --camera_roll; }) \
595 CONSOLE_COMMAND("+roll_left", { --camera_roll; }) \
596 CONSOLE_COMMAND("-roll_left", { ++camera_roll; }) \
599 void ConsoleCommand_macro_init()
601 // first init normal commands
602 #define CONSOLE_COMMAND(name, execution) \
603 { registercommand(name); }
605 CONSOLE_COMMANDS_NORMAL();
606 #undef CONSOLE_COMMAND
608 // then init movement commands
613 #define CONSOLE_COMMAND(name, execution) \
614 registercommand(name);
616 CONSOLE_COMMANDS_MOVEMENT();
617 #undef CONSOLE_COMMAND
623 bool ConsoleCommand_macro_normal(string s, int argc)
625 #define CONSOLE_COMMAND(name, execution) \
626 { if (name == s) { { execution } return true; } }
628 CONSOLE_COMMANDS_NORMAL();
629 #undef CONSOLE_COMMAND
634 bool ConsoleCommand_macro_movement(string s, int argc)
638 #define CONSOLE_COMMAND(name, execution) \
639 { if (name == s) { { execution } return true; } }
641 CONSOLE_COMMANDS_MOVEMENT();
642 #undef CONSOLE_COMMAND
649 // ======================================================
650 // Main Function Called By Engine (registered commands)
651 // ======================================================
652 // Used to parse commands in the console that have been registered with the "registercommand" function
654 bool CSQC_ConsoleCommand(string command)
656 int argc = tokenize_console(command);
657 string s = strtolower(argv(0));
658 // Return value should be true if CSQC handled the command, otherwise return false to have the engine handle it.
659 return ConsoleCommand_macro_normal(s, argc)
660 || ConsoleCommand_macro_movement(s, argc)