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
832 // =========================================
833 // Cvar Handling With 'dumpnotifs' Command
834 // =========================================
836 void Dump_Notifications(float fh, float alsoprint)
838 #define NOTIF_WRITE(a) { \
840 if(alsoprint) { print(a); } }
841 #define NOTIF_WRITE_ENTITY(description) { \
844 "seta notification_%s \"%d\" \"%s\"\n", \
845 e.nent_name, e.nent_default, description \
847 NOTIF_WRITE(notif_msg) }
848 #define NOTIF_WRITE_HARDCODED(cvar,default,description) { \
851 "seta notification_%s \"%s\" \"%s\"\n", \
852 cvar, default, description \
854 NOTIF_WRITE(notif_msg) }
860 // Note: This warning only applies to the notifications.cfg file that is output...
862 // You ARE supposed to manually edit this function to add i.e. hard coded
863 // notification variables for mutators or game modes or such and then
864 // regenerate the notifications.cfg file from the new code.
866 NOTIF_WRITE("// ********************************************** //\n");
867 NOTIF_WRITE("// ** WARNING - DO NOT MANUALLY EDIT THIS FILE ** //\n");
868 NOTIF_WRITE("// ** ** //\n");
869 NOTIF_WRITE("// ** This file is automatically generated ** //\n");
870 NOTIF_WRITE("// ** by code with the command 'dumpnotifs'. ** //\n");
871 NOTIF_WRITE("// ** ** //\n");
872 NOTIF_WRITE("// ** If you add a new notification, please ** //\n");
873 NOTIF_WRITE("// ** regenerate this file with that command ** //\n");
874 NOTIF_WRITE("// ** making sure that the output matches ** //\n");
875 NOTIF_WRITE("// ** with the lists and defaults in code. ** //\n");
876 NOTIF_WRITE("// ** ** //\n");
877 NOTIF_WRITE("// ********************************************** //\n");
879 // These notifications will also append their string as a comment...
880 // This is not necessary, and does not matter if they vary between config versions,
881 // it is just a semi-helpful tool for those who want to manually change their user settings.
883 NOTIF_WRITE(sprintf("\n// MSG_ANNCE notifications (count = %d):\n", NOTIF_ANNCE_COUNT));
884 for(i = 1; i <= NOTIF_ANNCE_COUNT; ++i)
886 e = Get_Notif_Ent(MSG_ANNCE, i);
887 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
890 "Notification control cvar: 0 = disabled, 1 = enabled if gentle mode is off, 2 = always enabled)"
894 NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT));
895 for(i = 1; i <= NOTIF_INFO_COUNT; ++i)
897 e = Get_Notif_Ent(MSG_INFO, i);
898 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
901 "Notification control cvar: 0 = off, 1 = print to console, "
902 "2 = print to console and chatbox (if notification_allow_chatboxprint is enabled)"
906 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
907 for(i = 1; i <= NOTIF_CENTER_COUNT; ++i)
909 e = Get_Notif_Ent(MSG_CENTER, i);
910 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
913 "Notification control cvar: 0 = off, 1 = centerprint"
917 NOTIF_WRITE(sprintf("\n// MSG_MULTI notifications (count = %d):\n", NOTIF_MULTI_COUNT));
918 for(i = 1; i <= NOTIF_MULTI_COUNT; ++i)
920 e = Get_Notif_Ent(MSG_MULTI, i);
921 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
924 "Notification control cvar: 0 = off, 1 = trigger subcalls"
928 NOTIF_WRITE(sprintf("\n// MSG_CHOICE notifications (count = %d):\n", NOTIF_CHOICE_COUNT));
929 for(i = 1; i <= NOTIF_CHOICE_COUNT; ++i)
931 e = Get_Notif_Ent(MSG_CHOICE, i);
932 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
935 "Notification control cvar: 0 = off, 1 = trigger option A subcall, 2 = trigger option B subcall"
939 // edit these to match whichever cvars are used for specific notification options
940 NOTIF_WRITE("\n// HARD CODED notification variables:\n");
942 NOTIF_WRITE_HARDCODED(
943 "allow_chatboxprint", "1",
944 "Allow notifications to be printed to chat box by setting notification cvar to 2 "
945 "(You can also set this cvar to 2 to force ALL notifications to be printed to the chatbox)"
948 NOTIF_WRITE_HARDCODED(
949 "ctf_capture_verbose", "0",
950 "Show extra information when someone captures a flag"
953 NOTIF_WRITE_HARDCODED(
954 "ctf_pickup_enemy_verbose", "0",
955 "Show extra information if an enemy picks up a flag"
958 NOTIF_WRITE_HARDCODED(
959 "ctf_pickup_team_verbose", "0",
960 "Show extra information if a team mate picks up a flag"
963 NOTIF_WRITE_HARDCODED(
965 "Print extra debug information on all notification function calls "
966 "(Requires -DNOTIFICATIONS_DEBUG flag to be enabled on QCSRC compilation)... "
967 "0 = disabled, 1 = dprint, 2 = print"
970 NOTIF_WRITE_HARDCODED(
971 "errors_are_fatal", "1",
972 "If a notification fails upon initialization, cause a Host_Error to stop the program"
975 NOTIF_WRITE_HARDCODED(
977 "Show extra information when you frag someone (or when you are fragged"
980 NOTIF_WRITE_HARDCODED(
981 "item_centerprinttime", "1.5",
982 "How long to show item information centerprint messages (like 'You got the Electro' or such)"
985 NOTIF_WRITE_HARDCODED(
986 "lifetime_mapload", "10",
987 "Amount of time that notification entities last immediately at mapload (in seconds) "
988 "to help prevent notifications from being lost on early init (like gamestart countdown)"
991 NOTIF_WRITE_HARDCODED(
992 "lifetime_runtime", "0.5",
993 "Amount of time that notification entities last on the server during runtime (In seconds)"
996 NOTIF_WRITE_HARDCODED(
997 "server_allows_frag_verbose", "1",
998 "Server side cvar for showing extra information in frag messages... 0 = no extra frag information, "
999 "1 = frag information only in warmup, 2 = frag information allowed all the time"
1002 NOTIF_WRITE_HARDCODED(
1003 "server_allows_location", "1",
1004 "Server side cvar for allowing death messages to show location information too"
1007 NOTIF_WRITE_HARDCODED(
1008 "show_location", "0",
1009 "Append location information to MSG_INFO death/kill messages"
1012 NOTIF_WRITE_HARDCODED(
1013 "show_location_string", "",
1014 "Replacement string piped into sprintf, "
1015 "so you can do different messages like this: ' at the %s' or ' (near %s)'"
1018 NOTIF_WRITE_HARDCODED(
1020 "Print information about sprees in death/kill messages"
1023 NOTIF_WRITE_HARDCODED(
1024 "show_sprees_center", "1",
1025 "Show spree information in MSG_CENTER messages... "
1026 "0 = off, 1 = target (but only for first victim) and attacker"
1029 NOTIF_WRITE_HARDCODED(
1030 "show_sprees_center_specialonly", "1",
1031 "Don't show spree information in MSG_CENTER messages if it isn't an achievement"
1034 NOTIF_WRITE_HARDCODED(
1035 "show_sprees_info", "3",
1036 "Show spree information in MSG_INFO messages... "
1037 "0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker"
1040 NOTIF_WRITE_HARDCODED(
1041 "show_sprees_info_newline", "1",
1042 "Show attacker spree information for MSG_INFO messages on a separate line than the death notification itself"
1045 NOTIF_WRITE_HARDCODED(
1046 "show_sprees_info_specialonly", "1",
1047 "Don't show attacker spree information in MSG_INFO messages if it isn't an achievement"
1050 NOTIF_WRITE(sprintf(
1052 "\n// Notification counts (total = %d): ",
1053 "MSG_ANNCE = %d, MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d, MSG_CHOICE = %d\n"
1058 NOTIF_CENTER_COUNT +
1070 #undef NOTIF_WRITE_HARDCODED
1071 #undef NOTIF_WRITE_ENTITY
1076 void Notification_GetCvars()
1078 GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
1083 // ===============================
1084 // Frontend Notification Pushing
1085 // ===============================
1087 #ifdef NOTIFICATIONS_DEBUG
1088 void Debug_Notification(string input)
1090 switch(autocvar_notification_debug)
1092 case 1: { dprint(input); break; }
1093 case 2: { print(input); break; }
1098 string Local_Notification_sprintf(
1099 string input, string args,
1100 string s1, string s2, string s3, string s4,
1101 float f1, float f2, float f3, float f4)
1103 #ifdef NOTIFICATIONS_DEBUG
1104 Debug_Notification(sprintf(
1105 "Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
1106 MakeConsoleSafe(input),
1108 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1109 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1115 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
1119 for(sel_num = 0;(args != "");)
1121 selected = car(args); args = cdr(args);
1122 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
1123 switch(strtolower(selected))
1125 #define ARG_CASE(prog,selected,result) \
1127 #if (prog != ARG_SV) && (prog != ARG_DC) \
1128 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
1131 #if (prog != ARG_CS) && (prog != ARG_DC) \
1132 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
1137 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
1140 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]);
1144 void Local_Notification_sound(
1145 float soundchannel, string soundfile,
1146 float soundvolume, float soundposition)
1148 if((soundfile != prev_soundfile) || (time >= (prev_soundtime + autocvar_cl_announcer_antispam)))
1150 #ifdef NOTIFICATIONS_DEBUG
1151 Debug_Notification(sprintf(
1152 "Local_Notification_sound(world, %f, '%s', %f, %f);\n",
1155 "announcer/%s/%s.wav",
1156 autocvar_cl_announcer,
1168 "announcer/%s/%s.wav",
1169 autocvar_cl_announcer,
1176 if(prev_soundfile) { strunzone(prev_soundfile); }
1177 prev_soundfile = strzone(soundfile);
1178 prev_soundtime = time;
1182 #ifdef NOTIFICATIONS_DEBUG
1183 Debug_Notification(sprintf(
1185 "Local_Notification_sound(world, %f, '%s', %f, %f) ",
1186 "^1BLOCKED BY ANTISPAM:^7 prevsnd: '%s', timediff: %f, limit: %f\n"
1190 "announcer/%s/%s.wav",
1191 autocvar_cl_announcer,
1197 (time - prev_soundtime),
1198 autocvar_cl_announcer_antispam
1204 void Local_Notification_HUD_Notify_Push(
1205 string icon, string hudargs,
1206 string s1, string s2, string s3, string s4)
1210 arg_slot[0] = ""; arg_slot[1] = "";
1212 for(sel_num = 0;(hudargs != "");)
1214 selected = car(hudargs); hudargs = cdr(hudargs);
1215 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
1216 switch(strtolower(selected))
1218 #define ARG_CASE(prog,selected,result) \
1219 #if (prog == ARG_CS_SV_HA) \
1220 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
1224 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
1227 #ifdef NOTIFICATIONS_DEBUG
1228 Debug_Notification(sprintf(
1229 "Local_Notification_HUD_Notify_Push('%s^7', '%s', %s, %s);\n",
1232 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1233 MakeConsoleSafe(sprintf("'%s^7', '%s^7'", stof(arg_slot[0]), stof(arg_slot[1])))
1236 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
1239 void Local_Notification_centerprint_generic(
1240 string input, string durcnt,
1241 float cpid, float f1, float f2)
1245 arg_slot[0] = ""; arg_slot[1] = "";
1247 for(sel_num = 0;(durcnt != "");)
1249 selected = car(durcnt); durcnt = cdr(durcnt);
1250 NOTIF_HIT_MAX(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic")
1251 switch(strtolower(selected))
1253 #define ARG_CASE(prog,selected,result) \
1254 #if (prog == ARG_CS_SV_DC) || (prog == ARG_DC) \
1255 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
1261 if(ftos(stof(selected)) != "") { arg_slot[sel_num] = selected; ++sel_num; }
1262 else { NOTIF_HIT_UNKNOWN(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic") }
1267 #ifdef NOTIFICATIONS_DEBUG
1268 Debug_Notification(sprintf(
1269 "Local_Notification_centerprint_generic('%s^7', '%s', %d, %d, %d, %d);\n",
1270 MakeConsoleSafe(input),
1273 stof(arg_slot[0]), stof(arg_slot[1])
1276 centerprint_generic(cpid, input, stof(arg_slot[0]), stof(arg_slot[1]));
1280 void Local_Notification(float net_type, float net_name, ...count)
1282 // check supplied type and name for errors
1283 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
1284 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
1286 entity notif = Get_Notif_Ent(net_type, net_name);
1287 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
1288 if not(notif.nent_enabled)
1290 #ifdef NOTIFICATIONS_DEBUG
1291 Debug_Notification(sprintf(
1292 "Local_Notification(%s, %s): Entity was disabled...\n",
1293 Get_Notif_TypeName(net_type),
1300 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1304 "Not enough arguments for Local_Notification(%s, %s, ...)! ",
1305 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1306 "Check the definition and function call for accuracy...?\n"
1308 Get_Notif_TypeName(net_type), notif.nent_name,
1309 notif.nent_stringcount, notif.nent_floatcount, count
1313 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1317 "Too many 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
1327 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1328 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1329 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1330 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1331 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1332 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1333 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1334 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1336 #ifdef NOTIFICATIONS_DEBUG
1337 Debug_Notification(sprintf(
1338 "Local_Notification(%s, %s, %s, %s);\n",
1339 Get_Notif_TypeName(net_type),
1341 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1342 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1351 Local_Notification_sound(
1358 backtrace("MSG_ANNCE on server?... Please notify Samual immediately!\n");
1366 Local_Notification_sprintf(
1373 if(notif.nent_icon != "")
1375 Local_Notification_HUD_Notify_Push(
1387 Local_Notification_centerprint_generic(
1388 Local_Notification_sprintf(
1402 if(notif.nent_msginfo)
1403 if(notif.nent_msginfo.nent_enabled)
1405 Local_Notification_WOVA(
1407 notif.nent_msginfo.nent_id,
1408 notif.nent_msginfo.nent_stringcount,
1409 notif.nent_msginfo.nent_floatcount,
1414 if(notif.nent_msgannce)
1415 if(notif.nent_msgannce.nent_enabled)
1417 Local_Notification_WOVA(
1419 notif.nent_msgannce.nent_id,
1424 if(notif.nent_msgcenter)
1425 if(notif.nent_msgcenter.nent_enabled)
1427 Local_Notification_WOVA(
1429 notif.nent_msgcenter.nent_id,
1430 notif.nent_msgcenter.nent_stringcount,
1431 notif.nent_msgcenter.nent_floatcount,
1441 entity found_choice;
1442 switch(cvar_string(sprintf("notification_%s", notif.nent_name)))
1444 case 1: found_choice = notif.nent_optiona; break;
1445 case 2: found_choice = notif.nent_optionb; break;
1446 default: return; // not enabled anyway
1448 Local_Notification_WOVA(
1449 found_choice.nent_type,
1450 found_choice.nent_id,
1451 found_choice.nent_stringcount,
1452 found_choice.nent_floatcount,
1459 // WOVA = Without Variable Arguments
1460 void Local_Notification_WOVA(
1461 float net_type, float net_name,
1462 float stringcount, float floatcount,
1463 string s1, string s2, string s3, string s4,
1464 float f1, float f2, float f3, float f4)
1466 #define VARITEM(stringc,floatc,args) \
1467 if((stringcount == stringc) && (floatcount == floatc)) \
1468 { Local_Notification(net_type, net_name, args); return; }
1469 EIGHT_VARS_TO_VARARGS_VARLIST
1471 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
1475 // =========================
1476 // Notification Networking
1477 // =========================
1480 void Read_Notification(float is_new)
1482 float net_type = ReadByte();
1483 float net_name = ReadShort();
1487 if(net_type == MSG_CENTER_CPID)
1489 #ifdef NOTIFICATIONS_DEBUG
1490 Debug_Notification(sprintf(
1491 "Read_Notification(%d) at %f: net_type = %s, net_name = %d\n",
1494 Get_Notif_TypeName(net_type),
1501 if(net_name == 0) { reset_centerprint_messages(); }
1502 else if(net_name != NO_CPID)
1504 // in this case, net_name IS the cpid we want to kill
1505 centerprint_generic(net_name, "", 0, 0);
1510 "Read_Notification(%d) at %f: ^1TRIED TO KILL NO_CPID CENTERPRINT!\n",
1519 notif = Get_Notif_Ent(net_type, net_name);
1520 if not(notif) { backtrace("Read_Notification: Could not find notification entity!\n"); return; }
1522 #ifdef NOTIFICATIONS_DEBUG
1523 Debug_Notification(sprintf(
1524 "Read_Notification(%d) at %f: net_type = %s, net_name = %s\n",
1527 Get_Notif_TypeName(net_type),
1532 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
1533 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
1534 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
1535 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
1536 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
1537 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
1538 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
1539 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
1543 Local_Notification_WOVA(
1545 notif.nent_stringcount,
1546 notif.nent_floatcount,
1555 void Net_Notification_Remove()
1557 if not(self) { backtrace(sprintf("Net_Notification_Remove() at %f: Missing self!?\n", time)); return; }
1559 #ifdef NOTIFICATIONS_DEBUG
1560 Debug_Notification(sprintf(
1561 "Net_Notification_Remove() at %f: %s '%s - %s' notification\n",
1563 ((self.nent_net_name == -1) ? "Killed" : "Removed"),
1564 Get_Notif_TypeName(self.nent_net_type),
1565 self.owner.nent_name
1570 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
1574 float Net_Write_Notification(entity client, float sf)
1576 if(Notification_ShouldSend(self.nent_broadcast, client, self.nent_client))
1579 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
1580 WriteByte(MSG_ENTITY, self.nent_net_type);
1581 WriteShort(MSG_ENTITY, self.nent_net_name);
1582 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
1583 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
1586 else { return FALSE; }
1589 void Kill_Notification(
1590 float broadcast, entity client,
1591 float net_type, float net_name)
1593 string checkargs = Notification_CheckArgs(broadcast, client, 1, 1);
1594 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Kill_Notification: %s\n", checkargs)); return; }
1596 #ifdef NOTIFICATIONS_DEBUG
1597 Debug_Notification(sprintf(
1598 "Kill_Notification(%d, '%s', %s, %d);\n",
1601 (net_type ? Get_Notif_TypeName(net_type) : "0"),
1606 entity notif, net_notif;
1607 float killed_cpid = NO_CPID;
1613 killed_cpid = 0; // kill ALL centerprints
1621 entity notif = Get_Notif_Ent(net_type, net_name);
1622 if not(notif) { backtrace("Kill_Notification: Could not find notification entity!\n"); return; }
1625 killed_cpid = notif.nent_cpid;
1627 killed_cpid = NO_CPID;
1631 killed_cpid = 0; // kill ALL centerprints
1636 case MSG_CENTER_CPID:
1638 killed_cpid = net_name;
1643 if(killed_cpid != NO_CPID)
1645 net_notif = spawn();
1646 net_notif.classname = "net_kill_notification";
1647 net_notif.nent_broadcast = broadcast;
1648 net_notif.nent_client = client;
1649 net_notif.nent_net_type = MSG_CENTER_CPID;
1650 net_notif.nent_net_name = killed_cpid;
1651 Net_LinkEntity(net_notif, FALSE, autocvar_notification_lifetime_runtime, Net_Write_Notification);
1654 for(notif = world; (notif = find(notif, classname, "net_notification"));)
1658 if((killed_cpid != NO_CPID) && (notif.nent_net_type == MSG_CENTER))
1660 if(notif.owner.nent_cpid == killed_cpid)
1662 notif.nent_net_name = -1;
1663 notif.nextthink = time;
1665 else { continue; } // we ARE looking for a specific CPID, don't kill everything else too
1667 else if(notif.nent_net_type == net_type)
1671 if(notif.nent_net_name == net_name) { notif.nent_net_name = -1; notif.nextthink = time; }
1672 else { continue; } // we ARE looking for a certain net_name, don't kill everything else too
1674 else { notif.nent_net_name = -1; notif.nextthink = time; }
1676 else { continue; } // we ARE looking for a certain net_type, don't kill everything else too
1678 else { notif.nent_net_name = -1; notif.nextthink = time; }
1682 void Send_Notification(
1683 float broadcast, entity client,
1684 float net_type, float net_name,
1687 // check supplied broadcast, target, type, and name for errors
1688 string checkargs = Notification_CheckArgs(broadcast, client, net_type, net_name);
1689 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
1691 // retreive counts for the arguments of this notification
1692 entity notif = Get_Notif_Ent(net_type, net_name);
1693 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
1695 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1699 "Not enough arguments for Send_Notification(%d, %s, %s, ...)! ",
1700 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1701 "Check the definition and function call for accuracy...?\n"
1703 broadcast, Get_Notif_TypeName(net_type), notif.nent_name,
1704 notif.nent_stringcount, notif.nent_floatcount, count
1708 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1712 "Too many 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
1722 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1723 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1724 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1725 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1726 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1727 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1728 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1729 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1731 #ifdef NOTIFICATIONS_DEBUG
1732 Debug_Notification(sprintf(
1733 "Send_Notification(%d, %s, %s, %s, %s);\n",
1735 Get_Notif_TypeName(net_type),
1737 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1738 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1746 broadcast == NOTIF_ALL
1748 broadcast == NOTIF_ALL_EXCEPT
1752 net_type == MSG_ANNCE
1754 net_type == MSG_CENTER
1758 Local_Notification_WOVA(
1760 notif.nent_stringcount,
1761 notif.nent_floatcount,
1766 if(net_type == MSG_CHOICE)
1768 // THIS GETS TRICKY... now we have to cycle through each possible player (checking broadcast)
1769 // and then do an individual NOTIF_ONE_ONLY recursive call for each one depending on their option...
1770 // It's slow, but it's better than the alternatives:
1771 // 1. Constantly networking all info and letting client decide
1772 // 2. Manually handling each separate call on per-usage basis (See old CTF usage of verbose)
1773 entity found_choice;
1775 #define RECURSE_FROM_CHOICE(ent,action) \
1776 switch(ent.msg_choice_choices[net_name]) \
1778 case 1: found_choice = notif.nent_optiona; break; \
1779 case 2: found_choice = notif.nent_optionb; break; \
1782 Send_Notification_WOVA( \
1785 found_choice.nent_type, \
1786 found_choice.nent_id, \
1792 case NOTIF_ONE_ONLY: // we can potentially save processing power with this broadcast method
1794 if(IS_REAL_CLIENT(client))
1795 { RECURSE_FROM_CHOICE(client, return) }
1801 FOR_EACH_REALCLIENT(to)
1802 { if(Notification_ShouldSend(broadcast, to, client))
1803 { RECURSE_FROM_CHOICE(to, continue) } }
1810 entity net_notif = spawn();
1811 net_notif.owner = notif;
1812 net_notif.classname = "net_notification";
1813 net_notif.nent_broadcast = broadcast;
1814 net_notif.nent_client = client;
1815 net_notif.nent_net_type = net_type;
1816 net_notif.nent_net_name = net_name;
1817 net_notif.nent_stringcount = notif.nent_stringcount;
1818 net_notif.nent_floatcount = notif.nent_floatcount;
1821 for(i = 0; i < net_notif.nent_stringcount; ++i)
1822 { net_notif.nent_strings[i] = strzone(...(i, string)); }
1823 for(i = 0; i < net_notif.nent_floatcount; ++i)
1824 { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
1826 net_notif.think = Net_Notification_Remove;
1827 net_notif.nextthink =
1828 ((time > autocvar_notification_lifetime_mapload)
1830 (time + autocvar_notification_lifetime_runtime)
1832 autocvar_notification_lifetime_mapload
1835 Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
1839 // WOVA = Without Variable Arguments
1840 void Send_Notification_WOVA(
1841 float broadcast, entity client,
1842 float net_type, float net_name,
1843 string s1, string s2, string s3, string s4,
1844 float f1, float f2, float f3, float f4)
1846 entity notif = Get_Notif_Ent(net_type, net_name);
1848 #ifdef NOTIFICATIONS_DEBUG
1849 Debug_Notification(sprintf(
1850 "Send_Notification_WOVA(%d, %s, %s, %s, %s);\n",
1852 Get_Notif_TypeName(net_type),
1854 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1855 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1859 #define VARITEM(stringc,floatc,args) \
1860 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
1861 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
1862 EIGHT_VARS_TO_VARARGS_VARLIST
1864 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
1866 #endif // ifdef SVQC