1 // ================================================
2 // Unified notification system, written by Samual
3 // Last updated: February, 2013
4 // ================================================
6 entity Get_Notif_Ent(float net_type, float net_name)
10 case MSG_INFO: return msg_info_notifs[net_name - 1];
11 case MSG_CENTER: return msg_center_notifs[net_name - 1];
12 case MSG_WEAPON: return msg_weapon_notifs[net_name - 1];
13 case MSG_DEATH: return msg_death_notifs[net_name - 1];
15 backtrace(sprintf("Get_Notif_Ent(%d, %d): Improper net type!\n", net_type, net_name));
20 // ===============================
21 // Frontend Notification Pushing
22 // ===============================
24 void Dump_Notifications(float fh, float alsoprint)
26 #define NOTIF_WRITE(type,name,text) { \
27 notif_msg = sprintf("seta %s 1 // %s - %s\n", name, #type, strreplace("\n", "\\n", text)); \
28 fputs(fh, notif_msg); \
29 if(alsoprint) { print(strreplace("^", "^^", notif_msg)); } }
35 for(i = 0; i < NOTIF_INFO_COUNT; ++i) {
36 e = Get_Notif_Ent(MSG_INFO, i);
37 NOTIF_WRITE(MSG_INFO, e.nent_name, e.nent_string); }
39 for(i = 0; i < NOTIF_CENTER_COUNT; ++i) {
40 e = Get_Notif_Ent(MSG_CENTER, i);
41 NOTIF_WRITE(MSG_CENTER, e.nent_name, e.nent_string); }
43 for(i = 0; i < NOTIF_WEAPON_COUNT; ++i) {
44 e = Get_Notif_Ent(MSG_WEAPON, i);
45 NOTIF_WRITE(MSG_WEAPON, e.nent_name, sprintf("infoname: %s, centername: %s",
46 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name)); }
48 for(i = 0; i < NOTIF_DEATH_COUNT; ++i) {
49 e = Get_Notif_Ent(MSG_DEATH, i);
50 NOTIF_WRITE(MSG_DEATH, e.nent_name, sprintf("infoname: %s, centername: %s",
51 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name)); }
53 print(sprintf("Notification counts: MSG_INFO = %d, MSG_CENTER = %d, MSG_WEAPON = %d, MSG_DEATH = %d\n",
54 NOTIF_INFO_COUNT, NOTIF_CENTER_COUNT, NOTIF_WEAPON_COUNT, NOTIF_DEATH_COUNT));
60 string Local_Notification_sprintf(string input, string args,
61 string s1, string s2, string s3, string s4,
62 float f1, float f2, float f3, float f4)
64 #ifdef NOTIFICATIONS_DEBUG
66 sprintf("Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
67 strreplace("\n", "\\n", input),
69 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
70 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
77 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
83 for(sel_num = 0;(args != "");)
85 selected = car(args); args = cdr(args);
86 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
87 switch(strtolower(selected))
89 #define ARG_CASE(prog,selected,result) \
91 #if (prog == ARG_BOTH) || (prog == ARG_TRIPLE) || (prog == ARG_CSQC) \
92 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
95 #if (prog == ARG_BOTH) || (prog == ARG_TRIPLE) || (prog == ARG_SVQC) \
96 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
101 NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
104 return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
108 void Local_Notification_HUD_Notify_Push(string icon, string hudargs, string s1, string s2, string s3, string s4)
112 arg_slot[0] = ""; arg_slot[1] = "";
114 for(sel_num = 0;(hudargs != "");)
116 selected = car(hudargs); hudargs = cdr(hudargs);
117 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
118 switch(strtolower(selected))
120 #define ARG_CASE(prog,selected,result) \
121 #if (prog == ARG_TRIPLE) \
122 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
126 NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
129 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
133 void Local_Notification(float net_type, float net_name, ...count)
135 // check supplied type and name for errors
136 string checkargs = "";
137 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
138 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
139 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
142 CHECKARG_TYPENAME(INFO)
143 CHECKARG_TYPENAME(CENTER)
144 CHECKARG_TYPENAME(WEAPON)
145 CHECKARG_TYPENAME(DEATH)
146 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
148 #undef CHECKARG_TYPENAME
149 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
151 entity notif = Get_Notif_Ent(net_type, net_name);
152 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
153 if not(notif.nent_enabled) { print("Local_Notification: Entity was disabled...\n"); return; }
155 if((notif.nent_stringcount + notif.nent_floatcount) > count)
159 "Not enough arguments for Local_Notification! ",
160 "stringcount(%d) + floatcount(%d) > count(%d)\n",
161 "Check the definition and function call for accuracy...?\n"
163 notif.nent_stringcount, notif.nent_floatcount, count));
166 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
170 "Too many arguments for Local_Notification! ",
171 "stringcount(%d) + floatcount(%d) < count(%d)\n",
172 "Check the definition and function call for accuracy...?\n"
174 notif.nent_stringcount, notif.nent_floatcount, count));
178 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
179 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
180 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
181 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
182 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
183 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
184 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
185 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
187 #ifdef NOTIFICATIONS_DEBUG
189 sprintf("Local_Notification(%d, %s, %s, %s);\n",
192 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
193 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
203 Local_Notification_sprintf(
210 if(notif.nent_icon != "")
212 Local_Notification_HUD_Notify_Push(
226 Local_Notification_sprintf(
239 if(notif.nent_msginfo)
240 if(notif.nent_msginfo.nent_enabled)
242 Local_Notification_Without_VarArgs(
244 notif.nent_msginfo.nent_id,
245 notif.nent_msginfo.nent_stringcount,
246 notif.nent_msginfo.nent_floatcount,
251 if(notif.nent_msgcenter)
252 if(notif.nent_msgcenter.nent_enabled)
254 Local_Notification_Without_VarArgs(
256 notif.nent_msgcenter.nent_id,
257 notif.nent_msgcenter.nent_stringcount,
258 notif.nent_msgcenter.nent_floatcount,
268 void Local_Notification_Without_VarArgs(float net_type, float net_name,
269 float stringcount, float floatcount,
270 string s1, string s2, string s3, string s4,
271 float f1, float f2, float f3, float f4)
273 #define VARITEM(stringc,floatc,args) \
274 if((stringcount == stringc) && (floatcount == floatc)) \
275 { Local_Notification(net_type, net_name, args); return; }
276 EIGHT_VARS_TO_VARARGS_VARLIST
278 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
282 // =========================
283 // Notification Networking
284 // =========================
287 void Read_Notification(float is_new)
289 float net_type = ReadByte();
290 float net_name = ReadShort();
292 entity notif = Get_Notif_Ent(net_type, net_name);
293 if not(notif) { print("Read_Notification: Could not find notification entity!\n"); return; }
295 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
296 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
297 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
298 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
299 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
300 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
301 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
302 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
304 #ifdef NOTIFICATIONS_DEBUG
305 dprint(sprintf("Read_Notification(%d) at %f: net_name = %s.\n", is_new, time, notif.nent_name));
310 Local_Notification_Without_VarArgs(
312 notif.nent_stringcount,
313 notif.nent_floatcount,
321 void Notification_Remove()
324 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
328 float Write_Notification(entity client, float sf)
330 float i, send = FALSE;
332 switch(self.nent_broadcast)
334 case NOTIF_ONE: { if((client == self.nent_client) || (client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
335 case NOTIF_ONE_ONLY: { if(client == self.nent_client) { send = TRUE; } break; }
336 case NOTIF_TEAM: { if((client.team == self.nent_client.team) || (client.classname == STR_SPECTATOR && client.enemy.team == self.nent_client.team)) { send = TRUE; } break; }
337 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; }
338 case NOTIF_ANY: { send = TRUE; break; }
339 case NOTIF_ANY_EXCEPT: { if((client != self.nent_client) && !(client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
340 default: { send = FALSE; break; }
345 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
346 WriteByte(MSG_ENTITY, self.nent_net_type);
347 WriteShort(MSG_ENTITY, self.nent_net_name);
348 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
349 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
355 void Send_Notification(float broadcast, entity client,
356 float net_type, float net_name, ...count)
358 // check supplied broadcast, target, type, and name for errors
359 string checkargs = "";
360 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
361 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
362 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
365 CHECKARG_TYPENAME(INFO)
366 CHECKARG_TYPENAME(CENTER)
367 CHECKARG_TYPENAME(WEAPON)
368 CHECKARG_TYPENAME(DEATH)
369 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
371 #undef CHECKARG_TYPENAME
372 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
376 case NOTIF_ONE_ONLY: { if(clienttype(client) == CLIENTTYPE_NOTACLIENT) { checkargs = sprintf("%sNo client provided!", checkargs); } break; }
377 case NOTIF_ANY_EXCEPT: { if(clienttype(client) == CLIENTTYPE_NOTACLIENT) { checkargs = sprintf("%sException can't be a non-client!", checkargs); } break; }
378 case NOTIF_ANY: { if(client) { checkargs = sprintf("%sEntity provided when world was required!", checkargs); } break; }
380 case NOTIF_TEAM_EXCEPT:
382 if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
383 else if(clienttype(client) == CLIENTTYPE_NOTACLIENT)
385 if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
386 else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
390 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
392 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
394 // retreive counts for the arguments of this notification
395 entity notif = Get_Notif_Ent(net_type, net_name);
396 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
398 if((notif.nent_stringcount + notif.nent_floatcount) > count)
402 "Not enough arguments for Send_Notification! ",
403 "stringcount(%d) + floatcount(%d) > count(%d)\n",
404 "Check the definition and function call for accuracy...?\n"
406 notif.nent_stringcount, notif.nent_floatcount, count));
409 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
413 "Too many arguments for Send_Notification! ",
414 "stringcount(%d) + floatcount(%d) < count(%d)\n",
415 "Check the definition and function call for accuracy...?\n"
417 notif.nent_stringcount, notif.nent_floatcount, count));
421 #ifdef NOTIFICATIONS_DEBUG
423 sprintf("Send_Notification(%d, %d, %s, stringcount: %d, floatcount: %d, varargs: %d);\n",
427 notif.nent_stringcount,
428 notif.nent_floatcount,
434 entity net_notif = spawn();
435 net_notif.nent_broadcast = broadcast;
436 net_notif.nent_client = client;
437 net_notif.nent_net_type = net_type;
438 net_notif.nent_net_name = net_name;
439 net_notif.nent_stringcount = notif.nent_stringcount;
440 net_notif.nent_floatcount = notif.nent_floatcount;
443 for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
444 for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
446 net_notif.think = Notification_Remove;
447 net_notif.nextthink = (time + 0.5);
449 Net_LinkEntity(net_notif, FALSE, 0, Write_Notification);
451 if((!server_is_local) && (broadcast == NOTIF_ANY || broadcast == NOTIF_ANY_EXCEPT) && (net_type != MSG_CENTER))
453 Local_Notification_Without_VarArgs(
455 notif.nent_stringcount,
456 notif.nent_floatcount,
457 IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3),
458 IFFL(0), IFFL(1), IFFL(2), IFFL(3));
462 void Send_Notification_Without_VarArgs(float broadcast, entity client,
463 float net_type, float net_name,
464 float stringcount, float floatcount,
465 string s1, string s2, string s3, string s4,
466 float f1, float f2, float f3, float f4)
468 #define VARITEM(stringc,floatc,args) \
469 if((stringcount == stringc) && (floatcount == floatc)) \
470 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
471 EIGHT_VARS_TO_VARARGS_VARLIST
473 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
476 void Send_Notification_Legacy_Wrapper(float broadcast, entity client,
477 float net_type, float net_name,
478 string s1, string s2,
479 float f1, float f2, float f3)
481 entity notif = Get_Notif_Ent(net_type, net_name);
482 Send_Notification_Without_VarArgs(
485 notif.nent_stringcount,
486 notif.nent_floatcount,
492 // =============================
493 // LEGACY NOTIFICATION SYSTEMS
494 // =============================
496 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
498 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
501 WRITESPECTATABLE_MSG_ONE({
502 WriteByte(MSG_ONE, SVC_TEMPENTITY);
503 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
504 WriteByte(MSG_ONE, id);
505 WriteString(MSG_ONE, s);
506 if (id != 0 && s != "")
508 WriteByte(MSG_ONE, duration);
509 WriteByte(MSG_ONE, countdown_num);
514 void Send_CSQC_Centerprint_Generic_Expire(entity e, float id)
516 Send_CSQC_Centerprint_Generic(e, id, "", 1, 0);