]> git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blobdiff - qcsrc/client/command/cl_cmd.qc
Merge branch 'master' into terencehill/itemstime
[xonotic/xonotic-data.pk3dir.git] / qcsrc / client / command / cl_cmd.qc
index 519372efa3c8c9bf54f30c5e71cff418dd0d054d..acac8b3121574d22a2ec706a9f78849b5a404712 100644 (file)
@@ -1,40 +1,8 @@
 // ==============================================
 //  CSQC client commands code, written by Samual
-//  Last updated: December 16th, 2011
+//  Last updated: December 28th, 2011
 // ==============================================
 
-float cvar_clientsettemp(string tmp_cvar, string value)
-{
-       entity e;
-       
-       for(e = world; (e = find(e, classname, "saved_cvar_value")); )
-               if(e.netname == tmp_cvar)
-                       goto saved;
-                       
-       // creating a new entity to keep track of this cvar
-       e = spawn();
-       e.classname = "saved_cvar_value";
-       e.netname = strzone(tmp_cvar);
-       e.message = strzone(cvar_string(tmp_cvar));
-       return TRUE;
-       
-       // an entity for this cvar already exists, update the value
-       :saved
-       cvar_set(tmp_cvar, value);
-       return FALSE;
-}
-
-float cvar_clientsettemp_restore()
-{
-       float i;
-       entity e;
-       
-       for(e = world; (e = find(e, classname, "saved_cvar_value")); )
-               { cvar_set(e.netname, e.message); ++i; } 
-               
-       return i;
-}
-
 void DrawDebugModel()
 {
        if(time - floor(time) > 0.5)
@@ -54,7 +22,7 @@ void DrawDebugModel()
 //  Command Sub-Functions
 // =======================
 
-void GameCommand_blurtest(float request)
+void LocalCommand_blurtest(float request)
 {
        // Simple command to work with postprocessing temporarily... possibly completely pointless, the glsl shader is used for a real feature now...
        // Anyway, to enable it, just compile the client with -DBLURTEST and then you can use the command.
@@ -89,7 +57,46 @@ void GameCommand_blurtest(float request)
        #endif
 }
 
-void GameCommand_debugmodel(float request, float argc)
+void LocalCommand_create_scrshot_ent(float request)
+{
+       switch(request)
+       {
+               case CMD_REQUEST_COMMAND:
+               {
+                       float fh;
+                       string filename = strcat(MapInfo_Map_bspname, "_scrshot_ent.txt");
+                       fh = fopen(filename, FILE_WRITE);
+                       
+                       if(fh >= 0)
+                       {
+                               fputs(fh, "{\n");
+                               fputs(fh, strcat("\"classname\" \"info_autoscreenshot\"\n"));
+                               fputs(fh, strcat("\"origin\" \"", strcat(ftos(view_origin_x), " ", ftos(view_origin_y), " ", ftos(view_origin_z)), "\"\n"));
+                               fputs(fh, strcat("\"angles\" \"", strcat(ftos(view_angles_x), " ", ftos(view_angles_y), " ", ftos(view_angles_z)), "\"\n"));
+                               fputs(fh, "}\n");
+                               
+                               print("Completed screenshot entity dump in ^2data/data/", MapInfo_Map_bspname, "_scrshot_ent.txt^7.\n");
+                               
+                               fclose(fh);
+                       }
+                       else
+                       {
+                               print("^1Error: ^7Could not dump to file!\n");
+                       }
+                       return;
+               }
+                       
+               default:
+               case CMD_REQUEST_USAGE:
+               {
+                       print("\nUsage:^3 cl_cmd create_scrshot_ent\n");
+                       print("  No arguments required.\n");
+                       return;
+               }
+       }
+}
+
+void LocalCommand_debugmodel(float request, float argc)
 {
        switch(request)
        {
@@ -119,7 +126,7 @@ void GameCommand_debugmodel(float request, float argc)
        }
 }
 
-void GameCommand_handlevote(float request, float argc)
+void LocalCommand_handlevote(float request, float argc)
 {
        switch(request)
        {
@@ -128,11 +135,15 @@ void GameCommand_handlevote(float request, float argc)
                        float vote_selection;
                        string vote_string;
                        
-                       switch(argv(1))
+                       if(InterpretBoolean(argv(1)))
                        {
-                               case "yes": vote_selection = 2; vote_string = "yes"; break;
-                               case "no": vote_selection = 1; vote_string = "no"; break;
-                               default: break;
+                               vote_selection = 2; 
+                               vote_string = "yes";
+                       }
+                       else
+                       {
+                               vote_selection = 1; 
+                               vote_string = "no"; 
                        }
                        
                        if(vote_selection)
@@ -162,7 +173,7 @@ void GameCommand_handlevote(float request, float argc)
        }
 }
 
-void GameCommand_hud(float request, float argc) // TODO: Add aliases in commands.cfg
+void LocalCommand_hud(float request, float argc)
 {
        switch(request)
        {
@@ -189,138 +200,129 @@ void GameCommand_hud(float request, float argc) // TODO: Add aliases in commands
                                        }
                                }
                                
-                               case "radar":
-                               {
-                                       if(argv(2))
-                                               hud_panel_radar_maximized = (stof(argv(2)) != 0);
-                                       else
-                                               hud_panel_radar_maximized = !hud_panel_radar_maximized;
-                                       
-                                       return;
-                               }
-                               
                                case "scoreboard_columns_set":
                                {
-                                       Cmd_HUD_SetFields(argc); // todo update this function
-                                       
+                                       Cmd_HUD_SetFields(argc); 
                                        return;
                                }
 
                                case "scoreboard_columns_help":
                                {
-                                       Cmd_HUD_Help(argc); // todo update this function
-                                       
+                                       Cmd_HUD_Help();
+                                       return;
+                               }
+                               
+                               case "radar":
+                               {
+                                       if(argv(2))
+                                               hud_panel_radar_maximized = InterpretBoolean(argv(2));
+                                       else
+                                               hud_panel_radar_maximized = !hud_panel_radar_maximized;
                                        return;
                                }
                        }
