1 // ================================================
2 // Unified notification system, written by Samual
3 // Last updated: December, 2012
4 // ================================================
7 // get the actual name of a notification and return it as a string
8 string Get_Field_Value(float field, float net_type, float net_name)
12 #define GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) \
14 case F_NAME: { output = VAR_TO_TEXT(name); break; } \
15 case F_STRNUM: { output = ftos(strnum); break; } \
16 case F_FLNUM: { output = ftos(flnum); break; } }
22 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
23 case name: { { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } break; }
27 MSG_INFO_NOTIFICATIONS
28 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_INFO, net_name = ", ftos(net_name), ".\n")); break; }
36 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
37 case name: { { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } break; }
41 MSG_CENTER_NOTIFICATIONS
42 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_CENTER, net_name = ", ftos(net_name), ".\n")); break; }
45 #undef MSG_CENTER_NOTIF
50 #define MSG_WEAPON_NOTIF(name,infoname,centername) \
51 case name: { { GET_FIELD_VALUE_OUTPUT(field,name, \
52 max(stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername))), \
53 max(stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)))) } break; }
57 MSG_WEAPON_NOTIFICATIONS
58 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_WEAPON, net_name = ", ftos(net_name), ".\n")); break; }
61 #undef MSG_WEAPON_NOTIF
66 #define MSG_DEATH_NOTIF(name,infoname,centername) \
67 case name: { { GET_FIELD_VALUE_OUTPUT(field,name, \
68 max(stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername))), \
69 max(stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)))) } break; }
73 MSG_DEATH_NOTIFICATIONS
74 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_DEATH, net_name = ", ftos(net_name), ".\n")); break; }
77 #undef MSG_DEATH_NOTIF
82 #undef GET_FIELD_VALUE_OUTPUT
85 #endif // ifndef MENUQC
88 // ===============================
89 // Frontend Notification Pushing
90 // ===============================
92 void Dump_Notifications(float fh, float alsoprint)
94 float MSG_INFO_NOTIFS = 0, MSG_CENTER_NOTIFS = 0, MSG_WEAPON_NOTIFS = 0, MSG_DEATH_NOTIFS = 0;
97 #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)); }
98 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) { ++MSG_INFO_NOTIFS; NOTIF_WRITE("MSG_INFO", VAR_TO_TEXT(name), normal) }
99 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) { ++MSG_CENTER_NOTIFS; NOTIF_WRITE("MSG_CENTER", VAR_TO_TEXT(name), normal) }
100 #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))) }
101 #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))) }
102 MSG_INFO_NOTIFICATIONS
103 MSG_CENTER_NOTIFICATIONS
104 MSG_WEAPON_NOTIFICATIONS
105 MSG_DEATH_NOTIFICATIONS
107 #undef MSG_INFO_NOTIF
108 #undef MSG_CENTER_NOTIF
109 #undef MSG_WEAPON_NOTIF
110 #undef MSG_DEATH_NOTIF
112 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));
118 void HUD_Notify_Push(string icon, string attacker, string victim)
123 if (kn_index == -1) { kn_index = KN_MAX_ENTRIES-1; }
124 killnotify_times[kn_index] = time;
127 if(killnotify_icon[kn_index]) { strunzone(killnotify_icon[kn_index]); }
128 killnotify_icon[kn_index] = strzone(icon);
131 if(killnotify_attackers[kn_index]) { strunzone(killnotify_attackers[kn_index]); }
132 killnotify_attackers[kn_index] = strzone(attacker);
135 if(killnotify_victims[kn_index]) { strunzone(killnotify_victims[kn_index]); }
136 killnotify_victims[kn_index] = strzone(victim);
141 void Local_Notification(float net_type, float net_name, ...count)
143 if(net_type && net_name)
145 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
146 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
148 string s1 = ((0 < stringcount) ? ...(0, string) : NO_STR_ARG);
149 string s2 = ((1 < stringcount) ? ...(1, string) : NO_STR_ARG);
150 string s3 = ((2 < stringcount) ? ...(2, string) : NO_STR_ARG);
151 string s4 = ((3 < stringcount) ? ...(3, string) : NO_STR_ARG);
152 float f1 = ((stringcount < count) ? ...(stringcount, float) : NO_FL_ARG);
153 float f2 = (((stringcount + 1) < count) ? ...((stringcount + 1), float) : NO_FL_ARG);
154 float f3 = (((stringcount + 2) < count) ? ...((stringcount + 2), float) : NO_FL_ARG);
155 float f4 = (((stringcount + 3) < count) ? ...((stringcount + 3), float) : NO_FL_ARG);
159 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")));
160 dprint(" ^--: stringcount: ", ftos(stringcount), ", floatcount: ", ftos(floatcount), ".\n");
162 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; }
163 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; }
169 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
170 case name: { CHECK_AUTOCVAR(name) \
172 tmp_s = normal_or_gentle(normal, gentle); if(tmp_s != "") \
174 if(substring(tmp_s, (strlen(tmp_s) - 1), 1) == "\n") { print(sprintf(CCR(tmp_s), args)); } \
175 else { backtrace(strcat("^1MISSING/BROKEN NEW LINE AT END OF NOTIFICATION: ^7net_type = MSG_INFO, net_name = ", Get_Field_Value(F_NAME, net_type, net_name), (GENTLE ? ", GENTLE string" : ", NORMAL string"), ".\n")); } \
177 tmp_s = icon; if(tmp_s != "") { HUD_Notify_Push(icon, hudargs); } \
180 else { backtrace(strcat("^1EMPTY NOTIFICATION: ^7net_type = MSG_INFO, net_name = ", Get_Field_Value(F_NAME, net_type, net_name), ".\n")); } \
185 MSG_INFO_NOTIFICATIONS
186 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_INFO, net_name = ", ftos(net_name), ".\n")); break; }
189 #undef MSG_INFO_NOTIF
195 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
196 case name: { CHECK_AUTOCVAR(name) \
198 tmp_s = normal_or_gentle(normal, gentle); if(tmp_s != "") { centerprint_generic(HANDLE_CPID(cpid), sprintf(CCR(tmp_s), args), durcnt); } \
199 else { backtrace(strcat("^1EMPTY NOTIFICATION: ^7net_type = MSG_CENTER, net_name = ", Get_Field_Value(F_NAME, net_type, net_name), ".\n")); } \
204 MSG_CENTER_NOTIFICATIONS
205 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_CENTER, net_name = ", ftos(net_name), ".\n")); break; }
208 #undef MSG_CENTER_NOTIF
214 #define MSG_WEAPON_NOTIF(name,infoname,centername) \
215 case name: { CHECK_AUTOCVAR(name) \
217 #if infoname != NO_MSG \
218 Local_Notification_Without_VarArgs(MSG_INFO, infoname, \
219 stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), \
220 stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), \
221 s1, s2, s3, s4, f1, f2, f3, f4); \
224 #if centername != NO_MSG \
225 Local_Notification_Without_VarArgs(MSG_CENTER, centername, \
226 stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername)), \
227 stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)), \
228 s1, s2, s3, s4, f1, f2, f3, f4); \
235 MSG_WEAPON_NOTIFICATIONS
236 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_WEAPON, net_name = ", ftos(net_name), ".\n")); break; }
239 #undef MSG_WEAPON_NOTIF
244 #define MSG_DEATH_NOTIF(name,infoname,centername) \
245 case name: { CHECK_AUTOCVAR(name) \
247 #if infoname != NO_MSG \
248 Local_Notification_Without_VarArgs(MSG_INFO, infoname, \
249 stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), \
250 stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), \
251 s1, s2, s3, s4, f1, f2, f3, f4); \
254 #if centername != NO_MSG \
255 Local_Notification_Without_VarArgs(MSG_CENTER, centername, \
256 stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername)), \
257 stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)), \
258 s1, s2, s3, s4, f1, f2, f3, f4); \
265 MSG_DEATH_NOTIFICATIONS
266 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_DEATH, net_name = ", ftos(net_name), ".\n")); break; }
269 #undef MSG_DEATH_NOTIF
274 else { backtrace("Incorrect usage of Local_Notification!\n"); }
277 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)
279 #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Local_Notification(net_type, net_name, args); return; }
280 EIGHT_VARS_TO_VARARGS_VARLIST
283 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
287 // =========================
288 // Notification Networking
289 // =========================
292 void Read_Notification(float is_new)
294 float net_type = ReadByte();
295 float net_name = ReadShort();
297 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
298 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
300 string s1 = ((stringcount >= 1) ? ReadString() : NO_STR_ARG);
301 string s2 = ((stringcount >= 2) ? ReadString() : NO_STR_ARG);
302 string s3 = ((stringcount >= 3) ? ReadString() : NO_STR_ARG);
303 string s4 = ((stringcount == 4) ? ReadString() : NO_STR_ARG);
304 float f1 = ((floatcount >= 1) ? ReadLong() : NO_FL_ARG);
305 float f2 = ((floatcount >= 2) ? ReadLong() : NO_FL_ARG);
306 float f3 = ((floatcount >= 3) ? ReadLong() : NO_FL_ARG);
307 float f4 = ((floatcount == 4) ? ReadLong() : NO_FL_ARG);
309 if(is_new) { Local_Notification_Without_VarArgs(net_type, net_name, stringcount, floatcount, s1, s2, s3, s4, f1, f2, f3, f4); }
310 else { print("received old notification? net_name = ", Get_Field_Value(F_NAME, net_type, net_name), ".\n"); }
315 void Notification_Remove()
318 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
322 float Write_Notification(entity client, float sf)
324 float i, send = FALSE;
326 switch(self.nent_broadcast)
328 case NOTIF_ONE: { if((client == self.nent_client) || (client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
329 case NOTIF_ONE_ONLY: { if(client == self.nent_client) { send = TRUE; } break; }
330 case NOTIF_TEAM: { if((client.team == self.nent_client.team) || (client.classname == STR_SPECTATOR && client.enemy.team == self.nent_client.team)) { send = TRUE; } break; }
331 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; }
332 case NOTIF_ANY: { send = TRUE; break; }
333 case NOTIF_ANY_EXCEPT: { if((client != self.nent_client) && !(client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
334 default: { send = FALSE; break; }
339 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
340 WriteByte(MSG_ENTITY, self.nent_net_type);
341 WriteShort(MSG_ENTITY, self.nent_net_name);
342 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
343 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
349 void Send_Notification(float broadcast, entity client, float net_type, float net_name, ...count)
351 if(broadcast && net_type && net_name)
353 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
354 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
357 dprint("Send_Notification(", ftos(broadcast), ", ", ftos(net_type), ", ", Get_Field_Value(F_NAME, net_type, net_name), strcat(", ", ftos(count), ");\n"));
358 dprint(" ^--: stringcount: ", ftos(stringcount), ", floatcount: ", ftos(floatcount), ".\n");
360 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; }
361 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; }
363 entity notif = spawn();
364 notif.nent_broadcast = broadcast;
365 notif.nent_client = client;
366 notif.nent_net_type = net_type;
367 notif.nent_net_name = net_name;
368 notif.nent_stringcount = stringcount;
369 notif.nent_floatcount = floatcount;
370 for(i = 0; i < stringcount; ++i) { notif.nent_strings[i] = strzone(...(i, string)); }
371 for(i = 0; i < floatcount; ++i) { notif.nent_floats[i] = ...((stringcount + i), float); }
373 notif.think = Notification_Remove;
374 notif.nextthink = (time + 0.5);
376 Net_LinkEntity(notif, FALSE, 0, Write_Notification);
380 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));
383 else { backtrace("Incorrect usage of Send_Notification!\n"); }
386 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)
388 #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Send_Notification(broadcast, client, net_type, net_name, args); return; }
389 EIGHT_VARS_TO_VARARGS_VARLIST
392 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
395 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)
397 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
398 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
399 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);
403 // =============================
404 // LEGACY NOTIFICATION SYSTEMS
405 // =============================
407 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
409 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
412 WRITESPECTATABLE_MSG_ONE({
413 WriteByte(MSG_ONE, SVC_TEMPENTITY);
414 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
415 WriteByte(MSG_ONE, id);
416 WriteString(MSG_ONE, s);
417 if (id != 0 && s != "")
419 WriteByte(MSG_ONE, duration);
420 WriteByte(MSG_ONE, countdown_num);
425 void Send_CSQC_Centerprint_Generic_Expire(entity e, float id)
427 Send_CSQC_Centerprint_Generic(e, id, "", 1, 0);
430 #endif // ifndef MENUQC