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(a,b) { \
30 if(b != "") { print(b); } \
33 #define NOTIF_WRITE_SETA(name,default,text) { \
36 "seta notification_%s %d \"notif string: %s\"\n", \
37 name, default, strreplace("\n", "\\n", text) \
39 NOTIF_WRITE(notif_msg, strreplace("^", "^^", notif_msg)) }
45 // Note: This warning only applies to the notifications.cfg file that is output...
47 // You ARE supposed to manually edit this function to add i.e. hard coded
48 // notification variables for mutators or game modes or such and then
49 // regenerate the notifications.cfg file from the new code.
51 NOTIF_WRITE("// ********************************************** //\n", "");
52 NOTIF_WRITE("// ** WARNING - DO NOT MANUALLY EDIT THIS FILE ** //\n", "");
53 NOTIF_WRITE("// ** ** //\n", "");
54 NOTIF_WRITE("// ** This file is automatically generated ** //\n", "");
55 NOTIF_WRITE("// ** by code with the command 'dumpnotifs'. ** //\n", "");
56 NOTIF_WRITE("// ** ** //\n", "");
57 NOTIF_WRITE("// ** If you add a new notification, please ** //\n", "");
58 NOTIF_WRITE("// ** regenerate this file with that command ** //\n", "");
59 NOTIF_WRITE("// ** making sure that the output matches ** //\n", "");
60 NOTIF_WRITE("// ** with the lists and defaults in code. ** //\n", "");
61 NOTIF_WRITE("// ** ** //\n", "");
62 NOTIF_WRITE("// ********************************************** //\n", "");
64 NOTIF_WRITE("\n// Version number to identify mismatches between code and config file...\n", "");
65 NOTIF_WRITE("// Increment NOTIF_VERSION in common/notifications.qh with any\n", "");
66 NOTIF_WRITE("// new notifications or other changes to notif cvars/this config.\n", "");
68 NOTIF_WRITE(sprintf("set notification_version %d\n", NOTIF_VERSION), "");
70 // These notifications will also append their string as a comment...
71 // This is not necessary, and does not matter if they vary between config versions,
72 // it is just a semi-helpful tool for those who want to manually change their user settings.
74 NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT), "");
75 for(i = 0; i <= NOTIF_INFO_COUNT; ++i) {
76 e = Get_Notif_Ent(MSG_INFO, i);
77 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
78 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, e.nent_string); }
80 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT), "");
81 for(i = 0; i <= NOTIF_CENTER_COUNT; ++i) {
82 e = Get_Notif_Ent(MSG_CENTER, i);
83 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
84 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, e.nent_string); }
86 NOTIF_WRITE(sprintf("\n// MSG_WEAPON notifications (count = %d):\n", NOTIF_WEAPON_COUNT), "");
87 for(i = 0; i <= NOTIF_WEAPON_COUNT; ++i) {
88 e = Get_Notif_Ent(MSG_WEAPON, i);
89 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
90 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, sprintf("infoname: %s, centername: %s",
91 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name)); }
93 NOTIF_WRITE(sprintf("\n// MSG_DEATH notifications (count = %d):\n", NOTIF_DEATH_COUNT), "");
94 for(i = 0; i <= NOTIF_DEATH_COUNT; ++i) {
95 e = Get_Notif_Ent(MSG_DEATH, i);
96 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
97 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, sprintf("infoname: %s, centername: %s",
98 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name)); }
100 // edit these to match whichever cvars are used for specific notification options
101 NOTIF_WRITE("\n// HARD CODED notification variables:\n", "");
102 NOTIF_WRITE("seta notification_version_mismatch_client_error 0 \"Cause a notif error on client if the version in notifications.cfg mismatches the code\"\n", "");
103 NOTIF_WRITE("seta notification_version_mismatch_server_error 1 \"Cause a notif error on server if the version in notifications.cfg mismatches the code\"\n", "");
104 NOTIF_WRITE("seta notification_errors_are_fatal 1 \"If a notification fails upon initialization, cause a Host_Error to stop the program\"\n", "");
105 NOTIF_WRITE("seta notification_ctf_pickup_team_verbose 1 \"Show extra information if a team mate picks up a flag\"\n", "");
106 NOTIF_WRITE("seta notification_ctf_pickup_enemy_verbose 1 \"Show extra information if an enemy picks up a flag\"\n", "");
107 NOTIF_WRITE("seta notification_ctf_capture_verbose 1 \"Show extra information when someone captures a flag\"\n", "");
108 NOTIF_WRITE("seta notification_frag_verbose 1 \"Show extra information when you frag someone (or when you are fragged\"\n", "");
110 NOTIF_WRITE(sprintf("\n// Notification counts (total = %d): MSG_INFO = %d, MSG_CENTER = %d, MSG_WEAPON = %d, MSG_DEATH = %d\n",
111 (NOTIF_INFO_COUNT + NOTIF_CENTER_COUNT + NOTIF_WEAPON_COUNT + NOTIF_DEATH_COUNT),
112 NOTIF_INFO_COUNT, NOTIF_CENTER_COUNT, NOTIF_WEAPON_COUNT, NOTIF_DEATH_COUNT), "");
115 #undef NOTIF_WRITE_SETA
120 void Notification_GetCvars()
122 GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
126 string Local_Notification_sprintf(string input, string args,
127 string s1, string s2, string s3, string s4,
128 float f1, float f2, float f3, float f4)
130 #ifdef NOTIFICATIONS_DEBUG
132 sprintf("Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
133 strreplace("\n", "\\n", input),
135 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
136 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
143 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
149 for(sel_num = 0;(args != "");)
151 selected = car(args); args = cdr(args);
152 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
153 switch(strtolower(selected))
155 #define ARG_CASE(prog,selected,result) \
157 #if (prog == ARG_DOUBLE) || (prog == ARG_TRIPLE) || (prog == ARG_CSQC) \
158 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
161 #if (prog == ARG_DOUBLE) || (prog == ARG_TRIPLE) || (prog == ARG_SVQC) \
162 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
167 NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
170 return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
174 void Local_Notification_HUD_Notify_Push(string icon, string hudargs, string s1, string s2, string s3, string s4)
178 arg_slot[0] = ""; arg_slot[1] = "";
180 for(sel_num = 0;(hudargs != "");)
182 selected = car(hudargs); hudargs = cdr(hudargs);
183 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
184 switch(strtolower(selected))
186 #define ARG_CASE(prog,selected,result) \
187 #if (prog == ARG_TRIPLE) \
188 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
192 NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
195 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
199 void Local_Notification(float net_type, float net_name, ...count)
201 // check supplied type and name for errors
202 string checkargs = "";
203 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
204 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
205 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
208 CHECKARG_TYPENAME(INFO)
209 CHECKARG_TYPENAME(CENTER)
210 CHECKARG_TYPENAME(WEAPON)
211 CHECKARG_TYPENAME(DEATH)
212 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
214 #undef CHECKARG_TYPENAME
215 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
217 entity notif = Get_Notif_Ent(net_type, net_name);
218 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
219 if not(notif.nent_enabled) { print("Local_Notification: Entity was disabled...\n"); return; }
221 if((notif.nent_stringcount + notif.nent_floatcount) > count)
225 "Not enough arguments for Local_Notification! ",
226 "stringcount(%d) + floatcount(%d) > count(%d)\n",
227 "Check the definition and function call for accuracy...?\n"
229 notif.nent_stringcount, notif.nent_floatcount, count));
232 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
236 "Too many arguments for Local_Notification! ",
237 "stringcount(%d) + floatcount(%d) < count(%d)\n",
238 "Check the definition and function call for accuracy...?\n"
240 notif.nent_stringcount, notif.nent_floatcount, count));
244 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
245 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
246 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
247 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
248 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
249 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
250 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
251 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
253 #ifdef NOTIFICATIONS_DEBUG
255 sprintf("Local_Notification(%d, %s, %s, %s);\n",
258 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
259 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
269 Local_Notification_sprintf(
276 if(notif.nent_icon != "")
278 Local_Notification_HUD_Notify_Push(
292 Local_Notification_sprintf(
305 if(notif.nent_msginfo)
306 if(notif.nent_msginfo.nent_enabled)
308 Local_Notification_WOVA(
310 notif.nent_msginfo.nent_id,
311 notif.nent_msginfo.nent_stringcount,
312 notif.nent_msginfo.nent_floatcount,
317 if(notif.nent_msgcenter)
318 if(notif.nent_msgcenter.nent_enabled)
320 Local_Notification_WOVA(
322 notif.nent_msgcenter.nent_id,
323 notif.nent_msgcenter.nent_stringcount,
324 notif.nent_msgcenter.nent_floatcount,
334 // WOVA = Without Variable Arguments
335 void Local_Notification_WOVA(float net_type, float net_name,
336 float stringcount, float floatcount,
337 string s1, string s2, string s3, string s4,
338 float f1, float f2, float f3, float f4)
340 #define VARITEM(stringc,floatc,args) \
341 if((stringcount == stringc) && (floatcount == floatc)) \
342 { Local_Notification(net_type, net_name, args); return; }
343 EIGHT_VARS_TO_VARARGS_VARLIST
345 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
349 // =========================
350 // Notification Networking
351 // =========================
354 void Read_Notification(float is_new)
356 float net_type = ReadByte();
357 float net_name = ReadShort();
359 entity notif = Get_Notif_Ent(net_type, net_name);
360 if not(notif) { print("Read_Notification: Could not find notification entity!\n"); return; }
362 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
363 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
364 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
365 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
366 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
367 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
368 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
369 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
371 #ifdef NOTIFICATIONS_DEBUG
372 dprint(sprintf("Read_Notification(%d) at %f: net_name = %s.\n", is_new, time, notif.nent_name));
377 Local_Notification_WOVA(
379 notif.nent_stringcount,
380 notif.nent_floatcount,
388 void Net_Notification_Remove()
391 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
395 float Net_Write_Notification(entity client, float sf)
397 float i, send = FALSE;
399 switch(self.nent_broadcast)
401 case NOTIF_ONE: // send to one client and their spectator
404 (client == self.nent_client)
407 (client.classname == STR_SPECTATOR)
409 (client.enemy == self.nent_client)
414 case NOTIF_ONE_ONLY: // send ONLY to one client
416 if(client == self.nent_client) { send = TRUE; }
419 case NOTIF_TEAM: // send only to X team and their spectators
422 (client.team == self.nent_client.team)
425 (client.classname == STR_SPECTATOR)
427 (client.enemy.team == self.nent_client.team)
432 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
435 (client != self.nent_client)
438 (client.team == self.nent_client.team)
441 (client.classname == STR_SPECTATOR)
444 (client.enemy != self.nent_client)
446 (client.enemy.team == self.nent_client.team)
453 case NOTIF_ANY: // send to everyone
458 case NOTIF_ANY_EXCEPT: // send to everyone except X person and their spectators
461 (client != self.nent_client)
464 (client.classname == STR_SPECTATOR)
466 (client.enemy == self.nent_client)
471 default: { send = FALSE; break; }
476 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
477 WriteByte(MSG_ENTITY, self.nent_net_type);
478 WriteShort(MSG_ENTITY, self.nent_net_name);
479 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
480 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
486 void Send_Notification(float broadcast, entity client,
487 float net_type, float net_name, ...count)
489 // check supplied broadcast, target, type, and name for errors
490 string checkargs = "";
491 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
492 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
493 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
496 CHECKARG_TYPENAME(INFO)
497 CHECKARG_TYPENAME(CENTER)
498 CHECKARG_TYPENAME(WEAPON)
499 CHECKARG_TYPENAME(DEATH)
500 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
502 #undef CHECKARG_TYPENAME
503 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
509 if(IS_NOT_A_CLIENT(client))
510 { checkargs = sprintf("%sNo client provided!", checkargs); }
514 case NOTIF_ANY_EXCEPT:
516 if(IS_NOT_A_CLIENT(client))
517 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
524 { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
529 case NOTIF_TEAM_EXCEPT:
531 if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
532 else if(IS_NOT_A_CLIENT(client))
534 if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
535 else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
540 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
542 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
544 // retreive counts for the arguments of this notification
545 entity notif = Get_Notif_Ent(net_type, net_name);
546 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
548 if((notif.nent_stringcount + notif.nent_floatcount) > count)
552 "Not enough arguments for Send_Notification! ",
553 "stringcount(%d) + floatcount(%d) > count(%d)\n",
554 "Check the definition and function call for accuracy...?\n"
556 notif.nent_stringcount, notif.nent_floatcount, count));
559 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
563 "Too many arguments for Send_Notification! ",
564 "stringcount(%d) + floatcount(%d) < count(%d)\n",
565 "Check the definition and function call for accuracy...?\n"
567 notif.nent_stringcount, notif.nent_floatcount, count));
571 #ifdef NOTIFICATIONS_DEBUG
573 sprintf("Send_Notification(%d, %d, %s, stringcount: %d, floatcount: %d, varargs: %d);\n",
577 notif.nent_stringcount,
578 notif.nent_floatcount,
584 entity net_notif = spawn();
585 net_notif.nent_broadcast = broadcast;
586 net_notif.nent_client = client;
587 net_notif.nent_net_type = net_type;
588 net_notif.nent_net_name = net_name;
589 net_notif.nent_stringcount = notif.nent_stringcount;
590 net_notif.nent_floatcount = notif.nent_floatcount;
593 for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
594 for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
596 net_notif.think = Net_Notification_Remove;
597 net_notif.nextthink = (time + 0.5);
599 Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
601 if((!server_is_local) && (broadcast == NOTIF_ANY || broadcast == NOTIF_ANY_EXCEPT) && (net_type != MSG_CENTER))
603 Local_Notification_WOVA(
605 notif.nent_stringcount,
606 notif.nent_floatcount,
607 IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3),
608 IFFL(0), IFFL(1), IFFL(2), IFFL(3));
612 // WOVA = Without Variable Arguments
613 void Send_Notification_WOVA(float broadcast, entity client,
614 float net_type, float net_name,
615 string s1, string s2, string s3, string s4,
616 float f1, float f2, float f3, float f4)
618 entity notif = Get_Notif_Ent(net_type, net_name);
619 #define VARITEM(stringc,floatc,args) \
620 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
621 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
622 EIGHT_VARS_TO_VARARGS_VARLIST
624 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
628 // =============================
629 // LEGACY NOTIFICATION SYSTEMS
630 // =============================
632 #define Send_CSQC_Centerprint_Generic_Expire(e,id) Send_CSQC_Centerprint_Generic(e, id, "", 1, 0)
634 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
636 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
639 WRITESPECTATABLE_MSG_ONE({
640 WriteByte(MSG_ONE, SVC_TEMPENTITY);
641 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
642 WriteByte(MSG_ONE, id);
643 WriteString(MSG_ONE, s);
644 if (id != 0 && s != "")
646 WriteByte(MSG_ONE, duration);
647 WriteByte(MSG_ONE, countdown_num);