1 // ================================================
2 // Unified notification system, written by Samual
3 // Last updated: February, 2013
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) }
28 NOTIF_SWITCH_LIST(MSG_INFO, net_name, return "")
35 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) case name: { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) }
37 NOTIF_SWITCH_LIST(MSG_CENTER, net_name, return "")
39 #undef MSG_CENTER_NOTIF
44 #define MSG_WEAPON_NOTIF(name,infoname,centername) case name: { GET_FIELD_VALUE_OUTPUT(field,name, \
45 max(CLPSE_GETVALUE(infoname, MSG_INFO, F_STRNUM), CLPSE_GETVALUE(centername, MSG_CENTER, F_STRNUM)), \
46 max(CLPSE_GETVALUE(infoname, MSG_INFO, F_FLNUM), CLPSE_GETVALUE(centername, MSG_CENTER, F_FLNUM))) }
48 NOTIF_SWITCH_LIST(MSG_WEAPON, net_name, return "")
50 #undef MSG_WEAPON_NOTIF
55 #define MSG_DEATH_NOTIF(name,infoname,centername) case name: { GET_FIELD_VALUE_OUTPUT(field,name, \
56 max(CLPSE_GETVALUE(infoname, MSG_INFO, F_STRNUM), CLPSE_GETVALUE(centername, MSG_CENTER, F_STRNUM)), \
57 max(CLPSE_GETVALUE(infoname, MSG_INFO, F_FLNUM), CLPSE_GETVALUE(centername, MSG_CENTER, F_FLNUM))) }
59 NOTIF_SWITCH_LIST(MSG_DEATH, net_name, return "")
61 #undef MSG_DEATH_NOTIF
66 #undef GET_FIELD_VALUE_OUTPUT
70 #endif // ifndef MENUQC
73 // ===============================
74 // Frontend Notification Pushing
75 // ===============================
77 void Dump_Notifications(float fh, float alsoprint)
79 float MSG_INFO_NOTIFS = 0, MSG_CENTER_NOTIFS = 0, MSG_WEAPON_NOTIFS = 0, MSG_DEATH_NOTIFS = 0;
82 #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)); }
83 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) { ++MSG_INFO_NOTIFS; NOTIF_WRITE("MSG_INFO", VAR_TO_TEXT(name), normal) }
84 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) { ++MSG_CENTER_NOTIFS; NOTIF_WRITE("MSG_CENTER", VAR_TO_TEXT(name), normal) }
85 #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))) }
86 #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))) }
87 MSG_INFO_NOTIFICATIONS
88 MSG_CENTER_NOTIFICATIONS
89 MSG_WEAPON_NOTIFICATIONS
90 MSG_DEATH_NOTIFICATIONS
93 #undef MSG_CENTER_NOTIF
94 #undef MSG_WEAPON_NOTIF
95 #undef MSG_DEATH_NOTIF
97 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));
103 void HUD_Notify_Push(string icon, string attacker, string victim)
108 if (kn_index == -1) { kn_index = KN_MAX_ENTRIES-1; }
109 killnotify_times[kn_index] = time;
112 if(killnotify_icon[kn_index]) { strunzone(killnotify_icon[kn_index]); }
113 killnotify_icon[kn_index] = strzone(icon);
116 if(killnotify_attackers[kn_index]) { strunzone(killnotify_attackers[kn_index]); }
117 killnotify_attackers[kn_index] = strzone(attacker);
120 if(killnotify_victims[kn_index]) { strunzone(killnotify_victims[kn_index]); }
121 killnotify_victims[kn_index] = strzone(victim);
126 void Local_Notification(float net_type, float net_name, ...count)
128 if(net_type && net_name)
130 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
131 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
133 string s1 = ((0 < stringcount) ? ...(0, string) : NO_STR_ARG);
134 string s2 = ((1 < stringcount) ? ...(1, string) : NO_STR_ARG);
135 string s3 = ((2 < stringcount) ? ...(2, string) : NO_STR_ARG);
136 string s4 = ((3 < stringcount) ? ...(3, string) : NO_STR_ARG);
137 float f1 = ((stringcount < count) ? ...(stringcount, float) : NO_FL_ARG);
138 float f2 = (((stringcount + 1) < count) ? ...((stringcount + 1), float) : NO_FL_ARG);
139 float f3 = (((stringcount + 2) < count) ? ...((stringcount + 2), float) : NO_FL_ARG);
140 float f4 = (((stringcount + 3) < count) ? ...((stringcount + 3), float) : NO_FL_ARG);
142 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")));
143 dprint(" ^--: stringcount: ", ftos(stringcount), ", floatcount: ", ftos(floatcount), ".\n");
145 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; }
146 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; }
152 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
153 case name: { CHECK_AUTOCVAR(name) \
155 print(sprintf(CCR(normal_or_gentle(normal, gentle)), args)); \
157 if(icon != "") { HUD_Notify_Push(icon, hudargs); } \
161 NOTIF_SWITCH_LIST(MSG_INFO, net_name, return)
163 #undef MSG_INFO_NOTIF
169 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
170 case name: { CHECK_AUTOCVAR(name) \
172 centerprint_generic(HANDLE_CPID(cpid), sprintf(CCR(normal_or_gentle(normal, gentle)), args), durcnt); \
175 NOTIF_SWITCH_LIST(MSG_CENTER, net_name, return)
177 #undef MSG_CENTER_NOTIF
183 #define MSG_WEAPON_NOTIF(name,infoname,centername) \
184 case name: { CHECK_AUTOCVAR(name) \
186 #if infoname != NO_MSG \
187 Local_Notification_Without_VarArgs(MSG_INFO, infoname, \
188 stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), \
189 stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), \
190 s1, s2, s3, s4, f1, f2, f3, f4); \
193 #if centername != NO_MSG \
194 Local_Notification_Without_VarArgs(MSG_CENTER, centername, \
195 stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername)), \
196 stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)), \
197 s1, s2, s3, s4, f1, f2, f3, f4); \
202 NOTIF_SWITCH_LIST(MSG_WEAPON, net_name, return)
204 #undef MSG_WEAPON_NOTIF
209 #define MSG_DEATH_NOTIF(name,infoname,centername) \
210 case name: { CHECK_AUTOCVAR(name) \
212 #if infoname != NO_MSG \
213 Local_Notification_Without_VarArgs(MSG_INFO, infoname, \
214 stof(Get_Field_Value(F_STRNUM, MSG_INFO, infoname)), \
215 stof(Get_Field_Value(F_FLNUM, MSG_INFO, infoname)), \
216 s1, s2, s3, s4, f1, f2, f3, f4); \
219 #if centername != NO_MSG \
220 Local_Notification_Without_VarArgs(MSG_CENTER, centername, \
221 stof(Get_Field_Value(F_STRNUM, MSG_CENTER, centername)), \
222 stof(Get_Field_Value(F_FLNUM, MSG_CENTER, centername)), \
223 s1, s2, s3, s4, f1, f2, f3, f4); \
228 NOTIF_SWITCH_LIST(MSG_DEATH, net_name, return)
230 #undef MSG_DEATH_NOTIF
235 else { backtrace("Incorrect usage of Local_Notification!\n"); }
238 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)
240 #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Local_Notification(net_type, net_name, args); return; }
241 EIGHT_VARS_TO_VARARGS_VARLIST
244 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
248 // =========================
249 // Notification Networking
250 // =========================
253 void Read_Notification(float is_new)
255 float net_type = ReadByte();
256 float net_name = ReadShort();
258 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
259 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
261 string s1 = ((stringcount >= 1) ? ReadString() : NO_STR_ARG);
262 string s2 = ((stringcount >= 2) ? ReadString() : NO_STR_ARG);
263 string s3 = ((stringcount >= 3) ? ReadString() : NO_STR_ARG);
264 string s4 = ((stringcount == 4) ? ReadString() : NO_STR_ARG);
265 float f1 = ((floatcount >= 1) ? ReadLong() : NO_FL_ARG);
266 float f2 = ((floatcount >= 2) ? ReadLong() : NO_FL_ARG);
267 float f3 = ((floatcount >= 3) ? ReadLong() : NO_FL_ARG);
268 float f4 = ((floatcount == 4) ? ReadLong() : NO_FL_ARG);
270 if(is_new) { Local_Notification_Without_VarArgs(net_type, net_name, stringcount, floatcount, s1, s2, s3, s4, f1, f2, f3, f4); }
271 else { print("received old notification? net_name = ", Get_Field_Value(F_NAME, net_type, net_name), ".\n"); }
276 void Notification_Remove()
279 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
283 float Write_Notification(entity client, float sf)
285 float i, send = FALSE;
287 switch(self.nent_broadcast)
289 case NOTIF_ONE: { if((client == self.nent_client) || (client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
290 case NOTIF_ONE_ONLY: { if(client == self.nent_client) { send = TRUE; } break; }
291 case NOTIF_TEAM: { if((client.team == self.nent_client.team) || (client.classname == STR_SPECTATOR && client.enemy.team == self.nent_client.team)) { send = TRUE; } break; }
292 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; }
293 case NOTIF_ANY: { send = TRUE; break; }
294 case NOTIF_ANY_EXCEPT: { if((client != self.nent_client) && !(client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
295 default: { send = FALSE; break; }
300 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
301 WriteByte(MSG_ENTITY, self.nent_net_type);
302 WriteShort(MSG_ENTITY, self.nent_net_name);
303 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
304 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
310 void Send_Notification(float broadcast, entity client, float net_type, float net_name, ...count)
312 if(broadcast && net_type && net_name)
314 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
315 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
318 dprint("Send_Notification(", ftos(broadcast), ", ", ftos(net_type), ", ", Get_Field_Value(F_NAME, net_type, net_name), strcat(", ", ftos(count), ");\n"));
319 dprint(" ^--: stringcount: ", ftos(stringcount), ", floatcount: ", ftos(floatcount), ".\n");
321 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; }
322 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; }
324 entity notif = spawn();
325 notif.nent_broadcast = broadcast;
326 notif.nent_client = client;
327 notif.nent_net_type = net_type;
328 notif.nent_net_name = net_name;
329 notif.nent_stringcount = stringcount;
330 notif.nent_floatcount = floatcount;
331 for(i = 0; i < stringcount; ++i) { notif.nent_strings[i] = strzone(...(i, string)); }
332 for(i = 0; i < floatcount; ++i) { notif.nent_floats[i] = ...((stringcount + i), float); }
334 notif.think = Notification_Remove;
335 notif.nextthink = (time + 0.5);
337 Net_LinkEntity(notif, FALSE, 0, Write_Notification);
339 if((!server_is_local) && (broadcast == NOTIF_ANY || broadcast == NOTIF_ANY_EXCEPT) && (net_type != MSG_CENTER))
341 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));
344 else { backtrace("Incorrect usage of Send_Notification!\n"); }
347 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)
349 #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Send_Notification(broadcast, client, net_type, net_name, args); return; }
350 EIGHT_VARS_TO_VARARGS_VARLIST
353 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
356 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)
358 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
359 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
360 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);
364 // =============================
365 // LEGACY NOTIFICATION SYSTEMS
366 // =============================
368 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
370 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
373 WRITESPECTATABLE_MSG_ONE({
374 WriteByte(MSG_ONE, SVC_TEMPENTITY);
375 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
376 WriteByte(MSG_ONE, id);
377 WriteString(MSG_ONE, s);
378 if (id != 0 && s != "")
380 WriteByte(MSG_ONE, duration);
381 WriteByte(MSG_ONE, countdown_num);
386 void Send_CSQC_Centerprint_Generic_Expire(entity e, float id)
388 Send_CSQC_Centerprint_Generic(e, id, "", 1, 0);
391 #endif // ifndef MENUQC