-                       return; 
                }
                        
                default:
                        print("Incorrect parameters for ^2hud^7\n");
                case CMD_REQUEST_USAGE:
                {
-                       print("\nUsage:^3 cl_cmd hud action [configname | radartoggle]\n");
+                       print("\nUsage:^3 cl_cmd hud action [configname | radartoggle | layout]\n");
                        print("  Where 'action' is the command to complete,\n");
                        print("  'configname' is the name to save to for \"save\" action,\n");
-                       print("  and 'radartoggle' is to control hud_panel_radar_maximized for \"radar\" action.\n");
-                       print("  Full list of commands here: \"configure, save, radar.\"\n");
+                       print("  'radartoggle' is to control hud_panel_radar_maximized for \"radar\" action,\n");
+                       print("  and 'layout' is how to organize the scoreboard columns for the set action.\n");
+                       print("  Full list of commands here: \"configure, save, scoreboard_columns_help, scoreboard_columns_set, radar.\"\n");
                        return;
                }
        }
 }
 
-void GameCommand_mv_download(float request, float argc)
+void LocalCommand_localprint(float request, float argc)
 {
        switch(request)
        {
                case CMD_REQUEST_COMMAND:
                {
-                       Cmd_MapVote_MapDownload(argc);
-                       
-                       return; 
+                       if(argv(1))
+                       {
+                               centerprint_hud(argv(1));
+                               return; 
+                       }
                }
                        
                default:
+                       print("Incorrect parameters for ^2localprint^7\n");
                case CMD_REQUEST_USAGE:
                {
-                       print("\nUsage:^3 cl_cmd mapvote_download mapid\n");
-                       print("  Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.\n");
+                       print("\nUsage:^3 cl_cmd localprint \"message\"\n");
+                       print("  'message' is the centerprint message to send to yourself.\n");
                        return;
                }
        }
 }
 
-void GameCommand_sendcvar(float request, float argc)
+void LocalCommand_mv_download(float request, float argc)
 {
        switch(request)
        {
                case CMD_REQUEST_COMMAND:
                {
-                       // W_FixWeaponOrder will trash argv, so save what we need.
-                       string thiscvar = strzone(argv(1));
-                       string s = cvar_string(thiscvar);
-                       
-                       if(thiscvar == "cl_weaponpriority")
-                               s = W_FixWeaponOrder(W_NumberWeaponOrder(s), 1);
-                       else if(substring(thiscvar, 0, 17) == "cl_weaponpriority" && strlen(thiscvar) == 18)
-                               s = W_FixWeaponOrder(W_NumberWeaponOrder(s), 0);
-                               
-                       localcmd("cmd sentcvar ", thiscvar, " \"", s, "\"\n");
-                       strunzone(thiscvar);
-                       
-                       return; 
+                       if(argv(1))
+                       {
+                               Cmd_MapVote_MapDownload(argc);
+                               return; 
+                       }
                }
                        
                default:
+                       print("Incorrect parameters for ^2mv_download^7\n");
                case CMD_REQUEST_USAGE:
                {
-                       print("\nUsage:^3 cl_cmd sendcvar <cvar>\n");
-                       print("  Where 'cvar' is the cvar plus arguments to send to the server.\n");
+                       print("\nUsage:^3 cl_cmd mv_download mapid\n");
+                       print("  Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.\n");
                        return;
                }
        }
 }
 
