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) { \
34 notif_msg = sprintf("seta notification_%s %d \"notif string: %s\"\n", name, default, strreplace("\n", "\\n", text)); \
35 NOTIF_WRITE(notif_msg, strreplace("^", "^^", 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 = 0; 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 = 0; 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 = 0; 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 = 0; 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_errors_are_fatal 1 \"If a notification fails upon initialization, cause a Host_Error to stop the program\"\n", "");
99 NOTIF_WRITE("seta notification_ctf_pickup_team_verbose 1 \"Show extra information if a team mate picks up a flag\"\n", "");
100 NOTIF_WRITE("seta notification_ctf_pickup_enemy_verbose 1 \"Show extra information if an enemy picks up a flag\"\n", "");
101 NOTIF_WRITE("seta notification_ctf_capture_verbose 1 \"Show extra information when someone captures a flag\"\n", "");
102 NOTIF_WRITE("seta notification_frag_verbose 1 \"Show extra information when you frag someone (or when you are fragged\"\n", "");
104 NOTIF_WRITE(sprintf("\n// Notification counts (total = %d): MSG_INFO = %d, MSG_CENTER = %d, MSG_WEAPON = %d, MSG_DEATH = %d\n",
105 (NOTIF_INFO_COUNT + NOTIF_CENTER_COUNT + NOTIF_WEAPON_COUNT + NOTIF_DEATH_COUNT),
106 NOTIF_INFO_COUNT, NOTIF_CENTER_COUNT, NOTIF_WEAPON_COUNT, NOTIF_DEATH_COUNT), "");
109 #undef NOTIF_WRITE_SETA
114 void Notification_GetCvars()
116 GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
120 string Local_Notification_sprintf(string input, string args,
121 string s1, string s2, string s3, string s4,
122 float f1, float f2, float f3, float f4)
124 #ifdef NOTIFICATIONS_DEBUG
126 sprintf("Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
127 strreplace("\n", "\\n", input),
129 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
130 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
137 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
143 for(sel_num = 0;(args != "");)
145 selected = car(args); args = cdr(args);
146 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
147 switch(strtolower(selected))
149 #define ARG_CASE(prog,selected,result) \
151 #if (prog == ARG_DOUBLE) || (prog == ARG_TRIPLE) || (prog == ARG_CSQC) \
152 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
155 #if (prog == ARG_DOUBLE) || (prog == ARG_TRIPLE) || (prog == ARG_SVQC) \
156 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
161 NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
164 return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
168 void Local_Notification_HUD_Notify_Push(string icon, string hudargs, string s1, string s2, string s3, string s4)
172 arg_slot[0] = ""; arg_slot[1] = "";
174 for(sel_num = 0;(hudargs != "");)
176 selected = car(hudargs); hudargs = cdr(hudargs);
177 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
178 switch(strtolower(selected))
180 #define ARG_CASE(prog,selected,result) \
181 #if (prog == ARG_TRIPLE) \
182 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
186 NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
189 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
193 void Local_Notification(float net_type, float net_name, ...count)
195 // check supplied type and name for errors
196 string checkargs = "";
197 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
198 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
199 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
202 CHECKARG_TYPENAME(INFO)
203 CHECKARG_TYPENAME(CENTER)
204 CHECKARG_TYPENAME(WEAPON)
205 CHECKARG_TYPENAME(DEATH)
206 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
208 #undef CHECKARG_TYPENAME
209 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
211 entity notif = Get_Notif_Ent(net_type, net_name);
212 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
213 if not(notif.nent_enabled) { print("Local_Notification: Entity was disabled...\n"); return; }
215 if((notif.nent_stringcount + notif.nent_floatcount) > count)
219 "Not enough arguments for Local_Notification! ",
220 "stringcount(%d) + floatcount(%d) > count(%d)\n",
221 "Check the definition and function call for accuracy...?\n"
223 notif.nent_stringcount, notif.nent_floatcount, count));
226 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
230 "Too many arguments for Local_Notification! ",
231 "stringcount(%d) + floatcount(%d) < count(%d)\n",
232 "Check the definition and function call for accuracy...?\n"
234 notif.nent_stringcount, notif.nent_floatcount, count));
238 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
239 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
240 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
241 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
242 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
243 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
244 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
245 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
247 #ifdef NOTIFICATIONS_DEBUG
249 sprintf("Local_Notification(%d, %s, %s, %s);\n",
252 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
253 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
263 Local_Notification_sprintf(
270 if(notif.nent_icon != "")
272 Local_Notification_HUD_Notify_Push(
286 Local_Notification_sprintf(
299 if(notif.nent_msginfo)
300 if(notif.nent_msginfo.nent_enabled)
302 Local_Notification_WOVA(
304 notif.nent_msginfo.nent_id,
305 notif.nent_msginfo.nent_stringcount,
306 notif.nent_msginfo.nent_floatcount,
311 if(notif.nent_msgcenter)
312 if(notif.nent_msgcenter.nent_enabled)
314 Local_Notification_WOVA(
316 notif.nent_msgcenter.nent_id,
317 notif.nent_msgcenter.nent_stringcount,
318 notif.nent_msgcenter.nent_floatcount,
328 // WOVA = Without Variable Arguments
329 void Local_Notification_WOVA(float net_type, float net_name,
330 float stringcount, float floatcount,
331 string s1, string s2, string s3, string s4,
332 float f1, float f2, float f3, float f4)
334 #define VARITEM(stringc,floatc,args) \
335 if((stringcount == stringc) && (floatcount == floatc)) \
336 { Local_Notification(net_type, net_name, args); return; }
337 EIGHT_VARS_TO_VARARGS_VARLIST
339 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
343 // =========================
344 // Notification Networking
345 // =========================
348 void Read_Notification(float is_new)
350 float net_type = ReadByte();
351 float net_name = ReadShort();
353 entity notif = Get_Notif_Ent(net_type, net_name);
354 if not(notif) { print("Read_Notification: Could not find notification entity!\n"); return; }
356 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
357 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
358 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
359 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
360 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
361 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
362 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
363 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
365 #ifdef NOTIFICATIONS_DEBUG
366 dprint(sprintf("Read_Notification(%d) at %f: net_name = %s.\n", is_new, time, notif.nent_name));
371 Local_Notification_WOVA(
373 notif.nent_stringcount,
374 notif.nent_floatcount,
382 void Net_Notification_Remove()
385 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
389 float Net_Write_Notification(entity client, float sf)
391 float i, send = FALSE;
393 switch(self.nent_broadcast)
395 case NOTIF_ONE: // send to one client and their spectator
398 (client == self.nent_client)
401 (client.classname == STR_SPECTATOR)
403 (client.enemy == self.nent_client)
408 case NOTIF_ONE_ONLY: // send ONLY to one client
410 if(client == self.nent_client) { send = TRUE; }
413 case NOTIF_TEAM: // send only to X team and their spectators
416 (client.team == self.nent_client.team)
419 (client.classname == STR_SPECTATOR)
421 (client.enemy.team == self.nent_client.team)
426 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
429 (client != self.nent_client)
432 (client.team == self.nent_client.team)
435 (client.classname == STR_SPECTATOR)
438 (client.enemy != self.nent_client)
440 (client.enemy.team == self.nent_client.team)
447 case NOTIF_ANY: // send to everyone
452 case NOTIF_ANY_EXCEPT: // send to everyone except X person and their spectators
455 (client != self.nent_client)
458 (client.classname == STR_SPECTATOR)
460 (client.enemy == self.nent_client)
465 default: { send = FALSE; break; }
470 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
471 WriteByte(MSG_ENTITY, self.nent_net_type);
472 WriteShort(MSG_ENTITY, self.nent_net_name);
473 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
474 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
480 void Send_Notification(float broadcast, entity client,
481 float net_type, float net_name, ...count)
483 // check supplied broadcast, target, type, and name for errors
484 string checkargs = "";
485 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
486 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
487 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
490 CHECKARG_TYPENAME(INFO)
491 CHECKARG_TYPENAME(CENTER)
492 CHECKARG_TYPENAME(WEAPON)
493 CHECKARG_TYPENAME(DEATH)
494 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
496 #undef CHECKARG_TYPENAME
497 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
503 if(IS_NOT_A_CLIENT(client))
504 { checkargs = sprintf("%sNo client provided!", checkargs); }
508 case NOTIF_ANY_EXCEPT:
510 if(IS_NOT_A_CLIENT(client))
511 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
518 { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
523 case NOTIF_TEAM_EXCEPT:
525 if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
526 else if(IS_NOT_A_CLIENT(client))
528 if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
529 else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
534 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
536 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
538 // retreive counts for the arguments of this notification
539 entity notif = Get_Notif_Ent(net_type, net_name);
540 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
542 if((notif.nent_stringcount + notif.nent_floatcount) > count)
546 "Not enough arguments for Send_Notification! ",
547 "stringcount(%d) + floatcount(%d) > count(%d)\n",
548 "Check the definition and function call for accuracy...?\n"
550 notif.nent_stringcount, notif.nent_floatcount, count));
553 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
557 "Too many arguments for Send_Notification! ",
558 "stringcount(%d) + floatcount(%d) < count(%d)\n",
559 "Check the definition and function call for accuracy...?\n"
561 notif.nent_stringcount, notif.nent_floatcount, count));
565 #ifdef NOTIFICATIONS_DEBUG
567 sprintf("Send_Notification(%d, %d, %s, stringcount: %d, floatcount: %d, varargs: %d);\n",
571 notif.nent_stringcount,
572 notif.nent_floatcount,
578 entity net_notif = spawn();
579 net_notif.nent_broadcast = broadcast;
580 net_notif.nent_client = client;
581 net_notif.nent_net_type = net_type;
582 net_notif.nent_net_name = net_name;
583 net_notif.nent_stringcount = notif.nent_stringcount;
584 net_notif.nent_floatcount = notif.nent_floatcount;
587 for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
588 for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
590 net_notif.think = Net_Notification_Remove;
591 net_notif.nextthink = (time + 0.5);
593 Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
595 if((!server_is_local) && (broadcast == NOTIF_ANY || broadcast == NOTIF_ANY_EXCEPT) && (net_type != MSG_CENTER))
597 Local_Notification_WOVA(
599 notif.nent_stringcount,
600 notif.nent_floatcount,
601 IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3),
602 IFFL(0), IFFL(1), IFFL(2), IFFL(3));
606 // WOVA = Without Variable Arguments
607 void Send_Notification_WOVA(float broadcast, entity client,
608 float net_type, float net_name,
609 string s1, string s2, string s3, string s4,
610 float f1, float f2, float f3, float f4)
612 entity notif = Get_Notif_Ent(net_type, net_name);
613 #define VARITEM(stringc,floatc,args) \
614 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
615 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
616 EIGHT_VARS_TO_VARARGS_VARLIST
618 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
622 // =============================
623 // LEGACY NOTIFICATION SYSTEMS
624 // =============================
626 #define Send_CSQC_Centerprint_Generic_Expire(e,id) Send_CSQC_Centerprint_Generic(e, id, "", 1, 0)
628 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
630 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
633 WRITESPECTATABLE_MSG_ONE({
634 WriteByte(MSG_ONE, SVC_TEMPENTITY);
635 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
636 WriteByte(MSG_ONE, id);
637 WriteString(MSG_ONE, s);
638 if (id != 0 && s != "")
640 WriteByte(MSG_ONE, duration);
641 WriteByte(MSG_ONE, countdown_num);