1 // ================================================
2 // Unified notification system, written by Samual
3 // Last updated: June, 2013
4 // ================================================
6 string Get_Notif_TypeName(float 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(float net_type, float 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));
35 string Notification_CheckArgs_TypeName(float net_type, float net_name)
37 // check supplied type and name for errors
38 string checkargs = "";
39 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
40 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
41 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
44 CHECKARG_TYPENAME(ANNCE)
45 CHECKARG_TYPENAME(INFO)
46 CHECKARG_TYPENAME(CENTER)
47 CHECKARG_TYPENAME(MULTI)
48 CHECKARG_TYPENAME(CHOICE)
49 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
51 #undef CHECKARG_TYPENAME
56 string Notification_CheckArgs(
57 float broadcast, entity client,
58 float net_type, float net_name)
60 // check supplied broadcast, target, type, and name for errors
61 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
62 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
68 if(IS_NOT_A_CLIENT(client))
69 { checkargs = sprintf("%sNo client provided!", checkargs); }
73 case NOTIF_ALL_EXCEPT:
75 if(IS_NOT_A_CLIENT(client))
76 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
83 { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
88 case NOTIF_TEAM_EXCEPT:
90 if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
91 else if(IS_NOT_A_CLIENT(client))
93 if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
94 else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
99 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
104 float Notification_ShouldSend(float broadcast, entity to_client, entity other_client)
108 case NOTIF_ONE: // send to one client and their spectator
111 (to_client == other_client)
116 (to_client.enemy == other_client)
121 case NOTIF_ONE_ONLY: // send ONLY to one client
123 if(to_client == other_client) { return TRUE; }
126 case NOTIF_TEAM: // send only to X team and their spectators
129 (to_client.team == other_client.team)
134 (to_client.enemy.team == other_client.team)
139 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
142 (to_client != other_client)
145 (to_client.team == other_client.team)
151 (to_client.enemy != other_client)
153 (to_client.enemy.team == other_client.team)
160 case NOTIF_ALL: // send to everyone
164 case NOTIF_ALL_EXCEPT: // send to everyone except X person and their spectators
167 (to_client != other_client)
172 (to_client.enemy == other_client)
183 // ===============================
184 // Initialization Core Functions
185 // ===============================
187 // used by restartnotifs command to initialize notifications
188 void Destroy_Notification_Entity(entity notif)
190 if(notif.nent_name != "") { strunzone(notif.nent_name); }
191 if(notif.nent_snd != "") { strunzone(notif.nent_snd); }
192 if(notif.nent_args != "") { strunzone(notif.nent_args); }
193 if(notif.nent_hudargs != "") { strunzone(notif.nent_hudargs); }
194 if(notif.nent_icon != "") { strunzone(notif.nent_icon); }
195 if(notif.nent_durcnt != "") { strunzone(notif.nent_durcnt); }
196 if(notif.nent_string != "") { strunzone(notif.nent_string); }
200 void Destroy_All_Notifications(void)
205 #define DESTROY_LOOP(type,count) \
206 for(i = 1; i <= count; ++i) \
208 notif = Get_Notif_Ent(type, i); \
209 if not(notif) { backtrace("Destroy_All_Notifications(): Missing notification entity!\n"); return; } \
210 Destroy_Notification_Entity(notif); \
213 // kill all networked notifications and centerprints
215 Kill_Notification(NOTIF_ALL, world, 0, 0);
217 reset_centerprint_messages();
220 // kill all real notification entities
221 DESTROY_LOOP(MSG_ANNCE, NOTIF_ANNCE_COUNT)
222 DESTROY_LOOP(MSG_INFO, NOTIF_INFO_COUNT)
223 DESTROY_LOOP(MSG_CENTER, NOTIF_CENTER_COUNT)
224 DESTROY_LOOP(MSG_MULTI, NOTIF_MULTI_COUNT)
225 DESTROY_LOOP(MSG_CHOICE, NOTIF_CHOICE_COUNT)
229 string Process_Notif_Line(
238 if(typeid == MSG_INFO)
240 if((chat && autocvar_notification_allow_chatboxprint)
241 || (autocvar_notification_allow_chatboxprint == 2))
243 // pass 1: add ETX char at beginning of line
244 input = strcat("\{3}", input);
246 // pass 2: add ETX char at end of each new line (so that
247 // messages with multiple lines are put through chatbox too)
248 input = strreplace("\n", "\n\{3}", input);
250 // pass 3: strip trailing ETX char
251 if(substring(input, (strlen(input) - 1), 1) == "\{3}")
252 { input = substring(input, 0, (strlen(input) - 1)); }
257 // done to both MSG_INFO and MSG_CENTER
258 if(substring(input, (strlen(input) - 1), 1) == "\n")
262 "^1TRAILING NEW LINE AT END OF NOTIFICATION: ",
263 "^7net_type = %s, net_name = %s, string = %s.\n"
270 input = substring(input, 1, (strlen(input) - 1));
276 string Process_Notif_Args(
282 string selected, remaining = args;
285 for(;(remaining != "");)
287 selected = car(remaining); remaining = cdr(remaining);
291 case 1: // normal args
293 if(sel_num == NOTIF_MAX_ARGS)
297 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
298 "^7net_type = %s, net_name = %s, max args = %d.\n"
308 switch(strtolower(selected))
310 #define ARG_CASE(prog,selected,result) \
311 #if (prog != ARG_DC) \
312 case selected: { ++sel_num; break; } \
320 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
321 "^7net_type = %s, net_name = %s, args arg = '%s'.\n"
335 if(sel_num == NOTIF_MAX_HUDARGS)
339 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
340 "^7net_type = %s, net_name = %s, max hudargs = %d.\n"
350 switch(strtolower(selected))
352 #define ARG_CASE(prog,selected,result) \
353 #if (prog == ARG_CS_SV_HA) \
354 case selected: { ++sel_num; break; } \
362 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
363 "^7net_type = %s, net_name = %s, hudargs arg = '%s'.\n"
377 if(sel_num == NOTIF_MAX_DURCNT)
381 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
382 "^7net_type = %s, net_name = %s, max durcnt = %d.\n"
392 switch(strtolower(selected))
394 #define ARG_CASE(prog,selected,result) \
395 #if (prog == ARG_CS_SV_DC) || (prog == ARG_DC) \
396 case selected: { ++sel_num; break; } \
402 if(ftos(stof(selected)) != "") { ++sel_num; }
407 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
408 "^7net_type = %s, net_name = %s, durcnt arg = '%s'.\n"
426 void Create_Notification_Entity(
452 // =====================
453 // Global Entity Setup
454 // =====================
455 entity notif = spawn();
456 string typestring = "";
461 msg_annce_notifs[nameid - 1] = notif;
462 notif.classname = "msg_annce_notification";
467 msg_info_notifs[nameid - 1] = notif;
468 notif.classname = "msg_info_notification";
473 msg_center_notifs[nameid - 1] = notif;
474 notif.classname = "msg_center_notification";
479 msg_multi_notifs[nameid - 1] = notif;
480 notif.classname = "msg_multi_notification";
485 msg_choice_notifs[nameid - 1] = notif;
486 notif.classname = "msg_choice_notification";
494 "^1NOTIFICATION WITH IMPROPER TYPE: ",
495 "^7net_type = %d, net_name = %s.\n"
500 return; // It's not possible to recover from this one
503 notif.nent_default = var_default;
504 notif.nent_name = strzone(namestring);
505 notif.nent_type = typeid;
506 notif.nent_id = nameid;
507 notif.nent_enabled = (1 <= var_cvar);
509 typestring = Get_Notif_TypeName(typeid);
511 // Other pre-notif-setup requisites
514 // ====================
515 // Notification Setup
516 // ====================
521 // Set MSG_ANNCE information and handle precaching
523 if not(GENTLE && (var_cvar == 1))
527 if(notif.nent_enabled)
529 precache_sound(sprintf("announcer/%s/%s.wav", autocvar_cl_announcer, snd));
530 notif.nent_channel = channel;
531 notif.nent_snd = strzone(snd);
532 notif.nent_vol = vol;
533 notif.nent_position = position;
540 "^1NOTIFICATION WITH NO SOUND: ",
541 "^7net_type = %s, net_name = %s.\n"
549 else { notif.nent_enabled = FALSE; }
551 notif.nent_enabled = FALSE;
560 // Set MSG_INFO and MSG_CENTER string/float counts
561 notif.nent_stringcount = strnum;
562 notif.nent_floatcount = flnum;
564 // Only initialize arguments if we're either a client or on a dedicated server
566 float should_process_args = server_is_dedicated;
568 float should_process_args = TRUE;
571 if(should_process_args)
573 // ========================
574 // Process Main Arguments
575 // ========================
580 notif.nent_args = strzone(
581 Process_Notif_Args(1, args, typestring, namestring));
583 else if((hudargs == "") && (durcnt ==""))
587 "^1NOTIFICATION HAS ARG COUNTS BUT NO ARGS OR HUDARGS OR DURCNT: ",
588 "^7net_type = %s, net_name = %s, strnum = %d, flnum = %d\n"
600 notif.nent_args = strzone(
601 Process_Notif_Args(1, args, typestring, namestring));
605 // =======================================
606 // Process HUD and Centerprint Arguments
607 // Only processed on CSQC, as these
608 // args are only for HUD features.
609 // =======================================
613 notif.nent_hudargs = strzone(
614 Process_Notif_Args(2, hudargs, typestring, namestring));
616 if(icon != "") { notif.nent_icon = strzone(icon); }
621 "^1NOTIFICATION HAS HUDARGS BUT NO ICON: ",
622 "^7net_type = %s, net_name = %s.\n"
634 "^1NOTIFICATION HAS ICON BUT NO HUDARGS: ",
635 "^7net_type = %s, net_name = %s.\n"
645 notif.nent_durcnt = strzone(
646 Process_Notif_Args(3, durcnt, typestring, namestring));
648 if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
653 "^1NOTIFICATION HAS DURCNT BUT NO CPID: ",
654 "^7net_type = %s, net_name = %s.\n"
662 else if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
666 // ======================
667 // Process Notif String
668 // ======================
669 #define SET_NOTIF_STRING(string,stringname) \
670 notif.nent_string = strzone(CCR( \
671 Process_Notif_Line( \
683 if(gentle != "") { SET_NOTIF_STRING(gentle, "GENTLE") }
684 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
686 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
688 #undef SET_NOTIF_STRING
690 // Check to make sure a string was chosen
691 if(notif.nent_string == "")
695 "^1EMPTY NOTIFICATION: ",
696 "^7net_type = %s, net_name = %s.\n"
710 // Set MSG_MULTI string/float counts
711 if((anncename == NO_MSG) && (infoname == NO_MSG) && (centername == NO_MSG))
715 "^1NOTIFICATION WITH NO SUBCALLS: ",
716 "^7net_type = %s, net_name = %s.\n"
725 // announcements don't actually need any arguments, so lets not even count them.
726 if(anncename != NO_MSG) { notif.nent_msgannce = msg_annce_notifs[anncename - 1]; }
728 float infoname_stringcount = 0, infoname_floatcount = 0;
729 float centername_stringcount = 0, centername_floatcount = 0;
731 if(infoname != NO_MSG)
733 notif.nent_msginfo = msg_info_notifs[infoname - 1];
734 infoname_stringcount = notif.nent_msginfo.nent_stringcount;
735 infoname_floatcount = notif.nent_msginfo.nent_floatcount;
738 if(centername != NO_MSG)
740 notif.nent_msgcenter = msg_center_notifs[centername - 1];
741 centername_stringcount = notif.nent_msgcenter.nent_stringcount;
742 centername_floatcount = notif.nent_msgcenter.nent_floatcount;
745 // set the requirements of THIS notification to the totals of its subcalls
746 notif.nent_stringcount = max(infoname_stringcount, centername_stringcount);
747 notif.nent_floatcount = max(infoname_floatcount, centername_floatcount);
755 if((chtype == NO_MSG) || (optiona == NO_MSG) || (optionb == NO_MSG))
759 "^1NOTIFICATION IS MISSING CHOICE PARAMS: ",
760 "^7net_type = %s, net_name = %s.\n"
773 notif.nent_optiona = msg_annce_notifs[optiona - 1];
774 notif.nent_optionb = msg_annce_notifs[optionb - 1];
779 notif.nent_optiona = msg_info_notifs[optiona - 1];
780 notif.nent_optionb = msg_info_notifs[optionb - 1];
785 notif.nent_optiona = msg_center_notifs[optiona - 1];
786 notif.nent_optionb = msg_center_notifs[optionb - 1];
791 notif.nent_optiona = msg_multi_notifs[optiona - 1];
792 notif.nent_optionb = msg_multi_notifs[optionb - 1];
795 case MSG_CHOICE: // should we REALLY allow nested options?...
797 notif.nent_optiona = msg_choice_notifs[optiona - 1];
798 notif.nent_optionb = msg_choice_notifs[optionb - 1];
806 "^1NOTIFICATION WITH IMPROPER TYPE: ",
807 "^7net_type = %d, net_name = %s.\n"
820 default: print("DAFUQ?\n"); notif_error = TRUE; break;
823 // now check to see if any errors happened
826 notif.nent_enabled = FALSE; // disable the notification so it can't cause trouble
827 notif_global_error = TRUE; // throw the red flag that an error happened on init
836 // used by MSG_CHOICE to build list of choices
838 void Notification_GetCvars(void)
841 for(i = 0; i <= NOTIF_CHOICE_COUNT; ++i)
843 GetCvars_handleFloat(
846 msg_choice_choices[i],
847 sprintf("notification_%s", msg_choice_notifs[i].nent_name)
851 GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
855 // used to output notifications.cfg file
856 void Dump_Notifications(float fh, float alsoprint)
858 #define NOTIF_WRITE(a) { \
860 if(alsoprint) { print(a); } }
861 #define NOTIF_WRITE_ENTITY(description) { \
864 "seta notification_%s \"%d\" \"%s\"\n", \
865 e.nent_name, e.nent_default, description \
867 NOTIF_WRITE(notif_msg) }
868 #define NOTIF_WRITE_HARDCODED(cvar,default,description) { \
871 "seta notification_%s \"%s\" \"%s\"\n", \
872 cvar, default, description \
874 NOTIF_WRITE(notif_msg) }
880 // Note: This warning only applies to the notifications.cfg file that is output...
882 // You ARE supposed to manually edit this function to add i.e. hard coded
883 // notification variables for mutators or game modes or such and then
884 // regenerate the notifications.cfg file from the new code.
886 NOTIF_WRITE("// ********************************************** //\n");
887 NOTIF_WRITE("// ** WARNING - DO NOT MANUALLY EDIT THIS FILE ** //\n");
888 NOTIF_WRITE("// ** ** //\n");
889 NOTIF_WRITE("// ** This file is automatically generated ** //\n");
890 NOTIF_WRITE("// ** by code with the command 'dumpnotifs'. ** //\n");
891 NOTIF_WRITE("// ** ** //\n");
892 NOTIF_WRITE("// ** If you add a new notification, please ** //\n");
893 NOTIF_WRITE("// ** regenerate this file with that command ** //\n");
894 NOTIF_WRITE("// ** making sure that the output matches ** //\n");
895 NOTIF_WRITE("// ** with the lists and defaults in code. ** //\n");
896 NOTIF_WRITE("// ** ** //\n");
897 NOTIF_WRITE("// ********************************************** //\n");
899 // These notifications will also append their string as a comment...
900 // This is not necessary, and does not matter if they vary between config versions,
901 // it is just a semi-helpful tool for those who want to manually change their user settings.
903 NOTIF_WRITE(sprintf("\n// MSG_ANNCE notifications (count = %d):\n", NOTIF_ANNCE_COUNT));
904 for(i = 1; i <= NOTIF_ANNCE_COUNT; ++i)
906 e = Get_Notif_Ent(MSG_ANNCE, i);
907 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
910 "Notification control cvar: 0 = disabled, 1 = enabled if gentle mode is off, 2 = always enabled)"
914 NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT));
915 for(i = 1; i <= NOTIF_INFO_COUNT; ++i)
917 e = Get_Notif_Ent(MSG_INFO, i);
918 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
921 "Notification control cvar: 0 = off, 1 = print to console, "
922 "2 = print to console and chatbox (if notification_allow_chatboxprint is enabled)"
926 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
927 for(i = 1; i <= NOTIF_CENTER_COUNT; ++i)
929 e = Get_Notif_Ent(MSG_CENTER, i);
930 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
933 "Notification control cvar: 0 = off, 1 = centerprint"
937 NOTIF_WRITE(sprintf("\n// MSG_MULTI notifications (count = %d):\n", NOTIF_MULTI_COUNT));
938 for(i = 1; i <= NOTIF_MULTI_COUNT; ++i)
940 e = Get_Notif_Ent(MSG_MULTI, i);
941 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
944 "Notification control cvar: 0 = off, 1 = trigger subcalls"
948 NOTIF_WRITE(sprintf("\n// MSG_CHOICE notifications (count = %d):\n", NOTIF_CHOICE_COUNT));
949 for(i = 1; i <= NOTIF_CHOICE_COUNT; ++i)
951 e = Get_Notif_Ent(MSG_CHOICE, i);
952 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
955 "Notification control cvar: 0 = off, 1 = trigger option A subcall, 2 = trigger option B subcall"
959 // edit these to match whichever cvars are used for specific notification options
960 NOTIF_WRITE("\n// HARD CODED notification variables:\n");
962 NOTIF_WRITE_HARDCODED(
963 "allow_chatboxprint", "1",
964 "Allow notifications to be printed to chat box by setting notification cvar to 2 "
965 "(You can also set this cvar to 2 to force ALL notifications to be printed to the chatbox)"
968 NOTIF_WRITE_HARDCODED(
969 "ctf_capture_verbose", "0",
970 "Show extra information when someone captures a flag"
973 NOTIF_WRITE_HARDCODED(
974 "ctf_pickup_enemy_verbose", "0",
975 "Show extra information if an enemy picks up a flag"
978 NOTIF_WRITE_HARDCODED(
979 "ctf_pickup_team_verbose", "0",
980 "Show extra information if a team mate picks up a flag"
983 NOTIF_WRITE_HARDCODED(
985 "Print extra debug information on all notification function calls "
986 "(Requires -DNOTIFICATIONS_DEBUG flag to be enabled on QCSRC compilation)... "
987 "0 = disabled, 1 = dprint, 2 = print"
990 NOTIF_WRITE_HARDCODED(
991 "errors_are_fatal", "1",
992 "If a notification fails upon initialization, cause a Host_Error to stop the program"
995 NOTIF_WRITE_HARDCODED(
997 "Show extra information when you frag someone (or when you are fragged"
1000 NOTIF_WRITE_HARDCODED(
1001 "item_centerprinttime", "1.5",
1002 "How long to show item information centerprint messages (like 'You got the Electro' or such)"
1005 NOTIF_WRITE_HARDCODED(
1006 "lifetime_mapload", "10",
1007 "Amount of time that notification entities last immediately at mapload (in seconds) "
1008 "to help prevent notifications from being lost on early init (like gamestart countdown)"
1011 NOTIF_WRITE_HARDCODED(
1012 "lifetime_runtime", "0.5",
1013 "Amount of time that notification entities last on the server during runtime (In seconds)"
1016 NOTIF_WRITE_HARDCODED(
1017 "server_allows_frag_verbose", "1",
1018 "Server side cvar for showing extra information in frag messages... 0 = no extra frag information, "
1019 "1 = frag information only in warmup, 2 = frag information allowed all the time"
1022 NOTIF_WRITE_HARDCODED(
1023 "server_allows_location", "1",
1024 "Server side cvar for allowing death messages to show location information too"
1027 NOTIF_WRITE_HARDCODED(
1028 "show_location", "0",
1029 "Append location information to MSG_INFO death/kill messages"
1032 NOTIF_WRITE_HARDCODED(
1033 "show_location_string", "",
1034 "Replacement string piped into sprintf, "
1035 "so you can do different messages like this: ' at the %s' or ' (near %s)'"
1038 NOTIF_WRITE_HARDCODED(
1040 "Print information about sprees in death/kill messages"
1043 NOTIF_WRITE_HARDCODED(
1044 "show_sprees_center", "1",
1045 "Show spree information in MSG_CENTER messages... "
1046 "0 = off, 1 = target (but only for first victim) and attacker"
1049 NOTIF_WRITE_HARDCODED(
1050 "show_sprees_center_specialonly", "1",
1051 "Don't show spree information in MSG_CENTER messages if it isn't an achievement"
1054 NOTIF_WRITE_HARDCODED(
1055 "show_sprees_info", "3",
1056 "Show spree information in MSG_INFO messages... "
1057 "0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker"
1060 NOTIF_WRITE_HARDCODED(
1061 "show_sprees_info_newline", "1",
1062 "Show attacker spree information for MSG_INFO messages on a separate line than the death notification itself"
1065 NOTIF_WRITE_HARDCODED(
1066 "show_sprees_info_specialonly", "1",
1067 "Don't show attacker spree information in MSG_INFO messages if it isn't an achievement"
1070 NOTIF_WRITE(sprintf(
1072 "\n// Notification counts (total = %d): ",
1073 "MSG_ANNCE = %d, MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d, MSG_CHOICE = %d\n"
1078 NOTIF_CENTER_COUNT +
1090 #undef NOTIF_WRITE_HARDCODED
1091 #undef NOTIF_WRITE_ENTITY
1096 // ===============================
1097 // Frontend Notification Pushing
1098 // ===============================
1100 #ifdef NOTIFICATIONS_DEBUG
1101 void Debug_Notification(string input)
1103 switch(autocvar_notification_debug)
1105 case 1: { dprint(input); break; }
1106 case 2: { print(input); break; }
1111 string Local_Notification_sprintf(
1112 string input, string args,
1113 string s1, string s2, string s3, string s4,
1114 float f1, float f2, float f3, float f4)
1116 #ifdef NOTIFICATIONS_DEBUG
1117 Debug_Notification(sprintf(
1118 "Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
1119 MakeConsoleSafe(input),
1121 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1122 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1128 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
1132 for(sel_num = 0;(args != "");)
1134 selected = car(args); args = cdr(args);
1135 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
1136 switch(strtolower(selected))
1138 #define ARG_CASE(prog,selected,result) \
1140 #if (prog != ARG_SV) && (prog != ARG_DC) \
1141 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
1144 #if (prog != ARG_CS) && (prog != ARG_DC) \
1145 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
1150 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
1153 return sprintf(strcat(input, "\n"), arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
1157 void Local_Notification_sound(
1158 float soundchannel, string soundfile,
1159 float soundvolume, float soundposition)
1161 if((soundfile != prev_soundfile) || (time >= (prev_soundtime + autocvar_cl_announcer_antispam)))
1163 #ifdef NOTIFICATIONS_DEBUG
1164 Debug_Notification(sprintf(
1165 "Local_Notification_sound(world, %f, '%s', %f, %f);\n",
1168 "announcer/%s/%s.wav",
1169 autocvar_cl_announcer,
1181 "announcer/%s/%s.wav",
1182 autocvar_cl_announcer,
1189 if(prev_soundfile) { strunzone(prev_soundfile); }
1190 prev_soundfile = strzone(soundfile);
1191 prev_soundtime = time;
1195 #ifdef NOTIFICATIONS_DEBUG
1196 Debug_Notification(sprintf(
1198 "Local_Notification_sound(world, %f, '%s', %f, %f) ",
1199 "^1BLOCKED BY ANTISPAM:^7 prevsnd: '%s', timediff: %f, limit: %f\n"
1203 "announcer/%s/%s.wav",
1204 autocvar_cl_announcer,
1210 (time - prev_soundtime),
1211 autocvar_cl_announcer_antispam
1217 void Local_Notification_HUD_Notify_Push(
1218 string icon, string hudargs,
1219 string s1, string s2, string s3, string s4)
1223 arg_slot[0] = ""; arg_slot[1] = "";
1225 for(sel_num = 0;(hudargs != "");)
1227 selected = car(hudargs); hudargs = cdr(hudargs);
1228 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
1229 switch(strtolower(selected))
1231 #define ARG_CASE(prog,selected,result) \
1232 #if (prog == ARG_CS_SV_HA) \
1233 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
1237 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
1240 #ifdef NOTIFICATIONS_DEBUG
1241 Debug_Notification(sprintf(
1242 "Local_Notification_HUD_Notify_Push('%s^7', '%s', %s, %s);\n",
1245 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1246 MakeConsoleSafe(sprintf("'%s^7', '%s^7'", stof(arg_slot[0]), stof(arg_slot[1])))
1249 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
1252 void Local_Notification_centerprint_generic(
1253 string input, string durcnt,
1254 float cpid, float f1, float f2)
1258 arg_slot[0] = ""; arg_slot[1] = "";
1260 for(sel_num = 0;(durcnt != "");)
1262 selected = car(durcnt); durcnt = cdr(durcnt);
1263 NOTIF_HIT_MAX(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic")
1264 switch(strtolower(selected))
1266 #define ARG_CASE(prog,selected,result) \
1267 #if (prog == ARG_CS_SV_DC) || (prog == ARG_DC) \
1268 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
1274 if(ftos(stof(selected)) != "") { arg_slot[sel_num] = selected; ++sel_num; }
1275 else { NOTIF_HIT_UNKNOWN(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic") }
1280 #ifdef NOTIFICATIONS_DEBUG
1281 Debug_Notification(sprintf(
1282 "Local_Notification_centerprint_generic('%s^7', '%s', %d, %d, %d, %d);\n",
1283 MakeConsoleSafe(input),
1286 stof(arg_slot[0]), stof(arg_slot[1])
1289 centerprint_generic(cpid, input, stof(arg_slot[0]), stof(arg_slot[1]));
1293 void Local_Notification(float net_type, float net_name, ...count)
1295 // check supplied type and name for errors
1296 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
1297 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
1299 entity notif = Get_Notif_Ent(net_type, net_name);
1300 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
1301 if not(notif.nent_enabled)
1303 #ifdef NOTIFICATIONS_DEBUG
1304 Debug_Notification(sprintf(
1305 "Local_Notification(%s, %s): Entity was disabled...\n",
1306 Get_Notif_TypeName(net_type),
1313 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1317 "Not enough arguments for Local_Notification(%s, %s, ...)! ",
1318 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1319 "Check the definition and function call for accuracy...?\n"
1321 Get_Notif_TypeName(net_type), notif.nent_name,
1322 notif.nent_stringcount, notif.nent_floatcount, count
1326 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1330 "Too many arguments for Local_Notification(%s, %s, ...)! ",
1331 "stringcount(%d) + floatcount(%d) < count(%d)\n",
1332 "Check the definition and function call for accuracy...?\n"
1334 Get_Notif_TypeName(net_type), notif.nent_name,
1335 notif.nent_stringcount, notif.nent_floatcount, count
1340 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1341 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1342 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1343 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1344 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1345 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1346 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1347 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1349 #ifdef NOTIFICATIONS_DEBUG
1350 Debug_Notification(sprintf(
1351 "Local_Notification(%s, %s, %s, %s);\n",
1352 Get_Notif_TypeName(net_type),
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)
1364 Local_Notification_sound(
1371 backtrace("MSG_ANNCE on server?... Please notify Samual immediately!\n");
1379 Local_Notification_sprintf(
1386 if(notif.nent_icon != "")
1388 Local_Notification_HUD_Notify_Push(
1400 Local_Notification_centerprint_generic(
1401 Local_Notification_sprintf(
1415 if(notif.nent_msginfo)
1416 if(notif.nent_msginfo.nent_enabled)
1418 Local_Notification_WOVA(
1420 notif.nent_msginfo.nent_id,
1421 notif.nent_msginfo.nent_stringcount,
1422 notif.nent_msginfo.nent_floatcount,
1427 if(notif.nent_msgannce)
1428 if(notif.nent_msgannce.nent_enabled)
1430 Local_Notification_WOVA(
1432 notif.nent_msgannce.nent_id,
1437 if(notif.nent_msgcenter)
1438 if(notif.nent_msgcenter.nent_enabled)
1440 Local_Notification_WOVA(
1442 notif.nent_msgcenter.nent_id,
1443 notif.nent_msgcenter.nent_stringcount,
1444 notif.nent_msgcenter.nent_floatcount,
1454 entity found_choice;
1455 switch(cvar_string(sprintf("notification_%s", notif.nent_name)))
1457 case 1: found_choice = notif.nent_optiona; break;
1458 case 2: found_choice = notif.nent_optionb; break;
1459 default: return; // not enabled anyway
1461 Local_Notification_WOVA(
1462 found_choice.nent_type,
1463 found_choice.nent_id,
1464 found_choice.nent_stringcount,
1465 found_choice.nent_floatcount,
1472 // WOVA = Without Variable Arguments
1473 void Local_Notification_WOVA(
1474 float net_type, float net_name,
1475 float stringcount, float floatcount,
1476 string s1, string s2, string s3, string s4,
1477 float f1, float f2, float f3, float f4)
1479 #define VARITEM(stringc,floatc,args) \
1480 if((stringcount == stringc) && (floatcount == floatc)) \
1481 { Local_Notification(net_type, net_name, args); return; }
1482 EIGHT_VARS_TO_VARARGS_VARLIST
1484 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
1488 // =========================
1489 // Notification Networking
1490 // =========================
1493 void Read_Notification(float is_new)
1495 float net_type = ReadByte();
1496 float net_name = ReadShort();
1500 if(net_type == MSG_CENTER_CPID)
1502 #ifdef NOTIFICATIONS_DEBUG
1503 Debug_Notification(sprintf(
1504 "Read_Notification(%d) at %f: net_type = %s, net_name = %d\n",
1507 Get_Notif_TypeName(net_type),
1514 if(net_name == 0) { reset_centerprint_messages(); }
1515 else if(net_name != NO_CPID)
1517 // in this case, net_name IS the cpid we want to kill
1518 centerprint_generic(net_name, "", 0, 0);
1523 "Read_Notification(%d) at %f: ^1TRIED TO KILL NO_CPID CENTERPRINT!\n",
1532 notif = Get_Notif_Ent(net_type, net_name);
1533 if not(notif) { backtrace("Read_Notification: Could not find notification entity!\n"); return; }
1535 #ifdef NOTIFICATIONS_DEBUG
1536 Debug_Notification(sprintf(
1537 "Read_Notification(%d) at %f: net_type = %s, net_name = %s\n",
1540 Get_Notif_TypeName(net_type),
1545 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
1546 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
1547 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
1548 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
1549 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
1550 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
1551 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
1552 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
1556 Local_Notification_WOVA(
1558 notif.nent_stringcount,
1559 notif.nent_floatcount,
1568 void Net_Notification_Remove()
1570 if not(self) { backtrace(sprintf("Net_Notification_Remove() at %f: Missing self!?\n", time)); return; }
1572 #ifdef NOTIFICATIONS_DEBUG
1573 Debug_Notification(sprintf(
1574 "Net_Notification_Remove() at %f: %s '%s - %s' notification\n",
1576 ((self.nent_net_name == -1) ? "Killed" : "Removed"),
1577 Get_Notif_TypeName(self.nent_net_type),
1578 self.owner.nent_name
1583 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
1587 float Net_Write_Notification(entity client, float sf)
1589 if(Notification_ShouldSend(self.nent_broadcast, client, self.nent_client))
1592 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
1593 WriteByte(MSG_ENTITY, self.nent_net_type);
1594 WriteShort(MSG_ENTITY, self.nent_net_name);
1595 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
1596 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
1599 else { return FALSE; }
1602 void Kill_Notification(
1603 float broadcast, entity client,
1604 float net_type, float net_name)
1606 string checkargs = Notification_CheckArgs(broadcast, client, 1, 1);
1607 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Kill_Notification: %s\n", checkargs)); return; }
1609 #ifdef NOTIFICATIONS_DEBUG
1610 Debug_Notification(sprintf(
1611 "Kill_Notification(%d, '%s', %s, %d);\n",
1614 (net_type ? Get_Notif_TypeName(net_type) : "0"),
1619 entity notif, net_notif;
1620 float killed_cpid = NO_CPID;
1626 killed_cpid = 0; // kill ALL centerprints
1634 entity notif = Get_Notif_Ent(net_type, net_name);
1635 if not(notif) { backtrace("Kill_Notification: Could not find notification entity!\n"); return; }
1638 killed_cpid = notif.nent_cpid;
1640 killed_cpid = NO_CPID;
1644 killed_cpid = 0; // kill ALL centerprints
1649 case MSG_CENTER_CPID:
1651 killed_cpid = net_name;
1656 if(killed_cpid != NO_CPID)
1658 net_notif = spawn();
1659 net_notif.classname = "net_kill_notification";
1660 net_notif.nent_broadcast = broadcast;
1661 net_notif.nent_client = client;
1662 net_notif.nent_net_type = MSG_CENTER_CPID;
1663 net_notif.nent_net_name = killed_cpid;
1664 Net_LinkEntity(net_notif, FALSE, autocvar_notification_lifetime_runtime, Net_Write_Notification);
1667 for(notif = world; (notif = find(notif, classname, "net_notification"));)
1671 if((killed_cpid != NO_CPID) && (notif.nent_net_type == MSG_CENTER))
1673 if(notif.owner.nent_cpid == killed_cpid)
1675 notif.nent_net_name = -1;
1676 notif.nextthink = time;
1678 else { continue; } // we ARE looking for a specific CPID, don't kill everything else too
1680 else if(notif.nent_net_type == net_type)
1684 if(notif.nent_net_name == net_name) { notif.nent_net_name = -1; notif.nextthink = time; }
1685 else { continue; } // we ARE looking for a certain net_name, don't kill everything else too
1687 else { notif.nent_net_name = -1; notif.nextthink = time; }
1689 else { continue; } // we ARE looking for a certain net_type, don't kill everything else too
1691 else { notif.nent_net_name = -1; notif.nextthink = time; }
1695 void Send_Notification(
1696 float broadcast, entity client,
1697 float net_type, float net_name,
1700 // check supplied broadcast, target, type, and name for errors
1701 string checkargs = Notification_CheckArgs(broadcast, client, net_type, net_name);
1702 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
1704 // retreive counts for the arguments of this notification
1705 entity notif = Get_Notif_Ent(net_type, net_name);
1706 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
1708 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1712 "Not enough arguments for Send_Notification(%d, %s, %s, ...)! ",
1713 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1714 "Check the definition and function call for accuracy...?\n"
1716 broadcast, Get_Notif_TypeName(net_type), notif.nent_name,
1717 notif.nent_stringcount, notif.nent_floatcount, count
1721 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1725 "Too many arguments for Send_Notification(%d, %s, %s, ...)! ",
1726 "stringcount(%d) + floatcount(%d) < count(%d)\n",
1727 "Check the definition and function call for accuracy...?\n"
1729 broadcast, Get_Notif_TypeName(net_type), notif.nent_name,
1730 notif.nent_stringcount, notif.nent_floatcount, count
1735 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1736 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1737 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1738 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1739 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1740 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1741 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1742 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1744 #ifdef NOTIFICATIONS_DEBUG
1745 Debug_Notification(sprintf(
1746 "Send_Notification(%d, %s, %s, %s, %s);\n",
1748 Get_Notif_TypeName(net_type),
1750 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1751 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1759 broadcast == NOTIF_ALL
1761 broadcast == NOTIF_ALL_EXCEPT
1765 net_type == MSG_ANNCE
1767 net_type == MSG_CENTER
1771 Local_Notification_WOVA(
1773 notif.nent_stringcount,
1774 notif.nent_floatcount,
1779 if(net_type == MSG_CHOICE)
1781 // float verbose_allowed = (autocvar_notification_server_allows_frag_verbose && ((autocvar_notification_server_allows_frag_verbose == 2) || inWarmupStage));
1782 // THIS GETS TRICKY... now we have to cycle through each possible player (checking broadcast)
1783 // and then do an individual NOTIF_ONE_ONLY recursive call for each one depending on their option...
1784 // It's slow, but it's better than the alternatives:
1785 // 1. Constantly networking all info and letting client decide
1786 // 2. Manually handling each separate call on per-usage basis (See old CTF usage of verbose)
1787 entity found_choice;
1789 #define RECURSE_FROM_CHOICE(ent,action) \
1790 switch(ent.msg_choice_choices[net_name]) \
1792 case 1: found_choice = notif.nent_optiona; break; \
1793 case 2: found_choice = notif.nent_optionb; break; \
1796 Send_Notification_WOVA( \
1799 found_choice.nent_type, \
1800 found_choice.nent_id, \
1806 case NOTIF_ONE_ONLY: // we can potentially save processing power with this broadcast method
1808 if(IS_REAL_CLIENT(client))
1809 { RECURSE_FROM_CHOICE(client, return) }
1815 FOR_EACH_REALCLIENT(to)
1816 { if(Notification_ShouldSend(broadcast, to, client))
1817 { RECURSE_FROM_CHOICE(to, continue) } }
1824 entity net_notif = spawn();
1825 net_notif.owner = notif;
1826 net_notif.classname = "net_notification";
1827 net_notif.nent_broadcast = broadcast;
1828 net_notif.nent_client = client;
1829 net_notif.nent_net_type = net_type;
1830 net_notif.nent_net_name = net_name;
1831 net_notif.nent_stringcount = notif.nent_stringcount;
1832 net_notif.nent_floatcount = notif.nent_floatcount;
1835 for(i = 0; i < net_notif.nent_stringcount; ++i)
1836 { net_notif.nent_strings[i] = strzone(...(i, string)); }
1837 for(i = 0; i < net_notif.nent_floatcount; ++i)
1838 { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
1840 net_notif.think = Net_Notification_Remove;
1841 net_notif.nextthink =
1842 ((time > autocvar_notification_lifetime_mapload)
1844 (time + autocvar_notification_lifetime_runtime)
1846 autocvar_notification_lifetime_mapload
1849 Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
1853 // WOVA = Without Variable Arguments
1854 void Send_Notification_WOVA(
1855 float broadcast, entity client,
1856 float net_type, float net_name,
1857 string s1, string s2, string s3, string s4,
1858 float f1, float f2, float f3, float f4)
1860 entity notif = Get_Notif_Ent(net_type, net_name);
1862 #ifdef NOTIFICATIONS_DEBUG
1863 Debug_Notification(sprintf(
1864 "Send_Notification_WOVA(%d, %s, %s, %s, %s);\n",
1866 Get_Notif_TypeName(net_type),
1868 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1869 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1873 #define VARITEM(stringc,floatc,args) \
1874 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
1875 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
1876 EIGHT_VARS_TO_VARARGS_VARLIST
1878 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
1880 #endif // ifdef SVQC