-void GameCommand_settemp(float request, float argc)
+void LocalCommand_sendcvar(float request, float argc)
 {
        switch(request)
        {
                case CMD_REQUEST_COMMAND:
                {
-                       if((argv(1) == "restore") && (argc == 3))
+                       if(argv(1))
                        {
-                               float i = cvar_clientsettemp_restore();
+                               // W_FixWeaponOrder will trash argv, so save what we need.
+                               string thiscvar = strzone(argv(1));
+                               string s = cvar_string(thiscvar);
                                
-                               if(i)
-                                       dprint("Restored ", ftos(i), " temporary cvar settings to their original values.\n");
-                               else
-                                       dprint("Nothing to restore.\n");
-                       }
-                       else
-                       {
-                               if(cvar_clientsettemp(argv(1), argv(2)))
-                                       dprint("Creating new settemp tracker for ", argv(1), " and setting it to \"", argv(2), "\" temporarily.\n"); 
-                               else
-                                       dprint("Already had a tracker for ", argv(1), ", updating it to \"", argv(2), "\".\n");
+                               if(thiscvar == "cl_weaponpriority")
+                                       s = W_FixWeaponOrder(W_NumberWeaponOrder(s), 1);
+                               else if(substring(thiscvar, 0, 17) == "cl_weaponpriority" && strlen(thiscvar) == 18)
+                                       s = W_FixWeaponOrder(W_NumberWeaponOrder(s), 0);
+                                       
+                               localcmd("cmd sentcvar ", thiscvar, " \"", s, "\"\n");
+                               strunzone(thiscvar);
+                               return; 
                        }
-                               
-                       return; 
                }
                        
                default:
+                       print("Incorrect parameters for ^2sendcvar^7\n");
                case CMD_REQUEST_USAGE:
                {
-                       print("\nUsage:^3 cl_cmd settemp <cvar> | [restore]\n");
-                       print("  Where 'cvar' is the cvar plus arguments to send to the server,\n");
-                       print("  or 'restore' allows you to restore all of the original temporary cvar values.\n");
+                       print("\nUsage:^3 cl_cmd sendcvar <cvar>\n");
+                       print("  Where 'cvar' is the cvar plus arguments to send to the server.\n");
                        return;
                }
        }
 }
 
-/* use this when creating a new command, making sure to place it in alphabetical order.
-void GameCommand_(float request)
+/* use this when creating a new command, making sure to place it in alphabetical order... also,
+** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
+void LocalCommand_(float request)
 {
        switch(request)
        {
@@ -346,21 +348,25 @@ void GameCommand_(float request)
 //  Macro system for client commands
 // ==================================
 
-// Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
+// Normally do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
+// but for 0.5 compat, we need vyes and vno here as they were replaced... REMOVE THEM AFTER 0.6 RELEASE!!!!
 #define CLIENT_COMMANDS(request,arguments) \
-       CLIENT_COMMAND("blurtest", GameCommand_blurtest(request), "Feature for testing blur postprocessing") \
-       CLIENT_COMMAND("debugmodel", GameCommand_debugmodel(request, arguments), "Spawn a debug model manually") \
-       CLIENT_COMMAND("handlevote", GameCommand_handlevote(request, arguments), "System to handle selecting a vote or option") \
-       CLIENT_COMMAND("hud", GameCommand_hud(request, arguments), "Commands regarding/controlling the HUD system") \
-       CLIENT_COMMAND("mv_download", GameCommand_mv_download(request, arguments), "Retrieve mapshot picture from the server") \
-       CLIENT_COMMAND("sendcvar", GameCommand_sendcvar(request, arguments), "Send a cvar to the server (like weaponpriority)") \
-       CLIENT_COMMAND("settemp", GameCommand_settemp(request, arguments), "Temporarily set a value to a cvar which is restored by command or end of each match") \
+       CLIENT_COMMAND("blurtest", LocalCommand_blurtest(request), "Feature for testing blur postprocessing") \
+       CLIENT_COMMAND("create_scrshot_ent", LocalCommand_create_scrshot_ent(request), "Create an entity at this location for automatic screenshots") \
+       CLIENT_COMMAND("debugmodel", LocalCommand_debugmodel(request, arguments), "Spawn a debug model manually") \
+       CLIENT_COMMAND("handlevote", LocalCommand_handlevote(request, arguments), "System to handle selecting a vote or option") \
+       CLIENT_COMMAND("hud", LocalCommand_hud(request, arguments), "Commands regarding/controlling the HUD system") \
+       CLIENT_COMMAND("localprint", LocalCommand_localprint(request, arguments), "Create your own centerprint sent to yourself") \
+       CLIENT_COMMAND("mv_download", LocalCommand_mv_download(request, arguments), "Retrieve mapshot picture from the server") \
+       CLIENT_COMMAND("sendcvar", LocalCommand_sendcvar(request, arguments), "Send a cvar to the server (like weaponpriority)") \
+       CLIENT_COMMAND("vyes", LocalCommand_handlevote(request, tokenize_console("handlevote yes")), "") \
+       CLIENT_COMMAND("vno", LocalCommand_handlevote(request, tokenize_console("handlevote no")), "") \
        /* nothing */
        
