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("\{3}", "", 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)
73 e = Get_Notif_Ent(MSG_INFO, i);
74 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
75 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, e.nent_string);
78 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
79 for(i = 1; i <= NOTIF_CENTER_COUNT; ++i)
81 e = Get_Notif_Ent(MSG_CENTER, i);
82 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
83 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 = 1; i <= NOTIF_WEAPON_COUNT; ++i)
89 e = Get_Notif_Ent(MSG_WEAPON, i);
90 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
91 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, sprintf("infoname: %s, centername: %s",
92 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name));
95 NOTIF_WRITE(sprintf("\n// MSG_DEATH notifications (count = %d):\n", NOTIF_DEATH_COUNT));
96 for(i = 1; i <= NOTIF_DEATH_COUNT; ++i)
98 e = Get_Notif_Ent(MSG_DEATH, i);
99 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
100 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, sprintf("infoname: %s, centername: %s",
101 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name));
104 // edit these to match whichever cvars are used for specific notification options
105 NOTIF_WRITE("\n// HARD CODED notification variables:\n");
106 NOTIF_WRITE("seta notification_allow_chatboxprint 1 \"Allow notifications to be printed to chat box by setting notification cvar to 2 (You can also set this cvar to 2 to force ALL notifications to be printed to the chatbox)\"\n");
107 NOTIF_WRITE("seta notification_show_sprees 1 \"Print information about sprees in death/kill messages\"\n");
108 NOTIF_WRITE("seta notification_show_sprees_info_newline 1 \"Show attacker spree information for MSG_INFO messages on a separate line than the death notification itself\"\n");
109 NOTIF_WRITE("seta notification_show_sprees_info_specialonly 1 \"Don't show attacker spree information if it isn't an achievement\"\n");
110 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");
111 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");
112 NOTIF_WRITE("seta notification_errors_are_fatal 1 \"If a notification fails upon initialization, cause a Host_Error to stop the program\"\n");
113 NOTIF_WRITE("seta notification_ctf_pickup_team_verbose 1 \"Show extra information if a team mate picks up a flag\"\n");
114 NOTIF_WRITE("seta notification_ctf_pickup_enemy_verbose 1 \"Show extra information if an enemy picks up a flag\"\n");
115 NOTIF_WRITE("seta notification_ctf_capture_verbose 1 \"Show extra information when someone captures a flag\"\n");
116 NOTIF_WRITE("seta notification_frag_verbose 1 \"Show extra information when you frag someone (or when you are fragged\"\n");
118 NOTIF_WRITE(sprintf("\n// Notification counts (total = %d): MSG_INFO = %d, MSG_CENTER = %d, MSG_WEAPON = %d, MSG_DEATH = %d\n",
119 (NOTIF_INFO_COUNT + NOTIF_CENTER_COUNT + NOTIF_WEAPON_COUNT + NOTIF_DEATH_COUNT),
120 NOTIF_INFO_COUNT, NOTIF_CENTER_COUNT, NOTIF_WEAPON_COUNT, NOTIF_DEATH_COUNT));
123 #undef NOTIF_WRITE_SETA
128 void Notification_GetCvars()
130 GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
134 string Local_Notification_sprintf(string input, string args,
135 string s1, string s2, string s3, string s4,
136 float f1, float f2, float f3, float f4)
138 #ifdef NOTIFICATIONS_DEBUG
140 sprintf("Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
141 strreplace("\n", "\\n", input),
143 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
144 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
151 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
157 for(sel_num = 0;(args != "");)
159 selected = car(args); args = cdr(args);
160 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
161 switch(strtolower(selected))
163 #define ARG_CASE(prog,selected,result) \
165 #if (prog == ARG_DOUBLE) || (prog == ARG_TRIPLE) || (prog == ARG_CSQC) \
166 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
169 #if (prog == ARG_DOUBLE) || (prog == ARG_TRIPLE) || (prog == ARG_SVQC) \
170 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
175 NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
178 return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
182 void Local_Notification_HUD_Notify_Push(string icon, string hudargs, string s1, string s2, string s3, string s4)
186 arg_slot[0] = ""; arg_slot[1] = "";
188 for(sel_num = 0;(hudargs != "");)
190 selected = car(hudargs); hudargs = cdr(hudargs);
191 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
192 switch(strtolower(selected))
194 #define ARG_CASE(prog,selected,result) \
195 #if (prog == ARG_TRIPLE) \
196 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
200 NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
203 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
207 void Local_Notification(float net_type, float net_name, ...count)
209 // check supplied type and name for errors
210 string checkargs = "";
211 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
212 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
213 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
216 CHECKARG_TYPENAME(INFO)
217 CHECKARG_TYPENAME(CENTER)
218 CHECKARG_TYPENAME(WEAPON)
219 CHECKARG_TYPENAME(DEATH)
220 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
222 #undef CHECKARG_TYPENAME
223 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
225 entity notif = Get_Notif_Ent(net_type, net_name);
226 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
227 if not(notif.nent_enabled) { print("Local_Notification: Entity was disabled...\n"); return; }
229 if((notif.nent_stringcount + notif.nent_floatcount) > count)
233 "Not enough 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));
240 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
244 "Too many arguments for Local_Notification! ",
245 "stringcount(%d) + floatcount(%d) < count(%d)\n",
246 "Check the definition and function call for accuracy...?\n"
248 notif.nent_stringcount, notif.nent_floatcount, count));
252 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
253 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
254 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
255 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
256 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
257 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
258 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
259 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
261 #ifdef NOTIFICATIONS_DEBUG
263 sprintf("Local_Notification(%d, %s, %s, %s);\n",
266 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
267 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
277 Local_Notification_sprintf(
284 if(notif.nent_icon != "")
286 Local_Notification_HUD_Notify_Push(
300 Local_Notification_sprintf(
313 if(notif.nent_msginfo)
314 if(notif.nent_msginfo.nent_enabled)
316 Local_Notification_WOVA(
318 notif.nent_msginfo.nent_id,
319 notif.nent_msginfo.nent_stringcount,
320 notif.nent_msginfo.nent_floatcount,
325 if(notif.nent_msgcenter)
326 if(notif.nent_msgcenter.nent_enabled)
328 Local_Notification_WOVA(
330 notif.nent_msgcenter.nent_id,
331 notif.nent_msgcenter.nent_stringcount,
332 notif.nent_msgcenter.nent_floatcount,
342 // WOVA = Without Variable Arguments
343 void Local_Notification_WOVA(float net_type, float net_name,
344 float stringcount, float floatcount,
345 string s1, string s2, string s3, string s4,
346 float f1, float f2, float f3, float f4)
348 #define VARITEM(stringc,floatc,args) \
349 if((stringcount == stringc) && (floatcount == floatc)) \
350 { Local_Notification(net_type, net_name, args); return; }
351 EIGHT_VARS_TO_VARARGS_VARLIST
353 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
357 // =========================
358 // Notification Networking
359 // =========================
362 void Read_Notification(float is_new)
364 float net_type = ReadByte();
365 float net_name = ReadShort();
367 entity notif = Get_Notif_Ent(net_type, net_name);
368 if not(notif) { print("Read_Notification: Could not find notification entity!\n"); return; }
370 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
371 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
372 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
373 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
374 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
375 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
376 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
377 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
379 #ifdef NOTIFICATIONS_DEBUG
380 dprint(sprintf("Read_Notification(%d) at %f: net_name = %s.\n", is_new, time, notif.nent_name));
385 Local_Notification_WOVA(
387 notif.nent_stringcount,
388 notif.nent_floatcount,
396 void Net_Notification_Remove()
399 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
403 float Net_Write_Notification(entity client, float sf)
405 float i, send = FALSE;
407 switch(self.nent_broadcast)
409 case NOTIF_ONE: // send to one client and their spectator
412 (client == self.nent_client)
415 (client.classname == STR_SPECTATOR)
417 (client.enemy == self.nent_client)
422 case NOTIF_ONE_ONLY: // send ONLY to one client
424 if(client == self.nent_client) { send = TRUE; }
427 case NOTIF_TEAM: // send only to X team and their spectators
430 (client.team == self.nent_client.team)
433 (client.classname == STR_SPECTATOR)
435 (client.enemy.team == self.nent_client.team)
440 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
443 (client != self.nent_client)
446 (client.team == self.nent_client.team)
449 (client.classname == STR_SPECTATOR)
452 (client.enemy != self.nent_client)
454 (client.enemy.team == self.nent_client.team)
461 case NOTIF_ANY: // send to everyone
466 case NOTIF_ANY_EXCEPT: // send to everyone except X person and their spectators
469 (client != self.nent_client)
472 (client.classname == STR_SPECTATOR)
474 (client.enemy == self.nent_client)
479 default: { send = FALSE; break; }
484 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
485 WriteByte(MSG_ENTITY, self.nent_net_type);
486 WriteShort(MSG_ENTITY, self.nent_net_name);
487 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
488 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
494 void Send_Notification(float broadcast, entity client,
495 float net_type, float net_name, ...count)
497 // check supplied broadcast, target, type, and name for errors
498 string checkargs = "";
499 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
500 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
501 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
504 CHECKARG_TYPENAME(INFO)
505 CHECKARG_TYPENAME(CENTER)
506 CHECKARG_TYPENAME(WEAPON)
507 CHECKARG_TYPENAME(DEATH)
508 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
510 #undef CHECKARG_TYPENAME
511 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
517 if(IS_NOT_A_CLIENT(client))
518 { checkargs = sprintf("%sNo client provided!", checkargs); }
522 case NOTIF_ANY_EXCEPT:
524 if(IS_NOT_A_CLIENT(client))
525 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
532 { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
537 case NOTIF_TEAM_EXCEPT:
539 if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
540 else if(IS_NOT_A_CLIENT(client))
542 if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
543 else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
548 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
550 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
552 // retreive counts for the arguments of this notification
553 entity notif = Get_Notif_Ent(net_type, net_name);
554 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
556 if((notif.nent_stringcount + notif.nent_floatcount) > count)
560 "Not enough 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));
567 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
571 "Too many arguments for Send_Notification! ",
572 "stringcount(%d) + floatcount(%d) < count(%d)\n",
573 "Check the definition and function call for accuracy...?\n"
575 notif.nent_stringcount, notif.nent_floatcount, count));
579 #ifdef NOTIFICATIONS_DEBUG
581 sprintf("Send_Notification(%d, %d, %s, stringcount: %d, floatcount: %d, varargs: %d);\n",
585 notif.nent_stringcount,
586 notif.nent_floatcount,
592 entity net_notif = spawn();
593 net_notif.nent_broadcast = broadcast;
594 net_notif.nent_client = client;
595 net_notif.nent_net_type = net_type;
596 net_notif.nent_net_name = net_name;
597 net_notif.nent_stringcount = notif.nent_stringcount;
598 net_notif.nent_floatcount = notif.nent_floatcount;
601 for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
602 for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
604 net_notif.think = Net_Notification_Remove;
605 net_notif.nextthink = (time + 0.5);
607 Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
609 if((!server_is_local) && (broadcast == NOTIF_ANY || broadcast == NOTIF_ANY_EXCEPT) && (net_type != MSG_CENTER))
611 Local_Notification_WOVA(
613 notif.nent_stringcount,
614 notif.nent_floatcount,
615 IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3),
616 IFFL(0), IFFL(1), IFFL(2), IFFL(3));
620 // WOVA = Without Variable Arguments
621 void Send_Notification_WOVA(float broadcast, entity client,
622 float net_type, float net_name,
623 string s1, string s2, string s3, string s4,
624 float f1, float f2, float f3, float f4)
626 entity notif = Get_Notif_Ent(net_type, net_name);
627 #define VARITEM(stringc,floatc,args) \
628 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
629 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
630 EIGHT_VARS_TO_VARARGS_VARLIST
632 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
636 // =============================
637 // LEGACY NOTIFICATION SYSTEMS
638 // =============================
640 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
642 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
645 WRITESPECTATABLE_MSG_ONE({
646 WriteByte(MSG_ONE, SVC_TEMPENTITY);
647 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
648 WriteByte(MSG_ONE, id);
649 WriteString(MSG_ONE, s);
650 if (id != 0 && s != "")
652 WriteByte(MSG_ONE, duration);
653 WriteByte(MSG_ONE, countdown_num);