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) { \
28 if(alsoprint) { print(a); } }
29 #define NOTIF_WRITE_SETA(name,default,text) { \
32 "seta notification_%s %d \"notif string: %s^7\"\n", \
33 name, default, strreplace("\{1}", "", strreplace("\n", "\\n", text)) \
35 NOTIF_WRITE(notif_msg) }
41 // Note: This warning only applies to the notifications.cfg file that is output...
43 // You ARE supposed to manually edit this function to add i.e. hard coded
44 // notification variables for mutators or game modes or such and then
45 // regenerate the notifications.cfg file from the new code.
47 NOTIF_WRITE("// ********************************************** //\n");
48 NOTIF_WRITE("// ** WARNING - DO NOT MANUALLY EDIT THIS FILE ** //\n");
49 NOTIF_WRITE("// ** ** //\n");
50 NOTIF_WRITE("// ** This file is automatically generated ** //\n");
51 NOTIF_WRITE("// ** by code with the command 'dumpnotifs'. ** //\n");
52 NOTIF_WRITE("// ** ** //\n");
53 NOTIF_WRITE("// ** If you add a new notification, please ** //\n");
54 NOTIF_WRITE("// ** regenerate this file with that command ** //\n");
55 NOTIF_WRITE("// ** making sure that the output matches ** //\n");
56 NOTIF_WRITE("// ** with the lists and defaults in code. ** //\n");
57 NOTIF_WRITE("// ** ** //\n");
58 NOTIF_WRITE("// ********************************************** //\n");
60 NOTIF_WRITE("\n// Version number to identify mismatches between code and config file...\n");
61 NOTIF_WRITE("// Increment NOTIF_VERSION in common/notifications.qh with any\n");
62 NOTIF_WRITE("// new notifications or other changes to notif cvars/this config.\n");
64 NOTIF_WRITE(sprintf("set notification_version %d\n", NOTIF_VERSION));
66 // These notifications will also append their string as a comment...
67 // This is not necessary, and does not matter if they vary between config versions,
68 // it is just a semi-helpful tool for those who want to manually change their user settings.
70 NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT));
71 for(i = 1; i <= NOTIF_INFO_COUNT; ++i) {
72 e = Get_Notif_Ent(MSG_INFO, i);
73 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
74 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, e.nent_string); }
76 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
77 for(i = 1; i <= NOTIF_CENTER_COUNT; ++i) {
78 e = Get_Notif_Ent(MSG_CENTER, i);
79 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
80 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, e.nent_string); }
82 NOTIF_WRITE(sprintf("\n// MSG_WEAPON notifications (count = %d):\n", NOTIF_WEAPON_COUNT));
83 for(i = 1; i <= NOTIF_WEAPON_COUNT; ++i) {
84 e = Get_Notif_Ent(MSG_WEAPON, i);
85 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
86 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, sprintf("infoname: %s, centername: %s",
87 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name)); }
89 NOTIF_WRITE(sprintf("\n// MSG_DEATH notifications (count = %d):\n", NOTIF_DEATH_COUNT));
90 for(i = 1; i <= NOTIF_DEATH_COUNT; ++i) {
91 e = Get_Notif_Ent(MSG_DEATH, i);
92 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
93 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, sprintf("infoname: %s, centername: %s",
94 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name)); }
96 // edit these to match whichever cvars are used for specific notification options
97 NOTIF_WRITE("\n// HARD CODED notification variables:\n");
98 NOTIF_WRITE("seta notification_show_sprees 1 \"Print information about sprees in death/kill messages\"\n");
99 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");
100 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");
101 NOTIF_WRITE("seta notification_errors_are_fatal 1 \"If a notification fails upon initialization, cause a Host_Error to stop the program\"\n");
102 NOTIF_WRITE("seta notification_ctf_pickup_team_verbose 1 \"Show extra information if a team mate picks up a flag\"\n");
103 NOTIF_WRITE("seta notification_ctf_pickup_enemy_verbose 1 \"Show extra information if an enemy picks up a flag\"\n");
104 NOTIF_WRITE("seta notification_ctf_capture_verbose 1 \"Show extra information when someone captures a flag\"\n");
105 NOTIF_WRITE("seta notification_frag_verbose 1 \"Show extra information when you frag someone (or when you are fragged\"\n");
107 NOTIF_WRITE(sprintf("\n// Notification counts (total = %d): MSG_INFO = %d, MSG_CENTER = %d, MSG_WEAPON = %d, MSG_DEATH = %d\n",
108 (NOTIF_INFO_COUNT + NOTIF_CENTER_COUNT + NOTIF_WEAPON_COUNT + NOTIF_DEATH_COUNT),
109 NOTIF_INFO_COUNT, NOTIF_CENTER_COUNT, NOTIF_WEAPON_COUNT, NOTIF_DEATH_COUNT));
112 #undef NOTIF_WRITE_SETA
117 void Notification_GetCvars()
119 GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
123 string Local_Notification_sprintf(string input, string args,
124 string s1, string s2, string s3, string s4,
125 float f1, float f2, float f3, float f4)
127 #ifdef NOTIFICATIONS_DEBUG
129 sprintf("Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
130 strreplace("\n", "\\n", input),
132 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
133 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
140 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
146 for(sel_num = 0;(args != "");)
148 selected = car(args); args = cdr(args);
149 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
150 switch(strtolower(selected))
152 #define ARG_CASE(prog,selected,result) \
154 #if (prog == ARG_DOUBLE) || (prog == ARG_TRIPLE) || (prog == ARG_CSQC) \
155 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
158 #if (prog == ARG_DOUBLE) || (prog == ARG_TRIPLE) || (prog == ARG_SVQC) \
159 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
164 NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
167 return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
171 void Local_Notification_HUD_Notify_Push(string icon, string hudargs, string s1, string s2, string s3, string s4)
175 arg_slot[0] = ""; arg_slot[1] = "";
177 for(sel_num = 0;(hudargs != "");)
179 selected = car(hudargs); hudargs = cdr(hudargs);
180 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
181 switch(strtolower(selected))
183 #define ARG_CASE(prog,selected,result) \
184 #if (prog == ARG_TRIPLE) \
185 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
189 NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
192 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
196 void Local_Notification(float net_type, float net_name, ...count)
198 // check supplied type and name for errors
199 string checkargs = "";
200 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
201 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
202 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
205 CHECKARG_TYPENAME(INFO)
206 CHECKARG_TYPENAME(CENTER)
207 CHECKARG_TYPENAME(WEAPON)
208 CHECKARG_TYPENAME(DEATH)
209 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
211 #undef CHECKARG_TYPENAME
212 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
214 entity notif = Get_Notif_Ent(net_type, net_name);
215 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
216 if not(notif.nent_enabled) { print("Local_Notification: Entity was disabled...\n"); return; }
218 if((notif.nent_stringcount + notif.nent_floatcount) > count)
222 "Not enough arguments for Local_Notification! ",
223 "stringcount(%d) + floatcount(%d) > count(%d)\n",
224 "Check the definition and function call for accuracy...?\n"
226 notif.nent_stringcount, notif.nent_floatcount, count));
229 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
233 "Too many arguments for Local_Notification! ",
234 "stringcount(%d) + floatcount(%d) < count(%d)\n",
235 "Check the definition and function call for accuracy...?\n"
237 notif.nent_stringcount, notif.nent_floatcount, count));
241 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
242 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
243 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
244 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
245 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
246 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
247 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
248 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
250 #ifdef NOTIFICATIONS_DEBUG
252 sprintf("Local_Notification(%d, %s, %s, %s);\n",
255 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
256 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
266 Local_Notification_sprintf(
273 if(notif.nent_icon != "")
275 Local_Notification_HUD_Notify_Push(
289 Local_Notification_sprintf(
302 if(notif.nent_msginfo)
303 if(notif.nent_msginfo.nent_enabled)
305 Local_Notification_WOVA(
307 notif.nent_msginfo.nent_id,
308 notif.nent_msginfo.nent_stringcount,
309 notif.nent_msginfo.nent_floatcount,
314 if(notif.nent_msgcenter)
315 if(notif.nent_msgcenter.nent_enabled)
317 Local_Notification_WOVA(
319 notif.nent_msgcenter.nent_id,
320 notif.nent_msgcenter.nent_stringcount,
321 notif.nent_msgcenter.nent_floatcount,
331 // WOVA = Without Variable Arguments
332 void Local_Notification_WOVA(float net_type, float net_name,
333 float stringcount, float floatcount,
334 string s1, string s2, string s3, string s4,
335 float f1, float f2, float f3, float f4)
337 #define VARITEM(stringc,floatc,args) \
338 if((stringcount == stringc) && (floatcount == floatc)) \
339 { Local_Notification(net_type, net_name, args); return; }
340 EIGHT_VARS_TO_VARARGS_VARLIST
342 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
346 // =========================
347 // Notification Networking
348 // =========================
351 void Read_Notification(float is_new)
353 float net_type = ReadByte();
354 float net_name = ReadShort();
356 entity notif = Get_Notif_Ent(net_type, net_name);
357 if not(notif) { print("Read_Notification: Could not find notification entity!\n"); return; }
359 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
360 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
361 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
362 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
363 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
364 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
365 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
366 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
368 #ifdef NOTIFICATIONS_DEBUG
369 dprint(sprintf("Read_Notification(%d) at %f: net_name = %s.\n", is_new, time, notif.nent_name));
374 Local_Notification_WOVA(
376 notif.nent_stringcount,
377 notif.nent_floatcount,
385 void Net_Notification_Remove()
388 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
392 float Net_Write_Notification(entity client, float sf)
394 float i, send = FALSE;
396 switch(self.nent_broadcast)
398 case NOTIF_ONE: // send to one client and their spectator
401 (client == self.nent_client)
404 (client.classname == STR_SPECTATOR)
406 (client.enemy == self.nent_client)
411 case NOTIF_ONE_ONLY: // send ONLY to one client
413 if(client == self.nent_client) { send = TRUE; }
416 case NOTIF_TEAM: // send only to X team and their spectators
419 (client.team == self.nent_client.team)
422 (client.classname == STR_SPECTATOR)
424 (client.enemy.team == self.nent_client.team)
429 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
432 (client != self.nent_client)
435 (client.team == self.nent_client.team)
438 (client.classname == STR_SPECTATOR)
441 (client.enemy != self.nent_client)
443 (client.enemy.team == self.nent_client.team)
450 case NOTIF_ANY: // send to everyone
455 case NOTIF_ANY_EXCEPT: // send to everyone except X person and their spectators
458 (client != self.nent_client)
461 (client.classname == STR_SPECTATOR)
463 (client.enemy == self.nent_client)
468 default: { send = FALSE; break; }
473 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
474 WriteByte(MSG_ENTITY, self.nent_net_type);
475 WriteShort(MSG_ENTITY, self.nent_net_name);
476 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
477 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
483 void Send_Notification(float broadcast, entity client,
484 float net_type, float net_name, ...count)
486 // check supplied broadcast, target, type, and name for errors
487 string checkargs = "";
488 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
489 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
490 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
493 CHECKARG_TYPENAME(INFO)
494 CHECKARG_TYPENAME(CENTER)
495 CHECKARG_TYPENAME(WEAPON)
496 CHECKARG_TYPENAME(DEATH)
497 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
499 #undef CHECKARG_TYPENAME
500 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
506 if(IS_NOT_A_CLIENT(client))
507 { checkargs = sprintf("%sNo client provided!", checkargs); }
511 case NOTIF_ANY_EXCEPT:
513 if(IS_NOT_A_CLIENT(client))
514 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
521 { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
526 case NOTIF_TEAM_EXCEPT:
528 if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
529 else if(IS_NOT_A_CLIENT(client))
531 if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
532 else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
537 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
539 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
541 // retreive counts for the arguments of this notification
542 entity notif = Get_Notif_Ent(net_type, net_name);
543 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
545 if((notif.nent_stringcount + notif.nent_floatcount) > count)
549 "Not enough arguments for Send_Notification! ",
550 "stringcount(%d) + floatcount(%d) > count(%d)\n",
551 "Check the definition and function call for accuracy...?\n"
553 notif.nent_stringcount, notif.nent_floatcount, count));
556 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
560 "Too many arguments for Send_Notification! ",
561 "stringcount(%d) + floatcount(%d) < count(%d)\n",
562 "Check the definition and function call for accuracy...?\n"
564 notif.nent_stringcount, notif.nent_floatcount, count));
568 #ifdef NOTIFICATIONS_DEBUG
570 sprintf("Send_Notification(%d, %d, %s, stringcount: %d, floatcount: %d, varargs: %d);\n",
574 notif.nent_stringcount,
575 notif.nent_floatcount,
581 entity net_notif = spawn();
582 net_notif.nent_broadcast = broadcast;
583 net_notif.nent_client = client;
584 net_notif.nent_net_type = net_type;
585 net_notif.nent_net_name = net_name;
586 net_notif.nent_stringcount = notif.nent_stringcount;
587 net_notif.nent_floatcount = notif.nent_floatcount;
590 for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
591 for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
593 net_notif.think = Net_Notification_Remove;
594 net_notif.nextthink = (time + 0.5);
596 Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
598 if((!server_is_local) && (broadcast == NOTIF_ANY || broadcast == NOTIF_ANY_EXCEPT) && (net_type != MSG_CENTER))
600 Local_Notification_WOVA(
602 notif.nent_stringcount,
603 notif.nent_floatcount,
604 IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3),
605 IFFL(0), IFFL(1), IFFL(2), IFFL(3));
609 // WOVA = Without Variable Arguments
610 void Send_Notification_WOVA(float broadcast, entity client,
611 float net_type, float net_name,
612 string s1, string s2, string s3, string s4,
613 float f1, float f2, float f3, float f4)
615 entity notif = Get_Notif_Ent(net_type, net_name);
616 #define VARITEM(stringc,floatc,args) \
617 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
618 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
619 EIGHT_VARS_TO_VARARGS_VARLIST
621 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
625 // =============================
626 // LEGACY NOTIFICATION SYSTEMS
627 // =============================
629 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
631 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
634 WRITESPECTATABLE_MSG_ONE({
635 WriteByte(MSG_ONE, SVC_TEMPENTITY);
636 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
637 WriteByte(MSG_ONE, id);
638 WriteString(MSG_ONE, s);
639 if (id != 0 && s != "")
641 WriteByte(MSG_ONE, duration);
642 WriteByte(MSG_ONE, countdown_num);