-void GameCommand_macro_help()
+void LocalCommand_macro_help()
 {
        #define CLIENT_COMMAND(name,function,description) \
-               { print("  ^2", name, "^7: ", description, "\n"); }
+               { if(strtolower(description) != "") { print("  ^2", name, "^7: ", description, "\n"); } }
                
        CLIENT_COMMANDS(0, 0)
        #undef CLIENT_COMMAND
@@ -368,7 +374,7 @@ void GameCommand_macro_help()
        return;
 }
 
-float GameCommand_macro_command(float argc)
+float LocalCommand_macro_command(float argc)
 {
        #define CLIENT_COMMAND(name,function,description) \
                { if(name == strtolower(argv(0))) { function; return TRUE; } }
@@ -379,7 +385,7 @@ float GameCommand_macro_command(float argc)
        return FALSE;
 }
 
-float GameCommand_macro_usage(float argc)
+float LocalCommand_macro_usage(float argc)
 {
        #define CLIENT_COMMAND(name,function,description) \
                { if(name == strtolower(argv(1))) { function; return TRUE; } }
@@ -390,6 +396,17 @@ float GameCommand_macro_usage(float argc)
        return FALSE;
 }
 
+void LocalCommand_macro_write_aliases(float fh)
+{
+       #define CLIENT_COMMAND(name,function,description) \
+               { if(strtolower(description) != "") { CMD_Write_Alias("qc_cmd_cl", name, description); } }
+               
+       CLIENT_COMMANDS(0, 0)
+       #undef CLIENT_COMMAND
+       
+       return;
+}
+
 
 // =========================================
 //  Main Function Called By Engine (cl_cmd)
@@ -400,32 +417,46 @@ void GameCommand(string command)
 {
        float argc = tokenize_console(command);
 
+       // Guide for working with argc arguments by example:
+       // argc:   1    - 2      - 3     - 4
+       // argv:   0    - 1      - 2     - 3 
+       // cmd     vote - master - login - password
+
        if(strtolower(argv(0)) == "help") 
        {
                if(argc == 1) 
                {
-                       print("\nUsage:^3 cl_cmd COMMAND...^7, where possible commands are:\n");
-                       GameCommand_macro_help();
-                       GameCommand_Generic("help");
-                       print("For help about specific commands, type cl_cmd help COMMAND\n");
+                       print("\nClient console commands:\n");
+                       LocalCommand_macro_help();
+
+                       print("\nGeneric commands shared by all programs:\n");
+                       GenericCommand_macro_help();
+                       
+                       print("\nUsage:^3 cl_cmd COMMAND...^7, where possible commands are listed above.\n");
+                       print("For help about a specific command, type cl_cmd help COMMAND\n");
+                       
                        return;
                } 
-               else if(GameCommand_macro_usage(argc)) // Instead of trying to call a command, we're going to see detailed information about it
+               else if(GenericCommand_macro_usage(argc)) // Instead of trying to call a command, we're going to see detailed information about it
+               {
+                       return;
+               }
+               else if(LocalCommand_macro_usage(argc)) // now try for normal commands too
                {
                        return;
                }
        } 
-       else if(GameCommand_Generic(command)) 
+       else if(GenericCommand(command)) 
        {
-               return; // handled by common/gamecommand.qc
+               return; // handled by common/command/generic.qc
        }
-       else if(GameCommand_macro_command(argc)) // continue as usual and scan for normal commands
+       else if(LocalCommand_macro_command(argc)) // continue as usual and scan for normal commands
        {
-               return; // handled by one of the above GameCommand_* functions
+               return; // handled by one of the above LocalCommand_* functions
        }
        
        // nothing above caught the command, must be invalid
-       print("Unknown client command", ((command != "") ? strcat(" \"", command, "\"") : ""), ". For a list of supported commands, try cl_cmd help.\n");
+       print(((command != "") ? strcat("Unknown client command \"", command, "\"") : "No command provided"), ". For a list of supported commands, try cl_cmd help.\n");
        
        return;
 }
@@ -536,4 +567,4 @@ float CSQC_ConsoleCommand(string command)
        // Return value should be 1 if CSQC handled the command, otherwise return 0 to have the engine handle it.
 
        return FALSE;
-}
\ No newline at end of file
+}