X-Git-Url: https://de.git.xonotic.org/?a=blobdiff_plain;f=qcsrc%2Fcommon%2Fnotifications.qc;h=eac793afb61fec7f5ebe10022687bca0826b434d;hb=403ee70400305be21f798bbc39f83c0ea12b415a;hp=ad884add3c1d37ad7695be97ed0f88bf1acc4c1d;hpb=19ab1a2ba6824a03f8d263d27cc84dc7d54958ac;p=xonotic%2Fxonotic-data.pk3dir.git diff --git a/qcsrc/common/notifications.qc b/qcsrc/common/notifications.qc index ad884add3..eac793afb 100644 --- a/qcsrc/common/notifications.qc +++ b/qcsrc/common/notifications.qc @@ -1,111 +1,60 @@ // ================================================ // Unified notification system, written by Samual -// Last updated: December, 2012 +// Last updated: February, 2013 // ================================================ -// ====================== -// Supporting Functions -// ====================== - -// team code replace -string TCR(string input, string teamcolor, string teamtext) // TODO: MOVE TO UTIL.QC +#ifndef MENUQC +entity Get_Notif_Ent(float net_type, float net_name) { - input = strreplace("^TC", teamcolor, input); - input = strreplace("^TT", teamtext, input); - return input; + switch(net_type) + { + case MSG_INFO: return msg_info_notifs[net_name - 1]; + case MSG_CENTER: return msg_center_notifs[net_name - 1]; + case MSG_WEAPON: return msg_weapon_notifs[net_name - 1]; + case MSG_DEATH: return msg_death_notifs[net_name - 1]; + } + backtrace(sprintf("Get_Notif_Ent(%d, %d): Improper net type!\n", net_type, net_name)); + return world; } -// color code replace, place inside of sprintf and parse the string -string CCR(string input) // TODO: MOVE TO UTIL.QC +string Get_Notif_Name(float net_type, float net_name) { - // foreground/normal colors - input = strreplace("^F1", "^2", input); // primary priority (important names, etc) - input = strreplace("^F2", "^3", input); // secondary priority (items, locations, numbers, etc) - - // "kill" colors - input = strreplace("^K1", "^1", input); // "bad" or "dangerous" text (death messages against you, kill notifications, etc) - input = strreplace("^K2", "^3", input); // similar to above, but less important... OR, a highlight out of above message type - input = strreplace("^K3", "^4", input); // "good" or "beneficial" text (you fragging someone, etc) - - // background colors - input = strreplace("^BG", "^7", input); // neutral/unimportant text - input = strreplace("^N", "^7", input); // "none"-- reset to white... - return input; + entity e = Get_Notif_Ent(net_type, net_name); + if(e) { return e.nent_name; } + backtrace(sprintf("Get_Notif_Name(%d, %d): Could not find entity!\n", net_type, net_name)); + return ""; } -#ifndef MENUQC -// select between the normal or the gentle message string based on client (or server) settings -string normal_or_gentle(string normal, string gentle) +float Get_Notif_Infval(float net_type, float net_name) { - #ifdef CSQC - if(autocvar_cl_gentle || autocvar_cl_gentle_messages) - #else - if(autocvar_sv_gentle) - #endif - return ((gentle != "") ? gentle : normal); - else - return normal; + entity e = Get_Notif_Ent(net_type, net_name); + if(e) { return e.nent_infoname; } + backtrace(sprintf("Get_Notif_Infval(%d, %d): Could not find entity!\n", net_type, net_name)); + return NO_MSG; } -float notif_checkstring(string input) +float Get_Notif_Cenval(float net_type, float net_name) { - if not(input == "") { return TRUE; } - else { return FALSE; } + entity e = Get_Notif_Ent(net_type, net_name); + if(e) { return e.nent_centername; } + backtrace(sprintf("Get_Notif_Cenval(%d, %d): Could not find entity!\n", net_type, net_name)); + return NO_MSG; } -// get the actual name of a notification and return it as a string -string Get_Field_Value(float field, float net_type, float net_name) +float Get_Notif_Strnum(float net_type, float net_name) { - string output = ""; - - #define GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) \ - switch(field) { \ - case F_NAME: { output = VAR_TO_TEXT(name); break; } \ - case F_STRNUM: { output = ftos(strnum); break; } \ - case F_FLNUM: { output = ftos(flnum); break; } } - - switch(net_type) - { - case MSG_INFO: - { - #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \ - { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } } - MSG_INFO_NOTIFICATIONS - #undef MSG_INFO_NOTIF - break; - } - case MSG_CENTER: - { - #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \ - { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } } - MSG_CENTER_NOTIFICATIONS - #undef MSG_CENTER_NOTIF - break; - } - case MSG_WEAPON: - { - #define MSG_WEAPON_NOTIF(name,infoname,centername) \ - { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name, \ - max(stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername))), \ - max(stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)))) } } - MSG_WEAPON_NOTIFICATIONS - #undef MSG_WEAPON_NOTIF - break; - } - case MSG_DEATH: - { - #define MSG_DEATH_NOTIF(name,infoname,centername) \ - { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name, \ - max(stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername))), \ - max(stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)))) } } - MSG_DEATH_NOTIFICATIONS - #undef MSG_DEATH_NOTIF - break; - } - } + entity e = Get_Notif_Ent(net_type, net_name); + if(e) { return e.nent_stringcount; } + backtrace(sprintf("Get_Notif_Strnum(%d, %d): Could not find entity!\n", net_type, net_name)); + return NO_MSG; +} - #undef GET_FIELD_VALUE_OUTPUT - return output; +float Get_Notif_Flnum(float net_type, float net_name) +{ + entity e = Get_Notif_Ent(net_type, net_name); + if(e) { return e.nent_floatcount; } + backtrace(sprintf("Get_Notif_Flnum(%d, %d): Could not find entity!\n", net_type, net_name)); + return NO_MSG; } #endif // ifndef MENUQC @@ -117,170 +66,219 @@ string Get_Field_Value(float field, float net_type, float net_name) void Dump_Notifications(float fh, float alsoprint) { float MSG_INFO_NOTIFS = 0, MSG_CENTER_NOTIFS = 0, MSG_WEAPON_NOTIFS = 0, MSG_DEATH_NOTIFS = 0; + + #define NOTIF_WRITE(type,name,text) { \ + ++##type##_NOTIFS; \ + notif_msg = sprintf("seta %s 1 // %s - %s\n", name, #type, strreplace("\n", "\\n", text)); \ + fputs(fh, notif_msg); \ + if(alsoprint) { print(strreplace("^", "^^", notif_msg)); } } + + #ifndef MENUQC string notif_msg; + float i; + entity e; + + for(i = 0; i < NOTIF_INFO_COUNT; ++i) { + e = Get_Notif_Ent(MSG_INFO, i); + NOTIF_WRITE(MSG_INFO, e.nent_name, e.nent_string); } + + for(i = 0; i < NOTIF_CENTER_COUNT; ++i) { + e = Get_Notif_Ent(MSG_CENTER, i); + NOTIF_WRITE(MSG_CENTER, e.nent_name, e.nent_string); } + + for(i = 0; i < NOTIF_WEAPON_COUNT; ++i) { + e = Get_Notif_Ent(MSG_WEAPON, i); + NOTIF_WRITE(MSG_WEAPON, e.nent_name, sprintf("infoname: %s, centername: %s", + Get_Notif_Name(MSG_INFO, Get_Notif_Infval(MSG_WEAPON, i)), + Get_Notif_Name(MSG_CENTER, Get_Notif_Cenval(MSG_WEAPON, i)) ) ); } + + for(i = 0; i < NOTIF_DEATH_COUNT; ++i) { + e = Get_Notif_Ent(MSG_DEATH, i); + NOTIF_WRITE(MSG_DEATH, e.nent_name, sprintf("infoname: %s, centername: %s", + Get_Notif_Name(MSG_INFO, Get_Notif_Infval(MSG_DEATH, i)), + Get_Notif_Name(MSG_CENTER, Get_Notif_Cenval(MSG_DEATH, i)) ) ); } + + #endif - #define NOTIF_WRITE(type,name,text) notif_msg = sprintf("seta %s 1 // %s - %s\n", name, type, strreplace("\n", "\\n", text)); fputs(fh, notif_msg); if(alsoprint) { print(strreplace("^", "^^", notif_msg)); } - #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) { ++MSG_INFO_NOTIFS; NOTIF_WRITE("MSG_INFO", VAR_TO_TEXT(name), normal) } - #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) { ++MSG_CENTER_NOTIFS; NOTIF_WRITE("MSG_CENTER", VAR_TO_TEXT(name), normal) } - #define MSG_WEAPON_NOTIF(name,infoname,centername) { ++MSG_WEAPON_NOTIFS; NOTIF_WRITE("MSG_WEAPON", VAR_TO_TEXT(name),sprintf("infoname: %s, centername: %s", VAR_TO_TEXT(infoname), VAR_TO_TEXT(centername))) } - #define MSG_DEATH_NOTIF(name,infoname,centername) { ++MSG_DEATH_NOTIFS; NOTIF_WRITE("MSG_DEATH", VAR_TO_TEXT(name), sprintf("infoname: %s, centername: %s", VAR_TO_TEXT(infoname), VAR_TO_TEXT(centername))) } - MSG_INFO_NOTIFICATIONS - MSG_CENTER_NOTIFICATIONS - MSG_WEAPON_NOTIFICATIONS - MSG_DEATH_NOTIFICATIONS - #undef NOTIF_WRITE - #undef MSG_INFO_NOTIF - #undef MSG_CENTER_NOTIF - #undef MSG_WEAPON_NOTIF - #undef MSG_DEATH_NOTIF + print(sprintf("Notification counts: MSG_INFO = %d, MSG_CENTER = %d, MSG_WEAPON = %d, MSG_DEATH = %d\n", + MSG_INFO_NOTIFS, MSG_CENTER_NOTIFS, MSG_WEAPON_NOTIFS, MSG_DEATH_NOTIFS)); - print(sprintf("Notification counts: MSG_INFO = %d, MSG_CENTER = %d, MSG_WEAPON = %d, MSG_DEATH = %d\n", MSG_INFO_NOTIFS, MSG_CENTER_NOTIFS, MSG_WEAPON_NOTIFS, MSG_DEATH_NOTIFS)); return; + #undef NOTIF_WRITE } #ifndef MENUQC -#ifdef CSQC -void HUD_Notify_Push(string icon, string attacker, string victim) +string Local_Notification_sprintf(string input, string args, + string s1, string s2, string s3, string s4, + float f1, float f2, float f3, float f4) { - if(icon != "") + #ifdef NOTIFICATIONS_DEBUG + dprint(sprintf("Local_Notification_sprintf('%s^7', '%s', %s, %s);\n", + strreplace("\n", "\\n", input), args, + sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4), + sprintf("%d, %d, %d, %d", f1, f2, f3, f4))); + #endif + + string selected, remaining = args; + float sel_num = 0; + + #ifdef CSQC + string tmp_s; + #endif + + if((remaining != "") && (input != "")) { - --kn_index; - if (kn_index == -1) { kn_index = KN_MAX_ENTRIES-1; } - killnotify_times[kn_index] = time; - - // icon - if(killnotify_icon[kn_index]) { strunzone(killnotify_icon[kn_index]); } - killnotify_icon[kn_index] = strzone(icon); - - // attacker - if(killnotify_attackers[kn_index]) { strunzone(killnotify_attackers[kn_index]); } - killnotify_attackers[kn_index] = strzone(attacker); - - // victim - if(killnotify_victims[kn_index]) { strunzone(killnotify_victims[kn_index]); } - killnotify_victims[kn_index] = strzone(victim); + arg_slot[0] = ""; arg_slot[1] = ""; arg_slot[2] = ""; arg_slot[3] = ""; arg_slot[4] = ""; arg_slot[5] = ""; arg_slot[6] = ""; + for(;remaining;) + { + selected = car(remaining); remaining = cdr(remaining); + if(sel_num == 7) { backtrace("Local_Notification_sprintf: Hit maximum arguments!\n"); break; } + switch(strtolower(selected)) + { + #define ARG_CASE(prog,selected,result) \ + #ifdef CSQC \ + #if (prog == ARG_BOTH) || (prog == ARG_CSQC) \ + case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \ + #endif \ + #else \ + #if (prog == ARG_BOTH) || (prog == ARG_SVQC) \ + case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \ + #endif \ + #endif + NOTIF_ARGUMENT_LIST + #undef ARG_CASE + default: { backtrace(sprintf("Local_Notification_sprintf: Hit unknown token in selected string! '%s'\n", selected)); break; } + } + } + return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]); } + + return ""; } -void backtrace(string msg) // TODO: MOVE TO UTIL.QC +#ifdef CSQC +void Local_Notification_HUD_Notify_Push(string icon, string hudargs, string s1, string s2) { - float dev, war; - dev = cvar("developer"); - war = cvar("prvm_backtraceforwarnings"); - cvar_set("developer", "1"); - cvar_set("prvm_backtraceforwarnings", "1"); - print("\n"); - print("--- CUT HERE ---\nWARNING: "); - print(msg); - print("\n"); - remove(world); // isn't there any better way to cause a backtrace? - print("\n--- CUT UNTIL HERE ---\n"); - cvar_set("developer", ftos(dev)); - cvar_set("prvm_backtraceforwarnings", ftos(war)); + string selected, remaining = hudargs; + float sel_num = 0; + arg_slot[0] = ""; arg_slot[1] = ""; + if(remaining != "") + { + for(;remaining;) + { + selected = car(remaining); remaining = cdr(remaining); + if(sel_num == 2) { backtrace("Local_Notification_HUD_Notify_Push: Hit maximum arguments!\n"); break; } + switch(strtolower(selected)) + { + #define ARG_CASE(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; } + ARG_CASE("s1", s1) + ARG_CASE("s2", s2) + #undef ARG_CASE + default: { backtrace(sprintf("Local_Notification_HUD_Notify_Push: Hit unknown token in selected string! '%s'\n", selected)); break; } + } + } + } + HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]); } -#endif // ifdef CSQC +#endif void Local_Notification(float net_type, float net_name, ...count) { - float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name)); - float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name)); - - string s1 = ((0 < stringcount) ? ...(0, string) : NO_STR_ARG); - string s2 = ((1 < stringcount) ? ...(1, string) : NO_STR_ARG); - string s3 = ((2 < stringcount) ? ...(2, string) : NO_STR_ARG); - string s4 = ((3 < stringcount) ? ...(3, string) : NO_STR_ARG); - float f1 = ((stringcount < count) ? ...(stringcount, float) : NO_FL_ARG); - float f2 = (((stringcount + 1) < count) ? ...((stringcount + 1), float) : NO_FL_ARG); - float f3 = (((stringcount + 2) < count) ? ...((stringcount + 2), float) : NO_FL_ARG); - float f4 = (((stringcount + 3) < count) ? ...((stringcount + 3), float) : NO_FL_ARG); + // check supplied type and name for errors + #define CHECKARG_TYPENAME(type) case MSG_##type##: \ + { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \ + { checkargs = sprintf("Improper name: %d!", net_name); } break; } + string checkargs = ""; + 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 + 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! (This wasn't caught by usage check?...)\n"); return; } + if not(notif.nent_enabled) { print("Local_Notification: Entity was disabled...\n"); return; } + + if((notif.nent_stringcount + notif.nent_floatcount) > count) + { backtrace(sprintf(strcat("Not enough arguments for Local_Notification! stringcount(%d) + floatcount(%d) > count(%d)\n", + "Check the notification definition and function call for accuracy...?\n"), 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! stringcount(%d) + floatcount(%d) < count(%d)\n", + "Check the notification definition and function call for accuracy...?\n"), notif.nent_stringcount, notif.nent_floatcount, count)); return; } + + 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 = ((notif.nent_stringcount < count) ? ...(notif.nent_stringcount, float) : 0); + float f2 = (((notif.nent_stringcount + 1) < count) ? ...((notif.nent_stringcount + 1), float) : 0); + float f3 = (((notif.nent_stringcount + 2) < count) ? ...((notif.nent_stringcount + 2), float) : 0); + float f4 = (((notif.nent_stringcount + 3) < count) ? ...((notif.nent_stringcount + 3), float) : 0); + + #ifdef NOTIFICATIONS_DEBUG + dprint(sprintf("Local_Notification(%d, %s, %s, %s);\n", + 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))); + #endif - dprint("Local_Notification(", ftos(net_type), ", ", Get_Field_Value(F_NAME, net_type, net_name), strcat(", ", s1, ", ", s2, ", ", s3, ", ", s4, ", "), strcat(ftos(f1), strcat(", ", ftos(f2), ", ", ftos(f3), ", ", ftos(f4), ");\n"))); - dprint(" ^--: stringcount: ", ftos(stringcount), ", floatcount: ", ftos(floatcount), ".\n"); - - if((stringcount + floatcount) > count) { backtrace(strcat("Not enough arguments for Local_Notification! ", strcat("stringcount(", ftos(stringcount), ") + floatcount(", ftos(floatcount), ")"), " > count(", ftos(count), ").\nCheck the notification definition and the function call for accuracy...?\n")); return; } - else if((stringcount + floatcount) < count) { backtrace(strcat("Too many arguments for Local_Notification! ", strcat("stringcount(", ftos(stringcount), ") + floatcount(", ftos(floatcount), ")"), " < count(", ftos(count), ").\nCheck the notification definition and the function call for accuracy...?\n")); return; } - switch(net_type) { case MSG_INFO: { - #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \ - { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \ - { \ - if(notif_checkstring(normal)) { print(sprintf(CCR(normal_or_gentle(normal, gentle)), args)); } \ - #ifdef CSQC \ - if(notif_checkstring(icon)) { HUD_Notify_Push(icon, hudargs); } \ - #endif \ - } } - MSG_INFO_NOTIFICATIONS - #undef MSG_INFO_NOTIF + print(Local_Notification_sprintf(notif.nent_string, notif.nent_args, + s1, s2, s3, s4, f1, f2, f3, f4)); + #ifdef CSQC + if(notif.nent_icon != "") { Local_Notification_HUD_Notify_Push(notif.nent_icon, notif.nent_hudargs, s1, s2); } + #endif break; } + #ifdef CSQC case MSG_CENTER: { - #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \ - { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \ - { \ - if(notif_checkstring(normal)) { centerprint_generic(HANDLE_CPID(cpid), sprintf(CCR(normal_or_gentle(normal, gentle)), args), durcnt); } \ - } } - MSG_CENTER_NOTIFICATIONS - #undef MSG_CENTER_NOTIF + centerprint_generic(notif.nent_cpid, + Local_Notification_sprintf(notif.nent_string, notif.nent_args, + s1, s2, s3, s4, f1, f2, f3, f4), 0, 0); break; } #endif + case MSG_WEAPON: - { - #define MSG_WEAPON_NOTIF(name,infoname,centername) \ - { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \ - { \ - #if infoname != NO_MSG \ - Local_Notification_Without_VarArgs(MSG_INFO, infoname, \ - stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), \ - stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), \ - s1, s2, s3, s4, f1, f2, f3, f4); \ - #endif \ - #ifdef CSQC \ - #if centername != NO_MSG \ - Local_Notification_Without_VarArgs(MSG_CENTER, centername, \ - stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername)), \ - stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)), \ - s1, s2, s3, s4, f1, f2, f3, f4); \ - #endif \ - #endif \ - } } - MSG_WEAPON_NOTIFICATIONS - #undef MSG_WEAPON_NOTIF - break; - } case MSG_DEATH: { - #define MSG_DEATH_NOTIF(name,infoname,centername) \ - { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \ - { \ - #if infoname != NO_MSG \ - Local_Notification_Without_VarArgs(MSG_INFO, infoname, \ - stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), \ - stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), \ - s1, s2, s3, s4, f1, f2, f3, f4); \ - #endif \ - #ifdef CSQC \ - #if centername != NO_MSG \ - Local_Notification_Without_VarArgs(MSG_CENTER, centername, \ - stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername)), \ - stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)), \ - s1, s2, s3, s4, f1, f2, f3, f4); \ - #endif \ - #endif \ - } } - MSG_DEATH_NOTIFICATIONS - #undef MSG_DEATH_NOTIF + if(notif.nent_infoname) + if(msg_info_notifs[notif.nent_infoname - 1].nent_enabled) + { + Local_Notification_Without_VarArgs(MSG_INFO, notif.nent_infoname, + Get_Notif_Strnum(MSG_INFO, notif.nent_infoname), + Get_Notif_Flnum(MSG_INFO, notif.nent_infoname), + s1, s2, s3, s4, f1, f2, f3, f4); + } + #ifdef CSQC + if(notif.nent_centername) + if(msg_center_notifs[notif.nent_centername - 1].nent_enabled) + { + Local_Notification_Without_VarArgs(MSG_CENTER, notif.nent_centername, + Get_Notif_Strnum(MSG_CENTER, notif.nent_centername), + Get_Notif_Flnum(MSG_CENTER, notif.nent_centername), + s1, s2, s3, s4, f1, f2, f3, f4); + } + #endif break; } } } -void Local_Notification_Without_VarArgs(float net_type, float net_name, float stringcount, float floatcount, string s1, string s2, string s3, string s4, float f1, float f2, float f3, float f4) +void Local_Notification_Without_VarArgs(float net_type, float net_name, + float stringcount, float floatcount, + string s1, string s2, string s3, string s4, + float f1, float f2, float f3, float f4) { #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Local_Notification(net_type, net_name, args); return; } EIGHT_VARS_TO_VARARGS_VARLIST @@ -295,137 +293,166 @@ void Local_Notification_Without_VarArgs(float net_type, float net_name, float st // ========================= #ifdef CSQC -void Read_Notification(void) +void Read_Notification(float is_new) { float net_type = ReadByte(); float net_name = ReadShort(); - float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name)); - float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name)); + entity notif = Get_Notif_Ent(net_type, net_name); + if not(notif) { print("Read_Notification: Could not find notification entity!\n"); return; } + if not(notif.nent_enabled) { print("Read_Notification: Entity was disabled but networked anyway?!?...\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_name = %s.\n", is_new, time, notif.nent_name)); + #endif - Local_Notification_Without_VarArgs(net_type, net_name, - stringcount, floatcount, - ((stringcount >= 1) ? ReadString() : NO_STR_ARG), - ((stringcount >= 2) ? ReadString() : NO_STR_ARG), - ((stringcount >= 3) ? ReadString() : NO_STR_ARG), - ((stringcount == 4) ? ReadString() : NO_STR_ARG), - ((floatcount >= 1) ? ReadLong() : NO_FL_ARG), - ((floatcount >= 2) ? ReadLong() : NO_FL_ARG), - ((floatcount >= 3) ? ReadLong() : NO_FL_ARG), - ((floatcount == 4) ? ReadLong() : NO_FL_ARG)); + if(is_new) { Local_Notification_Without_VarArgs(net_type, net_name, notif.nent_stringcount, notif.nent_floatcount, s1, s2, s3, s4, f1, f2, f3, f4); } } #endif #ifdef SVQC -void Send_Notification(entity client, float broadcast, float net_type, float net_name, ...count) +void Notification_Remove() +{ + float i; + for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } } + remove(self); +} + +float Write_Notification(entity client, float sf) { - if((broadcast == MSG_BROADCAST || broadcast == MSG_ONE) && net_type && net_name) + float i, send = FALSE; + + switch(self.nent_broadcast) { - float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name)); - float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name)); - float i, tmp_f; - string tmp_s; - - dprint("Send_Notification(", ftos(broadcast), ", ", ftos(net_type), ", ", Get_Field_Value(F_NAME, net_type, net_name), strcat(", ", ftos(count), ");\n")); - dprint(" ^--: stringcount: ", ftos(stringcount), ", floatcount: ", ftos(floatcount), ".\n"); - - if((stringcount + floatcount) > count) { backtrace(strcat("Not enough arguments for Send_Notification! ", strcat("stringcount(", ftos(stringcount), ") + floatcount(", ftos(floatcount), "),"), " > count(", ftos(count), ").\nCheck the notification definition and the function call for accuracy...?\n")); return; } - else if((stringcount + floatcount) < count) { backtrace(strcat("Too many arguments for Send_Notification! ", strcat("stringcount(", ftos(stringcount), ") + floatcount(", ftos(floatcount), "),"), " < count(", ftos(count), ").\nCheck the notification definition and the function call for accuracy...?\n")); return; } - - //if(Count_Proper_Strings(NO_STR_ARG, s1, s2) > stringcount) { backtrace("Too many string arguments for notification!\n"); return; } - //if(Count_Proper_Floats(NO_FL_ARG, f1, f2, f3) > floatcount) { backtrace("Too many float arguments for notification!\n"); return; } - - #define WRITE_NOTIFICATION(msg) \ - WriteByte(msg, SVC_TEMPENTITY); \ - WriteByte(msg, TE_CSQC_NOTIFICATION); \ - WriteByte(msg, net_type); \ - WriteShort(msg, net_name); \ - for(i = 0; i < stringcount; ++i) \ - { tmp_s = ...(i, string); WriteString(msg, tmp_s); dprint("WriteString(...(", ftos(i), ", string)); - ", tmp_s, "\n"); } \ - for(i = 0; i < floatcount; ++i) \ - { tmp_f = ...((stringcount + i), float); WriteLong(msg, tmp_f); dprint("WriteLong(...(", ftos((stringcount + i)), ", float)); - ", ftos(tmp_f), "\n"); } - - - switch(broadcast) - { - case MSG_ONE: // personal/direct notification sent to ONE person and their spectators - { - if(client && (clienttype(client) == CLIENTTYPE_REAL) && (client.flags & FL_CLIENT)) - { - msg_entity = client; - WRITESPECTATABLE_MSG_ONE({WRITE_NOTIFICATION(MSG_ONE)}); - } - break; - } - - case MSG_BROADCAST: // global notification sent to EVERYONE - { - WRITE_NOTIFICATION(MSG_BROADCAST) - break; - } + case NOTIF_ONE: { if((client == self.nent_client) || (client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; } + case NOTIF_ONE_ONLY: { if(client == self.nent_client) { send = TRUE; } break; } + case NOTIF_TEAM: { if((client.team == self.nent_client.team) || (client.classname == STR_SPECTATOR && client.enemy.team == self.nent_client.team)) { send = TRUE; } break; } + case NOTIF_TEAM_EXCEPT: { if(((client != self.nent_client) && (client.team == self.nent_client.team) && !(client.classname == STR_SPECTATOR && client.enemy == self.nent_client))) { send = TRUE; } break; } + case NOTIF_ANY: { send = TRUE; break; } + case NOTIF_ANY_EXCEPT: { if((client != self.nent_client) && !(client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; } + default: { send = FALSE; break; } + } - case MSG_ALL: { backtrace("DO NOT USE MSG_ALL FOR NOTIFICATIONS, IT IS BAD!\n"); break; } - default: { backtrace("Unknown MSG_ type to write with!\n"); break; } - } + if(send) + { + WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION); + WriteByte(MSG_ENTITY, self.nent_net_type); + WriteShort(MSG_ENTITY, self.nent_net_name); + for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); } + for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); } + } - #undef WRITE_NOTIFICATION + return send; +} - if(!server_is_local) +void Send_Notification(float broadcast, entity client, + float net_type, float net_name, ...count) +{ + // check supplied broadcast, target, type, and name for errors + #define CHECKARG_TYPENAME(type) case MSG_##type##: \ + { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \ + { checkargs = sprintf("Improper name: %d!", net_name); } break; } + string checkargs = ""; + 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 + if(checkargs != "") { checkargs = strcat(checkargs, " "); } + switch(broadcast) + { + case NOTIF_ONE: + case NOTIF_ONE_ONLY: { if(clienttype(client) == CLIENTTYPE_NOTACLIENT) { checkargs = sprintf("%sNo client provided!", checkargs); } break; } + case NOTIF_ANY_EXCEPT: { if(clienttype(client) == CLIENTTYPE_NOTACLIENT) { 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: { - Local_Notification_Without_VarArgs(net_type, net_name, stringcount, floatcount, IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3), IFFL(0), IFFL(1), IFFL(2), IFFL(3)); + if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); } + else if(clienttype(client) == CLIENTTYPE_NOTACLIENT) + { + 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; } } - else { backtrace("Incorrect usage of Send_Notification!\n"); } + if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; } + + // retreive counts for the arguments of this notification + entity notif = Get_Notif_Ent(net_type, net_name); + if not(notif) { backtrace("Send_Notification: Could not find notification entity! (This wasn't caught by usage check?...)\n"); return; } + if not(notif.nent_enabled) { print("Send_Notification: Entity was disabled...\n"); return; } + + if((notif.nent_stringcount + notif.nent_floatcount) > count) + { backtrace(sprintf(strcat("Not enough arguments for Send_Notification! stringcount(%d) + floatcount(%d) > count(%d)\n", + "Check the notification definition and function call for accuracy...?\n"), 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! stringcount(%d) + floatcount(%d) < count(%d)\n", + "Check the notification definition and function call for accuracy...?\n"), notif.nent_stringcount, notif.nent_floatcount, count)); return; } + + #ifdef NOTIFICATIONS_DEBUG + dprint(sprintf("Send_Notification(%d, %d, %s, stringcount: %d, floatcount: %d, varargs: %d);\n", + broadcast, net_type, notif.nent_name, notif.nent_stringcount, notif.nent_floatcount, count)); + #endif + + entity net_notif = spawn(); + net_notif.nent_broadcast = broadcast; + net_notif.nent_client = client; + net_notif.nent_net_type = net_type; + net_notif.nent_net_name = net_name; + net_notif.nent_stringcount = notif.nent_stringcount; + net_notif.nent_floatcount = notif.nent_floatcount; + + 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 = Notification_Remove; + net_notif.nextthink = (time + 0.5); + + Net_LinkEntity(net_notif, FALSE, 0, Write_Notification); + + if((!server_is_local) && (broadcast == NOTIF_ANY || broadcast == NOTIF_ANY_EXCEPT) && (net_type != MSG_CENTER)) + { Local_Notification_Without_VarArgs(net_type, net_name, notif.nent_stringcount, notif.nent_floatcount, + IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3), IFFL(0), IFFL(1), IFFL(2), IFFL(3)); } } -void Send_Notification_Without_VarArgs(entity client, float broadcast, float net_type, float net_name, float stringcount, float floatcount, string s1, string s2, string s3, string s4, float f1, float f2, float f3, float f4) +void Send_Notification_Without_VarArgs(float broadcast, entity client, + float net_type, float net_name, + float stringcount, float floatcount, + string s1, string s2, string s3, string s4, + float f1, float f2, float f3, float f4) { - #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Send_Notification(client, broadcast, net_type, net_name, args); return; } + #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Send_Notification(broadcast, client, net_type, net_name, args); return; } EIGHT_VARS_TO_VARARGS_VARLIST #undef VARITEM - Send_Notification(client, broadcast, net_type, net_name); // some notifications don't have any arguments at all + Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all } -void Send_Notification_Legacy_Wrapper(entity client, float broadcast, float net_type, float net_name, string s1, string s2, float f1, float f2, float f3) +void Send_Notification_Legacy_Wrapper(float broadcast, entity client, + float net_type, float net_name, + string s1, string s2, + float f1, float f2, float f3) { - float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name)); - float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name)); - Send_Notification_Without_VarArgs(client, broadcast, net_type, net_name, stringcount, floatcount, s1, s2, NO_STR_ARG, NO_STR_ARG, f1, f2, f3, NO_FL_ARG); -} - -void Send_Notification_ToTeam(float targetteam, entity except, float net_type, float net_name, ...count) -{ - float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name)); - float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name)); - - entity tmp_entity; - FOR_EACH_REALCLIENT(tmp_entity) - { - if(tmp_entity.classname == STR_PLAYER) - if(tmp_entity.team == targetteam) - if(tmp_entity != except) - { - Send_Notification_Without_VarArgs(tmp_entity, MSG_ONE, net_type, net_name, stringcount, floatcount, IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3), IFFL(0), IFFL(1), IFFL(2), IFFL(3)); - } - } -} - -// WARNING: use this ONLY if you need exceptions or want to exclude spectators, otherwise use Send_Notification(world, MSG_BROADCAST, ...) -void Send_Notification_ToAll(entity except, float spectators, float net_type, float net_name, ...count) -{ - float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name)); - float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name)); - - entity tmp_entity; - FOR_EACH_REALCLIENT(tmp_entity) - { - if((tmp_entity.classname == STR_PLAYER) || spectators) - if(tmp_entity != except) - { - Send_Notification_Without_VarArgs(tmp_entity, MSG_ONE, net_type, net_name, stringcount, floatcount, IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3), IFFL(0), IFFL(1), IFFL(2), IFFL(3)); - } - } + float stringcount = Get_Notif_Strnum(net_type, net_name); + float floatcount = Get_Notif_Flnum(net_type, net_name); + Send_Notification_Without_VarArgs(broadcast, client, net_type, net_name, stringcount, floatcount, s1, s2, "", "", f1, f2, f3, 0); }