1 // ================================================
2 // Unified notification system, written by Samual
3 // Last updated: August, 2013
4 // ================================================
6 string Get_Notif_TypeName(int net_type)
10 case MSG_ANNCE: return "MSG_ANNCE";
11 case MSG_INFO: return "MSG_INFO";
12 case MSG_CENTER: return "MSG_CENTER";
13 case MSG_CENTER_CPID: return "MSG_CENTER_CPID";
14 case MSG_MULTI: return "MSG_MULTI";
15 case MSG_CHOICE: return "MSG_CHOICE";
17 backtrace(sprintf("Get_Notif_TypeName(%d): Improper net type!\n", net_type));
21 entity Get_Notif_Ent(int net_type, int net_name)
25 case MSG_ANNCE: return msg_annce_notifs[net_name - 1];
26 case MSG_INFO: return msg_info_notifs[net_name - 1];
27 case MSG_CENTER: return msg_center_notifs[net_name - 1];
28 case MSG_MULTI: return msg_multi_notifs[net_name - 1];
29 case MSG_CHOICE: return msg_choice_notifs[net_name - 1];
31 backtrace(sprintf("Get_Notif_Ent(%d, %d): Improper net type!\n", net_type, net_name));
36 #ifdef NOTIFICATIONS_DEBUG
37 string Get_Notif_BroadcastName(float broadcast)
41 case NOTIF_ONE: return "NOTIF_ONE";
42 case NOTIF_ONE_ONLY: return "NOTIF_ONE_ONLY";
43 case NOTIF_ALL_EXCEPT: return "NOTIF_ALL_EXCEPT";
44 case NOTIF_ALL: return "NOTIF_ALL";
45 case NOTIF_TEAM: return "NOTIF_TEAM";
46 case NOTIF_TEAM_EXCEPT: return "NOTIF_TEAM_EXCEPT";
48 backtrace(sprintf("Get_Notif_BroadcastName(%d): Improper broadcast!\n", broadcast));
54 string Notification_CheckArgs_TypeName(float net_type, float net_name)
56 // check supplied type and name for errors
57 string checkargs = "";
58 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
59 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
60 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
63 CHECKARG_TYPENAME(ANNCE)
64 CHECKARG_TYPENAME(INFO)
65 CHECKARG_TYPENAME(CENTER)
66 CHECKARG_TYPENAME(MULTI)
67 CHECKARG_TYPENAME(CHOICE)
68 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
70 #undef CHECKARG_TYPENAME
75 string Notification_CheckArgs(
76 float broadcast, entity client,
77 float net_type, float net_name)
79 // check supplied broadcast, target, type, and name for errors
80 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
81 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
87 if(IS_NOT_A_CLIENT(client))
88 { checkargs = sprintf("%sNo client provided!", checkargs); }
92 case NOTIF_ALL_EXCEPT:
94 if(IS_NOT_A_CLIENT(client))
95 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
102 { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
109 { checkargs = sprintf("%sTeamplay not active!", checkargs); }
110 //else if (!client.team) { checkargs = sprintf("%sNo team provided!", checkargs); }
114 case NOTIF_TEAM_EXCEPT:
117 { checkargs = sprintf("%sTeamplay not active!", checkargs); }
118 else if(IS_NOT_A_CLIENT(client))
119 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
123 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
128 float Notification_ShouldSend(float broadcast, entity to_client, entity other_client)
132 case NOTIF_ONE: // send to one client and their spectator
135 (to_client == other_client)
140 (to_client.enemy == other_client)
145 case NOTIF_ONE_ONLY: // send ONLY to one client
147 if(to_client == other_client) { return true; }
150 case NOTIF_TEAM: // send only to X team and their spectators
153 (to_client.team == other_client.team)
158 (to_client.enemy.team == other_client.team)
163 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
166 (to_client != other_client)
169 (to_client.team == other_client.team)
175 (to_client.enemy != other_client)
177 (to_client.enemy.team == other_client.team)
184 case NOTIF_ALL: // send to everyone
188 case NOTIF_ALL_EXCEPT: // send to everyone except X person and their spectators
191 (to_client != other_client)
196 (to_client.enemy == other_client)
207 // ===============================
208 // Initialization Core Functions
209 // ===============================
211 // used by restartnotifs command to initialize notifications
212 void Destroy_Notification_Entity(entity notif)
214 if(notif.nent_name != "") { strunzone(notif.nent_name); }
215 if(notif.nent_snd != "") { strunzone(notif.nent_snd); }
216 if(notif.nent_args != "") { strunzone(notif.nent_args); }
217 if(notif.nent_hudargs != "") { strunzone(notif.nent_hudargs); }
218 if(notif.nent_icon != "") { strunzone(notif.nent_icon); }
219 if(notif.nent_durcnt != "") { strunzone(notif.nent_durcnt); }
220 if(notif.nent_string != "") { strunzone(notif.nent_string); }
224 void Destroy_All_Notifications(void)
229 #define DESTROY_LOOP(type,count) do { \
230 for(i = 1; i <= count; ++i) \
232 notif = Get_Notif_Ent(type, i); \
233 if (!notif) { backtrace("Destroy_All_Notifications(): Missing notification entity!\n"); return; } \
234 Destroy_Notification_Entity(notif); \
238 // kill all networked notifications and centerprints
240 Kill_Notification(NOTIF_ALL, world, 0, 0);
242 reset_centerprint_messages();
245 // kill all real notification entities
246 DESTROY_LOOP(MSG_ANNCE, NOTIF_ANNCE_COUNT);
247 DESTROY_LOOP(MSG_INFO, NOTIF_INFO_COUNT);
248 DESTROY_LOOP(MSG_CENTER, NOTIF_CENTER_COUNT);
249 DESTROY_LOOP(MSG_MULTI, NOTIF_MULTI_COUNT);
250 DESTROY_LOOP(MSG_CHOICE, NOTIF_CHOICE_COUNT);
254 string Process_Notif_Line(
263 if(typeId == MSG_INFO)
265 if((chat && autocvar_notification_allow_chatboxprint)
266 || (autocvar_notification_allow_chatboxprint == 2))
268 // pass 1: add ETX char at beginning of line
269 input = strcat("\{3}", input);
271 // pass 2: add ETX char at end of each new line (so that
272 // messages with multiple lines are put through chatbox too)
273 input = strreplace("\n", "\n\{3}", input);
275 // pass 3: strip trailing ETX char
276 if(substring(input, (strlen(input) - 1), 1) == "\{3}")
277 { input = substring(input, 0, (strlen(input) - 1)); }
282 // done to both MSG_INFO and MSG_CENTER
283 if(substring(input, (strlen(input) - 1), 1) == "\n")
287 "^1TRAILING NEW LINE AT END OF NOTIFICATION: ",
288 "^7net_type = %s, net_name = %s, string = %s.\n"
295 input = substring(input, 1, (strlen(input) - 1));
301 string Process_Notif_Args(
307 string selected, remaining = args;
310 for(0;(remaining != "");)
312 selected = car(remaining); remaining = cdr(remaining);
316 case 1: // normal args
318 if(sel_num == NOTIF_MAX_ARGS)
322 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
323 "^7net_type = %s, net_name = %s, max args = %d.\n"
333 switch(strtolower(selected))
335 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { ++sel_num; break; }
336 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { ++sel_num; break; }
337 #define ARG_CASE_ARG_CS_SV(selected,result) case selected: { ++sel_num; break; }
338 #define ARG_CASE_ARG_CS(selected,result) case selected: { ++sel_num; break; }
339 #define ARG_CASE_ARG_SV(selected,result) case selected: { ++sel_num; break; }
340 #define ARG_CASE_ARG_DC(selected,result)
341 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
344 #undef ARG_CASE_ARG_DC
345 #undef ARG_CASE_ARG_SV
346 #undef ARG_CASE_ARG_CS
347 #undef ARG_CASE_ARG_CS_SV
348 #undef ARG_CASE_ARG_CS_SV_DC
349 #undef ARG_CASE_ARG_CS_SV_HA
354 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
355 "^7net_type = %s, net_name = %s, args arg = '%s'.\n"
369 if(sel_num == NOTIF_MAX_HUDARGS)
373 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
374 "^7net_type = %s, net_name = %s, max hudargs = %d.\n"
384 switch(strtolower(selected))
386 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { ++sel_num; break; }
387 #define ARG_CASE_ARG_CS_SV_DC(selected,result)
388 #define ARG_CASE_ARG_CS_SV(selected,result)
389 #define ARG_CASE_ARG_CS(selected,result)
390 #define ARG_CASE_ARG_SV(selected,result)
391 #define ARG_CASE_ARG_DC(selected,result)
392 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
395 #undef ARG_CASE_ARG_DC
396 #undef ARG_CASE_ARG_SV
397 #undef ARG_CASE_ARG_CS
398 #undef ARG_CASE_ARG_CS_SV
399 #undef ARG_CASE_ARG_CS_SV_DC
400 #undef ARG_CASE_ARG_CS_SV_HA
405 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
406 "^7net_type = %s, net_name = %s, hudargs arg = '%s'.\n"
420 if(sel_num == NOTIF_MAX_DURCNT)
424 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
425 "^7net_type = %s, net_name = %s, max durcnt = %d.\n"
435 switch(strtolower(selected))
437 #define ARG_CASE_ARG_CS_SV_HA(selected,result)
438 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { ++sel_num; break; }
439 #define ARG_CASE_ARG_CS_SV(selected,result)
440 #define ARG_CASE_ARG_CS(selected,result)
441 #define ARG_CASE_ARG_SV(selected,result)
442 #define ARG_CASE_ARG_DC(selected,result) case selected: { ++sel_num; break; }
443 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
446 #undef ARG_CASE_ARG_DC
447 #undef ARG_CASE_ARG_SV
448 #undef ARG_CASE_ARG_CS
449 #undef ARG_CASE_ARG_CS_SV
450 #undef ARG_CASE_ARG_CS_SV_DC
451 #undef ARG_CASE_ARG_CS_SV_HA
454 if(ftos(stof(selected)) != "") { ++sel_num; }
459 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
460 "^7net_type = %s, net_name = %s, durcnt arg = '%s'.\n"
478 void Create_Notification_Entity(
491 /* MSG_INFO & MSG_CENTER */
510 // =====================
511 // Global Entity Setup
512 // =====================
513 entity notif = spawn();
518 msg_annce_notifs[nameid - 1] = notif;
519 notif.classname = "msg_annce_notification";
524 msg_info_notifs[nameid - 1] = notif;
525 notif.classname = "msg_info_notification";
530 msg_center_notifs[nameid - 1] = notif;
531 notif.classname = "msg_center_notification";
536 msg_multi_notifs[nameid - 1] = notif;
537 notif.classname = "msg_multi_notification";
542 msg_choice_notifs[nameid - 1] = notif;
543 notif.classname = "msg_choice_notification";
551 "^1NOTIFICATION WITH IMPROPER TYPE: ",
552 "^7net_type = %d, net_name = %s.\n"
557 return; // It's not possible to recover from this one
560 notif.nent_default = var_default;
561 notif.nent_enabled = (1 <= var_cvar);
562 notif.nent_type = typeId;
563 notif.nent_id = nameid;
564 notif.nent_name = strzone(namestring);
566 string typestring = Get_Notif_TypeName(typeId);
568 // Other pre-notif-setup requisites
571 // ====================
572 // Notification Setup
573 // ====================
578 // Set MSG_ANNCE information and handle precaching
580 if (!(GENTLE && (var_cvar == 1)))
584 if(notif.nent_enabled)
586 precache_sound(sprintf("announcer/%s/%s.wav", autocvar_cl_announcer, snd));
587 notif.nent_channel = channel;
588 notif.nent_snd = strzone(snd);
589 notif.nent_vol = vol;
590 notif.nent_position = position;
597 "^1NOTIFICATION WITH NO SOUND: ",
598 "^7net_type = %s, net_name = %s.\n"
606 else { notif.nent_enabled = false; }
608 notif.nent_enabled = false;
617 // Set MSG_INFO and MSG_CENTER string/float counts
618 notif.nent_stringcount = strnum;
619 notif.nent_floatcount = flnum;
621 // Only initialize arguments if we're either a client or on a dedicated server
623 float should_process_args = server_is_dedicated;
625 float should_process_args = true;
628 if(should_process_args)
630 // ========================
631 // Process Main Arguments
632 // ========================
637 notif.nent_args = strzone(
638 Process_Notif_Args(1, args, typestring, namestring));
640 else if((hudargs == "") && (durcnt ==""))
644 "^1NOTIFICATION HAS ARG COUNTS BUT NO ARGS OR HUDARGS OR DURCNT: ",
645 "^7net_type = %s, net_name = %s, strnum = %d, flnum = %d\n"
657 notif.nent_args = strzone(
658 Process_Notif_Args(1, args, typestring, namestring));
662 // =======================================
663 // Process HUD and Centerprint Arguments
664 // Only processed on CSQC, as these
665 // args are only for HUD features.
666 // =======================================
670 notif.nent_hudargs = strzone(
671 Process_Notif_Args(2, hudargs, typestring, namestring));
673 if(icon != "") { notif.nent_icon = strzone(icon); }
678 "^1NOTIFICATION HAS HUDARGS BUT NO ICON: ",
679 "^7net_type = %s, net_name = %s.\n"
691 "^1NOTIFICATION HAS ICON BUT NO HUDARGS: ",
692 "^7net_type = %s, net_name = %s.\n"
702 notif.nent_durcnt = strzone(
703 Process_Notif_Args(3, durcnt, typestring, namestring));
705 if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
710 "^1NOTIFICATION HAS DURCNT BUT NO CPID: ",
711 "^7net_type = %s, net_name = %s.\n"
719 else if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
723 // ======================
724 // Process Notif String
725 // ======================
726 #define SET_NOTIF_STRING(string,stringname) do { \
727 notif.nent_string = strzone(CCR( \
728 Process_Notif_Line( \
741 if(gentle != "") { SET_NOTIF_STRING(gentle, "GENTLE"); }
742 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL"); }
744 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL"); }
745 #undef SET_NOTIF_STRING
747 // Check to make sure a string was chosen
748 if(notif.nent_string == "")
752 "^1EMPTY NOTIFICATION: ",
753 "^7net_type = %s, net_name = %s.\n"
767 // Set MSG_MULTI string/float counts
768 if((anncename == NO_MSG) && (infoname == NO_MSG) && (centername == NO_MSG))
772 "^1NOTIFICATION WITH NO SUBCALLS: ",
773 "^7net_type = %s, net_name = %s.\n"
782 // announcements don't actually need any arguments, so lets not even count them.
783 if(anncename != NO_MSG) { notif.nent_msgannce = msg_annce_notifs[anncename - 1]; }
785 float infoname_stringcount = 0, infoname_floatcount = 0;
786 float centername_stringcount = 0, centername_floatcount = 0;
788 if(infoname != NO_MSG)
790 notif.nent_msginfo = msg_info_notifs[infoname - 1];
791 infoname_stringcount = notif.nent_msginfo.nent_stringcount;
792 infoname_floatcount = notif.nent_msginfo.nent_floatcount;
795 if(centername != NO_MSG)
797 notif.nent_msgcenter = msg_center_notifs[centername - 1];
798 centername_stringcount = notif.nent_msgcenter.nent_stringcount;
799 centername_floatcount = notif.nent_msgcenter.nent_floatcount;
802 // set the requirements of THIS notification to the totals of its subcalls
803 notif.nent_stringcount = max(infoname_stringcount, centername_stringcount);
804 notif.nent_floatcount = max(infoname_floatcount, centername_floatcount);
812 if((chtype == NO_MSG) || (optiona == NO_MSG) || (optionb == NO_MSG))
816 "^1NOTIFICATION IS MISSING CHOICE PARAMS: ",
817 "^7net_type = %s, net_name = %s.\n"
830 notif.nent_optiona = msg_annce_notifs[optiona - 1];
831 notif.nent_optionb = msg_annce_notifs[optionb - 1];
836 notif.nent_optiona = msg_info_notifs[optiona - 1];
837 notif.nent_optionb = msg_info_notifs[optionb - 1];
842 notif.nent_optiona = msg_center_notifs[optiona - 1];
843 notif.nent_optionb = msg_center_notifs[optionb - 1];
848 notif.nent_optiona = msg_multi_notifs[optiona - 1];
849 notif.nent_optionb = msg_multi_notifs[optionb - 1];
852 case MSG_CHOICE: // should we REALLY allow nested options?...
854 notif.nent_optiona = msg_choice_notifs[optiona - 1];
855 notif.nent_optionb = msg_choice_notifs[optionb - 1];
863 "^1NOTIFICATION WITH IMPROPER TYPE: ",
864 "^7net_type = %d, net_name = %s.\n"
873 notif.nent_challow_def = challow_def; // 0: never allowed, 1: allowed in warmup, 2: always allowed
874 notif.nent_challow_var = challow_var; // 0: never allowed, 1: allowed in warmup, 2: always allowed
875 notif.nent_stringcount = max(notif.nent_optiona.nent_stringcount, notif.nent_optionb.nent_stringcount);
876 notif.nent_floatcount = max(notif.nent_optiona.nent_floatcount, notif.nent_optionb.nent_floatcount);
878 /*#ifdef NOTIFICATIONS_DEBUG
879 Debug_Notification(sprintf(
880 "Create_Notification_Entity(...): MSG_CHOICE: %s\n%s\n%s\n",
883 "^ optiona: %s %s : %d %d",
884 Get_Notif_TypeName(notif.nent_optiona.nent_type),
885 notif.nent_optiona.nent_name,
886 notif.nent_optiona.nent_stringcount,
887 notif.nent_optiona.nent_floatcount
890 "^ optionb: %s %s : %d %d",
891 Get_Notif_TypeName(notif.nent_optionb.nent_type),
892 notif.nent_optionb.nent_name,
893 notif.nent_optionb.nent_stringcount,
894 notif.nent_optionb.nent_floatcount
906 "^1NOTIFICATION WITH IMPROPER TYPE: ",
907 "^7net_type = %d, net_name = %s.\n"
917 // now check to see if any errors happened
920 notif.nent_enabled = false; // disable the notification so it can't cause trouble
921 notif_global_error = true; // throw the red flag that an error happened on init
930 // used by MSG_CHOICE to build list of choices
932 void Notification_GetCvars(void)
935 for(i = 0; i <= NOTIF_CHOICE_COUNT; ++i)
937 GetCvars_handleFloat(
940 msg_choice_choices[i],
941 sprintf("notification_%s", msg_choice_notifs[i].nent_name)
947 // used to output notifications.cfg file
948 void Dump_Notifications(float fh, float alsoprint)
950 #define NOTIF_WRITE(a) { \
952 if(alsoprint) { print(a); } }
953 #define NOTIF_WRITE_ENTITY(description) { \
956 "seta notification_%s \"%d\" \"%s\"\n", \
957 e.nent_name, e.nent_default, description \
959 NOTIF_WRITE(notif_msg) }
960 #define NOTIF_WRITE_ENTITY_CHOICE(descriptiona,descriptionb) { \
963 "seta notification_%s \"%d\" \"%s\"\n" \
964 "seta notification_%s_ALLOWED \"%d\" \"%s\"\n", \
965 e.nent_name, e.nent_default, descriptiona, \
966 e.nent_name, e.nent_challow_def, descriptionb \
968 NOTIF_WRITE(notif_msg) }
969 #define NOTIF_WRITE_HARDCODED(cvar,default,description) { \
972 "seta notification_%s \"%s\" \"%s\"\n", \
973 cvar, default, description \
975 NOTIF_WRITE(notif_msg) }
981 // Note: This warning only applies to the notifications.cfg file that is output...
983 // You ARE supposed to manually edit this function to add i.e. hard coded
984 // notification variables for mutators or game modes or such and then
985 // regenerate the notifications.cfg file from the new code.
987 NOTIF_WRITE("// ********************************************** //\n");
988 NOTIF_WRITE("// ** WARNING - DO NOT MANUALLY EDIT THIS FILE ** //\n");
989 NOTIF_WRITE("// ** ** //\n");
990 NOTIF_WRITE("// ** This file is automatically generated ** //\n");
991 NOTIF_WRITE("// ** by code with the command 'dumpnotifs'. ** //\n");
992 NOTIF_WRITE("// ** ** //\n");
993 NOTIF_WRITE("// ** If you add a new notification, please ** //\n");
994 NOTIF_WRITE("// ** regenerate this file with that command ** //\n");
995 NOTIF_WRITE("// ** making sure that the output matches ** //\n");
996 NOTIF_WRITE("// ** with the lists and defaults in code. ** //\n");
997 NOTIF_WRITE("// ** ** //\n");
998 NOTIF_WRITE("// ********************************************** //\n");
1000 // These notifications will also append their string as a comment...
1001 // This is not necessary, and does not matter if they vary between config versions,
1002 // it is just a semi-helpful tool for those who want to manually change their user settings.
1004 NOTIF_WRITE(sprintf("\n// MSG_ANNCE notifications (count = %d):\n", NOTIF_ANNCE_COUNT));
1005 for(i = 1; i <= NOTIF_ANNCE_COUNT; ++i)
1007 e = Get_Notif_Ent(MSG_ANNCE, i);
1008 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1011 "0 = disabled, 1 = enabled if gentle mode is off, 2 = always enabled"
1015 NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT));
1016 for(i = 1; i <= NOTIF_INFO_COUNT; ++i)
1018 e = Get_Notif_Ent(MSG_INFO, i);
1019 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1022 "0 = off, 1 = print to console, "
1023 "2 = print to console and chatbox (if notification_allow_chatboxprint is enabled)"
1027 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
1028 for(i = 1; i <= NOTIF_CENTER_COUNT; ++i)
1030 e = Get_Notif_Ent(MSG_CENTER, i);
1031 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1034 "0 = off, 1 = centerprint"
1038 NOTIF_WRITE(sprintf("\n// MSG_MULTI notifications (count = %d):\n", NOTIF_MULTI_COUNT));
1039 for(i = 1; i <= NOTIF_MULTI_COUNT; ++i)
1041 e = Get_Notif_Ent(MSG_MULTI, i);
1042 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1045 "Enable this multiple notification"
1049 NOTIF_WRITE(sprintf("\n// MSG_CHOICE notifications (count = %d):\n", NOTIF_CHOICE_COUNT));
1050 for(i = 1; i <= NOTIF_CHOICE_COUNT; ++i)
1052 e = Get_Notif_Ent(MSG_CHOICE, i);
1053 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1055 NOTIF_WRITE_ENTITY_CHOICE(
1056 "Choice for this notification 0 = off, 1 = default message, 2 = verbose message",
1057 "Allow choice for this notification 0 = off, 1 = only in warmup mode, 2 = always"
1061 // edit these to match whichever cvars are used for specific notification options
1062 NOTIF_WRITE("\n// HARD CODED notification variables:\n");
1064 NOTIF_WRITE_HARDCODED(
1065 "allow_chatboxprint", "1",
1066 "Allow INFO notifications to be printed to chat box"
1067 "0 = do not allow, "
1068 "1 = allow only if allowed by individual notification_INFO* cvars, "
1069 "2 = force all INFO notifications to be printed to the chatbox"
1072 NOTIF_WRITE_HARDCODED(
1074 "Print extra debug information on all notification function calls "
1075 "(Requires -DNOTIFICATIONS_DEBUG flag to be enabled on QCSRC compilation)... "
1076 "0 = disabled, 1 = dprint, 2 = print"
1079 NOTIF_WRITE_HARDCODED(
1080 "errors_are_fatal", "1",
1081 "If a notification fails upon initialization, cause a Host_Error to stop the program"
1084 NOTIF_WRITE_HARDCODED(
1085 "item_centerprinttime", "1.5",
1086 "How long to show item information centerprint messages (like 'You got the Electro' or such)"
1089 NOTIF_WRITE_HARDCODED(
1090 "lifetime_mapload", "10",
1091 "Amount of time that notification entities last immediately at mapload (in seconds) "
1092 "to help prevent notifications from being lost on early init (like gamestart countdown)"
1095 NOTIF_WRITE_HARDCODED(
1096 "lifetime_runtime", "0.5",
1097 "Amount of time that notification entities last on the server during runtime (In seconds)"
1100 NOTIF_WRITE_HARDCODED(
1101 "server_allows_location", "1",
1102 "Server side cvar for allowing death messages to show location information too"
1105 NOTIF_WRITE_HARDCODED(
1106 "show_location", "0",
1107 "Append location information to MSG_INFO death/kill messages"
1110 NOTIF_WRITE_HARDCODED(
1111 "show_location_string", "",
1112 "Replacement string piped into sprintf, "
1113 "so you can do different messages like this: ' at the %s' or ' (near %s)'"
1116 NOTIF_WRITE_HARDCODED(
1118 "Print information about sprees in death/kill messages"
1121 NOTIF_WRITE_HARDCODED(
1122 "show_sprees_center", "1",
1123 "Show spree information in MSG_CENTER messages... "
1124 "0 = off, 1 = target (but only for first victim) and attacker"
1127 NOTIF_WRITE_HARDCODED(
1128 "show_sprees_center_specialonly", "1",
1129 "Don't show spree information in MSG_CENTER messages if it isn't an achievement"
1132 NOTIF_WRITE_HARDCODED(
1133 "show_sprees_info", "3",
1134 "Show spree information in MSG_INFO messages... "
1135 "0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker"
1138 NOTIF_WRITE_HARDCODED(
1139 "show_sprees_info_newline", "1",
1140 "Show attacker spree information for MSG_INFO messages on a separate line than the death notification itself"
1143 NOTIF_WRITE_HARDCODED(
1144 "show_sprees_info_specialonly", "1",
1145 "Don't show attacker spree information in MSG_INFO messages if it isn't an achievement"
1148 NOTIF_WRITE(sprintf(
1150 "\n// Notification counts (total = %d): ",
1151 "MSG_ANNCE = %d, MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d, MSG_CHOICE = %d\n"
1156 NOTIF_CENTER_COUNT +
1168 #undef NOTIF_WRITE_HARDCODED
1169 #undef NOTIF_WRITE_ENTITY
1174 // ===============================
1175 // Frontend Notification Pushing
1176 // ===============================
1178 #ifdef NOTIFICATIONS_DEBUG
1179 void Debug_Notification(string input)
1181 switch(autocvar_notification_debug)
1183 case 1: { dprint(input); break; }
1184 case 2: { print(input); break; }
1189 string Local_Notification_sprintf(
1190 string input, string args,
1191 string s1, string s2, string s3, string s4,
1192 int f1, float f2, float f3, float f4)
1194 #ifdef NOTIFICATIONS_DEBUG
1195 Debug_Notification(sprintf(
1196 "Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
1197 MakeConsoleSafe(input),
1199 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1200 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1206 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
1210 for(sel_num = 0;(args != "");)
1212 selected = car(args); args = cdr(args);
1213 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf");
1214 switch(strtolower(selected))
1217 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1218 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1219 #define ARG_CASE_ARG_CS_SV(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1220 #define ARG_CASE_ARG_CS(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1221 #define ARG_CASE_ARG_SV(selected,result)
1222 #define ARG_CASE_ARG_DC(selected,result)
1224 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1225 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1226 #define ARG_CASE_ARG_CS_SV(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1227 #define ARG_CASE_ARG_CS(selected,result)
1228 #define ARG_CASE_ARG_SV(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1229 #define ARG_CASE_ARG_DC(selected,result)
1231 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
1234 #undef ARG_CASE_ARG_DC
1235 #undef ARG_CASE_ARG_SV
1236 #undef ARG_CASE_ARG_CS
1237 #undef ARG_CASE_ARG_CS_SV
1238 #undef ARG_CASE_ARG_CS_SV_DC
1239 #undef ARG_CASE_ARG_CS_SV_HA
1240 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
1244 strcat(input, "\n"),
1256 void Local_Notification_sound(
1257 float soundchannel, string soundfile,
1258 float soundvolume, float soundposition)
1260 if((soundfile != prev_soundfile) || (time >= (prev_soundtime + autocvar_cl_announcer_antispam)))
1262 #ifdef NOTIFICATIONS_DEBUG
1263 Debug_Notification(sprintf(
1264 "Local_Notification_sound(world, %f, '%s', %f, %f);\n",
1267 "announcer/%s/%s.wav",
1268 autocvar_cl_announcer,
1280 "announcer/%s/%s.wav",
1281 autocvar_cl_announcer,
1288 if(prev_soundfile) { strunzone(prev_soundfile); }
1289 prev_soundfile = strzone(soundfile);
1290 prev_soundtime = time;
1294 #ifdef NOTIFICATIONS_DEBUG
1295 Debug_Notification(sprintf(
1297 "Local_Notification_sound(world, %f, '%s', %f, %f) ",
1298 "^1BLOCKED BY ANTISPAM:^7 prevsnd: '%s', timediff: %f, limit: %f\n"
1302 "announcer/%s/%s.wav",
1303 autocvar_cl_announcer,
1309 (time - prev_soundtime),
1310 autocvar_cl_announcer_antispam
1316 void Local_Notification_HUD_Notify_Push(
1317 string icon, string hudargs,
1318 string s1, string s2, string s3, string s4,
1319 float f1, float f2, float f3, float f4)
1322 arg_slot[0] = ""; arg_slot[1] = "";
1325 for(sel_num = 0;(hudargs != "");)
1327 selected = car(hudargs); hudargs = cdr(hudargs);
1328 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push");
1329 switch(strtolower(selected))
1331 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1332 #define ARG_CASE_ARG_CS_SV_DC(selected,result)
1333 #define ARG_CASE_ARG_CS_SV(selected,result)
1334 #define ARG_CASE_ARG_CS(selected,result)
1335 #define ARG_CASE_ARG_SV(selected,result)
1336 #define ARG_CASE_ARG_DC(selected,result)
1337 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
1340 #undef ARG_CASE_ARG_DC
1341 #undef ARG_CASE_ARG_SV
1342 #undef ARG_CASE_ARG_CS
1343 #undef ARG_CASE_ARG_CS_SV
1344 #undef ARG_CASE_ARG_CS_SV_DC
1345 #undef ARG_CASE_ARG_CS_SV_HA
1346 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
1349 #ifdef NOTIFICATIONS_DEBUG
1350 Debug_Notification(sprintf(
1351 "Local_Notification_HUD_Notify_Push('%s^7', '%s', %s, %s, %s);\n",
1354 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1355 sprintf("%d, %d, %d, %d", f1, f2, f3, f4),
1356 MakeConsoleSafe(sprintf("'%s^7', '%s^7'", stof(arg_slot[0]), stof(arg_slot[1])))
1359 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
1362 void Local_Notification_centerprint_generic(
1363 string input, string durcnt,
1364 float cpid, float f1, float f2)
1368 arg_slot[0] = ""; arg_slot[1] = "";
1370 for(sel_num = 0;(durcnt != "");)
1372 selected = car(durcnt); durcnt = cdr(durcnt);
1373 NOTIF_HIT_MAX(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic");
1374 switch(strtolower(selected))
1376 #define ARG_CASE_ARG_CS_SV_HA(selected,result)
1377 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1378 #define ARG_CASE_ARG_CS_SV(selected,result)
1379 #define ARG_CASE_ARG_CS(selected,result)
1380 #define ARG_CASE_ARG_SV(selected,result)
1381 #define ARG_CASE_ARG_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1382 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
1385 #undef ARG_CASE_ARG_DC
1386 #undef ARG_CASE_ARG_SV
1387 #undef ARG_CASE_ARG_CS
1388 #undef ARG_CASE_ARG_CS_SV
1389 #undef ARG_CASE_ARG_CS_SV_DC
1390 #undef ARG_CASE_ARG_CS_SV_HA
1393 if(ftos(stof(selected)) != "") { arg_slot[sel_num] = selected; ++sel_num; }
1394 else { NOTIF_HIT_UNKNOWN(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic") }
1399 #ifdef NOTIFICATIONS_DEBUG
1400 Debug_Notification(sprintf(
1401 "Local_Notification_centerprint_generic('%s^7', '%s', %d, %d, %d, %d);\n",
1402 MakeConsoleSafe(input),
1409 centerprint_generic(cpid, input, stof(arg_slot[0]), stof(arg_slot[1]));
1413 void Local_Notification(float net_type, float net_name, ...count)
1415 // check if this should be aborted
1416 if(net_name == NOTIF_ABORT)
1418 #ifdef NOTIFICATIONS_DEBUG
1419 Debug_Notification(sprintf(
1420 "Local_Notification(%s, %s, ...);\n",
1421 Get_Notif_TypeName(net_type),
1428 // check supplied type and name for errors
1429 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
1432 #ifdef NOTIFICATIONS_DEBUG
1433 Debug_Notification(sprintf(
1434 "Local_Notification(%s, %d, ...);\n",
1435 Get_Notif_TypeName(net_type),
1436 Get_Notif_Ent(net_type, net_name).nent_name
1439 backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs));
1443 // retreive entity of this notification
1444 entity notif = Get_Notif_Ent(net_type, net_name);
1447 #ifdef NOTIFICATIONS_DEBUG
1448 Debug_Notification(sprintf(
1449 "Local_Notification(%s, %d, ...);\n",
1450 Get_Notif_TypeName(net_type),
1454 backtrace("Local_Notification: Could not find notification entity!\n");
1458 // check if the notification is enabled
1459 if (!notif.nent_enabled)
1461 #ifdef NOTIFICATIONS_DEBUG
1462 Debug_Notification(sprintf(
1463 "Local_Notification(%s, %s, ...): Entity was disabled...\n",
1464 Get_Notif_TypeName(net_type),
1471 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1472 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1473 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1474 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1475 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1476 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1477 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1478 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1480 #ifdef NOTIFICATIONS_DEBUG
1481 Debug_Notification(sprintf(
1482 "Local_Notification(%s, %s, %s, %s);\n",
1483 Get_Notif_TypeName(net_type),
1485 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1486 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1490 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1494 "Not enough arguments for Local_Notification(%s, %s, ...)! ",
1495 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1496 "Check the definition and function call for accuracy...?\n"
1498 Get_Notif_TypeName(net_type),
1500 notif.nent_stringcount,
1501 notif.nent_floatcount,
1506 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1510 "Too many arguments for Local_Notification(%s, %s, ...)! ",
1511 "stringcount(%d) + floatcount(%d) < count(%d)\n",
1512 "Check the definition and function call for accuracy...?\n"
1514 Get_Notif_TypeName(net_type),
1516 notif.nent_stringcount,
1517 notif.nent_floatcount,
1528 Local_Notification_sound(
1535 backtrace("MSG_ANNCE on server?... Please notify Samual immediately!\n");
1543 Local_Notification_sprintf(
1550 if(notif.nent_icon != "")
1552 Local_Notification_HUD_Notify_Push(
1565 Local_Notification_centerprint_generic(
1566 Local_Notification_sprintf(
1580 if(notif.nent_msginfo)
1581 if(notif.nent_msginfo.nent_enabled)
1583 Local_Notification_WOVA(
1585 notif.nent_msginfo.nent_id,
1586 notif.nent_msginfo.nent_stringcount,
1587 notif.nent_msginfo.nent_floatcount,
1592 if(notif.nent_msgannce)
1593 if(notif.nent_msgannce.nent_enabled)
1595 Local_Notification_WOVA(
1597 notif.nent_msgannce.nent_id,
1602 if(notif.nent_msgcenter)
1603 if(notif.nent_msgcenter.nent_enabled)
1605 Local_Notification_WOVA(
1607 notif.nent_msgcenter.nent_id,
1608 notif.nent_msgcenter.nent_stringcount,
1609 notif.nent_msgcenter.nent_floatcount,
1619 entity found_choice;
1621 if(notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2)))
1623 switch(cvar_string(sprintf("notification_%s", notif.nent_name)))
1625 case 1: found_choice = notif.nent_optiona; break;
1626 case 2: found_choice = notif.nent_optionb; break;
1627 default: return; // not enabled anyway
1630 else { found_choice = notif.nent_optiona; }
1632 Local_Notification_WOVA(
1633 found_choice.nent_type,
1634 found_choice.nent_id,
1635 found_choice.nent_stringcount,
1636 found_choice.nent_floatcount,
1643 // WOVA = Without Variable Arguments
1644 void Local_Notification_WOVA(
1645 float net_type, float net_name,
1646 float stringcount, float floatcount,
1647 string s1, string s2, string s3, string s4,
1648 float f1, float f2, float f3, float f4)
1650 #define VARITEM(stringc,floatc,args) \
1651 if((stringcount == stringc) && (floatcount == floatc)) \
1652 { Local_Notification(net_type, net_name, args); return; }
1653 EIGHT_VARS_TO_VARARGS_VARLIST
1655 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
1659 // =========================
1660 // Notification Networking
1661 // =========================
1664 void Read_Notification(float is_new)
1666 float net_type = ReadByte();
1667 float net_name = ReadShort();
1671 if(net_type == MSG_CENTER_CPID)
1673 #ifdef NOTIFICATIONS_DEBUG
1674 Debug_Notification(sprintf(
1675 "Read_Notification(%d) at %f: net_type = %s, net_name = %d\n",
1678 Get_Notif_TypeName(net_type),
1685 if(net_name == 0) { reset_centerprint_messages(); }
1686 else if(net_name != NO_CPID)
1688 // in this case, net_name IS the cpid we want to kill
1689 centerprint_generic(net_name, "", 0, 0);
1694 "Read_Notification(%d) at %f: ^1TRIED TO KILL NO_CPID CENTERPRINT!\n",
1703 notif = Get_Notif_Ent(net_type, net_name);
1704 if (!notif) { backtrace("Read_Notification: Could not find notification entity!\n"); return; }
1706 #ifdef NOTIFICATIONS_DEBUG
1707 Debug_Notification(sprintf(
1708 "Read_Notification(%d) at %f: net_type = %s, net_name = %s\n",
1711 Get_Notif_TypeName(net_type),
1716 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
1717 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
1718 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
1719 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
1720 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
1721 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
1722 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
1723 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
1727 Local_Notification_WOVA(
1729 notif.nent_stringcount,
1730 notif.nent_floatcount,
1739 void Net_Notification_Remove()
1741 if (!self) { backtrace(sprintf("Net_Notification_Remove() at %f: Missing self!?\n", time)); return; }
1743 #ifdef NOTIFICATIONS_DEBUG
1744 Debug_Notification(sprintf(
1745 "Net_Notification_Remove() at %f: %s '%s - %s' notification\n",
1747 ((self.nent_net_name == -1) ? "Killed" : "Removed"),
1748 Get_Notif_TypeName(self.nent_net_type),
1749 self.owner.nent_name
1754 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
1758 float Net_Write_Notification(entity client, float sf)
1760 if(Notification_ShouldSend(self.nent_broadcast, client, self.nent_client))
1763 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
1764 WriteByte(MSG_ENTITY, self.nent_net_type);
1765 WriteShort(MSG_ENTITY, self.nent_net_name);
1766 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
1767 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
1770 else { return false; }
1773 void Kill_Notification(
1774 float broadcast, entity client,
1775 float net_type, float net_name)
1777 #ifdef NOTIFICATIONS_DEBUG
1778 Debug_Notification(sprintf(
1779 "Kill_Notification(%s, '%s', %s, %d);\n",
1780 Get_Notif_BroadcastName(broadcast),
1782 (net_type ? Get_Notif_TypeName(net_type) : "0"),
1787 string checkargs = Notification_CheckArgs(broadcast, client, 1, 1);
1788 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Kill_Notification: %s\n", checkargs)); return; }
1790 entity notif, net_notif;
1791 float killed_cpid = NO_CPID;
1797 killed_cpid = 0; // kill ALL centerprints
1805 entity notif = Get_Notif_Ent(net_type, net_name);
1806 if (!notif) { backtrace("Kill_Notification: Could not find notification entity!\n"); return; }
1809 killed_cpid = notif.nent_cpid;
1811 killed_cpid = NO_CPID;
1815 killed_cpid = 0; // kill ALL centerprints
1820 case MSG_CENTER_CPID:
1822 killed_cpid = net_name;
1827 if(killed_cpid != NO_CPID)
1829 net_notif = spawn();
1830 net_notif.classname = "net_kill_notification";
1831 net_notif.nent_broadcast = broadcast;
1832 net_notif.nent_client = client;
1833 net_notif.nent_net_type = MSG_CENTER_CPID;
1834 net_notif.nent_net_name = killed_cpid;
1835 Net_LinkEntity(net_notif, false, autocvar_notification_lifetime_runtime, Net_Write_Notification);
1838 for(notif = world; (notif = find(notif, classname, "net_notification"));)
1842 if((killed_cpid != NO_CPID) && (notif.nent_net_type == MSG_CENTER))
1844 if(notif.owner.nent_cpid == killed_cpid)
1846 notif.nent_net_name = -1;
1847 notif.nextthink = time;
1849 else { continue; } // we ARE looking for a specific CPID, don't kill everything else too
1851 else if(notif.nent_net_type == net_type)
1855 if(notif.nent_net_name == net_name) { notif.nent_net_name = -1; notif.nextthink = time; }
1856 else { continue; } // we ARE looking for a certain net_name, don't kill everything else too
1858 else { notif.nent_net_name = -1; notif.nextthink = time; }
1860 else { continue; } // we ARE looking for a certain net_type, don't kill everything else too
1862 else { notif.nent_net_name = -1; notif.nextthink = time; }
1866 void Send_Notification(
1867 float broadcast, entity client,
1868 float net_type, float net_name,
1871 // check if this should be aborted
1872 if(net_name == NOTIF_ABORT)
1874 #ifdef NOTIFICATIONS_DEBUG
1875 Debug_Notification(sprintf(
1876 "Send_Notification(%s, '%s', %s, %s, ...);\n",
1877 Get_Notif_BroadcastName(broadcast),
1879 Get_Notif_TypeName(net_type),
1886 // check supplied broadcast, target, type, and name for errors
1887 string checkargs = Notification_CheckArgs(broadcast, client, net_type, net_name);
1890 #ifdef NOTIFICATIONS_DEBUG
1891 Debug_Notification(sprintf(
1892 "Send_Notification(%s, '%s', %s, %s, ...);\n",
1893 Get_Notif_BroadcastName(broadcast),
1895 Get_Notif_TypeName(net_type),
1896 Get_Notif_Ent(net_type, net_name).nent_name
1899 backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs));
1903 // retreive entity of this notification
1904 entity notif = Get_Notif_Ent(net_type, net_name);
1907 #ifdef NOTIFICATIONS_DEBUG
1908 Debug_Notification(sprintf(
1909 "Send_Notification(%s, '%s', %s, %d, ...);\n",
1910 Get_Notif_BroadcastName(broadcast),
1912 Get_Notif_TypeName(net_type),
1916 backtrace("Send_Notification: Could not find notification entity!\n");
1920 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1921 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1922 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1923 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1924 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1925 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1926 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1927 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1929 #ifdef NOTIFICATIONS_DEBUG
1930 Debug_Notification(sprintf(
1931 "Send_Notification(%s, %s, %s);\n",
1934 Get_Notif_BroadcastName(broadcast),
1936 Get_Notif_TypeName(net_type),
1939 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1940 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1944 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1948 "Not enough arguments for Send_Notification(%s, ...)! ",
1949 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1950 "Check the definition and function call for accuracy...?\n"
1953 #ifdef NOTIFICATIONS_DEBUG
1955 Get_Notif_BroadcastName(broadcast),
1961 Get_Notif_TypeName(net_type),
1964 notif.nent_stringcount,
1965 notif.nent_floatcount,
1970 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1974 "Too many arguments for Send_Notification(%s, ...)! ",
1975 "stringcount(%d) + floatcount(%d) < count(%d)\n",
1976 "Check the definition and function call for accuracy...?\n"
1979 #ifdef NOTIFICATIONS_DEBUG
1981 Get_Notif_BroadcastName(broadcast),
1987 Get_Notif_TypeName(net_type),
1990 notif.nent_stringcount,
1991 notif.nent_floatcount,
2001 broadcast == NOTIF_ALL
2003 broadcast == NOTIF_ALL_EXCEPT
2007 net_type == MSG_ANNCE
2009 net_type == MSG_CENTER
2013 Local_Notification_WOVA(
2015 notif.nent_stringcount,
2016 notif.nent_floatcount,
2021 if(net_type == MSG_CHOICE)
2023 // THIS GETS TRICKY... now we have to cycle through each possible player (checking broadcast)
2024 // and then do an individual NOTIF_ONE_ONLY recursive call for each one depending on their option...
2025 // It's slow, but it's better than the alternatives:
2026 // 1. Constantly networking all info and letting client decide
2027 // 2. Manually handling each separate call on per-usage basis (See old CTF usage of verbose)
2028 entity found_choice;
2030 #define RECURSE_FROM_CHOICE(ent,action) \
2031 if(notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2))) \
2033 switch(ent.msg_choice_choices[net_name - 1]) \
2035 case 1: found_choice = notif.nent_optiona; break; \
2036 case 2: found_choice = notif.nent_optionb; break; \
2040 else { found_choice = notif.nent_optiona; } \
2041 Send_Notification_WOVA( \
2044 found_choice.nent_type, \
2045 found_choice.nent_id, \
2046 found_choice.nent_stringcount, \
2047 found_choice.nent_floatcount, \
2053 case NOTIF_ONE_ONLY: // we can potentially save processing power with this broadcast method
2055 if(IS_REAL_CLIENT(client))
2056 { RECURSE_FROM_CHOICE(client, return) }
2062 FOR_EACH_REALCLIENT(to)
2063 { if(Notification_ShouldSend(broadcast, to, client))
2064 { RECURSE_FROM_CHOICE(to, continue) } }
2071 entity net_notif = spawn();
2072 net_notif.owner = notif;
2073 net_notif.classname = "net_notification";
2074 net_notif.nent_broadcast = broadcast;
2075 net_notif.nent_client = client;
2076 net_notif.nent_net_type = net_type;
2077 net_notif.nent_net_name = net_name;
2078 net_notif.nent_stringcount = notif.nent_stringcount;
2079 net_notif.nent_floatcount = notif.nent_floatcount;
2082 for(i = 0; i < net_notif.nent_stringcount; ++i)
2083 { net_notif.nent_strings[i] = strzone(...(i, string)); }
2084 for(i = 0; i < net_notif.nent_floatcount; ++i)
2085 { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
2087 net_notif.think = Net_Notification_Remove;
2088 net_notif.nextthink =
2089 ((time > autocvar_notification_lifetime_mapload)
2091 (time + autocvar_notification_lifetime_runtime)
2093 autocvar_notification_lifetime_mapload
2096 Net_LinkEntity(net_notif, false, 0, Net_Write_Notification);
2100 // WOVA = Without Variable Arguments
2101 void Send_Notification_WOVA(
2102 float broadcast, entity client,
2103 float net_type, float net_name,
2104 float stringcount, float floatcount,
2105 string s1, string s2, string s3, string s4,
2106 float f1, float f2, float f3, float f4)
2108 #ifdef NOTIFICATIONS_DEBUG
2109 entity notif = Get_Notif_Ent(net_type, net_name);
2110 Debug_Notification(sprintf(
2111 "Send_Notification_WOVA(%s, %d, %d, %s, %s);\n",
2114 Get_Notif_BroadcastName(broadcast),
2116 Get_Notif_TypeName(net_type),
2121 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
2122 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
2126 #define VARITEM(stringc,floatc,args) \
2127 if((stringcount == stringc) && (floatcount == floatc)) \
2128 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
2129 EIGHT_VARS_TO_VARARGS_VARLIST
2131 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
2134 // WOCOVA = Without Counts Or Variable Arguments
2135 void Send_Notification_WOCOVA(
2136 float broadcast, entity client,
2137 float net_type, float net_name,
2138 string s1, string s2, string s3, string s4,
2139 float f1, float f2, float f3, float f4)
2141 entity notif = Get_Notif_Ent(net_type, net_name);
2143 #ifdef NOTIFICATIONS_DEBUG
2144 Debug_Notification(sprintf(
2145 "Send_Notification_WOCOVA(%s, %s, %s);\n",
2148 Get_Notif_BroadcastName(broadcast),
2150 Get_Notif_TypeName(net_type),
2153 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
2154 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
2158 #define VARITEM(stringc,floatc,args) \
2159 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
2160 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
2161 EIGHT_VARS_TO_VARARGS_VARLIST
2163 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
2165 #endif // ifdef SVQC