4 #include "../dpdefs/progsdefs.qh"
5 #include "../dpdefs/dpextensions.qh"
6 #include "constants.qh"
8 #include "../server/autocvars.qh"
9 #include "../server/constants.qh"
10 #include "../server/defs.qh"
11 #include "notifications.qh"
12 #include "../server/mutators/mutators_include.qh"
15 // ================================================
16 // Unified notification system, written by Samual
17 // Last updated: August, 2013
18 // ================================================
20 string Get_Notif_TypeName(int net_type)
24 case MSG_ANNCE: return "MSG_ANNCE";
25 case MSG_INFO: return "MSG_INFO";
26 case MSG_CENTER: return "MSG_CENTER";
27 case MSG_CENTER_CPID: return "MSG_CENTER_CPID";
28 case MSG_MULTI: return "MSG_MULTI";
29 case MSG_CHOICE: return "MSG_CHOICE";
31 backtrace(sprintf("Get_Notif_TypeName(%d): Improper net type!\n", net_type));
35 entity Get_Notif_Ent(int net_type, int net_name)
39 case MSG_ANNCE: return msg_annce_notifs[net_name - 1];
40 case MSG_INFO: return msg_info_notifs[net_name - 1];
41 case MSG_CENTER: return msg_center_notifs[net_name - 1];
42 case MSG_MULTI: return msg_multi_notifs[net_name - 1];
43 case MSG_CHOICE: return msg_choice_notifs[net_name - 1];
45 backtrace(sprintf("Get_Notif_Ent(%d, %d): Improper net type!\n", net_type, net_name));
50 #ifdef NOTIFICATIONS_DEBUG
51 string Get_Notif_BroadcastName(float broadcast)
55 case NOTIF_ONE: return "NOTIF_ONE";
56 case NOTIF_ONE_ONLY: return "NOTIF_ONE_ONLY";
57 case NOTIF_ALL_EXCEPT: return "NOTIF_ALL_EXCEPT";
58 case NOTIF_ALL: return "NOTIF_ALL";
59 case NOTIF_TEAM: return "NOTIF_TEAM";
60 case NOTIF_TEAM_EXCEPT: return "NOTIF_TEAM_EXCEPT";
62 backtrace(sprintf("Get_Notif_BroadcastName(%d): Improper broadcast!\n", broadcast));
68 string Notification_CheckArgs_TypeName(float net_type, float net_name)
70 // check supplied type and name for errors
71 string checkargs = "";
72 #define CHECKARG_TYPENAME(type) case MSG_##type: \
73 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
74 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
77 CHECKARG_TYPENAME(ANNCE)
78 CHECKARG_TYPENAME(INFO)
79 CHECKARG_TYPENAME(CENTER)
80 CHECKARG_TYPENAME(MULTI)
81 CHECKARG_TYPENAME(CHOICE)
82 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
84 #undef CHECKARG_TYPENAME
89 string Notification_CheckArgs(
90 float broadcast, entity client,
91 float net_type, float net_name)
93 // check supplied broadcast, target, type, and name for errors
94 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
95 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
101 if(IS_NOT_A_CLIENT(client))
102 { checkargs = sprintf("%sNo client provided!", checkargs); }
106 case NOTIF_ALL_EXCEPT:
108 if(IS_NOT_A_CLIENT(client))
109 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
116 { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
123 { checkargs = sprintf("%sTeamplay not active!", checkargs); }
124 //else if (!client.team) { checkargs = sprintf("%sNo team provided!", checkargs); }
128 case NOTIF_TEAM_EXCEPT:
131 { checkargs = sprintf("%sTeamplay not active!", checkargs); }
132 else if(IS_NOT_A_CLIENT(client))
133 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
137 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
142 float Notification_ShouldSend(float broadcast, entity to_client, entity other_client)
146 case NOTIF_ONE: // send to one client and their spectator
149 (to_client == other_client)
154 (to_client.enemy == other_client)
159 case NOTIF_ONE_ONLY: // send ONLY to one client
161 if(to_client == other_client) { return true; }
164 case NOTIF_TEAM: // send only to X team and their spectators
167 (to_client.team == other_client.team)
172 (to_client.enemy.team == other_client.team)
177 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
180 (to_client != other_client)
183 (to_client.team == other_client.team)
189 (to_client.enemy != other_client)
191 (to_client.enemy.team == other_client.team)
198 case NOTIF_ALL: // send to everyone
202 case NOTIF_ALL_EXCEPT: // send to everyone except X person and their spectators
205 (to_client != other_client)
210 (to_client.enemy == other_client)
221 // ===============================
222 // Initialization Core Functions
223 // ===============================
225 // used by restartnotifs command to initialize notifications
226 void Destroy_Notification_Entity(entity notif)
228 if(notif.nent_name != "") { strunzone(notif.nent_name); }
229 if(notif.nent_snd != "") { strunzone(notif.nent_snd); }
230 if(notif.nent_args != "") { strunzone(notif.nent_args); }
231 if(notif.nent_hudargs != "") { strunzone(notif.nent_hudargs); }
232 if(notif.nent_icon != "") { strunzone(notif.nent_icon); }
233 if(notif.nent_durcnt != "") { strunzone(notif.nent_durcnt); }
234 if(notif.nent_string != "") { strunzone(notif.nent_string); }
238 void Destroy_All_Notifications(void)
243 #define DESTROY_LOOP(type,count) do { \
244 for(i = 1; i <= count; ++i) \
246 notif = Get_Notif_Ent(type, i); \
247 if (!notif) { backtrace("Destroy_All_Notifications(): Missing notification entity!\n"); return; } \
248 Destroy_Notification_Entity(notif); \
252 // kill all networked notifications and centerprints
254 Kill_Notification(NOTIF_ALL, world, 0, 0);
256 reset_centerprint_messages();
259 // kill all real notification entities
260 DESTROY_LOOP(MSG_ANNCE, NOTIF_ANNCE_COUNT);
261 DESTROY_LOOP(MSG_INFO, NOTIF_INFO_COUNT);
262 DESTROY_LOOP(MSG_CENTER, NOTIF_CENTER_COUNT);
263 DESTROY_LOOP(MSG_MULTI, NOTIF_MULTI_COUNT);
264 DESTROY_LOOP(MSG_CHOICE, NOTIF_CHOICE_COUNT);
268 string Process_Notif_Line(
277 if(typeId == MSG_INFO)
279 if((chat && autocvar_notification_allow_chatboxprint)
280 || (autocvar_notification_allow_chatboxprint == 2))
282 // pass 1: add ETX char at beginning of line
283 input = strcat("\{3}", input);
285 // pass 2: add ETX char at end of each new line (so that
286 // messages with multiple lines are put through chatbox too)
287 input = strreplace("\n", "\n\{3}", input);
289 // pass 3: strip trailing ETX char
290 if(substring(input, (strlen(input) - 1), 1) == "\{3}")
291 { input = substring(input, 0, (strlen(input) - 1)); }
296 // done to both MSG_INFO and MSG_CENTER
297 if(substring(input, (strlen(input) - 1), 1) == "\n")
301 "^1TRAILING NEW LINE AT END OF NOTIFICATION: ",
302 "^7net_type = %s, net_name = %s, string = %s.\n"
309 input = substring(input, 1, (strlen(input) - 1));
315 string Process_Notif_Args(
321 string selected, remaining = args;
324 for (;(remaining != "");)
326 selected = car(remaining); remaining = cdr(remaining);
330 case 1: // normal args
332 if(sel_num == NOTIF_MAX_ARGS)
336 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
337 "^7net_type = %s, net_name = %s, max args = %d.\n"
347 switch(strtolower(selected))
349 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { ++sel_num; break; }
350 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { ++sel_num; break; }
351 #define ARG_CASE_ARG_CS_SV(selected,result) case selected: { ++sel_num; break; }
352 #define ARG_CASE_ARG_CS(selected,result) case selected: { ++sel_num; break; }
353 #define ARG_CASE_ARG_SV(selected,result) case selected: { ++sel_num; break; }
354 #define ARG_CASE_ARG_DC(selected,result)
355 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
358 #undef ARG_CASE_ARG_DC
359 #undef ARG_CASE_ARG_SV
360 #undef ARG_CASE_ARG_CS
361 #undef ARG_CASE_ARG_CS_SV
362 #undef ARG_CASE_ARG_CS_SV_DC
363 #undef ARG_CASE_ARG_CS_SV_HA
368 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
369 "^7net_type = %s, net_name = %s, args arg = '%s'.\n"
383 if(sel_num == NOTIF_MAX_HUDARGS)
387 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
388 "^7net_type = %s, net_name = %s, max hudargs = %d.\n"
398 switch(strtolower(selected))
400 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { ++sel_num; break; }
401 #define ARG_CASE_ARG_CS_SV_DC(selected,result)
402 #define ARG_CASE_ARG_CS_SV(selected,result)
403 #define ARG_CASE_ARG_CS(selected,result)
404 #define ARG_CASE_ARG_SV(selected,result)
405 #define ARG_CASE_ARG_DC(selected,result)
406 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
409 #undef ARG_CASE_ARG_DC
410 #undef ARG_CASE_ARG_SV
411 #undef ARG_CASE_ARG_CS
412 #undef ARG_CASE_ARG_CS_SV
413 #undef ARG_CASE_ARG_CS_SV_DC
414 #undef ARG_CASE_ARG_CS_SV_HA
419 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
420 "^7net_type = %s, net_name = %s, hudargs arg = '%s'.\n"
434 if(sel_num == NOTIF_MAX_DURCNT)
438 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
439 "^7net_type = %s, net_name = %s, max durcnt = %d.\n"
449 switch(strtolower(selected))
451 #define ARG_CASE_ARG_CS_SV_HA(selected,result)
452 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { ++sel_num; break; }
453 #define ARG_CASE_ARG_CS_SV(selected,result)
454 #define ARG_CASE_ARG_CS(selected,result)
455 #define ARG_CASE_ARG_SV(selected,result)
456 #define ARG_CASE_ARG_DC(selected,result) case selected: { ++sel_num; break; }
457 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
460 #undef ARG_CASE_ARG_DC
461 #undef ARG_CASE_ARG_SV
462 #undef ARG_CASE_ARG_CS
463 #undef ARG_CASE_ARG_CS_SV
464 #undef ARG_CASE_ARG_CS_SV_DC
465 #undef ARG_CASE_ARG_CS_SV_HA
468 if(ftos(stof(selected)) != "") { ++sel_num; }
473 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
474 "^7net_type = %s, net_name = %s, durcnt arg = '%s'.\n"
492 void Create_Notification_Entity(
505 /* MSG_INFO & MSG_CENTER */
524 // =====================
525 // Global Entity Setup
526 // =====================
527 entity notif = spawn();
532 msg_annce_notifs[nameid - 1] = notif;
533 notif.classname = "msg_annce_notification";
538 msg_info_notifs[nameid - 1] = notif;
539 notif.classname = "msg_info_notification";
544 msg_center_notifs[nameid - 1] = notif;
545 notif.classname = "msg_center_notification";
550 msg_multi_notifs[nameid - 1] = notif;
551 notif.classname = "msg_multi_notification";
556 msg_choice_notifs[nameid - 1] = notif;
557 notif.classname = "msg_choice_notification";
565 "^1NOTIFICATION WITH IMPROPER TYPE: ",
566 "^7net_type = %d, net_name = %s.\n"
571 return; // It's not possible to recover from this one
574 notif.nent_default = var_default;
575 notif.nent_enabled = (1 <= var_cvar);
576 notif.nent_type = typeId;
577 notif.nent_id = nameid;
578 notif.nent_name = strzone(namestring);
580 string typestring = Get_Notif_TypeName(typeId);
582 // Other pre-notif-setup requisites
585 // ====================
586 // Notification Setup
587 // ====================
592 // Set MSG_ANNCE information and handle precaching
594 if (!(GENTLE && (var_cvar == 1)))
598 if(notif.nent_enabled)
600 precache_sound(sprintf("announcer/%s/%s.wav", autocvar_cl_announcer, snd));
601 notif.nent_channel = channel;
602 notif.nent_snd = strzone(snd);
603 notif.nent_vol = vol;
604 notif.nent_position = position;
611 "^1NOTIFICATION WITH NO SOUND: ",
612 "^7net_type = %s, net_name = %s.\n"
620 else { notif.nent_enabled = false; }
622 notif.nent_enabled = false;
631 // Set MSG_INFO and MSG_CENTER string/float counts
632 notif.nent_stringcount = strnum;
633 notif.nent_floatcount = flnum;
635 // Only initialize arguments if we're either a client or on a dedicated server
637 float should_process_args = server_is_dedicated;
639 float should_process_args = true;
642 if(should_process_args)
644 // ========================
645 // Process Main Arguments
646 // ========================
651 notif.nent_args = strzone(
652 Process_Notif_Args(1, args, typestring, namestring));
654 else if((hudargs == "") && (durcnt ==""))
658 "^1NOTIFICATION HAS ARG COUNTS BUT NO ARGS OR HUDARGS OR DURCNT: ",
659 "^7net_type = %s, net_name = %s, strnum = %d, flnum = %d\n"
671 notif.nent_args = strzone(
672 Process_Notif_Args(1, args, typestring, namestring));
676 // =======================================
677 // Process HUD and Centerprint Arguments
678 // Only processed on CSQC, as these
679 // args are only for HUD features.
680 // =======================================
684 notif.nent_hudargs = strzone(
685 Process_Notif_Args(2, hudargs, typestring, namestring));
687 if(icon != "") { notif.nent_icon = strzone(icon); }
692 "^1NOTIFICATION HAS HUDARGS BUT NO ICON: ",
693 "^7net_type = %s, net_name = %s.\n"
705 "^1NOTIFICATION HAS ICON BUT NO HUDARGS: ",
706 "^7net_type = %s, net_name = %s.\n"
716 notif.nent_durcnt = strzone(
717 Process_Notif_Args(3, durcnt, typestring, namestring));
719 if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
724 "^1NOTIFICATION HAS DURCNT BUT NO CPID: ",
725 "^7net_type = %s, net_name = %s.\n"
733 else if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
737 // ======================
738 // Process Notif String
739 // ======================
740 #define SET_NOTIF_STRING(string,stringname) do { \
741 notif.nent_string = strzone(CCR( \
742 Process_Notif_Line( \
755 if(gentle != "") { SET_NOTIF_STRING(gentle, "GENTLE"); }
756 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL"); }
758 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL"); }
759 #undef SET_NOTIF_STRING
761 // Check to make sure a string was chosen
762 if(notif.nent_string == "")
766 "^1EMPTY NOTIFICATION: ",
767 "^7net_type = %s, net_name = %s.\n"
781 // Set MSG_MULTI string/float counts
782 if((anncename == NO_MSG) && (infoname == NO_MSG) && (centername == NO_MSG))
786 "^1NOTIFICATION WITH NO SUBCALLS: ",
787 "^7net_type = %s, net_name = %s.\n"
796 // announcements don't actually need any arguments, so lets not even count them.
797 if(anncename != NO_MSG) { notif.nent_msgannce = msg_annce_notifs[anncename - 1]; }
799 float infoname_stringcount = 0, infoname_floatcount = 0;
800 float centername_stringcount = 0, centername_floatcount = 0;
802 if(infoname != NO_MSG)
804 notif.nent_msginfo = msg_info_notifs[infoname - 1];
805 infoname_stringcount = notif.nent_msginfo.nent_stringcount;
806 infoname_floatcount = notif.nent_msginfo.nent_floatcount;
809 if(centername != NO_MSG)
811 notif.nent_msgcenter = msg_center_notifs[centername - 1];
812 centername_stringcount = notif.nent_msgcenter.nent_stringcount;
813 centername_floatcount = notif.nent_msgcenter.nent_floatcount;
816 // set the requirements of THIS notification to the totals of its subcalls
817 notif.nent_stringcount = max(infoname_stringcount, centername_stringcount);
818 notif.nent_floatcount = max(infoname_floatcount, centername_floatcount);
826 if((chtype == NO_MSG) || (optiona == NO_MSG) || (optionb == NO_MSG))
830 "^1NOTIFICATION IS MISSING CHOICE PARAMS: ",
831 "^7net_type = %s, net_name = %s.\n"
844 notif.nent_optiona = msg_annce_notifs[optiona - 1];
845 notif.nent_optionb = msg_annce_notifs[optionb - 1];
850 notif.nent_optiona = msg_info_notifs[optiona - 1];
851 notif.nent_optionb = msg_info_notifs[optionb - 1];
856 notif.nent_optiona = msg_center_notifs[optiona - 1];
857 notif.nent_optionb = msg_center_notifs[optionb - 1];
862 notif.nent_optiona = msg_multi_notifs[optiona - 1];
863 notif.nent_optionb = msg_multi_notifs[optionb - 1];
866 case MSG_CHOICE: // should we REALLY allow nested options?...
868 notif.nent_optiona = msg_choice_notifs[optiona - 1];
869 notif.nent_optionb = msg_choice_notifs[optionb - 1];
877 "^1NOTIFICATION WITH IMPROPER TYPE: ",
878 "^7net_type = %d, net_name = %s.\n"
887 notif.nent_challow_def = challow_def; // 0: never allowed, 1: allowed in warmup, 2: always allowed
888 notif.nent_challow_var = challow_var; // 0: never allowed, 1: allowed in warmup, 2: always allowed
889 notif.nent_stringcount = max(notif.nent_optiona.nent_stringcount, notif.nent_optionb.nent_stringcount);
890 notif.nent_floatcount = max(notif.nent_optiona.nent_floatcount, notif.nent_optionb.nent_floatcount);
892 /*#ifdef NOTIFICATIONS_DEBUG
893 Debug_Notification(sprintf(
894 "Create_Notification_Entity(...): MSG_CHOICE: %s\n%s\n%s\n",
897 "^ optiona: %s %s : %d %d",
898 Get_Notif_TypeName(notif.nent_optiona.nent_type),
899 notif.nent_optiona.nent_name,
900 notif.nent_optiona.nent_stringcount,
901 notif.nent_optiona.nent_floatcount
904 "^ optionb: %s %s : %d %d",
905 Get_Notif_TypeName(notif.nent_optionb.nent_type),
906 notif.nent_optionb.nent_name,
907 notif.nent_optionb.nent_stringcount,
908 notif.nent_optionb.nent_floatcount
920 "^1NOTIFICATION WITH IMPROPER TYPE: ",
921 "^7net_type = %d, net_name = %s.\n"
931 // now check to see if any errors happened
934 notif.nent_enabled = false; // disable the notification so it can't cause trouble
935 notif_global_error = true; // throw the red flag that an error happened on init
944 // used by MSG_CHOICE to build list of choices
946 void Notification_GetCvars(void)
948 for(int i = 0; i <= NOTIF_CHOICE_COUNT; ++i)
950 GetCvars_handleFloat(
953 msg_choice_choices[i],
954 sprintf("notification_%s", msg_choice_notifs[i].nent_name)
960 // used to output notifications.cfg file
961 void Dump_Notifications(float fh, float alsoprint)
963 #define NOTIF_WRITE(a) { \
965 if(alsoprint) { LOG_INFO(a); } }
966 #define NOTIF_WRITE_ENTITY(description) { \
969 "seta notification_%s \"%d\" \"%s\"\n", \
970 e.nent_name, e.nent_default, description \
972 NOTIF_WRITE(notif_msg) }
973 #define NOTIF_WRITE_ENTITY_CHOICE(descriptiona,descriptionb) { \
976 "seta notification_%s \"%d\" \"%s\"\n" \
977 "seta notification_%s_ALLOWED \"%d\" \"%s\"\n", \
978 e.nent_name, e.nent_default, descriptiona, \
979 e.nent_name, e.nent_challow_def, descriptionb \
981 NOTIF_WRITE(notif_msg) }
982 #define NOTIF_WRITE_HARDCODED(cvar,default,description) { \
985 "seta notification_%s \"%s\" \"%s\"\n", \
986 cvar, default, description \
988 NOTIF_WRITE(notif_msg) }
994 // Note: This warning only applies to the notifications.cfg file that is output...
996 // You ARE supposed to manually edit this function to add i.e. hard coded
997 // notification variables for mutators or game modes or such and then
998 // regenerate the notifications.cfg file from the new code.
1000 NOTIF_WRITE("// ********************************************** //\n");
1001 NOTIF_WRITE("// ** WARNING - DO NOT MANUALLY EDIT THIS FILE ** //\n");
1002 NOTIF_WRITE("// ** ** //\n");
1003 NOTIF_WRITE("// ** This file is automatically generated ** //\n");
1004 NOTIF_WRITE("// ** by code with the command 'dumpnotifs'. ** //\n");
1005 NOTIF_WRITE("// ** ** //\n");
1006 NOTIF_WRITE("// ** If you add a new notification, please ** //\n");
1007 NOTIF_WRITE("// ** regenerate this file with that command ** //\n");
1008 NOTIF_WRITE("// ** making sure that the output matches ** //\n");
1009 NOTIF_WRITE("// ** with the lists and defaults in code. ** //\n");
1010 NOTIF_WRITE("// ** ** //\n");
1011 NOTIF_WRITE("// ********************************************** //\n");
1013 // These notifications will also append their string as a comment...
1014 // This is not necessary, and does not matter if they vary between config versions,
1015 // it is just a semi-helpful tool for those who want to manually change their user settings.
1017 NOTIF_WRITE(sprintf("\n// MSG_ANNCE notifications (count = %d):\n", NOTIF_ANNCE_COUNT));
1018 for(i = 1; i <= NOTIF_ANNCE_COUNT; ++i)
1020 e = Get_Notif_Ent(MSG_ANNCE, i);
1021 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1024 "0 = disabled, 1 = enabled if gentle mode is off, 2 = always enabled"
1028 NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT));
1029 for(i = 1; i <= NOTIF_INFO_COUNT; ++i)
1031 e = Get_Notif_Ent(MSG_INFO, i);
1032 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1035 "0 = off, 1 = print to console, "
1036 "2 = print to console and chatbox (if notification_allow_chatboxprint is enabled)"
1040 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
1041 for(i = 1; i <= NOTIF_CENTER_COUNT; ++i)
1043 e = Get_Notif_Ent(MSG_CENTER, i);
1044 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1047 "0 = off, 1 = centerprint"
1051 NOTIF_WRITE(sprintf("\n// MSG_MULTI notifications (count = %d):\n", NOTIF_MULTI_COUNT));
1052 for(i = 1; i <= NOTIF_MULTI_COUNT; ++i)
1054 e = Get_Notif_Ent(MSG_MULTI, i);
1055 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1058 "Enable this multiple notification"
1062 NOTIF_WRITE(sprintf("\n// MSG_CHOICE notifications (count = %d):\n", NOTIF_CHOICE_COUNT));
1063 for(i = 1; i <= NOTIF_CHOICE_COUNT; ++i)
1065 e = Get_Notif_Ent(MSG_CHOICE, i);
1066 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1068 NOTIF_WRITE_ENTITY_CHOICE(
1069 "Choice for this notification 0 = off, 1 = default message, 2 = verbose message",
1070 "Allow choice for this notification 0 = off, 1 = only in warmup mode, 2 = always"
1074 // edit these to match whichever cvars are used for specific notification options
1075 NOTIF_WRITE("\n// HARD CODED notification variables:\n");
1077 NOTIF_WRITE_HARDCODED(
1078 "allow_chatboxprint", "1",
1079 "Allow INFO notifications to be printed to chat box"
1080 "0 = do not allow, "
1081 "1 = allow only if allowed by individual notification_INFO* cvars, "
1082 "2 = force all INFO notifications to be printed to the chatbox"
1085 NOTIF_WRITE_HARDCODED(
1087 "Print extra debug information on all notification function calls "
1088 "(Requires -DNOTIFICATIONS_DEBUG flag to be enabled on QCSRC compilation)... "
1089 "0 = disabled, 1 = dprint, 2 = print"
1092 NOTIF_WRITE_HARDCODED(
1093 "errors_are_fatal", "1",
1094 "If a notification fails upon initialization, cause a Host_Error to stop the program"
1097 NOTIF_WRITE_HARDCODED(
1098 "item_centerprinttime", "1.5",
1099 "How long to show item information centerprint messages (like 'You got the Electro' or such)"
1102 NOTIF_WRITE_HARDCODED(
1103 "lifetime_mapload", "10",
1104 "Amount of time that notification entities last immediately at mapload (in seconds) "
1105 "to help prevent notifications from being lost on early init (like gamestart countdown)"
1108 NOTIF_WRITE_HARDCODED(
1109 "lifetime_runtime", "0.5",
1110 "Amount of time that notification entities last on the server during runtime (In seconds)"
1113 NOTIF_WRITE_HARDCODED(
1114 "server_allows_location", "1",
1115 "Server side cvar for allowing death messages to show location information too"
1118 NOTIF_WRITE_HARDCODED(
1119 "show_location", "0",
1120 "Append location information to MSG_INFO death/kill messages"
1123 NOTIF_WRITE_HARDCODED(
1124 "show_location_string", "",
1125 "Replacement string piped into sprintf, "
1126 "so you can do different messages like this: ' at the %s' or ' (near %s)'"
1129 NOTIF_WRITE_HARDCODED(
1131 "Print information about sprees in death/kill messages"
1134 NOTIF_WRITE_HARDCODED(
1135 "show_sprees_center", "1",
1136 "Show spree information in MSG_CENTER messages... "
1137 "0 = off, 1 = target (but only for first victim) and attacker"
1140 NOTIF_WRITE_HARDCODED(
1141 "show_sprees_center_specialonly", "1",
1142 "Don't show spree information in MSG_CENTER messages if it isn't an achievement"
1145 NOTIF_WRITE_HARDCODED(
1146 "show_sprees_info", "3",
1147 "Show spree information in MSG_INFO messages... "
1148 "0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker"
1151 NOTIF_WRITE_HARDCODED(
1152 "show_sprees_info_newline", "1",
1153 "Show attacker spree information for MSG_INFO messages on a separate line than the death notification itself"
1156 NOTIF_WRITE_HARDCODED(
1157 "show_sprees_info_specialonly", "1",
1158 "Don't show attacker spree information in MSG_INFO messages if it isn't an achievement"
1161 NOTIF_WRITE(sprintf(
1163 "\n// Notification counts (total = %d): ",
1164 "MSG_ANNCE = %d, MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d, MSG_CHOICE = %d\n"
1169 NOTIF_CENTER_COUNT +
1181 #undef NOTIF_WRITE_HARDCODED
1182 #undef NOTIF_WRITE_ENTITY
1187 // ===============================
1188 // Frontend Notification Pushing
1189 // ===============================
1191 #ifdef NOTIFICATIONS_DEBUG
1192 void Debug_Notification(string input)
1194 switch(autocvar_notification_debug)
1196 case 1: { LOG_TRACE(input); break; }
1197 case 2: { LOG_INFO(input); break; }
1202 string Local_Notification_sprintf(
1203 string input, string args,
1204 string s1, string s2, string s3, string s4,
1205 int f1, float f2, float f3, float f4)
1207 #ifdef NOTIFICATIONS_DEBUG
1208 Debug_Notification(sprintf(
1209 "Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
1210 MakeConsoleSafe(input),
1212 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1213 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1219 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
1223 for(sel_num = 0;(args != "");)
1225 selected = car(args); args = cdr(args);
1226 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf");
1227 switch(strtolower(selected))
1230 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1231 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1232 #define ARG_CASE_ARG_CS_SV(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1233 #define ARG_CASE_ARG_CS(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1234 #define ARG_CASE_ARG_SV(selected,result)
1235 #define ARG_CASE_ARG_DC(selected,result)
1237 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1238 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1239 #define ARG_CASE_ARG_CS_SV(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1240 #define ARG_CASE_ARG_CS(selected,result)
1241 #define ARG_CASE_ARG_SV(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1242 #define ARG_CASE_ARG_DC(selected,result)
1244 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
1247 #undef ARG_CASE_ARG_DC
1248 #undef ARG_CASE_ARG_SV
1249 #undef ARG_CASE_ARG_CS
1250 #undef ARG_CASE_ARG_CS_SV
1251 #undef ARG_CASE_ARG_CS_SV_DC
1252 #undef ARG_CASE_ARG_CS_SV_HA
1253 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
1257 strcat(input, "\n"),
1269 void Local_Notification_sound(
1270 float soundchannel, string soundfile,
1271 float soundvolume, float soundposition)
1273 if((soundfile != prev_soundfile) || (time >= (prev_soundtime + autocvar_cl_announcer_antispam)))
1275 #ifdef NOTIFICATIONS_DEBUG
1276 Debug_Notification(sprintf(
1277 "Local_Notification_sound(world, %f, '%s', %f, %f);\n",
1280 "announcer/%s/%s.wav",
1281 autocvar_cl_announcer,
1293 "announcer/%s/%s.wav",
1294 autocvar_cl_announcer,
1301 if(prev_soundfile) { strunzone(prev_soundfile); }
1302 prev_soundfile = strzone(soundfile);
1303 prev_soundtime = time;
1307 #ifdef NOTIFICATIONS_DEBUG
1308 Debug_Notification(sprintf(
1310 "Local_Notification_sound(world, %f, '%s', %f, %f) ",
1311 "^1BLOCKED BY ANTISPAM:^7 prevsnd: '%s', timediff: %f, limit: %f\n"
1315 "announcer/%s/%s.wav",
1316 autocvar_cl_announcer,
1322 (time - prev_soundtime),
1323 autocvar_cl_announcer_antispam
1329 void Local_Notification_HUD_Notify_Push(
1330 string icon, string hudargs,
1331 string s1, string s2, string s3, string s4,
1332 float f1, float f2, float f3, float f4)
1335 arg_slot[0] = ""; arg_slot[1] = "";
1338 for(sel_num = 0;(hudargs != "");)
1340 selected = car(hudargs); hudargs = cdr(hudargs);
1341 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push");
1342 switch(strtolower(selected))
1344 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1345 #define ARG_CASE_ARG_CS_SV_DC(selected,result)
1346 #define ARG_CASE_ARG_CS_SV(selected,result)
1347 #define ARG_CASE_ARG_CS(selected,result)
1348 #define ARG_CASE_ARG_SV(selected,result)
1349 #define ARG_CASE_ARG_DC(selected,result)
1350 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
1353 #undef ARG_CASE_ARG_DC
1354 #undef ARG_CASE_ARG_SV
1355 #undef ARG_CASE_ARG_CS
1356 #undef ARG_CASE_ARG_CS_SV
1357 #undef ARG_CASE_ARG_CS_SV_DC
1358 #undef ARG_CASE_ARG_CS_SV_HA
1359 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
1362 #ifdef NOTIFICATIONS_DEBUG
1363 Debug_Notification(sprintf(
1364 "Local_Notification_HUD_Notify_Push('%s^7', '%s', %s, %s, %s);\n",
1367 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1368 sprintf("%d, %d, %d, %d", f1, f2, f3, f4),
1369 MakeConsoleSafe(sprintf("'%s^7', '%s^7'", stof(arg_slot[0]), stof(arg_slot[1])))
1372 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
1375 void Local_Notification_centerprint_generic(
1376 string input, string durcnt,
1377 int cpid, float f1, float f2)
1379 arg_slot[0] = ""; arg_slot[1] = "";
1381 for(int sel_num = 0;(durcnt != "");)
1383 string selected = car(durcnt); durcnt = cdr(durcnt);
1384 NOTIF_HIT_MAX(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic");
1385 switch(strtolower(selected))
1387 #define ARG_CASE_ARG_CS_SV_HA(selected,result)
1388 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1389 #define ARG_CASE_ARG_CS_SV(selected,result)
1390 #define ARG_CASE_ARG_CS(selected,result)
1391 #define ARG_CASE_ARG_SV(selected,result)
1392 #define ARG_CASE_ARG_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1393 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
1396 #undef ARG_CASE_ARG_DC
1397 #undef ARG_CASE_ARG_SV
1398 #undef ARG_CASE_ARG_CS
1399 #undef ARG_CASE_ARG_CS_SV
1400 #undef ARG_CASE_ARG_CS_SV_DC
1401 #undef ARG_CASE_ARG_CS_SV_HA
1404 if(ftos(stof(selected)) != "") { arg_slot[sel_num] = selected; ++sel_num; }
1405 else { NOTIF_HIT_UNKNOWN(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic") }
1410 #ifdef NOTIFICATIONS_DEBUG
1411 Debug_Notification(sprintf(
1412 "Local_Notification_centerprint_generic('%s^7', '%s', %d, %d, %d, %d);\n",
1413 MakeConsoleSafe(input),
1420 centerprint_generic(cpid, input, stof(arg_slot[0]), stof(arg_slot[1]));
1424 void Local_Notification(int net_type, int net_name, ...count)
1426 // check if this should be aborted
1427 if(net_name == NOTIF_ABORT)
1429 #ifdef NOTIFICATIONS_DEBUG
1430 Debug_Notification(sprintf(
1431 "Local_Notification(%s, %s, ...);\n",
1432 Get_Notif_TypeName(net_type),
1439 // check supplied type and name for errors
1440 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
1443 #ifdef NOTIFICATIONS_DEBUG
1444 Debug_Notification(sprintf(
1445 "Local_Notification(%s, %d, ...);\n",
1446 Get_Notif_TypeName(net_type),
1447 Get_Notif_Ent(net_type, net_name).nent_name
1450 backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs));
1454 // retreive entity of this notification
1455 entity notif = Get_Notif_Ent(net_type, net_name);
1458 #ifdef NOTIFICATIONS_DEBUG
1459 Debug_Notification(sprintf(
1460 "Local_Notification(%s, %d, ...);\n",
1461 Get_Notif_TypeName(net_type),
1465 backtrace("Local_Notification: Could not find notification entity!\n");
1469 // check if the notification is enabled
1470 if (!notif.nent_enabled)
1472 #ifdef NOTIFICATIONS_DEBUG
1473 Debug_Notification(sprintf(
1474 "Local_Notification(%s, %s, ...): Entity was disabled...\n",
1475 Get_Notif_TypeName(net_type),
1482 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1483 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1484 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1485 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1486 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1487 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1488 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1489 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1491 #ifdef NOTIFICATIONS_DEBUG
1492 Debug_Notification(sprintf(
1493 "Local_Notification(%s, %s, %s, %s);\n",
1494 Get_Notif_TypeName(net_type),
1496 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1497 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1501 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1505 "Not enough arguments for Local_Notification(%s, %s, ...)! ",
1506 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1507 "Check the definition and function call for accuracy...?\n"
1509 Get_Notif_TypeName(net_type),
1511 notif.nent_stringcount,
1512 notif.nent_floatcount,
1517 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1521 "Too many arguments for Local_Notification(%s, %s, ...)! ",
1522 "stringcount(%d) + floatcount(%d) < count(%d)\n",
1523 "Check the definition and function call for accuracy...?\n"
1525 Get_Notif_TypeName(net_type),
1527 notif.nent_stringcount,
1528 notif.nent_floatcount,
1539 Local_Notification_sound(
1546 backtrace("MSG_ANNCE on server?... Please notify Samual immediately!\n");
1554 Local_Notification_sprintf(
1561 if(notif.nent_icon != "")
1563 if ( notif.nent_iconargs != "" )
1565 notif.nent_icon = Local_Notification_sprintf(
1566 notif.nent_icon,notif.nent_iconargs,
1567 s1, s2, s3, s4, f1, f2, f3, f4);
1568 // remove the newline added by Local_Notification_sprintf
1569 notif.nent_icon = strzone(substring(notif.nent_icon,0,strlen(notif.nent_icon)-1));
1571 Local_Notification_HUD_Notify_Push(
1584 Local_Notification_centerprint_generic(
1585 Local_Notification_sprintf(
1599 if(notif.nent_msginfo)
1600 if(notif.nent_msginfo.nent_enabled)
1602 Local_Notification_WOVA(
1604 notif.nent_msginfo.nent_id,
1605 notif.nent_msginfo.nent_stringcount,
1606 notif.nent_msginfo.nent_floatcount,
1611 if(notif.nent_msgannce)
1612 if(notif.nent_msgannce.nent_enabled)
1614 Local_Notification_WOVA(
1616 notif.nent_msgannce.nent_id,
1621 if(notif.nent_msgcenter)
1622 if(notif.nent_msgcenter.nent_enabled)
1624 Local_Notification_WOVA(
1626 notif.nent_msgcenter.nent_id,
1627 notif.nent_msgcenter.nent_stringcount,
1628 notif.nent_msgcenter.nent_floatcount,
1638 entity found_choice;
1640 if(notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2)))
1642 switch(cvar(sprintf("notification_%s", notif.nent_name)))
1644 case 1: found_choice = notif.nent_optiona; break;
1645 case 2: found_choice = notif.nent_optionb; break;
1646 default: return; // not enabled anyway
1649 else { found_choice = notif.nent_optiona; }
1651 Local_Notification_WOVA(
1652 found_choice.nent_type,
1653 found_choice.nent_id,
1654 found_choice.nent_stringcount,
1655 found_choice.nent_floatcount,
1662 // WOVA = Without Variable Arguments
1663 void Local_Notification_WOVA(
1664 int net_type, float net_name,
1665 float stringcount, float floatcount,
1666 string s1, string s2, string s3, string s4,
1667 float f1, float f2, float f3, float f4)
1669 #define VARITEM(stringc,floatc,args) \
1670 if((stringcount == stringc) && (floatcount == floatc)) \
1671 { Local_Notification(net_type, net_name, args); return; }
1672 EIGHT_VARS_TO_VARARGS_VARLIST
1674 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
1678 // =========================
1679 // Notification Networking
1680 // =========================
1683 void Read_Notification(float is_new)
1685 int net_type = ReadByte();
1686 int net_name = ReadShort();
1690 if(net_type == MSG_CENTER_CPID)
1692 #ifdef NOTIFICATIONS_DEBUG
1693 Debug_Notification(sprintf(
1694 "Read_Notification(%d) at %f: net_type = %s, net_name = %d\n",
1697 Get_Notif_TypeName(net_type),
1704 if(net_name == 0) { reset_centerprint_messages(); }
1705 else if(net_name != NO_CPID)
1707 // in this case, net_name IS the cpid we want to kill
1708 centerprint_generic(net_name, "", 0, 0);
1713 "Read_Notification(%d) at %f: ^1TRIED TO KILL NO_CPID CENTERPRINT!\n",
1722 notif = Get_Notif_Ent(net_type, net_name);
1723 if (!notif) { backtrace("Read_Notification: Could not find notification entity!\n"); return; }
1725 #ifdef NOTIFICATIONS_DEBUG
1726 Debug_Notification(sprintf(
1727 "Read_Notification(%d) at %f: net_type = %s, net_name = %s\n",
1730 Get_Notif_TypeName(net_type),
1735 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
1736 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
1737 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
1738 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
1739 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
1740 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
1741 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
1742 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
1746 Local_Notification_WOVA(
1748 notif.nent_stringcount,
1749 notif.nent_floatcount,
1758 void Net_Notification_Remove()
1760 if (!self) { backtrace(sprintf("Net_Notification_Remove() at %f: Missing self!?\n", time)); return; }
1762 #ifdef NOTIFICATIONS_DEBUG
1763 Debug_Notification(sprintf(
1764 "Net_Notification_Remove() at %f: %s '%s - %s' notification\n",
1766 ((self.nent_net_name == -1) ? "Killed" : "Removed"),
1767 Get_Notif_TypeName(self.nent_net_type),
1768 self.owner.nent_name
1772 for(int i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
1776 bool Net_Write_Notification(entity this, entity client, int sf)
1778 if(Notification_ShouldSend(self.nent_broadcast, client, self.nent_client))
1780 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
1781 WriteByte(MSG_ENTITY, self.nent_net_type);
1782 WriteShort(MSG_ENTITY, self.nent_net_name);
1783 for(int i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
1784 for(int i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
1787 else { return false; }
1790 void Kill_Notification(
1791 float broadcast, entity client,
1792 float net_type, float net_name)
1794 #ifdef NOTIFICATIONS_DEBUG
1795 Debug_Notification(sprintf(
1796 "Kill_Notification(%s, '%s', %s, %d);\n",
1797 Get_Notif_BroadcastName(broadcast),
1799 (net_type ? Get_Notif_TypeName(net_type) : "0"),
1804 string checkargs = Notification_CheckArgs(broadcast, client, 1, 1);
1805 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Kill_Notification: %s\n", checkargs)); return; }
1807 entity notif, net_notif;
1808 float killed_cpid = NO_CPID;
1814 killed_cpid = 0; // kill ALL centerprints
1822 entity notif = Get_Notif_Ent(net_type, net_name);
1823 if (!notif) { backtrace("Kill_Notification: Could not find notification entity!\n"); return; }
1826 killed_cpid = notif.nent_cpid;
1828 killed_cpid = NO_CPID;
1832 killed_cpid = 0; // kill ALL centerprints
1837 case MSG_CENTER_CPID:
1839 killed_cpid = net_name;
1844 if(killed_cpid != NO_CPID)
1846 net_notif = spawn();
1847 net_notif.classname = "net_kill_notification";
1848 net_notif.nent_broadcast = broadcast;
1849 net_notif.nent_client = client;
1850 net_notif.nent_net_type = MSG_CENTER_CPID;
1851 net_notif.nent_net_name = killed_cpid;
1852 Net_LinkEntity(net_notif, false, autocvar_notification_lifetime_runtime, Net_Write_Notification);
1855 for(notif = world; (notif = find(notif, classname, "net_notification"));)
1859 if((killed_cpid != NO_CPID) && (notif.nent_net_type == MSG_CENTER))
1861 if(notif.owner.nent_cpid == killed_cpid)
1863 notif.nent_net_name = -1;
1864 notif.nextthink = time;
1866 else { continue; } // we ARE looking for a specific CPID, don't kill everything else too
1868 else if(notif.nent_net_type == net_type)
1872 if(notif.nent_net_name == net_name) { notif.nent_net_name = -1; notif.nextthink = time; }
1873 else { continue; } // we ARE looking for a certain net_name, don't kill everything else too
1875 else { notif.nent_net_name = -1; notif.nextthink = time; }
1877 else { continue; } // we ARE looking for a certain net_type, don't kill everything else too
1879 else { notif.nent_net_name = -1; notif.nextthink = time; }
1883 void Send_Notification(
1884 float broadcast, entity client,
1885 float net_type, float net_name,
1888 // check if this should be aborted
1889 if(net_name == NOTIF_ABORT)
1891 #ifdef NOTIFICATIONS_DEBUG
1892 Debug_Notification(sprintf(
1893 "Send_Notification(%s, '%s', %s, %s, ...);\n",
1894 Get_Notif_BroadcastName(broadcast),
1896 Get_Notif_TypeName(net_type),
1903 // check supplied broadcast, target, type, and name for errors
1904 string checkargs = Notification_CheckArgs(broadcast, client, net_type, net_name);
1907 #ifdef NOTIFICATIONS_DEBUG
1908 Debug_Notification(sprintf(
1909 "Send_Notification(%s, '%s', %s, %s, ...);\n",
1910 Get_Notif_BroadcastName(broadcast),
1912 Get_Notif_TypeName(net_type),
1913 Get_Notif_Ent(net_type, net_name).nent_name
1916 backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs));
1920 // retreive entity of this notification
1921 entity notif = Get_Notif_Ent(net_type, net_name);
1924 #ifdef NOTIFICATIONS_DEBUG
1925 Debug_Notification(sprintf(
1926 "Send_Notification(%s, '%s', %s, %d, ...);\n",
1927 Get_Notif_BroadcastName(broadcast),
1929 Get_Notif_TypeName(net_type),
1933 backtrace("Send_Notification: Could not find notification entity!\n");
1937 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1938 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1939 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1940 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1941 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1942 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1943 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1944 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1946 #ifdef NOTIFICATIONS_DEBUG
1947 Debug_Notification(sprintf(
1948 "Send_Notification(%s, %s, %s);\n",
1951 Get_Notif_BroadcastName(broadcast),
1953 Get_Notif_TypeName(net_type),
1956 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1957 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1961 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1964 #ifdef NOTIFICATIONS_DEBUG
1965 Get_Notif_BroadcastName(broadcast);
1971 "Not enough arguments for Send_Notification(%s, ...)! ",
1972 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1973 "Check the definition and function call for accuracy...?\n"
1979 Get_Notif_TypeName(net_type),
1982 notif.nent_stringcount,
1983 notif.nent_floatcount,
1988 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1991 #ifdef NOTIFICATIONS_DEBUG
1992 Get_Notif_BroadcastName(broadcast);
1998 "Too many arguments for Send_Notification(%s, ...)! ",
1999 "stringcount(%d) + floatcount(%d) < count(%d)\n",
2000 "Check the definition and function call for accuracy...?\n"
2006 Get_Notif_TypeName(net_type),
2009 notif.nent_stringcount,
2010 notif.nent_floatcount,
2020 broadcast == NOTIF_ALL
2022 broadcast == NOTIF_ALL_EXCEPT
2026 net_type == MSG_ANNCE
2028 net_type == MSG_CENTER
2032 Local_Notification_WOVA(
2034 notif.nent_stringcount,
2035 notif.nent_floatcount,
2040 if(net_type == MSG_CHOICE)
2042 // THIS GETS TRICKY... now we have to cycle through each possible player (checking broadcast)
2043 // and then do an individual NOTIF_ONE_ONLY recursive call for each one depending on their option...
2044 // It's slow, but it's better than the alternatives:
2045 // 1. Constantly networking all info and letting client decide
2046 // 2. Manually handling each separate call on per-usage basis (See old CTF usage of verbose)
2047 entity found_choice;
2049 #define RECURSE_FROM_CHOICE(ent,action) do { \
2050 if(notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2))) \
2052 switch(ent.msg_choice_choices[net_name - 1]) \
2054 case 1: found_choice = notif.nent_optiona; break; \
2055 case 2: found_choice = notif.nent_optionb; break; \
2059 else { found_choice = notif.nent_optiona; } \
2060 Send_Notification_WOVA( \
2063 found_choice.nent_type, \
2064 found_choice.nent_id, \
2065 found_choice.nent_stringcount, \
2066 found_choice.nent_floatcount, \
2073 case NOTIF_ONE_ONLY: // we can potentially save processing power with this broadcast method
2075 if(IS_REAL_CLIENT(client))
2077 RECURSE_FROM_CHOICE(client, return);
2084 FOR_EACH_REALCLIENT(to)
2086 if(Notification_ShouldSend(broadcast, to, client))
2088 RECURSE_FROM_CHOICE(to, continue);
2097 entity net_notif = spawn();
2098 net_notif.owner = notif;
2099 net_notif.classname = "net_notification";
2100 net_notif.nent_broadcast = broadcast;
2101 net_notif.nent_client = client;
2102 net_notif.nent_net_type = net_type;
2103 net_notif.nent_net_name = net_name;
2104 net_notif.nent_stringcount = notif.nent_stringcount;
2105 net_notif.nent_floatcount = notif.nent_floatcount;
2107 for(int i = 0; i < net_notif.nent_stringcount; ++i)
2108 { net_notif.nent_strings[i] = strzone(...(i, string)); }
2109 for(int i = 0; i < net_notif.nent_floatcount; ++i)
2110 { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
2112 net_notif.think = Net_Notification_Remove;
2113 net_notif.nextthink =
2114 ((time > autocvar_notification_lifetime_mapload)
2116 (time + autocvar_notification_lifetime_runtime)
2118 autocvar_notification_lifetime_mapload
2121 Net_LinkEntity(net_notif, false, 0, Net_Write_Notification);
2125 // WOVA = Without Variable Arguments
2126 void Send_Notification_WOVA(
2127 float broadcast, entity client,
2128 float net_type, float net_name,
2129 float stringcount, float floatcount,
2130 string s1, string s2, string s3, string s4,
2131 float f1, float f2, float f3, float f4)
2133 #ifdef NOTIFICATIONS_DEBUG
2134 entity notif = Get_Notif_Ent(net_type, net_name);
2135 Debug_Notification(sprintf(
2136 "Send_Notification_WOVA(%s, %d, %d, %s, %s);\n",
2139 Get_Notif_BroadcastName(broadcast),
2141 Get_Notif_TypeName(net_type),
2146 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
2147 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
2151 #define VARITEM(stringc,floatc,args) \
2152 if((stringcount == stringc) && (floatcount == floatc)) \
2153 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
2154 EIGHT_VARS_TO_VARARGS_VARLIST
2156 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
2159 // WOCOVA = Without Counts Or Variable Arguments
2160 void Send_Notification_WOCOVA(
2161 float broadcast, entity client,
2162 float net_type, float net_name,
2163 string s1, string s2, string s3, string s4,
2164 float f1, float f2, float f3, float f4)
2166 entity notif = Get_Notif_Ent(net_type, net_name);
2168 #ifdef NOTIFICATIONS_DEBUG
2169 Debug_Notification(sprintf(
2170 "Send_Notification_WOCOVA(%s, %s, %s);\n",
2173 Get_Notif_BroadcastName(broadcast),
2175 Get_Notif_TypeName(net_type),
2178 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
2179 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
2183 #define VARITEM(stringc,floatc,args) \
2184 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
2185 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
2186 EIGHT_VARS_TO_VARARGS_VARLIST
2188 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
2190 #endif // ifdef SVQC