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)
10 #define GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) switch(field) { \
11 case F_NAME: { return VAR_TO_TEXT(name); } \
12 case F_STRNUM: { return ftos(strnum); } \
13 case F_FLNUM: { return ftos(flnum); } }
15 #define CLPSE_GETVALUE(name,type,field) \
17 stof(Get_Field_Value(field, type, name)) \
26 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) case name: { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) }
30 MSG_INFO_NOTIFICATIONS
31 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_INFO, net_name = ", ftos(net_name), ".\n")); return ""; }
39 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) case name: { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) }
43 MSG_CENTER_NOTIFICATIONS
44 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_CENTER, net_name = ", ftos(net_name), ".\n")); return ""; }
47 #undef MSG_CENTER_NOTIF
52 #define MSG_WEAPON_NOTIF(name,infoname,centername) case name: { GET_FIELD_VALUE_OUTPUT(field,name, \
53 max(CLPSE_GETVALUE(infoname, MSG_INFO, F_STRNUM), CLPSE_GETVALUE(centername, MSG_CENTER, F_STRNUM)), \
54 max(CLPSE_GETVALUE(infoname, MSG_INFO, F_FLNUM), CLPSE_GETVALUE(centername, MSG_CENTER, F_FLNUM))) }
58 MSG_WEAPON_NOTIFICATIONS
59 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_WEAPON, net_name = ", ftos(net_name), ".\n")); return ""; }
62 #undef MSG_WEAPON_NOTIF
67 #define MSG_DEATH_NOTIF(name,infoname,centername) case name: { GET_FIELD_VALUE_OUTPUT(field,name, \
68 max(CLPSE_GETVALUE(infoname, MSG_INFO, F_STRNUM), CLPSE_GETVALUE(centername, MSG_CENTER, F_STRNUM)), \
69 max(CLPSE_GETVALUE(infoname, MSG_INFO, F_FLNUM), CLPSE_GETVALUE(centername, MSG_CENTER, F_FLNUM))) }
73 MSG_DEATH_NOTIFICATIONS
74 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_DEATH, net_name = ", ftos(net_name), ".\n")); return ""; }
77 #undef MSG_DEATH_NOTIF
82 #undef GET_FIELD_VALUE_OUTPUT
86 #endif // ifndef MENUQC
89 // ===============================
90 // Frontend Notification Pushing
91 // ===============================
93 void Dump_Notifications(float fh, float alsoprint)
95 float MSG_INFO_NOTIFS = 0, MSG_CENTER_NOTIFS = 0, MSG_WEAPON_NOTIFS = 0, MSG_DEATH_NOTIFS = 0;
98 #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)); }
99 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) { ++MSG_INFO_NOTIFS; NOTIF_WRITE("MSG_INFO", VAR_TO_TEXT(name), normal) }
100 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) { ++MSG_CENTER_NOTIFS; NOTIF_WRITE("MSG_CENTER", VAR_TO_TEXT(name), normal) }
101 #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))) }
102 #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))) }
103 MSG_INFO_NOTIFICATIONS
104 MSG_CENTER_NOTIFICATIONS
105 MSG_WEAPON_NOTIFICATIONS
106 MSG_DEATH_NOTIFICATIONS
108 #undef MSG_INFO_NOTIF
109 #undef MSG_CENTER_NOTIF
110 #undef MSG_WEAPON_NOTIF
111 #undef MSG_DEATH_NOTIF
113 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));
119 void HUD_Notify_Push(string icon, string attacker, string victim)
124 if (kn_index == -1) { kn_index = KN_MAX_ENTRIES-1; }
125 killnotify_times[kn_index] = time;
128 if(killnotify_icon[kn_index]) { strunzone(killnotify_icon[kn_index]); }
129 killnotify_icon[kn_index] = strzone(icon);
132 if(killnotify_attackers[kn_index]) { strunzone(killnotify_attackers[kn_index]); }
133 killnotify_attackers[kn_index] = strzone(attacker);
136 if(killnotify_victims[kn_index]) { strunzone(killnotify_victims[kn_index]); }
137 killnotify_victims[kn_index] = strzone(victim);
142 void Local_Notification(float net_type, float net_name, ...count)
144 if(net_type && net_name)
146 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
147 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
149 string s1 = ((0 < stringcount) ? ...(0, string) : NO_STR_ARG);
150 string s2 = ((1 < stringcount) ? ...(1, string) : NO_STR_ARG);
151 string s3 = ((2 < stringcount) ? ...(2, string) : NO_STR_ARG);
152 string s4 = ((3 < stringcount) ? ...(3, string) : NO_STR_ARG);
153 float f1 = ((stringcount < count) ? ...(stringcount, float) : NO_FL_ARG);
154 float f2 = (((stringcount + 1) < count) ? ...((stringcount + 1), float) : NO_FL_ARG);
155 float f3 = (((stringcount + 2) < count) ? ...((stringcount + 2), float) : NO_FL_ARG);
156 float f4 = (((stringcount + 3) < count) ? ...((stringcount + 3), float) : NO_FL_ARG);
158 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")));
159 dprint(" ^--: stringcount: ", ftos(stringcount), ", floatcount: ", ftos(floatcount), ".\n");
161 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; }
162 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; }
168 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
169 case name: { CHECK_AUTOCVAR(name) \
171 print(sprintf(CCR(normal_or_gentle(normal, gentle)), args)); \
173 if(icon != "") { HUD_Notify_Push(icon, hudargs); } \
179 MSG_INFO_NOTIFICATIONS
180 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_INFO, net_name = ", ftos(net_name), ".\n")); return; }
183 #undef MSG_INFO_NOTIF
189 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
190 case name: { CHECK_AUTOCVAR(name) \
192 centerprint_generic(HANDLE_CPID(cpid), sprintf(CCR(normal_or_gentle(normal, gentle)), args), durcnt); \
197 MSG_CENTER_NOTIFICATIONS
198 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_CENTER, net_name = ", ftos(net_name), ".\n")); return; }
201 #undef MSG_CENTER_NOTIF
207 #define MSG_WEAPON_NOTIF(name,infoname,centername) \
208 case name: { CHECK_AUTOCVAR(name) \
210 #if infoname != NO_MSG \
211 Local_Notification_Without_VarArgs(MSG_INFO, infoname, \
212 stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), \
213 stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), \
214 s1, s2, s3, s4, f1, f2, f3, f4); \
217 #if centername != NO_MSG \
218 Local_Notification_Without_VarArgs(MSG_CENTER, centername, \
219 stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername)), \
220 stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)), \
221 s1, s2, s3, s4, f1, f2, f3, f4); \
228 MSG_WEAPON_NOTIFICATIONS
229 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_WEAPON, net_name = ", ftos(net_name), ".\n")); return; }
232 #undef MSG_WEAPON_NOTIF
237 #define MSG_DEATH_NOTIF(name,infoname,centername) \
238 case name: { CHECK_AUTOCVAR(name) \
240 #if infoname != NO_MSG \
241 Local_Notification_Without_VarArgs(MSG_INFO, infoname, \
242 stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), \
243 stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), \
244 s1, s2, s3, s4, f1, f2, f3, f4); \
247 #if centername != NO_MSG \
248 Local_Notification_Without_VarArgs(MSG_CENTER, centername, \
249 stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername)), \
250 stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)), \
251 s1, s2, s3, s4, f1, f2, f3, f4); \
258 MSG_DEATH_NOTIFICATIONS
259 default: { backtrace(strcat("^1NOTIFICATION HAD NO MATCH: ^7net_type = MSG_DEATH, net_name = ", ftos(net_name), ".\n")); return; }
262 #undef MSG_DEATH_NOTIF
267 else { backtrace("Incorrect usage of Local_Notification!\n"); }
270 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)
272 #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Local_Notification(net_type, net_name, args); return; }
273 EIGHT_VARS_TO_VARARGS_VARLIST
276 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
280 // =========================
281 // Notification Networking
282 // =========================
285 void Read_Notification(float is_new)
287 float net_type = ReadByte();
288 float net_name = ReadShort();
290 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
291 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
293 string s1 = ((stringcount >= 1) ? ReadString() : NO_STR_ARG);
294 string s2 = ((stringcount >= 2) ? ReadString() : NO_STR_ARG);
295 string s3 = ((stringcount >= 3) ? ReadString() : NO_STR_ARG);
296 string s4 = ((stringcount == 4) ? ReadString() : NO_STR_ARG);
297 float f1 = ((floatcount >= 1) ? ReadLong() : NO_FL_ARG);
298 float f2 = ((floatcount >= 2) ? ReadLong() : NO_FL_ARG);
299 float f3 = ((floatcount >= 3) ? ReadLong() : NO_FL_ARG);
300 float f4 = ((floatcount == 4) ? ReadLong() : NO_FL_ARG);
302 if(is_new) { Local_Notification_Without_VarArgs(net_type, net_name, stringcount, floatcount, s1, s2, s3, s4, f1, f2, f3, f4); }
303 else { print("received old notification? net_name = ", Get_Field_Value(F_NAME, net_type, net_name), ".\n"); }
308 void Notification_Remove()
311 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
315 float Write_Notification(entity client, float sf)
317 float i, send = FALSE;
319 switch(self.nent_broadcast)
321 case NOTIF_ONE: { if((client == self.nent_client) || (client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
322 case NOTIF_ONE_ONLY: { if(client == self.nent_client) { send = TRUE; } break; }
323 case NOTIF_TEAM: { if((client.team == self.nent_client.team) || (client.classname == STR_SPECTATOR && client.enemy.team == self.nent_client.team)) { send = TRUE; } break; }
324 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; }
325 case NOTIF_ANY: { send = TRUE; break; }
326 case NOTIF_ANY_EXCEPT: { if((client != self.nent_client) && !(client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
327 default: { send = FALSE; break; }
332 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
333 WriteByte(MSG_ENTITY, self.nent_net_type);
334 WriteShort(MSG_ENTITY, self.nent_net_name);
335 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
336 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
342 void Send_Notification(float broadcast, entity client, float net_type, float net_name, ...count)
344 if(broadcast && net_type && net_name)
346 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
347 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
350 dprint("Send_Notification(", ftos(broadcast), ", ", ftos(net_type), ", ", Get_Field_Value(F_NAME, net_type, net_name), strcat(", ", ftos(count), ");\n"));
351 dprint(" ^--: stringcount: ", ftos(stringcount), ", floatcount: ", ftos(floatcount), ".\n");
353 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; }
354 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; }
356 entity notif = spawn();
357 notif.nent_broadcast = broadcast;
358 notif.nent_client = client;
359 notif.nent_net_type = net_type;
360 notif.nent_net_name = net_name;
361 notif.nent_stringcount = stringcount;
362 notif.nent_floatcount = floatcount;
363 for(i = 0; i < stringcount; ++i) { notif.nent_strings[i] = strzone(...(i, string)); }
364 for(i = 0; i < floatcount; ++i) { notif.nent_floats[i] = ...((stringcount + i), float); }
366 notif.think = Notification_Remove;
367 notif.nextthink = (time + 0.5);
369 Net_LinkEntity(notif, FALSE, 0, Write_Notification);
373 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));
376 else { backtrace("Incorrect usage of Send_Notification!\n"); }
379 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)
381 #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Send_Notification(broadcast, client, net_type, net_name, args); return; }
382 EIGHT_VARS_TO_VARARGS_VARLIST
385 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
388 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)
390 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
391 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
392 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);
396 // =============================
397 // LEGACY NOTIFICATION SYSTEMS
398 // =============================
400 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
402 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
405 WRITESPECTATABLE_MSG_ONE({
406 WriteByte(MSG_ONE, SVC_TEMPENTITY);
407 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
408 WriteByte(MSG_ONE, id);
409 WriteString(MSG_ONE, s);
410 if (id != 0 && s != "")
412 WriteByte(MSG_ONE, duration);
413 WriteByte(MSG_ONE, countdown_num);
418 void Send_CSQC_Centerprint_Generic_Expire(entity e, float id)
420 Send_CSQC_Centerprint_Generic(e, id, "", 1, 0);
423 #endif // ifndef MENUQC