1 // ================================================
2 // Unified notification system, written by Samual
3 // Last updated: December, 2012
4 // ================================================
6 // ======================
7 // Supporting Functions
8 // ======================
11 string TCR(string input, string teamcolor, string teamtext) // TODO: MOVE TO UTIL.QC
13 input = strreplace("^TC", teamcolor, input);
14 input = strreplace("^TT", teamtext, input);
19 // select between the normal or the gentle message string based on client (or server) settings
20 string normal_or_gentle(string normal, string gentle)
23 if(autocvar_cl_gentle || autocvar_cl_gentle_messages)
25 if(autocvar_sv_gentle)
27 return ((gentle != "") ? gentle : normal);
32 float notif_checkstring(string input)
34 if not(input == "") { return TRUE; }
35 else { return FALSE; }
38 // get the actual name of a notification and return it as a string
39 string Get_Field_Value(float field, float net_type, float net_name)
43 #define GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) \
45 case F_NAME: { output = VAR_TO_TEXT(name); break; } \
46 case F_STRNUM: { output = ftos(strnum); break; } \
47 case F_FLNUM: { output = ftos(flnum); break; } }
53 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
54 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } }
55 MSG_INFO_NOTIFICATIONS
61 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
62 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } }
63 MSG_CENTER_NOTIFICATIONS
64 #undef MSG_CENTER_NOTIF
69 #define MSG_WEAPON_NOTIF(name,infoname,centername) \
70 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name, \
71 max(stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername))), \
72 max(stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)))) } }
73 MSG_WEAPON_NOTIFICATIONS
74 #undef MSG_WEAPON_NOTIF
79 #define MSG_DEATH_NOTIF(name,infoname,centername) \
80 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name, \
81 max(stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername))), \
82 max(stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)))) } }
83 MSG_DEATH_NOTIFICATIONS
84 #undef MSG_DEATH_NOTIF
89 #undef GET_FIELD_VALUE_OUTPUT
92 #endif // ifndef MENUQC
95 // ===============================
96 // Frontend Notification Pushing
97 // ===============================
99 void Dump_Notifications(float fh, float alsoprint)
101 float MSG_INFO_NOTIFS = 0, MSG_CENTER_NOTIFS = 0, MSG_WEAPON_NOTIFS = 0, MSG_DEATH_NOTIFS = 0;
104 #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)); }
105 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) { ++MSG_INFO_NOTIFS; NOTIF_WRITE("MSG_INFO", VAR_TO_TEXT(name), normal) }
106 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) { ++MSG_CENTER_NOTIFS; NOTIF_WRITE("MSG_CENTER", VAR_TO_TEXT(name), normal) }
107 #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))) }
108 #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))) }
109 MSG_INFO_NOTIFICATIONS
110 MSG_CENTER_NOTIFICATIONS
111 MSG_WEAPON_NOTIFICATIONS
112 MSG_DEATH_NOTIFICATIONS
114 #undef MSG_INFO_NOTIF
115 #undef MSG_CENTER_NOTIF
116 #undef MSG_WEAPON_NOTIF
117 #undef MSG_DEATH_NOTIF
119 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));
125 void HUD_Notify_Push(string icon, string attacker, string victim)
130 if (kn_index == -1) { kn_index = KN_MAX_ENTRIES-1; }
131 killnotify_times[kn_index] = time;
134 if(killnotify_icon[kn_index]) { strunzone(killnotify_icon[kn_index]); }
135 killnotify_icon[kn_index] = strzone(icon);
138 if(killnotify_attackers[kn_index]) { strunzone(killnotify_attackers[kn_index]); }
139 killnotify_attackers[kn_index] = strzone(attacker);
142 if(killnotify_victims[kn_index]) { strunzone(killnotify_victims[kn_index]); }
143 killnotify_victims[kn_index] = strzone(victim);
148 void Local_Notification(float net_type, float net_name, ...count)
150 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
151 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
153 string s1 = ((0 < stringcount) ? ...(0, string) : NO_STR_ARG);
154 string s2 = ((1 < stringcount) ? ...(1, string) : NO_STR_ARG);
155 string s3 = ((2 < stringcount) ? ...(2, string) : NO_STR_ARG);
156 string s4 = ((3 < stringcount) ? ...(3, string) : NO_STR_ARG);
157 float f1 = ((stringcount < count) ? ...(stringcount, float) : NO_FL_ARG);
158 float f2 = (((stringcount + 1) < count) ? ...((stringcount + 1), float) : NO_FL_ARG);
159 float f3 = (((stringcount + 2) < count) ? ...((stringcount + 2), float) : NO_FL_ARG);
160 float f4 = (((stringcount + 3) < count) ? ...((stringcount + 3), float) : NO_FL_ARG);
162 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")));
163 dprint(" ^--: stringcount: ", ftos(stringcount), ", floatcount: ", ftos(floatcount), ".\n");
165 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; }
166 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; }
172 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
173 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
175 if(notif_checkstring(normal)) { print(sprintf(CCR(normal_or_gentle(normal, gentle)), args)); } \
177 if(notif_checkstring(icon)) { HUD_Notify_Push(icon, hudargs); } \
180 MSG_INFO_NOTIFICATIONS
181 #undef MSG_INFO_NOTIF
187 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
188 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
190 if(notif_checkstring(normal)) { centerprint_generic(HANDLE_CPID(cpid), sprintf(CCR(normal_or_gentle(normal, gentle)), args), durcnt); } \
192 MSG_CENTER_NOTIFICATIONS
193 #undef MSG_CENTER_NOTIF
199 #define MSG_WEAPON_NOTIF(name,infoname,centername) \
200 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
202 #if infoname != NO_MSG \
203 Local_Notification_Without_VarArgs(MSG_INFO, infoname, \
204 stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), \
205 stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), \
206 s1, s2, s3, s4, f1, f2, f3, f4); \
209 #if centername != NO_MSG \
210 Local_Notification_Without_VarArgs(MSG_CENTER, centername, \
211 stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername)), \
212 stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)), \
213 s1, s2, s3, s4, f1, f2, f3, f4); \
217 MSG_WEAPON_NOTIFICATIONS
218 #undef MSG_WEAPON_NOTIF
223 #define MSG_DEATH_NOTIF(name,infoname,centername) \
224 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
226 #if infoname != NO_MSG \
227 Local_Notification_Without_VarArgs(MSG_INFO, infoname, \
228 stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), \
229 stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), \
230 s1, s2, s3, s4, f1, f2, f3, f4); \
233 #if centername != NO_MSG \
234 Local_Notification_Without_VarArgs(MSG_CENTER, centername, \
235 stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername)), \
236 stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)), \
237 s1, s2, s3, s4, f1, f2, f3, f4); \
241 MSG_DEATH_NOTIFICATIONS
242 #undef MSG_DEATH_NOTIF
248 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)
250 #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Local_Notification(net_type, net_name, args); return; }
251 EIGHT_VARS_TO_VARARGS_VARLIST
254 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
258 // =========================
259 // Notification Networking
260 // =========================
263 void Read_Notification(float is_new)
265 float net_type = ReadByte();
266 float net_name = ReadShort();
268 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
269 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
271 string s1 = ((stringcount >= 1) ? ReadString() : NO_STR_ARG);
272 string s2 = ((stringcount >= 2) ? ReadString() : NO_STR_ARG);
273 string s3 = ((stringcount >= 3) ? ReadString() : NO_STR_ARG);
274 string s4 = ((stringcount == 4) ? ReadString() : NO_STR_ARG);
275 float f1 = ((floatcount >= 1) ? ReadLong() : NO_FL_ARG);
276 float f2 = ((floatcount >= 2) ? ReadLong() : NO_FL_ARG);
277 float f3 = ((floatcount >= 3) ? ReadLong() : NO_FL_ARG);
278 float f4 = ((floatcount == 4) ? ReadLong() : NO_FL_ARG);
280 if(is_new) { Local_Notification_Without_VarArgs(net_type, net_name, stringcount, floatcount, s1, s2, s3, s4, f1, f2, f3, f4); }
281 else { print("received old notification? net_name = ", ftos(net_name), ".\n"); }
286 void Notification_Remove()
289 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
293 float Write_Notification(entity client, float sf)
295 float i, send = FALSE;
297 switch(self.nent_broadcast)
299 case NOTIF_ONE: { if((client == self.nent_client) || (client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
300 case NOTIF_ONE_ONLY: { if(client == self.nent_client) { send = TRUE; } break; }
301 case NOTIF_TEAM: { if((client.team == self.nent_client.team) || (client.classname == STR_SPECTATOR && client.enemy.team == self.nent_client.team)) { send = TRUE; } break; }
302 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; }
303 case NOTIF_ANY: { send = TRUE; break; }
304 case NOTIF_ANY_EXCEPT: { if((client != self.nent_client) && !(client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
305 default: { send = FALSE; break; }
310 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
311 WriteByte(MSG_ENTITY, self.nent_net_type);
312 WriteShort(MSG_ENTITY, self.nent_net_name);
313 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
314 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
320 void Send_Notification(float broadcast, entity client, float net_type, float net_name, ...count)
322 if(broadcast && net_type && net_name)
324 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
325 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
328 dprint("Send_Notification(", ftos(broadcast), ", ", ftos(net_type), ", ", Get_Field_Value(F_NAME, net_type, net_name), strcat(", ", ftos(count), ");\n"));
329 dprint(" ^--: stringcount: ", ftos(stringcount), ", floatcount: ", ftos(floatcount), ".\n");
331 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; }
332 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; }
334 entity notif = spawn();
335 notif.nent_broadcast = broadcast;
336 notif.nent_client = client;
337 notif.nent_net_type = net_type;
338 notif.nent_net_name = net_name;
339 notif.nent_stringcount = stringcount;
340 notif.nent_floatcount = floatcount;
341 for(i = 0; i < stringcount; ++i) { notif.nent_strings[i] = strzone(...(i, string)); }
342 for(i = 0; i < floatcount; ++i) { notif.nent_floats[i] = ...((stringcount + i), float); }
344 notif.think = Notification_Remove;
345 notif.nextthink = (time + 0.5);
347 Net_LinkEntity(notif, FALSE, 0, Write_Notification);
351 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));
354 else { backtrace("Incorrect usage of Send_Notification!\n"); }
357 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)
359 #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Send_Notification(broadcast, client, net_type, net_name, args); return; }
360 EIGHT_VARS_TO_VARARGS_VARLIST
363 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
366 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)
368 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
369 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
370 Send_Notification_Without_VarArgs(broadcast, client, net_type, net_name, stringcount, floatcount, s1, s2, NO_STR_ARG, NO_STR_ARG, f1, f2, f3, NO_FL_ARG);
374 // =============================
375 // LEGACY NOTIFICATION SYSTEMS
376 // =============================
378 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
380 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
383 WRITESPECTATABLE_MSG_ONE({
384 WriteByte(MSG_ONE, SVC_TEMPENTITY);
385 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
386 WriteByte(MSG_ONE, id);
387 WriteString(MSG_ONE, s);
388 if (id != 0 && s != "")
390 WriteByte(MSG_ONE, duration);
391 WriteByte(MSG_ONE, countdown_num);
396 void Send_CSQC_Centerprint_Generic_Expire(entity e, float id)
398 Send_CSQC_Centerprint_Generic(e, id, "", 1, 0);
401 #endif // ifndef MENUQC