]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blobdiff - qcsrc/common/notifications.qc
More work on item messages
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / notifications.qc
index b25dde7bd54d27537938a4485651e957bdf5667a..5653a6d9a946e9e8fcc20e5c8641b2660813fd62 100644 (file)
@@ -3,6 +3,19 @@
 //  Last updated: February, 2013
 // ================================================
 
+string Get_Notif_TypeName(float net_type)
+{
+       switch(net_type)
+       {
+               case MSG_INFO: return "MSG_INFO";
+               case MSG_CENTER: return "MSG_CENTER";
+               case MSG_WEAPON: return "MSG_WEAPON";
+               case MSG_DEATH: return "MSG_DEATH";
+       }
+       backtrace(sprintf("Get_Notif_TypeName(%d): Improper net type!\n", net_type));
+       return "your ass";
+}
+
 entity Get_Notif_Ent(float net_type, float net_name)
 {
        switch(net_type)
@@ -16,6 +29,72 @@ entity Get_Notif_Ent(float net_type, float net_name)
        return world;
 }
 
+string Notification_CheckArgs_TypeName(float net_type, float net_name)
+{
+       // check supplied type and name for errors
+       string checkargs = "";
+       #define CHECKARG_TYPENAME(type) case MSG_##type##: \
+               { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
+               { checkargs = sprintf("Improper name: %d!", net_name); } break; }
+       switch(net_type)
+       {
+               CHECKARG_TYPENAME(INFO)
+               CHECKARG_TYPENAME(CENTER)
+               CHECKARG_TYPENAME(WEAPON)
+               CHECKARG_TYPENAME(DEATH)
+               default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
+       }
+       #undef CHECKARG_TYPENAME
+       return checkargs;
+}
+
+#ifdef SVQC
+string Notification_CheckArgs(float broadcast, entity client, float net_type, float net_name)
+{
+       // check supplied broadcast, target, type, and name for errors
+       string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
+       if(checkargs != "") { checkargs = strcat(checkargs, " "); }
+       switch(broadcast)
+       {
+               case NOTIF_ONE:
+               case NOTIF_ONE_ONLY:
+               {
+                       if(IS_NOT_A_CLIENT(client))
+                               { checkargs = sprintf("%sNo client provided!", checkargs); }
+                       break;
+               }
+               
+               case NOTIF_ANY_EXCEPT:
+               {
+                       if(IS_NOT_A_CLIENT(client))
+                               { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
+                       break;
+               }
+               
+               case NOTIF_ANY:
+               {
+                       if(client)
+                               { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
+                       break;
+               }
+               
+               case NOTIF_TEAM:
+               case NOTIF_TEAM_EXCEPT:
+               {
+                       if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
+                       else if(IS_NOT_A_CLIENT(client))
+                       {
+                               if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
+                               else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
+                       }
+                       break;
+               }
+               
+               default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
+       }
+       return checkargs;
+}
+#endif
 
 // ===============================
 //  Frontend Notification Pushing
@@ -111,6 +190,8 @@ void Dump_Notifications(float fh, float alsoprint)
        NOTIF_WRITE("seta notification_ctf_pickup_enemy_verbose 1 \"Show extra information if an enemy picks up a flag\"\n");
        NOTIF_WRITE("seta notification_ctf_capture_verbose 1 \"Show extra information when someone captures a flag\"\n");
        NOTIF_WRITE("seta notification_frag_verbose 1 \"Show extra information when you frag someone (or when you are fragged\"\n");
+       NOTIF_WRITE("seta notification_lifetime_runtime 0.5 \"Amount of time that notification entities last on the server during runtime (In seconds)\"\n");
+       NOTIF_WRITE("seta notification_lifetime_mapload 10 \"Amount of time that notification entities last immediately at mapload (in seconds) to help prevent notifications from being lost on early init (like gamestart countdown)\"\n");
 
        NOTIF_WRITE(sprintf("\n// Notification counts (total = %d): MSG_INFO = %d, MSG_CENTER = %d, MSG_WEAPON = %d, MSG_DEATH = %d\n",
                (NOTIF_INFO_COUNT + NOTIF_CENTER_COUNT + NOTIF_WEAPON_COUNT + NOTIF_DEATH_COUNT), 
@@ -211,7 +292,7 @@ void Local_Notification_centerprint_generic(string input, string durcnt, float c
                switch(strtolower(selected))
                {
                        #define ARG_CASE(prog,selected,result) \
-                               #if (prog == ARG_CS_SV_DC) \
+                               #if (prog == ARG_CS_SV_DC) || (prog == ARG_DC) \
                                        case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
                                #endif
                        NOTIF_ARGUMENT_LIST
@@ -231,45 +312,36 @@ void Local_Notification_centerprint_generic(string input, string durcnt, float c
 void Local_Notification(float net_type, float net_name, ...count)
 {
        // check supplied type and name for errors
-       string checkargs = "";
-       #define CHECKARG_TYPENAME(type) case MSG_##type##: \
-               { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
-               { checkargs = sprintf("Improper name: %d!", net_name); } break; }
-       switch(net_type)
-       {
-               CHECKARG_TYPENAME(INFO)
-               CHECKARG_TYPENAME(CENTER)
-               CHECKARG_TYPENAME(WEAPON)
-               CHECKARG_TYPENAME(DEATH)
-               default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
-       }
-       #undef CHECKARG_TYPENAME
+       string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
        if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
 
        entity notif = Get_Notif_Ent(net_type, net_name);
        if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
-       if not(notif.nent_enabled) { print("Local_Notification: Entity was disabled...\n"); return; }
 
+       #ifdef NOTIFICATIONS_DEBUG
+       if not(notif.nent_enabled) { dprint(sprintf("Local_Notification(%s, %s): Entity was disabled...\n", Get_Notif_TypeName(net_type), notif.nent_name)); return; }
+       #endif
+       
        if((notif.nent_stringcount + notif.nent_floatcount) > count)
        {
                backtrace(sprintf(
                        strcat(
-                               "Not enough arguments for Local_Notification(%d, %s, ...)! ",
+                               "Not enough arguments for Local_Notification(%s, %s, ...)! ",
                                "stringcount(%d) + floatcount(%d) > count(%d)\n", 
                                "Check the definition and function call for accuracy...?\n"
                        ),
-                       net_type, notif.nent_name, notif.nent_stringcount, notif.nent_floatcount, count));
+                       Get_Notif_TypeName(net_type), notif.nent_name, notif.nent_stringcount, notif.nent_floatcount, count));
                return;
        }
        else if((notif.nent_stringcount + notif.nent_floatcount) < count)
        {
                backtrace(sprintf(
                        strcat(
-                               "Too many arguments for Local_Notification(%d, %s, ...)! ",
+                               "Too many arguments for Local_Notification(%s, %s, ...)! ",
                                "stringcount(%d) + floatcount(%d) < count(%d)\n",
                                "Check the definition and function call for accuracy...?\n"
                        ),
-                       net_type, notif.nent_name, notif.nent_stringcount, notif.nent_floatcount, count));
+                       Get_Notif_TypeName(net_type), notif.nent_name, notif.nent_stringcount, notif.nent_floatcount, count));
                return;
        }
 
@@ -284,8 +356,8 @@ void Local_Notification(float net_type, float net_name, ...count)
 
        #ifdef NOTIFICATIONS_DEBUG
        dprint(
-               sprintf("Local_Notification(%d, %s, %s, %s);\n",
-                       net_type,
+               sprintf("Local_Notification(%s, %s, %s, %s);\n",
+                       Get_Notif_TypeName(net_type),
                        notif.nent_name,
                        sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
                        sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
@@ -389,30 +461,46 @@ void Read_Notification(float is_new)
        float net_type = ReadByte();
        float net_name = ReadShort();
 
-       entity notif = Get_Notif_Ent(net_type, net_name);
-       if not(notif) { print("Read_Notification: Could not find notification entity!\n"); return; }
+       if(net_type == MSG_CENTER_KILL)
+       {
+               if(is_new)
+               {
+                       if(net_name == 0) { reset_centerprint_messages(); }
+                       else
+                       {
+                               entity notif = Get_Notif_Ent(MSG_CENTER, net_name);
+                               if not(notif) { backtrace("Read_Notification: Could not find notification entity!\n"); return; }
+                               centerprint_generic(notif.nent_cpid, "", 0, 0);
+                       }
+               }
+       }
+       else
+       {
+               entity notif = Get_Notif_Ent(net_type, net_name);
+               if not(notif) { backtrace("Read_Notification: Could not find notification entity!\n"); return; }
 
-       string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
-       string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
-       string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
-       string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
-       float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
-       float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
-       float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
-       float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
+               #ifdef NOTIFICATIONS_DEBUG
+               dprint(sprintf("Read_Notification(%d) at %f: net_type = %s, net_name = %s\n", is_new, time, Get_Notif_TypeName(net_type), notif.nent_name));
+               #endif
 
-       #ifdef NOTIFICATIONS_DEBUG
-       dprint(sprintf("Read_Notification(%d) at %f: net_name = %s.\n", is_new, time, notif.nent_name));
-       #endif
+               string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
+               string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
+               string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
+               string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
+               float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
+               float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
+               float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
+               float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
        
-       if(is_new)
-       {
-               Local_Notification_WOVA(
-                       net_type, net_name,
-                       notif.nent_stringcount,
-                       notif.nent_floatcount,
-                       s1, s2, s3, s4,
-                       f1, f2, f3, f4);
+               if(is_new)
+               {
+                       Local_Notification_WOVA(
+                               net_type, net_name,
+                               notif.nent_stringcount,
+                               notif.nent_floatcount,
+                               s1, s2, s3, s4,
+                               f1, f2, f3, f4);
+               }
        }
 }
 #endif
@@ -516,62 +604,48 @@ float Net_Write_Notification(entity client, float sf)
        return send; 
 }
 
-void Send_Notification(float broadcast, entity client,
-       float net_type, float net_name, ...count)
+void Kill_Notification(float broadcast, entity client, float net_type, float net_name)
 {
-       // check supplied broadcast, target, type, and name for errors
-       string checkargs = "";
-       #define CHECKARG_TYPENAME(type) case MSG_##type##: \
-               { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
-               { checkargs = sprintf("Improper name: %d!", net_name); } break; }
-       switch(net_type)
+       string checkargs = Notification_CheckArgs(broadcast, client, net_type, 1);
+       if(checkargs != "") { backtrace(sprintf("Incorrect usage of Kill_Notification: %s\n", checkargs)); return; }
+
+       entity notif;
+
+       // if this is a centerprint, we must tell the client
+       // to kill the cpid in the centerprint queue
+       if(net_type == MSG_CENTER)
        {
-               CHECKARG_TYPENAME(INFO)
-               CHECKARG_TYPENAME(CENTER)
-               CHECKARG_TYPENAME(WEAPON)
-               CHECKARG_TYPENAME(DEATH)
-               default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
+               notif = spawn();
+               notif.classname = "net_kill_notification";
+               notif.nent_broadcast = broadcast;
+               notif.nent_client = client;
+               notif.nent_net_type = MSG_CENTER_KILL;
+               notif.nent_net_name = net_name;
+               Net_LinkEntity(notif, FALSE, autocvar_notification_lifetime_runtime, Net_Write_Notification);
        }
-       #undef CHECKARG_TYPENAME
-       if(checkargs != "") { checkargs = strcat(checkargs, " "); }
-       switch(broadcast)
+
+       for(notif = world; (notif = find(notif, classname, "net_notification"));)
        {
-               case NOTIF_ONE:
-               case NOTIF_ONE_ONLY:
-               {
-                       if(IS_NOT_A_CLIENT(client))
-                               { checkargs = sprintf("%sNo client provided!", checkargs); }
-                       break;
-               }
-               
-               case NOTIF_ANY_EXCEPT:
+               // now kill the old send notification entity
+               if(notif.nent_net_type == net_type)
                {
-                       if(IS_NOT_A_CLIENT(client))
-                               { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
-                       break;
-               }
-               
-               case NOTIF_ANY:
-               {
-                       if(client)
-                               { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
-                       break;
-               }
-               
-               case NOTIF_TEAM:
-               case NOTIF_TEAM_EXCEPT:
-               {
-                       if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
-                       else if(IS_NOT_A_CLIENT(client))
-                       {
-                               if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
-                               else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
-                       }
-                       break;
+                       if(net_name)
+                               { if(notif.nent_net_name == net_name) { notif.think(); } }
+                       else
+                               { notif.think(); }
+
+                       #ifdef NOTIFICATIONS_DEBUG
+                       print(sprintf("killed '%s'\n", notif.classname));
+                       #endif
                }
-               
-               default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
        }
+}
+
+void Send_Notification(float broadcast, entity client,
+       float net_type, float net_name, ...count)
+{
+       // check supplied broadcast, target, type, and name for errors
+       string checkargs = Notification_CheckArgs(broadcast, client, net_type, net_name);
        if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
 
        // retreive counts for the arguments of this notification
@@ -582,39 +656,48 @@ void Send_Notification(float broadcast, entity client,
        {
                backtrace(sprintf(
                        strcat(
-                               "Not enough arguments for Send_Notification(%d, %d, %s, ...)! ",
+                               "Not enough arguments for Send_Notification(%d, %s, %s, ...)! ",
                                "stringcount(%d) + floatcount(%d) > count(%d)\n", 
                                "Check the definition and function call for accuracy...?\n"
                        ),
-                       broadcast, net_type, notif.nent_name, notif.nent_stringcount, notif.nent_floatcount, count));
+                       broadcast, Get_Notif_TypeName(net_type), notif.nent_name, notif.nent_stringcount, notif.nent_floatcount, count));
                return;
        }
        else if((notif.nent_stringcount + notif.nent_floatcount) < count)
        {
                backtrace(sprintf(
                        strcat(
-                               "Too many arguments for Send_Notification(%d, %d, %s, ...)! ",
+                               "Too many arguments for Send_Notification(%d, %s, %s, ...)! ",
                                "stringcount(%d) + floatcount(%d) < count(%d)\n",
                                "Check the definition and function call for accuracy...?\n"
                        ),
-                       broadcast, net_type, notif.nent_name, notif.nent_stringcount, notif.nent_floatcount, count));
+                       broadcast, Get_Notif_TypeName(net_type), notif.nent_name, notif.nent_stringcount, notif.nent_floatcount, count));
                return;
        }
-       
+
        #ifdef NOTIFICATIONS_DEBUG
+       string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
+       string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
+       string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
+       string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
+       float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
+       float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
+       float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
+       float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
        dprint(
-               sprintf("Send_Notification(%d, %d, %s, stringcount: %d, floatcount: %d, varargs: %d);\n",
+               sprintf("Send_Notification(%d, %s, %s, %s, %s - %d %d);\n",
                        broadcast,
-                       net_type,
+                       Get_Notif_TypeName(net_type),
                        notif.nent_name,
-                       notif.nent_stringcount,
-                       notif.nent_floatcount,
-                       count
+                       sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
+                       sprintf("%d, %d, %d, %d", f1, f2, f3, f4),
+                       notif.nent_stringcount, notif.nent_floatcount
                )
        );
        #endif
 
        entity net_notif = spawn();
+       net_notif.classname = "net_notification";
        net_notif.nent_broadcast = broadcast;
        net_notif.nent_client = client;
        net_notif.nent_net_type = net_type;
@@ -625,13 +708,19 @@ void Send_Notification(float broadcast, entity client,
        float i;
        for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
        for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
-       
+
        net_notif.think = Net_Notification_Remove;
-       net_notif.nextthink = (time + 0.5); 
+       net_notif.nextthink =
+               ((time > autocvar_notification_lifetime_mapload)
+               ?
+                       (time + autocvar_notification_lifetime_runtime)
+                       :
+                       autocvar_notification_lifetime_mapload
+               ); 
 
        Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
 
-       if((!server_is_local) && (broadcast == NOTIF_ANY || broadcast == NOTIF_ANY_EXCEPT) && (net_type != MSG_CENTER))
+       if(server_is_dedicated && (broadcast == NOTIF_ANY || broadcast == NOTIF_ANY_EXCEPT) && (net_type != MSG_CENTER))
        {
                Local_Notification_WOVA(
                        net_type, net_name,
@@ -649,6 +738,20 @@ void Send_Notification_WOVA(float broadcast, entity client,
        float f1, float f2, float f3, float f4)
 {
        entity notif = Get_Notif_Ent(net_type, net_name);
+       
+       #ifdef NOTIFICATIONS_DEBUG
+       dprint(
+               sprintf("Send_Notification_WOVA(%d, %s, %s, %s, %s - %d %d);\n",
+                       broadcast,
+                       Get_Notif_TypeName(net_type),
+                       notif.nent_name,
+                       sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
+                       sprintf("%d, %d, %d, %d", f1, f2, f3, f4),
+                       notif.nent_stringcount, notif.nent_floatcount
+               )
+       );
+       #endif
+       
        #define VARITEM(stringc,floatc,args) \
                if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
                        { Send_Notification(broadcast, client, net_type, net_name, args); return; }