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 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, e.nent_string); }
75 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT), "");
76 for(i = 0; i < NOTIF_CENTER_COUNT; ++i) {
77 e = Get_Notif_Ent(MSG_CENTER, i);
78 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, e.nent_string); }
80 NOTIF_WRITE(sprintf("\n// MSG_WEAPON notifications (count = %d):\n", NOTIF_WEAPON_COUNT), "");
81 for(i = 0; i < NOTIF_WEAPON_COUNT; ++i) {
82 e = Get_Notif_Ent(MSG_WEAPON, i);
83 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, sprintf("infoname: %s, centername: %s",
84 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name)); }
86 NOTIF_WRITE(sprintf("\n// MSG_DEATH notifications (count = %d):\n", NOTIF_DEATH_COUNT), "");
87 for(i = 0; i < NOTIF_DEATH_COUNT; ++i) {
88 e = Get_Notif_Ent(MSG_DEATH, i);
89 NOTIF_WRITE_SETA(e.nent_name, e.nent_default, sprintf("infoname: %s, centername: %s",
90 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name)); }
92 // edit these to match whichever cvars are used for specific notification options
93 NOTIF_WRITE("\n// HARD CODED notification variables:\n", "");
94 NOTIF_WRITE("seta notification_errors_are_fatal 1 \"If a notification fails upon initialization, cause a Host_Error to stop the program\"\n", "");
95 NOTIF_WRITE("seta notification_ctf_pickup_team_verbose 1 \"Show extra information if a team mate picks up a flag\"\n", "");
96 NOTIF_WRITE("seta notification_ctf_pickup_enemy_verbose 1 \"Show extra information if an enemy picks up a flag\"\n", "");
97 NOTIF_WRITE("seta notification_ctf_capture_verbose 1 \"Show extra information when someone captures a flag\"\n", "");
98 NOTIF_WRITE("seta notification_frag_verbose 1 \"Show extra information when you frag someone (or when you are fragged\"\n", "");
100 NOTIF_WRITE(sprintf("\n// Notification counts (total = %d): MSG_INFO = %d, MSG_CENTER = %d, MSG_WEAPON = %d, MSG_DEATH = %d\n",
101 (NOTIF_INFO_COUNT + NOTIF_CENTER_COUNT + NOTIF_WEAPON_COUNT + NOTIF_DEATH_COUNT),
102 NOTIF_INFO_COUNT, NOTIF_CENTER_COUNT, NOTIF_WEAPON_COUNT, NOTIF_DEATH_COUNT), "");
105 #undef NOTIF_WRITE_SETA
109 string Local_Notification_sprintf(string input, string args,
110 string s1, string s2, string s3, string s4,
111 float f1, float f2, float f3, float f4)
113 #ifdef NOTIFICATIONS_DEBUG
115 sprintf("Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
116 strreplace("\n", "\\n", input),
118 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
119 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
126 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
132 for(sel_num = 0;(args != "");)
134 selected = car(args); args = cdr(args);
135 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
136 switch(strtolower(selected))
138 #define ARG_CASE(prog,selected,result) \
140 #if (prog == ARG_BOTH) || (prog == ARG_TRIPLE) || (prog == ARG_CSQC) \
141 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
144 #if (prog == ARG_BOTH) || (prog == ARG_TRIPLE) || (prog == ARG_SVQC) \
145 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
150 NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
153 return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
157 void Local_Notification_HUD_Notify_Push(string icon, string hudargs, string s1, string s2, string s3, string s4)
161 arg_slot[0] = ""; arg_slot[1] = "";
163 for(sel_num = 0;(hudargs != "");)
165 selected = car(hudargs); hudargs = cdr(hudargs);
166 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
167 switch(strtolower(selected))
169 #define ARG_CASE(prog,selected,result) \
170 #if (prog == ARG_TRIPLE) \
171 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
175 NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
178 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
182 void Local_Notification(float net_type, float net_name, ...count)
184 // check supplied type and name for errors
185 string checkargs = "";
186 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
187 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
188 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
191 CHECKARG_TYPENAME(INFO)
192 CHECKARG_TYPENAME(CENTER)
193 CHECKARG_TYPENAME(WEAPON)
194 CHECKARG_TYPENAME(DEATH)
195 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
197 #undef CHECKARG_TYPENAME
198 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
200 entity notif = Get_Notif_Ent(net_type, net_name);
201 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
202 if not(notif.nent_enabled) { print("Local_Notification: Entity was disabled...\n"); return; }
204 if((notif.nent_stringcount + notif.nent_floatcount) > count)
208 "Not enough arguments for Local_Notification! ",
209 "stringcount(%d) + floatcount(%d) > count(%d)\n",
210 "Check the definition and function call for accuracy...?\n"
212 notif.nent_stringcount, notif.nent_floatcount, count));
215 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
219 "Too many 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));
227 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
228 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
229 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
230 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
231 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
232 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
233 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
234 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
236 #ifdef NOTIFICATIONS_DEBUG
238 sprintf("Local_Notification(%d, %s, %s, %s);\n",
241 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
242 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
252 Local_Notification_sprintf(
259 if(notif.nent_icon != "")
261 Local_Notification_HUD_Notify_Push(
275 Local_Notification_sprintf(
288 if(notif.nent_msginfo)
289 if(notif.nent_msginfo.nent_enabled)
291 Local_Notification_Without_VarArgs(
293 notif.nent_msginfo.nent_id,
294 notif.nent_msginfo.nent_stringcount,
295 notif.nent_msginfo.nent_floatcount,
300 if(notif.nent_msgcenter)
301 if(notif.nent_msgcenter.nent_enabled)
303 Local_Notification_Without_VarArgs(
305 notif.nent_msgcenter.nent_id,
306 notif.nent_msgcenter.nent_stringcount,
307 notif.nent_msgcenter.nent_floatcount,
317 void Local_Notification_Without_VarArgs(float net_type, float net_name,
318 float stringcount, float floatcount,
319 string s1, string s2, string s3, string s4,
320 float f1, float f2, float f3, float f4)
322 #define VARITEM(stringc,floatc,args) \
323 if((stringcount == stringc) && (floatcount == floatc)) \
324 { Local_Notification(net_type, net_name, args); return; }
325 EIGHT_VARS_TO_VARARGS_VARLIST
327 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
331 // =========================
332 // Notification Networking
333 // =========================
336 void Read_Notification(float is_new)
338 float net_type = ReadByte();
339 float net_name = ReadShort();
341 entity notif = Get_Notif_Ent(net_type, net_name);
342 if not(notif) { print("Read_Notification: Could not find notification entity!\n"); return; }
344 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
345 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
346 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
347 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
348 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
349 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
350 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
351 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
353 #ifdef NOTIFICATIONS_DEBUG
354 dprint(sprintf("Read_Notification(%d) at %f: net_name = %s.\n", is_new, time, notif.nent_name));
359 Local_Notification_Without_VarArgs(
361 notif.nent_stringcount,
362 notif.nent_floatcount,
370 void Net_Notification_Remove()
373 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
377 float Net_Write_Notification(entity client, float sf)
379 float i, send = FALSE;
381 switch(self.nent_broadcast)
383 case NOTIF_ONE: // send to one client and their spectator
386 (client == self.nent_client)
389 (client.classname == STR_SPECTATOR)
391 (client.enemy == self.nent_client)
396 case NOTIF_ONE_ONLY: // send ONLY to one client
398 if(client == self.nent_client) { send = TRUE; }
401 case NOTIF_TEAM: // send only to X team and their spectators
404 (client.team == self.nent_client.team)
407 (client.classname == STR_SPECTATOR)
409 (client.enemy.team == self.nent_client.team)
414 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
417 (client != self.nent_client)
420 (client.team == self.nent_client.team)
423 (client.classname == STR_SPECTATOR)
426 (client.enemy != self.nent_client)
428 (client.enemy.team == self.nent_client.team)
435 case NOTIF_ANY: // send to everyone
440 case NOTIF_ANY_EXCEPT: // send to everyone except X person and their spectators
443 (client != self.nent_client)
446 (client.classname == STR_SPECTATOR)
448 (client.enemy == self.nent_client)
453 default: { send = FALSE; break; }
458 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
459 WriteByte(MSG_ENTITY, self.nent_net_type);
460 WriteShort(MSG_ENTITY, self.nent_net_name);
461 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
462 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
468 void Send_Notification(float broadcast, entity client,
469 float net_type, float net_name, ...count)
471 // check supplied broadcast, target, type, and name for errors
472 string checkargs = "";
473 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
474 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
475 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
478 CHECKARG_TYPENAME(INFO)
479 CHECKARG_TYPENAME(CENTER)
480 CHECKARG_TYPENAME(WEAPON)
481 CHECKARG_TYPENAME(DEATH)
482 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
484 #undef CHECKARG_TYPENAME
485 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
491 if(IS_NOT_A_CLIENT(client))
492 { checkargs = sprintf("%sNo client provided!", checkargs); }
496 case NOTIF_ANY_EXCEPT:
498 if(IS_NOT_A_CLIENT(client))
499 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
506 { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
511 case NOTIF_TEAM_EXCEPT:
513 if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
514 else if(IS_NOT_A_CLIENT(client))
516 if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
517 else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
522 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
524 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
526 // retreive counts for the arguments of this notification
527 entity notif = Get_Notif_Ent(net_type, net_name);
528 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
530 if((notif.nent_stringcount + notif.nent_floatcount) > count)
534 "Not enough arguments for Send_Notification! ",
535 "stringcount(%d) + floatcount(%d) > count(%d)\n",
536 "Check the definition and function call for accuracy...?\n"
538 notif.nent_stringcount, notif.nent_floatcount, count));
541 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
545 "Too many arguments for Send_Notification! ",
546 "stringcount(%d) + floatcount(%d) < count(%d)\n",
547 "Check the definition and function call for accuracy...?\n"
549 notif.nent_stringcount, notif.nent_floatcount, count));
553 #ifdef NOTIFICATIONS_DEBUG
555 sprintf("Send_Notification(%d, %d, %s, stringcount: %d, floatcount: %d, varargs: %d);\n",
559 notif.nent_stringcount,
560 notif.nent_floatcount,
566 entity net_notif = spawn();
567 net_notif.nent_broadcast = broadcast;
568 net_notif.nent_client = client;
569 net_notif.nent_net_type = net_type;
570 net_notif.nent_net_name = net_name;
571 net_notif.nent_stringcount = notif.nent_stringcount;
572 net_notif.nent_floatcount = notif.nent_floatcount;
575 for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
576 for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
578 net_notif.think = Net_Notification_Remove;
579 net_notif.nextthink = (time + 0.5);
581 Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
583 if((!server_is_local) && (broadcast == NOTIF_ANY || broadcast == NOTIF_ANY_EXCEPT) && (net_type != MSG_CENTER))
585 Local_Notification_Without_VarArgs(
587 notif.nent_stringcount,
588 notif.nent_floatcount,
589 IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3),
590 IFFL(0), IFFL(1), IFFL(2), IFFL(3));
594 void Send_Notification_Without_VarArgs(float broadcast, entity client,
595 float net_type, float net_name,
596 float stringcount, float floatcount,
597 string s1, string s2, string s3, string s4,
598 float f1, float f2, float f3, float f4)
600 #define VARITEM(stringc,floatc,args) \
601 if((stringcount == stringc) && (floatcount == floatc)) \
602 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
603 EIGHT_VARS_TO_VARARGS_VARLIST
605 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
608 void Send_Notification_Legacy_Wrapper(float broadcast, entity client,
609 float net_type, float net_name,
610 string s1, string s2,
611 float f1, float f2, float f3)
613 entity notif = Get_Notif_Ent(net_type, net_name);
614 Send_Notification_Without_VarArgs(
617 notif.nent_stringcount,
618 notif.nent_floatcount,
624 // =============================
625 // LEGACY NOTIFICATION SYSTEMS
626 // =============================
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);
646 void Send_CSQC_Centerprint_Generic_Expire(entity e, float id)
648 Send_CSQC_Centerprint_Generic(e, id, "", 1, 0);