X-Git-Url: http://git.xonotic.org/?a=blobdiff_plain;f=qcsrc%2Fcommon%2Fnotifications.qc;h=ad884add3c1d37ad7695be97ed0f88bf1acc4c1d;hb=6ec50d2b480d38a5b9e46618ca957aa46d1f7d1b;hp=b3fc4c25b3108131633b95484cc8aa04d88e1712;hpb=6e8f0d5061c98b67c2ba073c0703fcd46685c4f4;p=xonotic%2Fxonotic-data.pk3dir.git diff --git a/qcsrc/common/notifications.qc b/qcsrc/common/notifications.qc index b3fc4c25b..ad884add3 100644 --- a/qcsrc/common/notifications.qc +++ b/qcsrc/common/notifications.qc @@ -1,192 +1,39 @@ // ================================================ // Unified notification system, written by Samual -// Last updated: September, 2012 +// Last updated: December, 2012 // ================================================ -// main types/groups of notifications -#define MSG_INFO 1 // "Global" information messages (sent to console, and notify panel if it has an icon) -#define MSG_CENTER 2 // "Personal" centerprint messages -#define MSG_WEAPON 3 // "Personal" weapon messages (like "You got the Nex", sent to weapon notify panel) - -#define NO_STR_ARG "" -#define NO_FL_ARG -12345 - -#define F_NAME 1 -#define F_STRNUM 2 -#define F_FLNUM 3 - -// allow sending of notifications to also pass through to spectators (specifically for centerprints) -#ifdef SVQC -#define WRITESPECTATABLE_MSG_ONE_VARNAME(varname,statement) entity varname; varname = msg_entity; FOR_EACH_REALCLIENT(msg_entity) if(msg_entity == varname || (msg_entity.classname == STR_SPECTATOR && msg_entity.enemy == varname)) statement msg_entity = varname -#define WRITESPECTATABLE_MSG_ONE(statement) WRITESPECTATABLE_MSG_ONE_VARNAME(oldmsg_entity, statement) -#define WRITESPECTATABLE(msg,statement) if(msg == MSG_ONE) { WRITESPECTATABLE_MSG_ONE(statement); } else statement float WRITESPECTATABLE_workaround = 0 -#endif - -#define NOTIF_MATCH(a,b) if(min(NOTIF_MAX, a) == b) -#ifdef CSQC -string got_commandkey; -#define ADD_CSQC_AUTOCVAR(name) var float autocvar_notification_##name = TRUE; -var float autocvar_notification_ctf_capture_verbose = TRUE; -var float autocvar_notification_ctf_pickup_team_verbose = TRUE; -var float autocvar_notification_ctf_pickup_enemy_verbose = TRUE; -#define CHECK_AUTOCVAR(name) if(autocvar_notification_##name) -#define HANDLE_CPID(cpid) ((min(NOTIF_MAX, cpid) == NO_CPID) ? FALSE : cpid) -#define PASS_KEY ((((got_commandkey = getcommandkey("pass", "+use")) != "pass") && !(strstrofs(got_commandkey, "not bound", 0) >= 0)) ? sprintf(CCR(_(" ^F1(Press %s)")), got_commandkey) : "") -#else -#define ADD_CSQC_AUTOCVAR(name) -#endif - -string team_name_red = _("RED"); -string team_name_blue = _("BLUE"); -string team_color_red = _("^1"); -string team_color_blue = _("^5"); - - -// ==================================== -// Notifications List and Information -// ==================================== -/* - List of all notifications (including identifiers and display information) - Format: name, strnum, flnum, args, *icon/CPID, *durcnt, normal, gentle - Asterisked fields are not present in all notification types. - Specifications: - Name of notification - Number of STRING arguments (so that networking knows how many to send/receive) - Number of FLOAT arguments (so that networking knows how many to send/receive) - Arguments for sprintf(string, args), if no args needed then use "" - *Icon/CPID: - MSG_INFO: STRING: icon string name for the hud notify panel, "" if no icon is used - MSG_CENTER: FLOAT: centerprint ID number (CPID_*), NO_CPID if no CPID is needed - *Duration/Countdown: - MSG_CENTER: XPND2(FLOAT, FLOAT): extra arguments for centerprint messages - Normal message (string for sprintf when gentle messages are NOT enabled) - Gentle message (string for sprintf when gentle messages ARE enabled) - - Messages have ^F1, ^F2, and ^BG in them-- these are replaced - with colors according to the cvars the user has chosen. - ^F1 = highest priority, "primary" - ^F2 = next highest priority, "secondary" - ^BG = normal/less important priority, "tertiary" - - Guidlines (please try and follow these): - -ALWAYS start the string with a color, preferably background. - -ALWAYS reset a color after a name (this way they don't set it for the whole string). - -NEVER re-declare an event twice. - -NEVER add or remove fields from the format, it SHOULD already work. - -MSG_INFO messages must ALWAYS end with a new line: \n - -Be clean and simple with your notification naming, - nothing too long for the name field... Abbreviations are your friend. :D - -Keep the spacing as clean as possible... if the arguments are abnormally long, - it's okay to go out of line a bit... but try and keep it clean still. - -Keep the notifications in alphabetical order. - ARIRE unir frk jvgu lbhe bja zbgure. (gvc sbe zvxrrhfn) -- Don't pay attention to this ^_^ -*/ - -// flag.netname = ((teamnumber) ? "^1RED^7 flag" : "^4BLUE^7 flag"); -// weaponorder[f1].netname - -#define TWO_TEAMS_INFO(prefix,strnum,flnum,args,icon,normal,gentle) \ - MSG_INFO_NOTIF(prefix##RED, strnum, flnum, args, sprintf(icon, "red"), TEAM_CCR(normal, team_color_red, team_name_red), TEAM_CCR(gentle, team_color_red, team_name_red)) \ - MSG_INFO_NOTIF(prefix##BLUE, strnum, flnum, args, sprintf(icon, "blue"), TEAM_CCR(normal, team_color_blue, team_name_blue), TEAM_CCR(gentle, team_color_blue, team_name_blue)) -#define MSG_INFO_NOTIFICATIONS \ - MSG_INFO_NOTIF(INFO_EMPTY, 0, 0, NO_STR_ARG, "", "", "") \ - TWO_TEAMS_INFO(INFO_CTF_FLAGRETURN_DROPPED_, 0, 0, NO_STR_ARG, "", _("^BGThe ^TC^TT^BG flag was dropped in the base and returned itself\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_FLAGRETURN_DAMAGED_, 0, 0, NO_STR_ARG, "", _("^BGThe ^TC^TT^BG flag was destroyed and returned to base\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_FLAGRETURN_SPEEDRUN_, 0, 1, f1/100, "", _("^BGThe ^TC^TT^BG flag became impatient after ^F1%.2f^BG seconds and returned itself\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_FLAGRETURN_NEEDKILL_, 0, 0, NO_STR_ARG, "", _("^BGThe ^TC^TT^BG flag fell somewhere it couldn't be reached and returned to base\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_FLAGRETURN_ABORTRUN_, 0, 0, NO_STR_ARG, "", _("^BGThe ^TC^TT^BG flag was returned to base by its owner\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_FLAGRETURN_TIMEOUT_, 0, 0, NO_STR_ARG, "", _("^BGThe ^TC^TT^BG flag has returned to the base\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_PICKUP_, 1, 0, s1, "notify_%s_taken", _("^BG%s^BG got the ^TC^TT^BG flag\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_RETURN_, 1, 0, s1, "notify_%s_returned", _("^BG%s^BG returned the ^TC^TT^BG flag\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_LOST_, 1, 0, s1, "notify_%s_lost", _("^BG%s^BG lost the ^TC^TT^BG flag\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_CAPTURE_, 1, 0, s1, "notify_%s_capture", _("^BG%s^BG captured the ^TC^TT^BG flag\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_CAPTURE_TIME_, 1, 1, XPND2(s1, f1/100), "notify_%s_capture", _("^BG%s^BG captured the ^TC^TT^BG flag in ^F1%.2f^BG seconds\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_CAPTURE_BROKEN_, 2, 2, XPND4(s1, f1/100, s2, f2/100), "notify_%s_capture", _("^BG%s^BG captured the ^TC^TT^BG flag in ^F1%.2f^BG seconds, breaking ^BG%s^BG's previous record of ^F2%.2f^BG seconds\n"), "") \ - TWO_TEAMS_INFO(INFO_CTF_CAPTURE_UNBROKEN_, 2, 2, XPND4(s1, f1/100, s2, f2/100), "notify_%s_capture", _("^BG%s^BG captured the ^TC^TT^BG flag in ^F2%.2f^BG seconds, failing to break ^BG%s^BG's previous record of ^F1%.2f^BG seconds\n"), "") \ - #undef MSG_INFO_NOTIF - -#define TWO_TEAMS_CENTER(prefix,strnum,flnum,args,cpid,durcnt,normal,gentle) \ - MSG_CENTER_NOTIF(prefix##RED, strnum, flnum, args, cpid, durcnt, TEAM_CCR(normal, team_color_red, team_name_red), TEAM_CCR(gentle, team_color_red, team_name_red)) \ - MSG_CENTER_NOTIF(prefix##BLUE, strnum, flnum, args, cpid, durcnt, TEAM_CCR(normal, team_color_blue, team_name_blue), TEAM_CCR(gentle, team_color_blue, team_name_blue)) -#define MSG_CENTER_NOTIFICATIONS \ - MSG_CENTER_NOTIF(CENTER_EMPTY, 0, 0, NO_STR_ARG, NO_CPID, XPND2(0, 0), "", "") \ - MSG_CENTER_NOTIF(CENTER_CTF_CAPTURESHIELD_SHIELDED, 0, 0, NO_STR_ARG, CPID_CTF_CAPSHIELD, XPND2(0, 0), _("^BGYou are now ^F1shielded^BG from the flag\n^BGfor ^F2too many unsuccessful attempts^BG to capture.\n^BGMake some defensive scores before trying again."), "") \ - MSG_CENTER_NOTIF(CENTER_CTF_CAPTURESHIELD_FREE, 0, 0, NO_STR_ARG, CPID_CTF_CAPSHIELD, XPND2(0, 0), _("^BGYou are now free.\n^BGFeel free to ^F2try to capture^BG the flag again\n^BGif you think you will succeed."), "") \ - TWO_TEAMS_CENTER(CENTER_CTF_PASS_OTHER_, 2, 0, XPND2(s1, s2), CPID_CTF_PASS, XPND2(0, 0), _("^BG%s^BG passed the ^TC^TT^BG flag to %s"), "") \ - TWO_TEAMS_CENTER(CENTER_CTF_PASS_SENT_, 1, 0, s1, CPID_CTF_PASS, XPND2(0, 0), _("^BGYou passed the ^TC^TT^BG flag to %s"), "") \ - TWO_TEAMS_CENTER(CENTER_CTF_PASS_RECEIVED_, 1, 0, s1, CPID_CTF_PASS, XPND2(0, 0), _("^BGYou received the ^TC^TT^BG flag from %s"), "") \ - MSG_CENTER_NOTIF(CENTER_CTF_PASS_REQUESTING, 1, 0, s1, CPID_CTF_PASS, XPND2(0, 0), _("^BGRequesting %s^BG to pass you the flag"), "") \ - MSG_CENTER_NOTIF(CENTER_CTF_PASS_REQUESTED, 1, 0, XPND2(s1, PASS_KEY), CPID_CTF_PASS, XPND2(0, 0), _("^BG%s^BG requests you to pass the flag%s"), "") \ - TWO_TEAMS_CENTER(CENTER_CTF_RETURN_, 0, 0, NO_STR_ARG, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYou returned the ^TC^TT^BG flag!"), "") \ - TWO_TEAMS_CENTER(CENTER_CTF_CAPTURE_, 0, 0, NO_STR_ARG, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYou captured the ^TC^TT^BG flag!"), "") \ - TWO_TEAMS_CENTER(CENTER_CTF_PICKUP_, 0, 0, NO_STR_ARG, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYou got the ^TC^TT^BG flag!"), "") \ - MSG_CENTER_NOTIF(CENTER_CTF_PICKUP_TEAM, 1, 0, s1, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYour %steam mate^BG got the flag! Protect them!"), "") \ - MSG_CENTER_NOTIF(CENTER_CTF_PICKUP_TEAM_VERBOSE, 2, 0, XPND3(s1, s2, s1), CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYour %steam mate (^BG%s%s)^BG got the flag! Protect them!"), "") \ - MSG_CENTER_NOTIF(CENTER_CTF_PICKUP_ENEMY, 1, 0, s1, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGThe %senemy^BG got your flag! Retrieve it!"), "") \ - MSG_CENTER_NOTIF(CENTER_CTF_PICKUP_ENEMY_VERBOSE, 2, 0, XPND3(s1, s2, s1), CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGThe %senemy (^BG%s%s)^BG got your flag! Retrieve it!"), "") \ - MSG_CENTER_NOTIF(CENTER_CTF_STALEMATE_CARRIER, 0, 0, NO_STR_ARG, CPID_STALEMATE, XPND2(0, 0), _("^BGStalemate! Enemies can now see you on radar!"), "") \ - MSG_CENTER_NOTIF(CENTER_CTF_STALEMATE_OTHER, 0, 0, NO_STR_ARG, CPID_STALEMATE, XPND2(0, 0), _("^BGStalemate! Flag carriers can now be seen by enemies on radar!"), "") \ - MSG_CENTER_NOTIF(CENTER_CTF_FLAG_THROW_PUNISH, 0, 1, f1, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGToo many flag throws! Throwing disabled for %d seconds."), "") \ - #undef MSG_CENTER_NOTIF - -#define MSG_WEAPON_NOTIFICATIONS \ - MSG_WEAPON_NOTIF(DEATH_MARBLES_LOST3, 2, 1, XPND3(s1, s2, f1), _("^F1%s^BG lost their marbles against ^F1%s^BG using the ^F2%s^BG\n"), "") \ - #undef MSG_WEAPON_NOTIF - - -// ==================================== -// Initialization/Create Declarations -// ==================================== - -#define NOTIF_FIRST 1 -#define NOTIF_MAX 1024 // limit of recursive functions with ACCUMULATE_FUNCTION -float NOTIF_INFO_COUNT; -float NOTIF_CENTER_COUNT; -float NOTIF_WEAPON_COUNT; -float NOTIF_CPID_COUNT; - -#define MSG_INFO_NOTIF(name,strnum,flnum,args,icon,normal,gentle) \ - ADD_CSQC_AUTOCVAR(name) \ - float name; \ - void RegisterNotification_##name() \ - { \ - SET_FIELD_COUNT(name, NOTIF_FIRST, NOTIF_INFO_COUNT) \ - CHECK_MAX_COUNT(name, NOTIF_MAX, NOTIF_INFO_COUNT, "notifications") \ - } \ - ACCUMULATE_FUNCTION(RegisterNotifications, RegisterNotification_##name) - -#define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \ - ADD_CSQC_AUTOCVAR(name) \ - float name; \ - float cpid; \ - void RegisterNotification_##name() \ - { \ - SET_FIELD_COUNT(name, NOTIF_FIRST, NOTIF_CENTER_COUNT) \ - SET_FIELD_COUNT(cpid, NOTIF_FIRST, NOTIF_CPID_COUNT) \ - CHECK_MAX_COUNT(name, NOTIF_MAX, NOTIF_CENTER_COUNT, "notifications") \ - } \ - ACCUMULATE_FUNCTION(RegisterNotifications, RegisterNotification_##name) - -#define MSG_WEAPON_NOTIF(name,strnum,flnum,args,normal,gentle) \ - ADD_CSQC_AUTOCVAR(name) \ - float name; \ - void RegisterNotification_##name() \ - { \ - SET_FIELD_COUNT(name, NOTIF_FIRST, NOTIF_WEAPON_COUNT) \ - CHECK_MAX_COUNT(name, NOTIF_MAX, NOTIF_WEAPON_COUNT, "notifications") \ - } \ - ACCUMULATE_FUNCTION(RegisterNotifications, RegisterNotification_##name) - -// NOW we actually activate the declarations -MSG_INFO_NOTIFICATIONS -MSG_CENTER_NOTIFICATIONS -MSG_WEAPON_NOTIFICATIONS - - // ====================== // Supporting Functions // ====================== +// team code replace +string TCR(string input, string teamcolor, string teamtext) // TODO: MOVE TO UTIL.QC +{ + input = strreplace("^TC", teamcolor, input); + input = strreplace("^TT", teamtext, input); + return input; +} + +// color code replace, place inside of sprintf and parse the string +string CCR(string input) // TODO: MOVE TO UTIL.QC +{ + // 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; +} + +#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) { @@ -200,40 +47,31 @@ string normal_or_gentle(string normal, string gentle) return normal; } -float notif_stringcount(string s1, string s2) +float notif_checkstring(string input) { - float stringcount; - if(s1 != NO_STR_ARG) ++stringcount; - if(s2 != NO_STR_ARG) ++stringcount; - return stringcount; -} - -float notif_floatcount(float f1, float f2, float f3) -{ - float floatcount; - if(f1 != NO_FL_ARG) ++floatcount; - if(f2 != NO_FL_ARG) ++floatcount; - if(f3 != NO_FL_ARG) ++floatcount; - return floatcount; + if not(input == "") { return TRUE; } + else { return FALSE; } } // 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) { - string output; + string output = ""; #define GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) \ - if(field == F_NAME) { output = VAR_TO_TEXT(name); } \ - else if(field == F_STRNUM) { output = ftos(strnum); } \ - else if(field == F_FLNUM) { output = ftos(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,icon,normal,gentle) \ + #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: @@ -241,13 +79,27 @@ string Get_Field_Value(float field, float net_type, float net_name) #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,strnum,flnum,args,normal,gentle) \ - { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } } + #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; } } @@ -255,63 +107,187 @@ string Get_Field_Value(float field, float net_type, float net_name) #undef GET_FIELD_VALUE_OUTPUT return output; } +#endif // ifndef MENUQC -string TEAM_CCR(string input, string teamcolor, string teamtext) -{ - input = strreplace("^TC", teamcolor, input); - input = strreplace("^TT", teamtext, input); - return input; +// =============================== +// Frontend Notification Pushing +// =============================== + +void Dump_Notifications(float fh, float alsoprint) +{ + float MSG_INFO_NOTIFS = 0, MSG_CENTER_NOTIFS = 0, MSG_WEAPON_NOTIFS = 0, MSG_DEATH_NOTIFS = 0; + string notif_msg; + + #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)); + return; } -// color code replace, place inside of sprintf and parse the string -string CCR(string input) +#ifndef MENUQC +#ifdef CSQC +void HUD_Notify_Push(string icon, string attacker, string victim) { - input = strreplace("^F1", "^2", input); // autocvar_notification_colors_F1 - input = strreplace("^F2", "^3", input); // autocvar_notification_colors_F2 - input = strreplace("^K1", "^1", input); // autocvar_notification_colors_K1 - input = strreplace("^K2", "^3", input); // autocvar_notification_colors_K2 - input = strreplace("^BG", "^7", input); // autocvar_notification_colors_BG + if(icon != "") + { + --kn_index; + if (kn_index == -1) { kn_index = KN_MAX_ENTRIES-1; } + killnotify_times[kn_index] = time; - input = strreplace("^N", "^7", input); // "none"-- reset to white + // icon + if(killnotify_icon[kn_index]) { strunzone(killnotify_icon[kn_index]); } + killnotify_icon[kn_index] = strzone(icon); - return input; -} + // 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); + } +} -// =============================== -// Frontend Notification Pushing -// =============================== +void backtrace(string msg) // TODO: MOVE TO UTIL.QC +{ + 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)); +} +#endif // ifdef CSQC -#ifdef CSQC -void Local_Notification(float net_type, float net_name, string s1, string s2, float f1, float f2, float f3) +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); + + 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,icon,normal,gentle) \ - { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) { print(sprintf(CCR(normal_or_gentle(normal, gentle)), args)); } } + #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 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) { centerprint_generic(HANDLE_CPID(cpid), sprintf(CCR(normal_or_gentle(normal, gentle)), args), durcnt); } } + { 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 break; } + #endif case MSG_WEAPON: { - #define MSG_WEAPON_NOTIF(name,strnum,flnum,args,normal,gentle) \ - { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) { print("unhandled\n"); } } + #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 break; } } } -#endif + +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 + #undef VARITEM + + Local_Notification(net_type, net_name); // some notifications don't have any arguments at all +} // ========================= @@ -327,70 +303,102 @@ void Read_Notification(void) float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name)); float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name)); - Local_Notification(net_type, net_name, - ((stringcount >= 1) ? ReadString() : ""), - ((stringcount == 2) ? ReadString() : ""), - ((floatcount >= 1) ? ReadLong() : 0), - ((floatcount >= 2) ? ReadLong() : 0), - ((floatcount == 3) ? ReadLong() : 0)); + 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)); } #endif #ifdef SVQC -void Send_Notification(entity client, float net_type, float net_name, string s1, string s2, float f1, float f2, float f3) +void Send_Notification(entity client, float broadcast, float net_type, float net_name, ...count) { - if(net_type && net_name) + if((broadcast == MSG_BROADCAST || broadcast == MSG_ONE) && net_type && net_name) { - print("notification: ", Get_Field_Value(F_NAME, net_type, net_name), ": ", ftos(net_name), ".\n"); - float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name)); float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name)); - - if(notif_stringcount(s1, s2) > stringcount) { backtrace("Too many string arguments for notification!\n"); return; } - if(notif_floatcount(f1, f2, f3) > floatcount) { backtrace("Too many float arguments for notification!\n"); return; } - - if(client && (clienttype(client) == CLIENTTYPE_REAL) && (client.flags & FL_CLIENT)) - { - // personal/direct notification sent to ONE person and their spectators - msg_entity = client; - WRITESPECTATABLE_MSG_ONE({ - WriteByte(MSG_ONE, SVC_TEMPENTITY); - WriteByte(MSG_ONE, TE_CSQC_NOTIFICATION); - WriteByte(MSG_ONE, net_type); - WriteShort(MSG_ONE, net_name); - if(stringcount >= 1) { WriteString(MSG_ONE, s1); } - if(stringcount == 2) { WriteString(MSG_ONE, s2); } - if(floatcount >= 1) { WriteLong(MSG_ONE, f1); } - if(floatcount >= 2) { WriteLong(MSG_ONE, f2); } - if(floatcount == 3) { WriteLong(MSG_ONE, f3); } - }); - } - else + 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) { - // global notification sent to EVERYONE - WriteByte(MSG_ALL, SVC_TEMPENTITY); - WriteByte(MSG_ALL, TE_CSQC_NOTIFICATION); - WriteByte(MSG_ALL, net_type); - WriteShort(MSG_ALL, net_name); - if(stringcount >= 1) { WriteString(MSG_ALL, s1); } - if(stringcount == 2) { WriteString(MSG_ALL, s2); } - if(floatcount >= 1) { WriteLong(MSG_ALL, f1); } - if(floatcount >= 2) { WriteLong(MSG_ALL, f2); } - if(floatcount == 3) { WriteLong(MSG_ALL, f3); } + 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 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(!server_is_local && (net_type == MSG_INFO)) + #undef WRITE_NOTIFICATION + + if(!server_is_local) { - #define MSG_INFO_NOTIF(name,strnum,flnum,args,icon,normal,gentle) \ - { NOTIF_MATCH(name, net_name) { print(sprintf(CCR(normal_or_gentle(normal, gentle)), args)); } } - MSG_INFO_NOTIFICATIONS + 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)); } } else { backtrace("Incorrect usage of Send_Notification!\n"); } } -void Send_Notification_ToTeam(float targetteam, entity except, float net_type, float net_name, string s1, string s2, float f1, float f2, float f3) +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) +{ + #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Send_Notification(client, broadcast, 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 +} + +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) +{ + 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) { @@ -398,21 +406,24 @@ void Send_Notification_ToTeam(float targetteam, entity except, float net_type, f if(tmp_entity.team == targetteam) if(tmp_entity != except) { - Send_Notification(tmp_entity, net_type, net_name, s1, s2, f1, f2, f3); + 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, ...) -void Send_Notification_ToAll(entity except, float spectators, float net_type, float net_name, string s1, string s2, float f1, float f2, float f3) +// 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(tmp_entity, net_type, net_name, s1, s2, f1, f2, f3); + 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)); } } } @@ -422,34 +433,6 @@ void Send_Notification_ToAll(entity except, float spectators, float net_type, fl // LEGACY NOTIFICATION SYSTEMS // ============================= -void Send_KillNotification(string s1, string s2, string s3, float msg, float type) -{ - WriteByte(MSG_ALL, SVC_TEMPENTITY); - WriteByte(MSG_ALL, TE_CSQC_KILLNOTIFY); - WriteString(MSG_ALL, s1); - WriteString(MSG_ALL, s2); - WriteString(MSG_ALL, s3); - WriteShort(MSG_ALL, msg); - WriteByte(MSG_ALL, type); -} - -// Function is used to send a generic centerprint whose content CSQC gets to decide (gentle version or not in the below cases) -void Send_CSQC_KillCenterprint(entity e, string s1, string s2, float msg, float type) -{ - if (clienttype(e) == CLIENTTYPE_REAL) - { - msg_entity = e; - WRITESPECTATABLE_MSG_ONE({ - WriteByte(MSG_ONE, SVC_TEMPENTITY); - WriteByte(MSG_ONE, TE_CSQC_KILLCENTERPRINT); - WriteString(MSG_ONE, s1); - WriteString(MSG_ONE, s2); - WriteShort(MSG_ONE, msg); - WriteByte(MSG_ONE, type); - }); - } -} - void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num) { if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT)) @@ -472,4 +455,5 @@ void Send_CSQC_Centerprint_Generic_Expire(entity e, float id) { Send_CSQC_Centerprint_Generic(e, id, "", 1, 0); } -#endif +#endif // ifdef SVQC +#endif // ifndef MENUQC