3 #include <client/announcer.qh>
6 #include <common/constants.qh>
7 #include <common/net_linked.qh>
8 #include <common/teams.qh>
9 #include <server/autocvars.qh>
10 #include <server/constants.qh>
11 #include <server/defs.qh>
12 #include <server/mutators/_mod.qh>
15 // ================================================
16 // Unified notification system, written by Samual
17 // Last updated: August, 2013
18 // ================================================
21 string Notification_CheckArgs(
22 NOTIF broadcast, entity client)
24 // check supplied broadcast and target for errors
30 if (IS_NOT_A_CLIENT(client)) {
31 return "No client provided!";
36 case NOTIF_ALL_EXCEPT:
38 if (IS_NOT_A_CLIENT(client)) {
39 return "Exception can't be a non-client!";
47 return "Entity provided when NULL was required!";
55 return "Teamplay not active!";
56 } else if (!client.team) {
57 // checkargs = sprintf("%sNo team provided!", checkargs);
62 case NOTIF_TEAM_EXCEPT:
65 return "Teamplay not active!";
66 } else if (IS_NOT_A_CLIENT(client)) {
67 return "Exception can't be a non-client!";
74 return sprintf("Improper broadcast: %d!", broadcast);
80 bool Notification_ShouldSend(NOTIF broadcast, entity to_client, entity other_client)
86 (to_client == other_client)
88 (IS_SPEC(to_client) && (to_client.enemy == other_client))
91 return (to_client == other_client);
94 (to_client.team == other_client.team)
99 (to_client.enemy.team == other_client.team)
102 case NOTIF_TEAM_EXCEPT:
104 (to_client != other_client)
107 (to_client.team == other_client.team)
113 (to_client.enemy != other_client)
115 (to_client.enemy.team == other_client.team)
122 case NOTIF_ALL_EXCEPT:
124 (to_client != other_client)
129 (to_client.enemy == other_client)
139 // ===============================
140 // Initialization Core Functions
141 // ===============================
143 // used by restartnotifs command to initialize notifications
144 void Destroy_Notification_Entity(entity notif)
146 if (notif.nent_name != "") strunzone(notif.nent_name);
147 if (notif.nent_snd != "") strunzone(notif.nent_snd);
148 if (notif.nent_args != "") strunzone(notif.nent_args);
149 if (notif.nent_hudargs != "") strunzone(notif.nent_hudargs);
150 if (notif.nent_icon != "") strunzone(notif.nent_icon);
151 if (notif.nent_durcnt != "") strunzone(notif.nent_durcnt);
152 if (notif.nent_string != "") strunzone(notif.nent_string);
156 void Destroy_All_Notifications()
158 // kill all networked notifications and centerprints
160 Kill_Notification(NOTIF_ALL, NULL, MSG_Null, CPID_Null);
162 reset_centerprint_messages();
165 // kill all real notification entities
166 FOREACH(Notifications, true, { Destroy_Notification_Entity(it); });
169 string Process_Notif_Line(
178 if(typeId == MSG_INFO)
180 if((chat && autocvar_notification_allow_chatboxprint)
181 || (autocvar_notification_allow_chatboxprint == 2))
183 // pass 1: add ETX char at beginning of line
184 input = strcat("\{3}", input);
186 // pass 2: add ETX char at end of each new line (so that
187 // messages with multiple lines are put through chatbox too)
188 input = strreplace("\n", "\n\{3}", input);
190 // pass 3: strip trailing ETX char
191 if(substring(input, (strlen(input) - 1), 1) == "\{3}")
192 { input = substring(input, 0, (strlen(input) - 1)); }
197 // done to both MSG_INFO and MSG_CENTER
198 if(substring(input, (strlen(input) - 1), 1) == "\n")
202 "^1TRAILING NEW LINE AT END OF NOTIFICATION: "
203 "^7net_type = %s, net_name = %s, string = %s."
210 input = substring(input, 1, (strlen(input) - 1));
216 string Process_Notif_Args(
222 string selected, remaining = args;
225 for (;(remaining != "");)
227 selected = car(remaining); remaining = cdr(remaining);
231 case 1: // normal args
233 if(sel_num == NOTIF_MAX_ARGS)
237 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: "
238 "^7net_type = %s, net_name = %s, max args = %d."
248 switch(strtolower(selected))
250 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: ++sel_num; break;
251 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: ++sel_num; break;
252 #define ARG_CASE_ARG_CS_SV(selected,result) case selected: ++sel_num; break;
253 #define ARG_CASE_ARG_CS(selected,result) case selected: ++sel_num; break;
254 #define ARG_CASE_ARG_SV(selected,result) case selected: ++sel_num; break;
255 #define ARG_CASE_ARG_DC(selected,result)
256 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
259 #undef ARG_CASE_ARG_DC
260 #undef ARG_CASE_ARG_SV
261 #undef ARG_CASE_ARG_CS
262 #undef ARG_CASE_ARG_CS_SV
263 #undef ARG_CASE_ARG_CS_SV_DC
264 #undef ARG_CASE_ARG_CS_SV_HA
269 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: "
270 "^7net_type = %s, net_name = %s, args arg = '%s'."
284 if(sel_num == NOTIF_MAX_HUDARGS)
288 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: "
289 "^7net_type = %s, net_name = %s, max hudargs = %d."
299 switch(strtolower(selected))
301 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: ++sel_num; break;
302 #define ARG_CASE_ARG_CS_SV_DC(selected,result)
303 #define ARG_CASE_ARG_CS_SV(selected,result)
304 #define ARG_CASE_ARG_CS(selected,result)
305 #define ARG_CASE_ARG_SV(selected,result)
306 #define ARG_CASE_ARG_DC(selected,result)
307 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
310 #undef ARG_CASE_ARG_DC
311 #undef ARG_CASE_ARG_SV
312 #undef ARG_CASE_ARG_CS
313 #undef ARG_CASE_ARG_CS_SV
314 #undef ARG_CASE_ARG_CS_SV_DC
315 #undef ARG_CASE_ARG_CS_SV_HA
320 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: "
321 "^7net_type = %s, net_name = %s, hudargs arg = '%s'."
335 if(sel_num == NOTIF_MAX_DURCNT)
339 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: "
340 "^7net_type = %s, net_name = %s, max durcnt = %d."
350 switch(strtolower(selected))
352 #define ARG_CASE_ARG_CS_SV_HA(selected,result)
353 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: ++sel_num; break;
354 #define ARG_CASE_ARG_CS_SV(selected,result)
355 #define ARG_CASE_ARG_CS(selected,result)
356 #define ARG_CASE_ARG_SV(selected,result)
357 #define ARG_CASE_ARG_DC(selected,result) case selected: ++sel_num; break;
358 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
361 #undef ARG_CASE_ARG_DC
362 #undef ARG_CASE_ARG_SV
363 #undef ARG_CASE_ARG_CS
364 #undef ARG_CASE_ARG_CS_SV
365 #undef ARG_CASE_ARG_CS_SV_DC
366 #undef ARG_CASE_ARG_CS_SV_HA
369 if(ftos(stof(selected)) != "") { ++sel_num; }
374 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: "
375 "^7net_type = %s, net_name = %s, durcnt arg = '%s'."
393 void Create_Notification_Entity(entity notif,
400 // =====================
401 // Global Entity Setup
402 // =====================
403 notif.nent_default = var_default;
404 notif.nent_enabled = (var_cvar >= 1);
405 notif.nent_type = typeId;
406 notif.nent_name = strzone(namestring);
407 notif.nent_teamnum = teamnum;
409 // Other pre-notif-setup requisites
423 "^1NOTIFICATION WITH IMPROPER TYPE: "
424 "^7net_type = %d, net_name = %s."
433 // now check to see if any errors happened
436 notif.nent_enabled = false; // disable the notification so it can't cause trouble
437 notif_global_error = true; // throw the red flag that an error happened on init
441 #define AnnouncerFilename(snd) sprintf("announcer/%s/%s.wav", AnnouncerOption(), snd)
443 void Create_Notification_Entity_Annce(entity notif,
452 // Set MSG_ANNCE information and handle precaching
454 MSG typeId = MSG_ANNCE;
455 if (!(GENTLE && (var_cvar == 1)))
459 if(notif.nent_enabled)
461 precache_sound(AnnouncerFilename(snd));
462 notif.nent_channel = channel;
463 notif.nent_snd = strzone(snd);
464 notif.nent_vol = vol;
465 notif.nent_position = position;
470 string typestring = Get_Notif_TypeName(typeId);
473 "^1NOTIFICATION WITH NO SOUND: "
474 "^7net_type = %s, net_name = %s."
482 else { notif.nent_enabled = false; }
484 notif.nent_enabled = false;
489 void Create_Notification_Entity_InfoCenter(entity notif,
494 /* MSG_INFO & MSG_CENTER */
503 MSG typeId = notif.nent_type;
504 // Set MSG_INFO and MSG_CENTER string/float counts
505 notif.nent_stringcount = strnum;
506 notif.nent_floatcount = flnum;
508 // Only initialize arguments if we're either a client or on a dedicated server
510 float should_process_args = server_is_dedicated;
512 float should_process_args = true;
514 string typestring = Get_Notif_TypeName(typeId);
515 if(should_process_args)
517 // ========================
518 // Process Main Arguments
519 // ========================
524 notif.nent_args = strzone(
525 Process_Notif_Args(1, args, typestring, namestring));
527 else if((hudargs == "") && (durcnt ==""))
531 "^1NOTIFICATION HAS ARG COUNTS BUT NO ARGS OR HUDARGS OR DURCNT: "
532 "^7net_type = %s, net_name = %s, strnum = %d, flnum = %d"
544 notif.nent_args = strzone(
545 Process_Notif_Args(1, args, typestring, namestring));
549 // =======================================
550 // Process HUD and Centerprint Arguments
551 // Only processed on CSQC, as these
552 // args are only for HUD features.
553 // =======================================
557 notif.nent_hudargs = strzone(
558 Process_Notif_Args(2, hudargs, typestring, namestring));
560 if(icon != "") { notif.nent_icon = strzone(icon); }
565 "^1NOTIFICATION HAS HUDARGS BUT NO ICON: "
566 "^7net_type = %s, net_name = %s."
578 "^1NOTIFICATION HAS ICON BUT NO HUDARGS: "
579 "^7net_type = %s, net_name = %s.\n"
589 notif.nent_durcnt = strzone(Process_Notif_Args(3, durcnt, typestring, namestring));
591 if (cpid == CPID_Null && durcnt != "0 0")
595 "Notification has durcnt but no cpid: "
596 "net_type = %s, net_name = %s."
604 notif.nent_cpid = cpid;
608 // ======================
609 // Process Notif String
610 // ======================
611 #define SET_NOTIF_STRING(string,stringname) MACRO_BEGIN \
612 notif.nent_string = strzone(CCR( \
613 Process_Notif_Line( \
626 if(gentle != "") { SET_NOTIF_STRING(gentle, "GENTLE"); }
627 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL"); }
629 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL"); }
630 #undef SET_NOTIF_STRING
632 // Check to make sure a string was chosen
633 if(notif.nent_string == "")
637 "^1EMPTY NOTIFICATION: "
638 "^7net_type = %s, net_name = %s."
648 void Create_Notification_Entity_Multi(entity notif,
652 Notification anncename,
653 Notification infoname,
654 Notification centername)
656 MSG typeId = MSG_MULTI;
657 // Set MSG_MULTI string/float counts
658 if (!anncename && !infoname && !centername)
660 string typestring = Get_Notif_TypeName(typeId);
663 "^1NOTIFICATION WITH NO SUBCALLS: "
664 "^7net_type = %s, net_name = %s."
673 // announcements don't actually need any arguments, so lets not even count them.
674 if (anncename) { notif.nent_msgannce = anncename; }
676 float infoname_stringcount = 0, infoname_floatcount = 0;
677 float centername_stringcount = 0, centername_floatcount = 0;
681 notif.nent_msginfo = infoname;
682 infoname_stringcount = notif.nent_msginfo.nent_stringcount;
683 infoname_floatcount = notif.nent_msginfo.nent_floatcount;
688 notif.nent_msgcenter = centername;
689 centername_stringcount = notif.nent_msgcenter.nent_stringcount;
690 centername_floatcount = notif.nent_msgcenter.nent_floatcount;
693 // set the requirements of THIS notification to the totals of its subcalls
694 notif.nent_stringcount = max(infoname_stringcount, centername_stringcount);
695 notif.nent_floatcount = max(infoname_floatcount, centername_floatcount);
699 void Create_Notification_Entity_Choice(entity notif,
706 Notification optiona,
707 Notification optionb)
709 MSG typeId = MSG_CHOICE;
710 if (chtype == MSG_Null || !optiona || !optionb)
712 string typestring = Get_Notif_TypeName(typeId);
715 "^1NOTIFICATION IS MISSING CHOICE PARAMS: "
716 "^7net_type = %s, net_name = %s."
725 notif.nent_optiona = optiona;
726 notif.nent_optionb = optionb;
727 notif.nent_challow_def = challow_def; // 0: never allowed, 1: allowed in warmup, 2: always allowed
728 notif.nent_challow_var = challow_var; // 0: never allowed, 1: allowed in warmup, 2: always allowed
729 notif.nent_stringcount = max(notif.nent_optiona.nent_stringcount, notif.nent_optionb.nent_stringcount);
730 notif.nent_floatcount = max(notif.nent_optiona.nent_floatcount, notif.nent_optionb.nent_floatcount);
732 /*#ifdef NOTIFICATIONS_DEBUG
733 Debug_Notification(sprintf(
734 "Create_Notification_Entity(...): MSG_CHOICE: %s\n%s\n%s\n",
737 "^ optiona: %s %s : %d %d",
738 Get_Notif_TypeName(notif.nent_optiona.nent_type),
739 notif.nent_optiona.nent_name,
740 notif.nent_optiona.nent_stringcount,
741 notif.nent_optiona.nent_floatcount
744 "^ optionb: %s %s : %d %d",
745 Get_Notif_TypeName(notif.nent_optionb.nent_type),
746 notif.nent_optionb.nent_name,
747 notif.nent_optionb.nent_stringcount,
748 notif.nent_optionb.nent_floatcount
760 // used by MSG_CHOICE to build list of choices
762 void Notification_GetCvars(entity this)
764 FOREACH(Notifications, it.nent_type == MSG_CHOICE, {
765 GetCvars_handleFloat(
770 msg_choice_choices[it.nent_choice_idx],
771 sprintf("notification_%s", Get_Notif_CvarName(it))
777 /** used to output notifications.cfg file */
778 void Dump_Notifications(int fh, bool alsoprint)
780 #define NOTIF_WRITE(str) write_String_To_File(fh, str, alsoprint)
782 #define NOTIF_WRITE_ENTITY(e, description) \
783 NOTIF_WRITE(sprintf( \
784 "seta notification_%s \"%d\" \"%s\"\n", \
785 Get_Notif_CvarName(e), e.nent_default, description \
788 #define NOTIF_WRITE_ENTITY_CHOICE(e, descriptiona, descriptionb) \
789 NOTIF_WRITE(sprintf( \
790 "seta notification_%s \"%d\" \"%s\"\n" \
791 "seta notification_%s_ALLOWED \"%d\" \"%s\"\n", \
792 Get_Notif_CvarName(e), e.nent_default, descriptiona, \
793 Get_Notif_CvarName(e), e.nent_challow_def, descriptionb \
796 #define NOTIF_WRITE_HARDCODED(cvar, default, description) \
797 NOTIF_WRITE("seta notification_" cvar " \"" default "\" \"" description "\"\n")
799 // Note: This warning only applies to the notifications.cfg file that is output...
800 // You ARE supposed to manually edit this function to add i.e. hard coded
801 // notification variables for mutators or game modes or such and then
802 // regenerate the notifications.cfg file from the new code.
805 "// ********************************************** //\n"
806 "// ** WARNING - DO NOT MANUALLY EDIT THIS FILE ** //\n"
808 "// ** This file is automatically generated ** //\n"
809 "// ** by code with the command 'dumpnotifs'. ** //\n"
811 "// ** If you add a new notification, please ** //\n"
812 "// ** regenerate this file with that command ** //\n"
813 "// ** making sure that the output matches ** //\n"
814 "// ** with the lists and defaults in code. ** //\n"
816 "// ********************************************** //\n");
818 // These notifications will also append their string as a comment...
819 // This is not necessary, and does not matter if they vary between config versions,
820 // it is just a semi-helpful tool for those who want to manually change their user settings.
822 int NOTIF_ANNCE_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_ANNCE, { ++NOTIF_ANNCE_COUNT; });
823 NOTIF_WRITE(sprintf("\n// MSG_ANNCE notifications (count = %d):\n", NOTIF_ANNCE_COUNT));
824 FOREACH(Notifications, it.nent_type == MSG_ANNCE && (!it.nent_teamnum || it.nent_teamnum == NUM_TEAM_1), {
825 NOTIF_WRITE_ENTITY(it,
826 "0 = disabled, 1 = enabled if gentle mode is off, 2 = always enabled"
830 int NOTIF_INFO_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_INFO, { ++NOTIF_INFO_COUNT; });
831 NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT));
832 FOREACH(Notifications, it.nent_type == MSG_INFO && (!it.nent_teamnum || it.nent_teamnum == NUM_TEAM_1), {
833 NOTIF_WRITE_ENTITY(it,
834 "0 = off, 1 = print to console, "
835 "2 = print to console and chatbox (if notification_allow_chatboxprint is enabled)"
839 int NOTIF_CENTER_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_CENTER, { ++NOTIF_CENTER_COUNT; });
840 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
841 FOREACH(Notifications, it.nent_type == MSG_CENTER && (!it.nent_teamnum || it.nent_teamnum == NUM_TEAM_1), {
842 NOTIF_WRITE_ENTITY(it,
843 "0 = off, 1 = centerprint"
847 int NOTIF_MULTI_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_MULTI, { ++NOTIF_MULTI_COUNT; });
848 NOTIF_WRITE(sprintf("\n// MSG_MULTI notifications (count = %d):\n", NOTIF_MULTI_COUNT));
849 FOREACH(Notifications, it.nent_type == MSG_MULTI && (!it.nent_teamnum || it.nent_teamnum == NUM_TEAM_1), {
850 NOTIF_WRITE_ENTITY(it,
851 "Enable this multiple notification"
855 int NOTIF_CHOICE_COUNT = 0; FOREACH(Notifications, it.nent_type == MSG_CHOICE, { ++NOTIF_CHOICE_COUNT; });
856 NOTIF_WRITE(sprintf("\n// MSG_CHOICE notifications (count = %d):\n", NOTIF_CHOICE_COUNT));
857 FOREACH(Notifications, it.nent_type == MSG_CHOICE && (!it.nent_teamnum || it.nent_teamnum == NUM_TEAM_1), {
858 NOTIF_WRITE_ENTITY_CHOICE(it,
859 "Choice for this notification 0 = off, 1 = default message, 2 = verbose message",
860 "Allow choice for this notification 0 = off, 1 = only in warmup mode, 2 = always"
864 // edit these to match whichever cvars are used for specific notification options
865 NOTIF_WRITE("\n// HARD CODED notification variables:\n");
867 NOTIF_WRITE_HARDCODED(
868 "allow_chatboxprint", "1",
869 "Allow INFO notifications to be printed to chat box "
871 "1 = allow only if allowed by individual notification_INFO* cvars, "
872 "2 = force all INFO notifications to be printed to the chatbox"
875 NOTIF_WRITE_HARDCODED(
877 "Print extra debug information on all notification function calls "
878 "(Requires -DNOTIFICATIONS_DEBUG flag to be enabled on QCSRC compilation)... "
879 "0 = disabled, 1 = dprint, 2 = print"
882 NOTIF_WRITE_HARDCODED(
883 "errors_are_fatal", "1",
884 "If a notification fails upon initialization, cause a Host_Error to stop the program"
887 NOTIF_WRITE_HARDCODED(
888 "item_centerprinttime", "1.5",
889 "How long to show item information centerprint messages (like 'You got the Electro' or such)"
892 NOTIF_WRITE_HARDCODED(
893 "lifetime_mapload", "10",
894 "Amount of time that notification entities last immediately at mapload (in seconds) "
895 "to help prevent notifications from being lost on early init (like gamestart countdown)"
898 NOTIF_WRITE_HARDCODED(
899 "lifetime_runtime", "0.5",
900 "Amount of time that notification entities last on the server during runtime (In seconds)"
903 NOTIF_WRITE_HARDCODED(
904 "server_allows_location", "1",
905 "Server side cvar for allowing death messages to show location information too"
908 NOTIF_WRITE_HARDCODED(
909 "show_location", "0",
910 "Append location information to MSG_INFO death/kill messages"
913 NOTIF_WRITE_HARDCODED(
914 "show_location_string", "",
915 "Replacement string piped into sprintf, "
916 "so you can do different messages like this: ' at the %s' or ' (near %s)'"
919 NOTIF_WRITE_HARDCODED(
921 "Print information about sprees in death/kill messages"
924 NOTIF_WRITE_HARDCODED(
925 "show_sprees_center", "1",
926 "Show spree information in MSG_CENTER messages... "
927 "0 = off, 1 = target (but only for first victim) and attacker"
930 NOTIF_WRITE_HARDCODED(
931 "show_sprees_center_specialonly", "1",
932 "Don't show spree information in MSG_CENTER messages if it isn't an achievement"
935 NOTIF_WRITE_HARDCODED(
936 "show_sprees_info", "3",
937 "Show spree information in MSG_INFO messages... "
938 "0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker"
941 NOTIF_WRITE_HARDCODED(
942 "show_sprees_info_newline", "1",
943 "Show attacker spree information for MSG_INFO messages on a separate line than the death notification itself"
946 NOTIF_WRITE_HARDCODED(
947 "show_sprees_info_specialonly", "1",
948 "Don't show attacker spree information in MSG_INFO messages if it isn't an achievement"
953 "\n// Notification counts (total = %d): "
954 "MSG_ANNCE = %d, MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d, MSG_CHOICE = %d\n"
969 #undef NOTIF_WRITE_HARDCODED
970 #undef NOTIF_WRITE_ENTITY
975 // ===============================
976 // Frontend Notification Pushing
977 // ===============================
979 string Local_Notification_sprintf(
980 string input, string args,
981 string s1, string s2, string s3, string s4,
982 int f1, float f2, float f3, float f4)
984 #ifdef NOTIFICATIONS_DEBUG
985 Debug_Notification(sprintf(
986 "Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
987 MakeConsoleSafe(input),
989 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
990 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
994 for (int sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
996 for (int sel_num = 0; (args != ""); )
998 string selected = car(args); args = cdr(args);
999 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf");
1000 string tmp_s; // used by NOTIF_ARGUMENT_LIST
1001 switch (strtolower(selected))
1003 #define ARG_CASE_ARG_CS_SV_HA(selected, result) case selected: arg_slot[sel_num++] = result; break;
1004 #define ARG_CASE_ARG_CS_SV_DC(selected, result) case selected: arg_slot[sel_num++] = result; break;
1005 #define ARG_CASE_ARG_CS_SV(selected, result) case selected: arg_slot[sel_num++] = result; break;
1007 #define ARG_CASE_ARG_CS(selected, result) case selected: arg_slot[sel_num++] = result; break;
1008 #define ARG_CASE_ARG_SV(selected, result)
1010 #define ARG_CASE_ARG_CS(selected, result)
1011 #define ARG_CASE_ARG_SV(selected, result) case selected: arg_slot[sel_num++] = result; break;
1013 #define ARG_CASE_ARG_DC(selected, result)
1014 #define ARG_CASE(prog, selected, result) ARG_CASE_##prog(selected, result)
1017 #undef ARG_CASE_ARG_DC
1018 #undef ARG_CASE_ARG_SV
1019 #undef ARG_CASE_ARG_CS
1020 #undef ARG_CASE_ARG_CS_SV
1021 #undef ARG_CASE_ARG_CS_SV_DC
1022 #undef ARG_CASE_ARG_CS_SV_HA
1023 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
1027 strcat(input, "\n"),
1039 void Local_Notification_sound(int soundchannel, string soundfile, float soundvolume, float soundposition)
1041 if ((soundfile != prev_soundfile) || (time >= (prev_soundtime + autocvar_cl_announcer_antispam)))
1043 #ifdef NOTIFICATIONS_DEBUG
1044 Debug_Notification(sprintf(
1045 "Local_Notification_sound(%f, '%s', %f, %f);\n",
1047 AnnouncerFilename(soundfile),
1053 _sound(NULL, soundchannel, AnnouncerFilename(soundfile), soundvolume, soundposition);
1055 strcpy(prev_soundfile, soundfile);
1056 prev_soundtime = time;
1060 #ifdef NOTIFICATIONS_DEBUG
1061 Debug_Notification(sprintf(
1063 "Local_Notification_sound(%f, '%s', %f, %f) "
1064 "^1BLOCKED BY ANTISPAM:^7 prevsnd: '%s', timediff: %f, limit: %f\n"
1067 AnnouncerFilename(soundfile),
1071 (time - prev_soundtime),
1072 autocvar_cl_announcer_antispam
1078 void Local_Notification_HUD_Notify_Push(
1079 string icon, string hudargs,
1080 string s1, string s2, string s3, string s4,
1081 float f1, float f2, float f3, float f4)
1083 arg_slot[0] = ""; arg_slot[1] = "";
1085 for (int sel_num = 0; (hudargs != ""); )
1087 string selected = car(hudargs); hudargs = cdr(hudargs);
1088 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push");
1089 switch (strtolower(selected))
1091 #define ARG_CASE_ARG_CS_SV_HA(selected, result) case selected: arg_slot[sel_num++] = result; break;
1092 #define ARG_CASE_ARG_CS_SV_DC(selected, result)
1093 #define ARG_CASE_ARG_CS_SV(selected, result)
1094 #define ARG_CASE_ARG_CS(selected, result)
1095 #define ARG_CASE_ARG_SV(selected, result)
1096 #define ARG_CASE_ARG_DC(selected, result)
1097 #define ARG_CASE(prog, selected, result) ARG_CASE_##prog(selected, result)
1100 #undef ARG_CASE_ARG_DC
1101 #undef ARG_CASE_ARG_SV
1102 #undef ARG_CASE_ARG_CS
1103 #undef ARG_CASE_ARG_CS_SV
1104 #undef ARG_CASE_ARG_CS_SV_DC
1105 #undef ARG_CASE_ARG_CS_SV_HA
1106 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
1109 #ifdef NOTIFICATIONS_DEBUG
1110 Debug_Notification(sprintf(
1111 "Local_Notification_HUD_Notify_Push('%s^7', '%s', %s, %s, %s);\n",
1114 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1115 sprintf("%d, %d, %d, %d", f1, f2, f3, f4),
1116 MakeConsoleSafe(sprintf("'%s^7', '%s^7'", stof(arg_slot[0]), stof(arg_slot[1])))
1119 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
1122 void Local_Notification_centerprint_generic(
1123 string input, string durcnt,
1124 CPID cpid, float f1, float f2)
1126 arg_slot[0] = ""; arg_slot[1] = "";
1128 for (int sel_num = 0; (durcnt != ""); )
1130 string selected = car(durcnt); durcnt = cdr(durcnt);
1131 NOTIF_HIT_MAX(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic");
1132 switch (strtolower(selected))
1134 #define ARG_CASE_ARG_CS_SV_HA(selected, result)
1135 #define ARG_CASE_ARG_CS_SV_DC(selected, result) case selected: arg_slot[sel_num++] = result; break;
1136 #define ARG_CASE_ARG_CS_SV(selected, result)
1137 #define ARG_CASE_ARG_CS(selected, result)
1138 #define ARG_CASE_ARG_SV(selected, result)
1139 #define ARG_CASE_ARG_DC(selected, result) case selected: arg_slot[sel_num++] = result; break;
1140 #define ARG_CASE(prog, selected, result) ARG_CASE_##prog(selected,result)
1143 #undef ARG_CASE_ARG_DC
1144 #undef ARG_CASE_ARG_SV
1145 #undef ARG_CASE_ARG_CS
1146 #undef ARG_CASE_ARG_CS_SV
1147 #undef ARG_CASE_ARG_CS_SV_DC
1148 #undef ARG_CASE_ARG_CS_SV_HA
1151 if (/* wtf */ ftos(stof(selected)) != "") { arg_slot[sel_num++] = selected; }
1152 else { NOTIF_HIT_UNKNOWN(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic") }
1157 #ifdef NOTIFICATIONS_DEBUG
1158 Debug_Notification(sprintf(
1159 "Local_Notification_centerprint_generic('%s^7', '%s', %d, %d, %d, %d);\n",
1160 MakeConsoleSafe(input),
1167 centerprint_generic(ORDINAL(cpid), input, stof(arg_slot[0]), stof(arg_slot[1]));
1171 void Local_Notification(MSG net_type, Notification net_name, ...count)
1173 // retreive entity of this notification
1174 entity notif = net_name;
1177 #ifdef NOTIFICATIONS_DEBUG
1178 Debug_Notification(sprintf(
1179 "Local_Notification(%s, NULL, ...);\n",
1180 Get_Notif_TypeName(net_type)
1183 LOG_WARNF("Incorrect usage of Local_Notification: %s", "Null notification");
1187 // check if the notification is enabled
1188 if (!notif.nent_enabled)
1190 #ifdef NOTIFICATIONS_DEBUG
1191 Debug_Notification(sprintf(
1192 "Local_Notification(%s, %s, ...): Entity was disabled...\n",
1193 Get_Notif_TypeName(net_type),
1200 string s1 = CCR((notif.nent_stringcount > 0) ? ...(0, string) : "");
1201 string s2 = CCR((notif.nent_stringcount > 1) ? ...(1, string) : "");
1202 string s3 = CCR((notif.nent_stringcount > 2) ? ...(2, string) : "");
1203 string s4 = CCR((notif.nent_stringcount > 3) ? ...(3, string) : "");
1204 float f1 = ((notif.nent_floatcount > 0) ? ...((notif.nent_stringcount + 0), float) : 0);
1205 float f2 = ((notif.nent_floatcount > 1) ? ...((notif.nent_stringcount + 1), float) : 0);
1206 float f3 = ((notif.nent_floatcount > 2) ? ...((notif.nent_stringcount + 2), float) : 0);
1207 float f4 = ((notif.nent_floatcount > 3) ? ...((notif.nent_stringcount + 3), float) : 0);
1209 #ifdef NOTIFICATIONS_DEBUG
1210 Debug_Notification(sprintf(
1211 "Local_Notification(%s, %s, %s, %s);\n",
1212 Get_Notif_TypeName(net_type),
1214 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1215 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1219 if ((notif.nent_stringcount + notif.nent_floatcount) != count)
1223 "Arguments mismatch for Local_Notification(%s, %s, ...)! "
1224 "stringcount(%d) + floatcount(%d) != count(%d)\n"
1225 "Check the definition and function call for accuracy...?\n"
1227 Get_Notif_TypeName(net_type),
1229 notif.nent_stringcount,
1230 notif.nent_floatcount,
1241 Local_Notification_sound(notif.nent_channel, notif.nent_snd, notif.nent_vol, notif.nent_position);
1243 backtrace("MSG_ANNCE on server?... Please notify Samual immediately!\n");
1251 Local_Notification_sprintf(
1258 if (notif.nent_icon != "")
1260 if (notif.nent_iconargs != "")
1262 string s = Local_Notification_sprintf(
1263 notif.nent_icon,notif.nent_iconargs,
1264 s1, s2, s3, s4, f1, f2, f3, f4);
1265 // remove the trailing newline
1266 notif.nent_icon = strzone(substring(s, 0, -1));
1268 Local_Notification_HUD_Notify_Push(
1281 Local_Notification_centerprint_generic(
1282 Local_Notification_sprintf(
1296 if (notif.nent_msginfo && notif.nent_msginfo.nent_enabled)
1298 Local_Notification_WOVA(
1301 notif.nent_msginfo.nent_stringcount,
1302 notif.nent_msginfo.nent_floatcount,
1307 if (notif.nent_msgannce && notif.nent_msgannce.nent_enabled)
1309 Local_Notification_WOVA(
1311 notif.nent_msgannce,
1316 if (notif.nent_msgcenter && notif.nent_msgcenter.nent_enabled)
1318 Local_Notification_WOVA(
1320 notif.nent_msgcenter,
1321 notif.nent_msgcenter.nent_stringcount,
1322 notif.nent_msgcenter.nent_floatcount,
1332 entity found_choice = notif.nent_optiona;
1333 if (notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2))) {
1334 switch (cvar(sprintf("notification_%s", Get_Notif_CvarName(notif))))
1337 case 2: found_choice = notif.nent_optionb; break;
1338 default: return; // not enabled anyway
1342 Local_Notification_WOVA(
1343 found_choice.nent_type,
1345 found_choice.nent_stringcount,
1346 found_choice.nent_floatcount,
1353 // WOVA = Without Variable Arguments
1354 void Local_Notification_WOVA(
1355 MSG net_type, Notification net_name,
1356 float stringcount, float floatcount,
1357 string s1, string s2, string s3, string s4,
1358 float f1, float f2, float f3, float f4)
1360 #define VARITEM(stringc, floatc, args) \
1361 if ((stringcount == stringc) && (floatcount == floatc)) \
1362 { Local_Notification(net_type, net_name, args); return; }
1363 EIGHT_VARS_TO_VARARGS_VARLIST
1365 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
1369 // =========================
1370 // Notification Networking
1371 // =========================
1373 /** networked as a linked entity to give newly connecting clients some notification context */
1374 REGISTER_NET_LINKED(ENT_CLIENT_NOTIFICATION)
1377 NET_HANDLE(ENT_CLIENT_NOTIFICATION, bool is_new)
1380 MSG net_type = ENUMCAST(MSG, ReadByte());
1381 int net_name = ReadShort();
1384 if (net_type == MSG_CENTER_KILL)
1386 if (!is_new) return;
1388 #ifdef NOTIFICATIONS_DEBUG
1389 Debug_Notification(sprintf(
1390 "Read_Notification(%d) at %f: net_type = %s, cpid = %d\n",
1393 Get_Notif_TypeName(net_type),
1397 int _net_name = net_name;
1398 CPID net_name = ENUMCAST(CPID, _net_name);
1399 if (net_name == CPID_Null) {
1401 reset_centerprint_messages();
1404 centerprint_generic(ORDINAL(net_name), "", 0, 0);
1409 Notification notif = Get_Notif_Ent(net_type, net_name);
1411 #ifdef NOTIFICATIONS_DEBUG
1412 Debug_Notification(sprintf(
1413 "Read_Notification(%d) at %f: net_type = %s, net_name = %s (%d)\n",
1416 Get_Notif_TypeName(net_type),
1417 notif.registered_id,
1423 backtrace("Read_Notification: Could not find notification entity!\n");
1427 string s1 = ((notif.nent_stringcount > 0) ? ReadString() : "");
1428 string s2 = ((notif.nent_stringcount > 1) ? ReadString() : "");
1429 string s3 = ((notif.nent_stringcount > 2) ? ReadString() : "");
1430 string s4 = ((notif.nent_stringcount > 3) ? ReadString() : "");
1431 float f1 = ((notif.nent_floatcount > 0) ? ReadLong() : 0);
1432 float f2 = ((notif.nent_floatcount > 1) ? ReadLong() : 0);
1433 float f3 = ((notif.nent_floatcount > 2) ? ReadLong() : 0);
1434 float f4 = ((notif.nent_floatcount > 3) ? ReadLong() : 0);
1436 if (!is_new) return;
1437 Local_Notification_WOVA(
1439 notif.nent_stringcount,
1440 notif.nent_floatcount,
1447 void Net_Notification_Remove(entity this)
1449 #ifdef NOTIFICATIONS_DEBUG
1450 Debug_Notification(sprintf(
1451 "Net_Notification_Remove() at %f: %s '%s - %s' notification\n",
1453 ((this.nent_net_name == -1) ? "Killed" : "Removed"),
1454 Get_Notif_TypeName(this.nent_net_type),
1455 this.owner.nent_name
1458 for (int i = 0; i < this.nent_stringcount; ++i) { strfree(this.nent_strings[i]); }
1462 bool Net_Write_Notification(entity this, entity client, int sf)
1464 if (!Notification_ShouldSend(this.nent_broadcast, client, this.nent_client)) return false;
1465 WriteHeader(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
1466 WriteByte(MSG_ENTITY, ORDINAL(this.nent_net_type));
1467 WriteShort(MSG_ENTITY, this.nent_net_name);
1468 for (int i = 0; i < this.nent_stringcount; ++i) { WriteString(MSG_ENTITY, this.nent_strings[i]); }
1469 for (int i = 0; i < this.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, this.nent_floats[i]); }
1473 void Kill_Notification(
1474 NOTIF broadcast, entity client,
1475 /** message group, MSG_Null for all */
1477 /** cpid group, CPID_Null for all */
1480 #ifdef NOTIFICATIONS_DEBUG
1481 Debug_Notification(sprintf(
1482 "Kill_Notification(%s, '%s', %s, %d);\n",
1483 Get_Notif_BroadcastName(broadcast),
1485 (net_type ? Get_Notif_TypeName(net_type) : "0"),
1490 string checkargs = Notification_CheckArgs(broadcast, client);
1491 if (checkargs != "") { LOG_WARNF("Incorrect usage of Kill_Notification: %s", checkargs); return; }
1493 entity net_notif = new_pure(net_kill_notification);
1494 net_notif.nent_broadcast = broadcast;
1495 net_notif.nent_client = client;
1496 net_notif.nent_net_type = MSG_CENTER_KILL;
1497 net_notif.nent_net_name = ORDINAL(net_cpid);
1498 Net_LinkEntity(net_notif, false, autocvar_notification_lifetime_runtime, Net_Write_Notification);
1500 IL_EACH(g_notifications,
1501 (it.owner.nent_type == net_type || net_type == MSG_Null) && (it.owner.nent_cpid == net_cpid || net_cpid == CPID_Null),
1503 it.nent_net_name = -1;
1504 it.nextthink = time;
1509 void Send_Notification(
1510 NOTIF broadcast, entity client,
1511 MSG net_type, Notification net_name,
1514 if (broadcast != NOTIF_ALL && broadcast != NOTIF_ALL_EXCEPT && !IS_REAL_CLIENT(client)) return;
1515 entity notif = net_name;
1516 string parms = sprintf("%s, '%s', %s, %s",
1517 Get_Notif_BroadcastName(broadcast),
1519 Get_Notif_TypeName(net_type),
1520 net_name.registered_id
1522 #ifdef NOTIFICATIONS_DEBUG
1523 Debug_Notification(sprintf("Send_Notification(%s, ...%d);\n", parms, count));
1528 LOG_WARN("Send_Notification: Could not find notification entity!");
1532 // check supplied broadcast, target, type, and name for errors
1533 string checkargs = Notification_CheckArgs(broadcast, client);
1534 if (!net_name) { checkargs = sprintf("No notification provided! %s", checkargs); }
1535 if (checkargs != "")
1537 LOG_WARNF("Incorrect usage of Send_Notification: %s", checkargs);
1541 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1542 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1543 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1544 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1545 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1546 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1547 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1548 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1550 #ifdef NOTIFICATIONS_DEBUG
1551 Debug_Notification(sprintf(
1552 "Send_Notification(%s, %s, %s);\n",
1554 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1555 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1559 if ((notif.nent_stringcount + notif.nent_floatcount) != count)
1562 "Argument mismatch for Send_Notification(%s, ...)! "
1563 "stringcount(%d) + floatcount(%d) != count(%d)\n"
1564 "Check the definition and function call for accuracy...?\n",
1566 notif.nent_stringcount,
1567 notif.nent_floatcount,
1573 if (server_is_dedicated
1574 && (broadcast == NOTIF_ALL || broadcast == NOTIF_ALL_EXCEPT)
1575 && !(net_type == MSG_ANNCE || net_type == MSG_CENTER)
1578 Local_Notification_WOVA(
1580 notif.nent_stringcount,
1581 notif.nent_floatcount,
1586 if (net_type == MSG_CHOICE)
1588 // THIS GETS TRICKY... now we have to cycle through each possible player (checking broadcast)
1589 // and then do an individual NOTIF_ONE_ONLY recursive call for each one depending on their option...
1590 // It's slow, but it's better than the alternatives:
1591 // 1. Constantly networking all info and letting client decide
1592 // 2. Manually handling each separate call on per-usage basis (See old CTF usage of verbose)
1593 entity found_choice;
1595 #define RECURSE_FROM_CHOICE(ent,action) MACRO_BEGIN \
1596 if (notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2))) { \
1597 switch (CS(ent).msg_choice_choices[net_name.nent_choice_idx]) \
1599 case 1: found_choice = notif.nent_optiona; break; \
1600 case 2: found_choice = notif.nent_optionb; break; \
1604 found_choice = notif.nent_optiona; \
1606 Send_Notification_WOVA( \
1609 found_choice.nent_type, \
1611 found_choice.nent_stringcount, \
1612 found_choice.nent_floatcount, \
1619 case NOTIF_ONE_ONLY: // we can potentially save processing power with this broadcast method
1621 if (IS_REAL_CLIENT(client)) {
1622 RECURSE_FROM_CHOICE(client, return);
1628 FOREACH_CLIENT(IS_REAL_CLIENT(it) && Notification_ShouldSend(broadcast, it, client), {
1629 RECURSE_FROM_CHOICE(it, continue);
1637 entity net_notif = new_pure(net_notification);
1638 IL_PUSH(g_notifications, net_notif);
1639 net_notif.owner = notif;
1640 net_notif.nent_broadcast = broadcast;
1641 net_notif.nent_client = client;
1642 net_notif.nent_net_type = net_type;
1643 net_notif.nent_net_name = notif.m_id;
1644 net_notif.nent_stringcount = notif.nent_stringcount;
1645 net_notif.nent_floatcount = notif.nent_floatcount;
1647 for (int i = 0; i < net_notif.nent_stringcount; ++i) {
1648 net_notif.nent_strings[i] = strzone(...(i, string));
1650 for (int i = 0; i < net_notif.nent_floatcount; ++i) {
1651 net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float);
1654 setthink(net_notif, Net_Notification_Remove);
1655 net_notif.nextthink = (time > autocvar_notification_lifetime_mapload)
1656 ? (time + autocvar_notification_lifetime_runtime)
1657 : autocvar_notification_lifetime_mapload;
1659 Net_LinkEntity(net_notif, false, 0, Net_Write_Notification);
1663 // WOVA = Without Variable Arguments
1664 void Send_Notification_WOVA(
1665 NOTIF broadcast, entity client,
1666 MSG net_type, Notification net_name,
1667 float stringcount, float floatcount,
1668 string s1, string s2, string s3, string s4,
1669 float f1, float f2, float f3, float f4)
1671 #ifdef NOTIFICATIONS_DEBUG
1672 entity notif = net_name;
1673 Debug_Notification(sprintf(
1674 "Send_Notification_WOVA(%s, %d, %d, %s, %s);\n",
1677 Get_Notif_BroadcastName(broadcast),
1679 Get_Notif_TypeName(net_type),
1684 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1685 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1689 #define VARITEM(stringc, floatc, args) \
1690 if ((stringcount == stringc) && (floatcount == floatc)) \
1691 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
1692 EIGHT_VARS_TO_VARARGS_VARLIST
1694 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
1697 // WOCOVA = Without Counts Or Variable Arguments
1698 void Send_Notification_WOCOVA(
1699 NOTIF broadcast, entity client,
1700 MSG net_type, Notification net_name,
1701 string s1, string s2, string s3, string s4,
1702 float f1, float f2, float f3, float f4)
1704 entity notif = net_name;
1706 #ifdef NOTIFICATIONS_DEBUG
1707 Debug_Notification(sprintf(
1708 "Send_Notification_WOCOVA(%s, %s, %s);\n",
1711 Get_Notif_BroadcastName(broadcast),
1713 Get_Notif_TypeName(net_type),
1716 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1717 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1721 #define VARITEM(stringc, floatc, args) \
1722 if ((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
1723 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
1724 EIGHT_VARS_TO_VARARGS_VARLIST
1726 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
1728 #endif // ifdef SVQC