2 #include "../dpdefs/csprogsdefs.qc"
3 #include "../client/Defs.qc"
8 #include "weapons/weapons.qh"
9 #include "../client/autocvars.qh"
10 #include "notifications.qh"
11 #include "../client/main.qh"
14 #include "../dpdefs/progsdefs.qc"
15 #include "../dpdefs/dpextensions.qc"
16 #include "constants.qh"
18 #include "counting.qh"
19 #include "../server/autocvars.qh"
20 #include "../server/constants.qh"
21 #include "../server/defs.qh"
22 #include "notifications.qh"
23 #include "../server/mutators/mutators_include.qh"
26 // ================================================
27 // Unified notification system, written by Samual
28 // Last updated: August, 2013
29 // ================================================
31 string Get_Notif_TypeName(int net_type)
35 case MSG_ANNCE: return "MSG_ANNCE";
36 case MSG_INFO: return "MSG_INFO";
37 case MSG_CENTER: return "MSG_CENTER";
38 case MSG_CENTER_CPID: return "MSG_CENTER_CPID";
39 case MSG_MULTI: return "MSG_MULTI";
40 case MSG_CHOICE: return "MSG_CHOICE";
42 backtrace(sprintf("Get_Notif_TypeName(%d): Improper net type!\n", net_type));
46 entity Get_Notif_Ent(int net_type, int net_name)
50 case MSG_ANNCE: return msg_annce_notifs[net_name - 1];
51 case MSG_INFO: return msg_info_notifs[net_name - 1];
52 case MSG_CENTER: return msg_center_notifs[net_name - 1];
53 case MSG_MULTI: return msg_multi_notifs[net_name - 1];
54 case MSG_CHOICE: return msg_choice_notifs[net_name - 1];
56 backtrace(sprintf("Get_Notif_Ent(%d, %d): Improper net type!\n", net_type, net_name));
61 #ifdef NOTIFICATIONS_DEBUG
62 string Get_Notif_BroadcastName(float broadcast)
66 case NOTIF_ONE: return "NOTIF_ONE";
67 case NOTIF_ONE_ONLY: return "NOTIF_ONE_ONLY";
68 case NOTIF_ALL_EXCEPT: return "NOTIF_ALL_EXCEPT";
69 case NOTIF_ALL: return "NOTIF_ALL";
70 case NOTIF_TEAM: return "NOTIF_TEAM";
71 case NOTIF_TEAM_EXCEPT: return "NOTIF_TEAM_EXCEPT";
73 backtrace(sprintf("Get_Notif_BroadcastName(%d): Improper broadcast!\n", broadcast));
79 string Notification_CheckArgs_TypeName(float net_type, float net_name)
81 // check supplied type and name for errors
82 string checkargs = "";
83 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
84 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
85 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
88 CHECKARG_TYPENAME(ANNCE)
89 CHECKARG_TYPENAME(INFO)
90 CHECKARG_TYPENAME(CENTER)
91 CHECKARG_TYPENAME(MULTI)
92 CHECKARG_TYPENAME(CHOICE)
93 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
95 #undef CHECKARG_TYPENAME
100 string Notification_CheckArgs(
101 float broadcast, entity client,
102 float net_type, float net_name)
104 // check supplied broadcast, target, type, and name for errors
105 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
106 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
112 if(IS_NOT_A_CLIENT(client))
113 { checkargs = sprintf("%sNo client provided!", checkargs); }
117 case NOTIF_ALL_EXCEPT:
119 if(IS_NOT_A_CLIENT(client))
120 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
127 { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
134 { checkargs = sprintf("%sTeamplay not active!", checkargs); }
135 //else if (!client.team) { checkargs = sprintf("%sNo team provided!", checkargs); }
139 case NOTIF_TEAM_EXCEPT:
142 { checkargs = sprintf("%sTeamplay not active!", checkargs); }
143 else if(IS_NOT_A_CLIENT(client))
144 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
148 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
153 float Notification_ShouldSend(float broadcast, entity to_client, entity other_client)
157 case NOTIF_ONE: // send to one client and their spectator
160 (to_client == other_client)
165 (to_client.enemy == other_client)
170 case NOTIF_ONE_ONLY: // send ONLY to one client
172 if(to_client == other_client) { return true; }
175 case NOTIF_TEAM: // send only to X team and their spectators
178 (to_client.team == other_client.team)
183 (to_client.enemy.team == other_client.team)
188 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
191 (to_client != other_client)
194 (to_client.team == other_client.team)
200 (to_client.enemy != other_client)
202 (to_client.enemy.team == other_client.team)
209 case NOTIF_ALL: // send to everyone
213 case NOTIF_ALL_EXCEPT: // send to everyone except X person and their spectators
216 (to_client != other_client)
221 (to_client.enemy == other_client)
232 // ===============================
233 // Initialization Core Functions
234 // ===============================
236 // used by restartnotifs command to initialize notifications
237 void Destroy_Notification_Entity(entity notif)
239 if(notif.nent_name != "") { strunzone(notif.nent_name); }
240 if(notif.nent_snd != "") { strunzone(notif.nent_snd); }
241 if(notif.nent_args != "") { strunzone(notif.nent_args); }
242 if(notif.nent_hudargs != "") { strunzone(notif.nent_hudargs); }
243 if(notif.nent_icon != "") { strunzone(notif.nent_icon); }
244 if(notif.nent_durcnt != "") { strunzone(notif.nent_durcnt); }
245 if(notif.nent_string != "") { strunzone(notif.nent_string); }
249 void Destroy_All_Notifications(void)
254 #define DESTROY_LOOP(type,count) do { \
255 for(i = 1; i <= count; ++i) \
257 notif = Get_Notif_Ent(type, i); \
258 if (!notif) { backtrace("Destroy_All_Notifications(): Missing notification entity!\n"); return; } \
259 Destroy_Notification_Entity(notif); \
263 // kill all networked notifications and centerprints
265 Kill_Notification(NOTIF_ALL, world, 0, 0);
267 reset_centerprint_messages();
270 // kill all real notification entities
271 DESTROY_LOOP(MSG_ANNCE, NOTIF_ANNCE_COUNT);
272 DESTROY_LOOP(MSG_INFO, NOTIF_INFO_COUNT);
273 DESTROY_LOOP(MSG_CENTER, NOTIF_CENTER_COUNT);
274 DESTROY_LOOP(MSG_MULTI, NOTIF_MULTI_COUNT);
275 DESTROY_LOOP(MSG_CHOICE, NOTIF_CHOICE_COUNT);
279 string Process_Notif_Line(
288 if(typeId == MSG_INFO)
290 if((chat && autocvar_notification_allow_chatboxprint)
291 || (autocvar_notification_allow_chatboxprint == 2))
293 // pass 1: add ETX char at beginning of line
294 input = strcat("\{3}", input);
296 // pass 2: add ETX char at end of each new line (so that
297 // messages with multiple lines are put through chatbox too)
298 input = strreplace("\n", "\n\{3}", input);
300 // pass 3: strip trailing ETX char
301 if(substring(input, (strlen(input) - 1), 1) == "\{3}")
302 { input = substring(input, 0, (strlen(input) - 1)); }
307 // done to both MSG_INFO and MSG_CENTER
308 if(substring(input, (strlen(input) - 1), 1) == "\n")
312 "^1TRAILING NEW LINE AT END OF NOTIFICATION: ",
313 "^7net_type = %s, net_name = %s, string = %s.\n"
320 input = substring(input, 1, (strlen(input) - 1));
326 string Process_Notif_Args(
332 string selected, remaining = args;
335 for(0;(remaining != "");)
337 selected = car(remaining); remaining = cdr(remaining);
341 case 1: // normal args
343 if(sel_num == NOTIF_MAX_ARGS)
347 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
348 "^7net_type = %s, net_name = %s, max args = %d.\n"
358 switch(strtolower(selected))
360 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { ++sel_num; break; }
361 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { ++sel_num; break; }
362 #define ARG_CASE_ARG_CS_SV(selected,result) case selected: { ++sel_num; break; }
363 #define ARG_CASE_ARG_CS(selected,result) case selected: { ++sel_num; break; }
364 #define ARG_CASE_ARG_SV(selected,result) case selected: { ++sel_num; break; }
365 #define ARG_CASE_ARG_DC(selected,result)
366 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
369 #undef ARG_CASE_ARG_DC
370 #undef ARG_CASE_ARG_SV
371 #undef ARG_CASE_ARG_CS
372 #undef ARG_CASE_ARG_CS_SV
373 #undef ARG_CASE_ARG_CS_SV_DC
374 #undef ARG_CASE_ARG_CS_SV_HA
379 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
380 "^7net_type = %s, net_name = %s, args arg = '%s'.\n"
394 if(sel_num == NOTIF_MAX_HUDARGS)
398 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
399 "^7net_type = %s, net_name = %s, max hudargs = %d.\n"
409 switch(strtolower(selected))
411 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { ++sel_num; break; }
412 #define ARG_CASE_ARG_CS_SV_DC(selected,result)
413 #define ARG_CASE_ARG_CS_SV(selected,result)
414 #define ARG_CASE_ARG_CS(selected,result)
415 #define ARG_CASE_ARG_SV(selected,result)
416 #define ARG_CASE_ARG_DC(selected,result)
417 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
420 #undef ARG_CASE_ARG_DC
421 #undef ARG_CASE_ARG_SV
422 #undef ARG_CASE_ARG_CS
423 #undef ARG_CASE_ARG_CS_SV
424 #undef ARG_CASE_ARG_CS_SV_DC
425 #undef ARG_CASE_ARG_CS_SV_HA
430 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
431 "^7net_type = %s, net_name = %s, hudargs arg = '%s'.\n"
445 if(sel_num == NOTIF_MAX_DURCNT)
449 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
450 "^7net_type = %s, net_name = %s, max durcnt = %d.\n"
460 switch(strtolower(selected))
462 #define ARG_CASE_ARG_CS_SV_HA(selected,result)
463 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { ++sel_num; break; }
464 #define ARG_CASE_ARG_CS_SV(selected,result)
465 #define ARG_CASE_ARG_CS(selected,result)
466 #define ARG_CASE_ARG_SV(selected,result)
467 #define ARG_CASE_ARG_DC(selected,result) case selected: { ++sel_num; break; }
468 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
471 #undef ARG_CASE_ARG_DC
472 #undef ARG_CASE_ARG_SV
473 #undef ARG_CASE_ARG_CS
474 #undef ARG_CASE_ARG_CS_SV
475 #undef ARG_CASE_ARG_CS_SV_DC
476 #undef ARG_CASE_ARG_CS_SV_HA
479 if(ftos(stof(selected)) != "") { ++sel_num; }
484 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
485 "^7net_type = %s, net_name = %s, durcnt arg = '%s'.\n"
503 void Create_Notification_Entity(
516 /* MSG_INFO & MSG_CENTER */
535 // =====================
536 // Global Entity Setup
537 // =====================
538 entity notif = spawn();
543 msg_annce_notifs[nameid - 1] = notif;
544 notif.classname = "msg_annce_notification";
549 msg_info_notifs[nameid - 1] = notif;
550 notif.classname = "msg_info_notification";
555 msg_center_notifs[nameid - 1] = notif;
556 notif.classname = "msg_center_notification";
561 msg_multi_notifs[nameid - 1] = notif;
562 notif.classname = "msg_multi_notification";
567 msg_choice_notifs[nameid - 1] = notif;
568 notif.classname = "msg_choice_notification";
576 "^1NOTIFICATION WITH IMPROPER TYPE: ",
577 "^7net_type = %d, net_name = %s.\n"
582 return; // It's not possible to recover from this one
585 notif.nent_default = var_default;
586 notif.nent_enabled = (1 <= var_cvar);
587 notif.nent_type = typeId;
588 notif.nent_id = nameid;
589 notif.nent_name = strzone(namestring);
591 string typestring = Get_Notif_TypeName(typeId);
593 // Other pre-notif-setup requisites
596 // ====================
597 // Notification Setup
598 // ====================
603 // Set MSG_ANNCE information and handle precaching
605 if (!(GENTLE && (var_cvar == 1)))
609 if(notif.nent_enabled)
611 precache_sound(sprintf("announcer/%s/%s.wav", autocvar_cl_announcer, snd));
612 notif.nent_channel = channel;
613 notif.nent_snd = strzone(snd);
614 notif.nent_vol = vol;
615 notif.nent_position = position;
622 "^1NOTIFICATION WITH NO SOUND: ",
623 "^7net_type = %s, net_name = %s.\n"
631 else { notif.nent_enabled = false; }
633 notif.nent_enabled = false;
642 // Set MSG_INFO and MSG_CENTER string/float counts
643 notif.nent_stringcount = strnum;
644 notif.nent_floatcount = flnum;
646 // Only initialize arguments if we're either a client or on a dedicated server
648 float should_process_args = server_is_dedicated;
650 float should_process_args = true;
653 if(should_process_args)
655 // ========================
656 // Process Main Arguments
657 // ========================
662 notif.nent_args = strzone(
663 Process_Notif_Args(1, args, typestring, namestring));
665 else if((hudargs == "") && (durcnt ==""))
669 "^1NOTIFICATION HAS ARG COUNTS BUT NO ARGS OR HUDARGS OR DURCNT: ",
670 "^7net_type = %s, net_name = %s, strnum = %d, flnum = %d\n"
682 notif.nent_args = strzone(
683 Process_Notif_Args(1, args, typestring, namestring));
687 // =======================================
688 // Process HUD and Centerprint Arguments
689 // Only processed on CSQC, as these
690 // args are only for HUD features.
691 // =======================================
695 notif.nent_hudargs = strzone(
696 Process_Notif_Args(2, hudargs, typestring, namestring));
698 if(icon != "") { notif.nent_icon = strzone(icon); }
703 "^1NOTIFICATION HAS HUDARGS BUT NO ICON: ",
704 "^7net_type = %s, net_name = %s.\n"
716 "^1NOTIFICATION HAS ICON BUT NO HUDARGS: ",
717 "^7net_type = %s, net_name = %s.\n"
727 notif.nent_durcnt = strzone(
728 Process_Notif_Args(3, durcnt, typestring, namestring));
730 if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
735 "^1NOTIFICATION HAS DURCNT BUT NO CPID: ",
736 "^7net_type = %s, net_name = %s.\n"
744 else if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
748 // ======================
749 // Process Notif String
750 // ======================
751 #define SET_NOTIF_STRING(string,stringname) do { \
752 notif.nent_string = strzone(CCR( \
753 Process_Notif_Line( \
766 if(gentle != "") { SET_NOTIF_STRING(gentle, "GENTLE"); }
767 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL"); }
769 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL"); }
770 #undef SET_NOTIF_STRING
772 // Check to make sure a string was chosen
773 if(notif.nent_string == "")
777 "^1EMPTY NOTIFICATION: ",
778 "^7net_type = %s, net_name = %s.\n"
792 // Set MSG_MULTI string/float counts
793 if((anncename == NO_MSG) && (infoname == NO_MSG) && (centername == NO_MSG))
797 "^1NOTIFICATION WITH NO SUBCALLS: ",
798 "^7net_type = %s, net_name = %s.\n"
807 // announcements don't actually need any arguments, so lets not even count them.
808 if(anncename != NO_MSG) { notif.nent_msgannce = msg_annce_notifs[anncename - 1]; }
810 float infoname_stringcount = 0, infoname_floatcount = 0;
811 float centername_stringcount = 0, centername_floatcount = 0;
813 if(infoname != NO_MSG)
815 notif.nent_msginfo = msg_info_notifs[infoname - 1];
816 infoname_stringcount = notif.nent_msginfo.nent_stringcount;
817 infoname_floatcount = notif.nent_msginfo.nent_floatcount;
820 if(centername != NO_MSG)
822 notif.nent_msgcenter = msg_center_notifs[centername - 1];
823 centername_stringcount = notif.nent_msgcenter.nent_stringcount;
824 centername_floatcount = notif.nent_msgcenter.nent_floatcount;
827 // set the requirements of THIS notification to the totals of its subcalls
828 notif.nent_stringcount = max(infoname_stringcount, centername_stringcount);
829 notif.nent_floatcount = max(infoname_floatcount, centername_floatcount);
837 if((chtype == NO_MSG) || (optiona == NO_MSG) || (optionb == NO_MSG))
841 "^1NOTIFICATION IS MISSING CHOICE PARAMS: ",
842 "^7net_type = %s, net_name = %s.\n"
855 notif.nent_optiona = msg_annce_notifs[optiona - 1];
856 notif.nent_optionb = msg_annce_notifs[optionb - 1];
861 notif.nent_optiona = msg_info_notifs[optiona - 1];
862 notif.nent_optionb = msg_info_notifs[optionb - 1];
867 notif.nent_optiona = msg_center_notifs[optiona - 1];
868 notif.nent_optionb = msg_center_notifs[optionb - 1];
873 notif.nent_optiona = msg_multi_notifs[optiona - 1];
874 notif.nent_optionb = msg_multi_notifs[optionb - 1];
877 case MSG_CHOICE: // should we REALLY allow nested options?...
879 notif.nent_optiona = msg_choice_notifs[optiona - 1];
880 notif.nent_optionb = msg_choice_notifs[optionb - 1];
888 "^1NOTIFICATION WITH IMPROPER TYPE: ",
889 "^7net_type = %d, net_name = %s.\n"
898 notif.nent_challow_def = challow_def; // 0: never allowed, 1: allowed in warmup, 2: always allowed
899 notif.nent_challow_var = challow_var; // 0: never allowed, 1: allowed in warmup, 2: always allowed
900 notif.nent_stringcount = max(notif.nent_optiona.nent_stringcount, notif.nent_optionb.nent_stringcount);
901 notif.nent_floatcount = max(notif.nent_optiona.nent_floatcount, notif.nent_optionb.nent_floatcount);
903 /*#ifdef NOTIFICATIONS_DEBUG
904 Debug_Notification(sprintf(
905 "Create_Notification_Entity(...): MSG_CHOICE: %s\n%s\n%s\n",
908 "^ optiona: %s %s : %d %d",
909 Get_Notif_TypeName(notif.nent_optiona.nent_type),
910 notif.nent_optiona.nent_name,
911 notif.nent_optiona.nent_stringcount,
912 notif.nent_optiona.nent_floatcount
915 "^ optionb: %s %s : %d %d",
916 Get_Notif_TypeName(notif.nent_optionb.nent_type),
917 notif.nent_optionb.nent_name,
918 notif.nent_optionb.nent_stringcount,
919 notif.nent_optionb.nent_floatcount
931 "^1NOTIFICATION WITH IMPROPER TYPE: ",
932 "^7net_type = %d, net_name = %s.\n"
942 // now check to see if any errors happened
945 notif.nent_enabled = false; // disable the notification so it can't cause trouble
946 notif_global_error = true; // throw the red flag that an error happened on init
955 // used by MSG_CHOICE to build list of choices
957 void Notification_GetCvars(void)
960 for(i = 0; i <= NOTIF_CHOICE_COUNT; ++i)
962 GetCvars_handleFloat(
965 msg_choice_choices[i],
966 sprintf("notification_%s", msg_choice_notifs[i].nent_name)
972 // used to output notifications.cfg file
973 void Dump_Notifications(float fh, float alsoprint)
975 #define NOTIF_WRITE(a) { \
977 if(alsoprint) { print(a); } }
978 #define NOTIF_WRITE_ENTITY(description) { \
981 "seta notification_%s \"%d\" \"%s\"\n", \
982 e.nent_name, e.nent_default, description \
984 NOTIF_WRITE(notif_msg) }
985 #define NOTIF_WRITE_ENTITY_CHOICE(descriptiona,descriptionb) { \
988 "seta notification_%s \"%d\" \"%s\"\n" \
989 "seta notification_%s_ALLOWED \"%d\" \"%s\"\n", \
990 e.nent_name, e.nent_default, descriptiona, \
991 e.nent_name, e.nent_challow_def, descriptionb \
993 NOTIF_WRITE(notif_msg) }
994 #define NOTIF_WRITE_HARDCODED(cvar,default,description) { \
997 "seta notification_%s \"%s\" \"%s\"\n", \
998 cvar, default, description \
1000 NOTIF_WRITE(notif_msg) }
1006 // Note: This warning only applies to the notifications.cfg file that is output...
1008 // You ARE supposed to manually edit this function to add i.e. hard coded
1009 // notification variables for mutators or game modes or such and then
1010 // regenerate the notifications.cfg file from the new code.
1012 NOTIF_WRITE("// ********************************************** //\n");
1013 NOTIF_WRITE("// ** WARNING - DO NOT MANUALLY EDIT THIS FILE ** //\n");
1014 NOTIF_WRITE("// ** ** //\n");
1015 NOTIF_WRITE("// ** This file is automatically generated ** //\n");
1016 NOTIF_WRITE("// ** by code with the command 'dumpnotifs'. ** //\n");
1017 NOTIF_WRITE("// ** ** //\n");
1018 NOTIF_WRITE("// ** If you add a new notification, please ** //\n");
1019 NOTIF_WRITE("// ** regenerate this file with that command ** //\n");
1020 NOTIF_WRITE("// ** making sure that the output matches ** //\n");
1021 NOTIF_WRITE("// ** with the lists and defaults in code. ** //\n");
1022 NOTIF_WRITE("// ** ** //\n");
1023 NOTIF_WRITE("// ********************************************** //\n");
1025 // These notifications will also append their string as a comment...
1026 // This is not necessary, and does not matter if they vary between config versions,
1027 // it is just a semi-helpful tool for those who want to manually change their user settings.
1029 NOTIF_WRITE(sprintf("\n// MSG_ANNCE notifications (count = %d):\n", NOTIF_ANNCE_COUNT));
1030 for(i = 1; i <= NOTIF_ANNCE_COUNT; ++i)
1032 e = Get_Notif_Ent(MSG_ANNCE, i);
1033 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1036 "0 = disabled, 1 = enabled if gentle mode is off, 2 = always enabled"
1040 NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT));
1041 for(i = 1; i <= NOTIF_INFO_COUNT; ++i)
1043 e = Get_Notif_Ent(MSG_INFO, i);
1044 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1047 "0 = off, 1 = print to console, "
1048 "2 = print to console and chatbox (if notification_allow_chatboxprint is enabled)"
1052 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
1053 for(i = 1; i <= NOTIF_CENTER_COUNT; ++i)
1055 e = Get_Notif_Ent(MSG_CENTER, i);
1056 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1059 "0 = off, 1 = centerprint"
1063 NOTIF_WRITE(sprintf("\n// MSG_MULTI notifications (count = %d):\n", NOTIF_MULTI_COUNT));
1064 for(i = 1; i <= NOTIF_MULTI_COUNT; ++i)
1066 e = Get_Notif_Ent(MSG_MULTI, i);
1067 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1070 "Enable this multiple notification"
1074 NOTIF_WRITE(sprintf("\n// MSG_CHOICE notifications (count = %d):\n", NOTIF_CHOICE_COUNT));
1075 for(i = 1; i <= NOTIF_CHOICE_COUNT; ++i)
1077 e = Get_Notif_Ent(MSG_CHOICE, i);
1078 if (!e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
1080 NOTIF_WRITE_ENTITY_CHOICE(
1081 "Choice for this notification 0 = off, 1 = default message, 2 = verbose message",
1082 "Allow choice for this notification 0 = off, 1 = only in warmup mode, 2 = always"
1086 // edit these to match whichever cvars are used for specific notification options
1087 NOTIF_WRITE("\n// HARD CODED notification variables:\n");
1089 NOTIF_WRITE_HARDCODED(
1090 "allow_chatboxprint", "1",
1091 "Allow INFO notifications to be printed to chat box"
1092 "0 = do not allow, "
1093 "1 = allow only if allowed by individual notification_INFO* cvars, "
1094 "2 = force all INFO notifications to be printed to the chatbox"
1097 NOTIF_WRITE_HARDCODED(
1099 "Print extra debug information on all notification function calls "
1100 "(Requires -DNOTIFICATIONS_DEBUG flag to be enabled on QCSRC compilation)... "
1101 "0 = disabled, 1 = dprint, 2 = print"
1104 NOTIF_WRITE_HARDCODED(
1105 "errors_are_fatal", "1",
1106 "If a notification fails upon initialization, cause a Host_Error to stop the program"
1109 NOTIF_WRITE_HARDCODED(
1110 "item_centerprinttime", "1.5",
1111 "How long to show item information centerprint messages (like 'You got the Electro' or such)"
1114 NOTIF_WRITE_HARDCODED(
1115 "lifetime_mapload", "10",
1116 "Amount of time that notification entities last immediately at mapload (in seconds) "
1117 "to help prevent notifications from being lost on early init (like gamestart countdown)"
1120 NOTIF_WRITE_HARDCODED(
1121 "lifetime_runtime", "0.5",
1122 "Amount of time that notification entities last on the server during runtime (In seconds)"
1125 NOTIF_WRITE_HARDCODED(
1126 "server_allows_location", "1",
1127 "Server side cvar for allowing death messages to show location information too"
1130 NOTIF_WRITE_HARDCODED(
1131 "show_location", "0",
1132 "Append location information to MSG_INFO death/kill messages"
1135 NOTIF_WRITE_HARDCODED(
1136 "show_location_string", "",
1137 "Replacement string piped into sprintf, "
1138 "so you can do different messages like this: ' at the %s' or ' (near %s)'"
1141 NOTIF_WRITE_HARDCODED(
1143 "Print information about sprees in death/kill messages"
1146 NOTIF_WRITE_HARDCODED(
1147 "show_sprees_center", "1",
1148 "Show spree information in MSG_CENTER messages... "
1149 "0 = off, 1 = target (but only for first victim) and attacker"
1152 NOTIF_WRITE_HARDCODED(
1153 "show_sprees_center_specialonly", "1",
1154 "Don't show spree information in MSG_CENTER messages if it isn't an achievement"
1157 NOTIF_WRITE_HARDCODED(
1158 "show_sprees_info", "3",
1159 "Show spree information in MSG_INFO messages... "
1160 "0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker"
1163 NOTIF_WRITE_HARDCODED(
1164 "show_sprees_info_newline", "1",
1165 "Show attacker spree information for MSG_INFO messages on a separate line than the death notification itself"
1168 NOTIF_WRITE_HARDCODED(
1169 "show_sprees_info_specialonly", "1",
1170 "Don't show attacker spree information in MSG_INFO messages if it isn't an achievement"
1173 NOTIF_WRITE(sprintf(
1175 "\n// Notification counts (total = %d): ",
1176 "MSG_ANNCE = %d, MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d, MSG_CHOICE = %d\n"
1181 NOTIF_CENTER_COUNT +
1193 #undef NOTIF_WRITE_HARDCODED
1194 #undef NOTIF_WRITE_ENTITY
1199 // ===============================
1200 // Frontend Notification Pushing
1201 // ===============================
1203 #ifdef NOTIFICATIONS_DEBUG
1204 void Debug_Notification(string input)
1206 switch(autocvar_notification_debug)
1208 case 1: { dprint(input); break; }
1209 case 2: { print(input); break; }
1214 string Local_Notification_sprintf(
1215 string input, string args,
1216 string s1, string s2, string s3, string s4,
1217 int f1, float f2, float f3, float f4)
1219 #ifdef NOTIFICATIONS_DEBUG
1220 Debug_Notification(sprintf(
1221 "Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
1222 MakeConsoleSafe(input),
1224 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1225 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1231 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
1235 for(sel_num = 0;(args != "");)
1237 selected = car(args); args = cdr(args);
1238 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf");
1239 switch(strtolower(selected))
1242 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1243 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1244 #define ARG_CASE_ARG_CS_SV(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1245 #define ARG_CASE_ARG_CS(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1246 #define ARG_CASE_ARG_SV(selected,result)
1247 #define ARG_CASE_ARG_DC(selected,result)
1249 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1250 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1251 #define ARG_CASE_ARG_CS_SV(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1252 #define ARG_CASE_ARG_CS(selected,result)
1253 #define ARG_CASE_ARG_SV(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1254 #define ARG_CASE_ARG_DC(selected,result)
1256 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
1259 #undef ARG_CASE_ARG_DC
1260 #undef ARG_CASE_ARG_SV
1261 #undef ARG_CASE_ARG_CS
1262 #undef ARG_CASE_ARG_CS_SV
1263 #undef ARG_CASE_ARG_CS_SV_DC
1264 #undef ARG_CASE_ARG_CS_SV_HA
1265 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
1269 strcat(input, "\n"),
1281 void Local_Notification_sound(
1282 float soundchannel, string soundfile,
1283 float soundvolume, float soundposition)
1285 if((soundfile != prev_soundfile) || (time >= (prev_soundtime + autocvar_cl_announcer_antispam)))
1287 #ifdef NOTIFICATIONS_DEBUG
1288 Debug_Notification(sprintf(
1289 "Local_Notification_sound(world, %f, '%s', %f, %f);\n",
1292 "announcer/%s/%s.wav",
1293 autocvar_cl_announcer,
1305 "announcer/%s/%s.wav",
1306 autocvar_cl_announcer,
1313 if(prev_soundfile) { strunzone(prev_soundfile); }
1314 prev_soundfile = strzone(soundfile);
1315 prev_soundtime = time;
1319 #ifdef NOTIFICATIONS_DEBUG
1320 Debug_Notification(sprintf(
1322 "Local_Notification_sound(world, %f, '%s', %f, %f) ",
1323 "^1BLOCKED BY ANTISPAM:^7 prevsnd: '%s', timediff: %f, limit: %f\n"
1327 "announcer/%s/%s.wav",
1328 autocvar_cl_announcer,
1334 (time - prev_soundtime),
1335 autocvar_cl_announcer_antispam
1341 void Local_Notification_HUD_Notify_Push(
1342 string icon, string hudargs,
1343 string s1, string s2, string s3, string s4,
1344 float f1, float f2, float f3, float f4)
1347 arg_slot[0] = ""; arg_slot[1] = "";
1350 for(sel_num = 0;(hudargs != "");)
1352 selected = car(hudargs); hudargs = cdr(hudargs);
1353 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push");
1354 switch(strtolower(selected))
1356 #define ARG_CASE_ARG_CS_SV_HA(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1357 #define ARG_CASE_ARG_CS_SV_DC(selected,result)
1358 #define ARG_CASE_ARG_CS_SV(selected,result)
1359 #define ARG_CASE_ARG_CS(selected,result)
1360 #define ARG_CASE_ARG_SV(selected,result)
1361 #define ARG_CASE_ARG_DC(selected,result)
1362 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
1365 #undef ARG_CASE_ARG_DC
1366 #undef ARG_CASE_ARG_SV
1367 #undef ARG_CASE_ARG_CS
1368 #undef ARG_CASE_ARG_CS_SV
1369 #undef ARG_CASE_ARG_CS_SV_DC
1370 #undef ARG_CASE_ARG_CS_SV_HA
1371 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
1374 #ifdef NOTIFICATIONS_DEBUG
1375 Debug_Notification(sprintf(
1376 "Local_Notification_HUD_Notify_Push('%s^7', '%s', %s, %s, %s);\n",
1379 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1380 sprintf("%d, %d, %d, %d", f1, f2, f3, f4),
1381 MakeConsoleSafe(sprintf("'%s^7', '%s^7'", stof(arg_slot[0]), stof(arg_slot[1])))
1384 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
1387 void Local_Notification_centerprint_generic(
1388 string input, string durcnt,
1389 float cpid, float f1, float f2)
1393 arg_slot[0] = ""; arg_slot[1] = "";
1395 for(sel_num = 0;(durcnt != "");)
1397 selected = car(durcnt); durcnt = cdr(durcnt);
1398 NOTIF_HIT_MAX(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic");
1399 switch(strtolower(selected))
1401 #define ARG_CASE_ARG_CS_SV_HA(selected,result)
1402 #define ARG_CASE_ARG_CS_SV_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1403 #define ARG_CASE_ARG_CS_SV(selected,result)
1404 #define ARG_CASE_ARG_CS(selected,result)
1405 #define ARG_CASE_ARG_SV(selected,result)
1406 #define ARG_CASE_ARG_DC(selected,result) case selected: { arg_slot[sel_num] = result; ++sel_num; break; }
1407 #define ARG_CASE(prog,selected,result) ARG_CASE_##prog(selected,result)
1410 #undef ARG_CASE_ARG_DC
1411 #undef ARG_CASE_ARG_SV
1412 #undef ARG_CASE_ARG_CS
1413 #undef ARG_CASE_ARG_CS_SV
1414 #undef ARG_CASE_ARG_CS_SV_DC
1415 #undef ARG_CASE_ARG_CS_SV_HA
1418 if(ftos(stof(selected)) != "") { arg_slot[sel_num] = selected; ++sel_num; }
1419 else { NOTIF_HIT_UNKNOWN(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic") }
1424 #ifdef NOTIFICATIONS_DEBUG
1425 Debug_Notification(sprintf(
1426 "Local_Notification_centerprint_generic('%s^7', '%s', %d, %d, %d, %d);\n",
1427 MakeConsoleSafe(input),
1434 centerprint_generic(cpid, input, stof(arg_slot[0]), stof(arg_slot[1]));
1438 void Local_Notification(float net_type, float net_name, ...count)
1440 // check if this should be aborted
1441 if(net_name == NOTIF_ABORT)
1443 #ifdef NOTIFICATIONS_DEBUG
1444 Debug_Notification(sprintf(
1445 "Local_Notification(%s, %s, ...);\n",
1446 Get_Notif_TypeName(net_type),
1453 // check supplied type and name for errors
1454 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
1457 #ifdef NOTIFICATIONS_DEBUG
1458 Debug_Notification(sprintf(
1459 "Local_Notification(%s, %d, ...);\n",
1460 Get_Notif_TypeName(net_type),
1461 Get_Notif_Ent(net_type, net_name).nent_name
1464 backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs));
1468 // retreive entity of this notification
1469 entity notif = Get_Notif_Ent(net_type, net_name);
1472 #ifdef NOTIFICATIONS_DEBUG
1473 Debug_Notification(sprintf(
1474 "Local_Notification(%s, %d, ...);\n",
1475 Get_Notif_TypeName(net_type),
1479 backtrace("Local_Notification: Could not find notification entity!\n");
1483 // check if the notification is enabled
1484 if (!notif.nent_enabled)
1486 #ifdef NOTIFICATIONS_DEBUG
1487 Debug_Notification(sprintf(
1488 "Local_Notification(%s, %s, ...): Entity was disabled...\n",
1489 Get_Notif_TypeName(net_type),
1496 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1497 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1498 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1499 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1500 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1501 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1502 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1503 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1505 #ifdef NOTIFICATIONS_DEBUG
1506 Debug_Notification(sprintf(
1507 "Local_Notification(%s, %s, %s, %s);\n",
1508 Get_Notif_TypeName(net_type),
1510 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1511 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1515 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1519 "Not enough arguments for Local_Notification(%s, %s, ...)! ",
1520 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1521 "Check the definition and function call for accuracy...?\n"
1523 Get_Notif_TypeName(net_type),
1525 notif.nent_stringcount,
1526 notif.nent_floatcount,
1531 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1535 "Too many arguments for Local_Notification(%s, %s, ...)! ",
1536 "stringcount(%d) + floatcount(%d) < count(%d)\n",
1537 "Check the definition and function call for accuracy...?\n"
1539 Get_Notif_TypeName(net_type),
1541 notif.nent_stringcount,
1542 notif.nent_floatcount,
1553 Local_Notification_sound(
1560 backtrace("MSG_ANNCE on server?... Please notify Samual immediately!\n");
1568 Local_Notification_sprintf(
1575 if(notif.nent_icon != "")
1577 Local_Notification_HUD_Notify_Push(
1590 Local_Notification_centerprint_generic(
1591 Local_Notification_sprintf(
1605 if(notif.nent_msginfo)
1606 if(notif.nent_msginfo.nent_enabled)
1608 Local_Notification_WOVA(
1610 notif.nent_msginfo.nent_id,
1611 notif.nent_msginfo.nent_stringcount,
1612 notif.nent_msginfo.nent_floatcount,
1617 if(notif.nent_msgannce)
1618 if(notif.nent_msgannce.nent_enabled)
1620 Local_Notification_WOVA(
1622 notif.nent_msgannce.nent_id,
1627 if(notif.nent_msgcenter)
1628 if(notif.nent_msgcenter.nent_enabled)
1630 Local_Notification_WOVA(
1632 notif.nent_msgcenter.nent_id,
1633 notif.nent_msgcenter.nent_stringcount,
1634 notif.nent_msgcenter.nent_floatcount,
1644 entity found_choice;
1646 if(notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2)))
1648 switch(cvar_string(sprintf("notification_%s", notif.nent_name)))
1650 case 1: found_choice = notif.nent_optiona; break;
1651 case 2: found_choice = notif.nent_optionb; break;
1652 default: return; // not enabled anyway
1655 else { found_choice = notif.nent_optiona; }
1657 Local_Notification_WOVA(
1658 found_choice.nent_type,
1659 found_choice.nent_id,
1660 found_choice.nent_stringcount,
1661 found_choice.nent_floatcount,
1668 // WOVA = Without Variable Arguments
1669 void Local_Notification_WOVA(
1670 float net_type, float net_name,
1671 float stringcount, float floatcount,
1672 string s1, string s2, string s3, string s4,
1673 float f1, float f2, float f3, float f4)
1675 #define VARITEM(stringc,floatc,args) \
1676 if((stringcount == stringc) && (floatcount == floatc)) \
1677 { Local_Notification(net_type, net_name, args); return; }
1678 EIGHT_VARS_TO_VARARGS_VARLIST
1680 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
1684 // =========================
1685 // Notification Networking
1686 // =========================
1689 void Read_Notification(float is_new)
1691 float net_type = ReadByte();
1692 float net_name = ReadShort();
1696 if(net_type == MSG_CENTER_CPID)
1698 #ifdef NOTIFICATIONS_DEBUG
1699 Debug_Notification(sprintf(
1700 "Read_Notification(%d) at %f: net_type = %s, net_name = %d\n",
1703 Get_Notif_TypeName(net_type),
1710 if(net_name == 0) { reset_centerprint_messages(); }
1711 else if(net_name != NO_CPID)
1713 // in this case, net_name IS the cpid we want to kill
1714 centerprint_generic(net_name, "", 0, 0);
1719 "Read_Notification(%d) at %f: ^1TRIED TO KILL NO_CPID CENTERPRINT!\n",
1728 notif = Get_Notif_Ent(net_type, net_name);
1729 if (!notif) { backtrace("Read_Notification: Could not find notification entity!\n"); return; }
1731 #ifdef NOTIFICATIONS_DEBUG
1732 Debug_Notification(sprintf(
1733 "Read_Notification(%d) at %f: net_type = %s, net_name = %s\n",
1736 Get_Notif_TypeName(net_type),
1741 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
1742 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
1743 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
1744 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
1745 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
1746 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
1747 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
1748 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
1752 Local_Notification_WOVA(
1754 notif.nent_stringcount,
1755 notif.nent_floatcount,
1764 void Net_Notification_Remove()
1766 if (!self) { backtrace(sprintf("Net_Notification_Remove() at %f: Missing self!?\n", time)); return; }
1768 #ifdef NOTIFICATIONS_DEBUG
1769 Debug_Notification(sprintf(
1770 "Net_Notification_Remove() at %f: %s '%s - %s' notification\n",
1772 ((self.nent_net_name == -1) ? "Killed" : "Removed"),
1773 Get_Notif_TypeName(self.nent_net_type),
1774 self.owner.nent_name
1779 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
1783 float Net_Write_Notification(entity client, float sf)
1785 if(Notification_ShouldSend(self.nent_broadcast, client, self.nent_client))
1788 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
1789 WriteByte(MSG_ENTITY, self.nent_net_type);
1790 WriteShort(MSG_ENTITY, self.nent_net_name);
1791 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
1792 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
1795 else { return false; }
1798 void Kill_Notification(
1799 float broadcast, entity client,
1800 float net_type, float net_name)
1802 #ifdef NOTIFICATIONS_DEBUG
1803 Debug_Notification(sprintf(
1804 "Kill_Notification(%s, '%s', %s, %d);\n",
1805 Get_Notif_BroadcastName(broadcast),
1807 (net_type ? Get_Notif_TypeName(net_type) : "0"),
1812 string checkargs = Notification_CheckArgs(broadcast, client, 1, 1);
1813 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Kill_Notification: %s\n", checkargs)); return; }
1815 entity notif, net_notif;
1816 float killed_cpid = NO_CPID;
1822 killed_cpid = 0; // kill ALL centerprints
1830 entity notif = Get_Notif_Ent(net_type, net_name);
1831 if (!notif) { backtrace("Kill_Notification: Could not find notification entity!\n"); return; }
1834 killed_cpid = notif.nent_cpid;
1836 killed_cpid = NO_CPID;
1840 killed_cpid = 0; // kill ALL centerprints
1845 case MSG_CENTER_CPID:
1847 killed_cpid = net_name;
1852 if(killed_cpid != NO_CPID)
1854 net_notif = spawn();
1855 net_notif.classname = "net_kill_notification";
1856 net_notif.nent_broadcast = broadcast;
1857 net_notif.nent_client = client;
1858 net_notif.nent_net_type = MSG_CENTER_CPID;
1859 net_notif.nent_net_name = killed_cpid;
1860 Net_LinkEntity(net_notif, false, autocvar_notification_lifetime_runtime, Net_Write_Notification);
1863 for(notif = world; (notif = find(notif, classname, "net_notification"));)
1867 if((killed_cpid != NO_CPID) && (notif.nent_net_type == MSG_CENTER))
1869 if(notif.owner.nent_cpid == killed_cpid)
1871 notif.nent_net_name = -1;
1872 notif.nextthink = time;
1874 else { continue; } // we ARE looking for a specific CPID, don't kill everything else too
1876 else if(notif.nent_net_type == net_type)
1880 if(notif.nent_net_name == net_name) { notif.nent_net_name = -1; notif.nextthink = time; }
1881 else { continue; } // we ARE looking for a certain net_name, don't kill everything else too
1883 else { notif.nent_net_name = -1; notif.nextthink = time; }
1885 else { continue; } // we ARE looking for a certain net_type, don't kill everything else too
1887 else { notif.nent_net_name = -1; notif.nextthink = time; }
1891 void Send_Notification(
1892 float broadcast, entity client,
1893 float net_type, float net_name,
1896 // check if this should be aborted
1897 if(net_name == NOTIF_ABORT)
1899 #ifdef NOTIFICATIONS_DEBUG
1900 Debug_Notification(sprintf(
1901 "Send_Notification(%s, '%s', %s, %s, ...);\n",
1902 Get_Notif_BroadcastName(broadcast),
1904 Get_Notif_TypeName(net_type),
1911 // check supplied broadcast, target, type, and name for errors
1912 string checkargs = Notification_CheckArgs(broadcast, client, net_type, net_name);
1915 #ifdef NOTIFICATIONS_DEBUG
1916 Debug_Notification(sprintf(
1917 "Send_Notification(%s, '%s', %s, %s, ...);\n",
1918 Get_Notif_BroadcastName(broadcast),
1920 Get_Notif_TypeName(net_type),
1921 Get_Notif_Ent(net_type, net_name).nent_name
1924 backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs));
1928 // retreive entity of this notification
1929 entity notif = Get_Notif_Ent(net_type, net_name);
1932 #ifdef NOTIFICATIONS_DEBUG
1933 Debug_Notification(sprintf(
1934 "Send_Notification(%s, '%s', %s, %d, ...);\n",
1935 Get_Notif_BroadcastName(broadcast),
1937 Get_Notif_TypeName(net_type),
1941 backtrace("Send_Notification: Could not find notification entity!\n");
1945 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1946 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1947 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1948 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1949 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1950 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1951 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1952 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1954 #ifdef NOTIFICATIONS_DEBUG
1955 Debug_Notification(sprintf(
1956 "Send_Notification(%s, %s, %s);\n",
1959 Get_Notif_BroadcastName(broadcast),
1961 Get_Notif_TypeName(net_type),
1964 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1965 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1969 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1973 "Not enough arguments for Send_Notification(%s, ...)! ",
1974 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1975 "Check the definition and function call for accuracy...?\n"
1978 #ifdef NOTIFICATIONS_DEBUG
1980 Get_Notif_BroadcastName(broadcast),
1986 Get_Notif_TypeName(net_type),
1989 notif.nent_stringcount,
1990 notif.nent_floatcount,
1995 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1999 "Too many arguments for Send_Notification(%s, ...)! ",
2000 "stringcount(%d) + floatcount(%d) < count(%d)\n",
2001 "Check the definition and function call for accuracy...?\n"
2004 #ifdef NOTIFICATIONS_DEBUG
2006 Get_Notif_BroadcastName(broadcast),
2012 Get_Notif_TypeName(net_type),
2015 notif.nent_stringcount,
2016 notif.nent_floatcount,
2026 broadcast == NOTIF_ALL
2028 broadcast == NOTIF_ALL_EXCEPT
2032 net_type == MSG_ANNCE
2034 net_type == MSG_CENTER
2038 Local_Notification_WOVA(
2040 notif.nent_stringcount,
2041 notif.nent_floatcount,
2046 if(net_type == MSG_CHOICE)
2048 // THIS GETS TRICKY... now we have to cycle through each possible player (checking broadcast)
2049 // and then do an individual NOTIF_ONE_ONLY recursive call for each one depending on their option...
2050 // It's slow, but it's better than the alternatives:
2051 // 1. Constantly networking all info and letting client decide
2052 // 2. Manually handling each separate call on per-usage basis (See old CTF usage of verbose)
2053 entity found_choice;
2055 #define RECURSE_FROM_CHOICE(ent,action) \
2056 if(notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2))) \
2058 switch(ent.msg_choice_choices[net_name - 1]) \
2060 case 1: found_choice = notif.nent_optiona; break; \
2061 case 2: found_choice = notif.nent_optionb; break; \
2065 else { found_choice = notif.nent_optiona; } \
2066 Send_Notification_WOVA( \
2069 found_choice.nent_type, \
2070 found_choice.nent_id, \
2071 found_choice.nent_stringcount, \
2072 found_choice.nent_floatcount, \
2078 case NOTIF_ONE_ONLY: // we can potentially save processing power with this broadcast method
2080 if(IS_REAL_CLIENT(client))
2081 { RECURSE_FROM_CHOICE(client, return) }
2087 FOR_EACH_REALCLIENT(to)
2088 { if(Notification_ShouldSend(broadcast, to, client))
2089 { RECURSE_FROM_CHOICE(to, continue) } }
2096 entity net_notif = spawn();
2097 net_notif.owner = notif;
2098 net_notif.classname = "net_notification";
2099 net_notif.nent_broadcast = broadcast;
2100 net_notif.nent_client = client;
2101 net_notif.nent_net_type = net_type;
2102 net_notif.nent_net_name = net_name;
2103 net_notif.nent_stringcount = notif.nent_stringcount;
2104 net_notif.nent_floatcount = notif.nent_floatcount;
2107 for(i = 0; i < net_notif.nent_stringcount; ++i)
2108 { net_notif.nent_strings[i] = strzone(...(i, string)); }
2109 for(i = 0; i < net_notif.nent_floatcount; ++i)
2110 { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
2112 net_notif.think = Net_Notification_Remove;
2113 net_notif.nextthink =
2114 ((time > autocvar_notification_lifetime_mapload)
2116 (time + autocvar_notification_lifetime_runtime)
2118 autocvar_notification_lifetime_mapload
2121 Net_LinkEntity(net_notif, false, 0, Net_Write_Notification);
2125 // WOVA = Without Variable Arguments
2126 void Send_Notification_WOVA(
2127 float broadcast, entity client,
2128 float net_type, float net_name,
2129 float stringcount, float floatcount,
2130 string s1, string s2, string s3, string s4,
2131 float f1, float f2, float f3, float f4)
2133 #ifdef NOTIFICATIONS_DEBUG
2134 entity notif = Get_Notif_Ent(net_type, net_name);
2135 Debug_Notification(sprintf(
2136 "Send_Notification_WOVA(%s, %d, %d, %s, %s);\n",
2139 Get_Notif_BroadcastName(broadcast),
2141 Get_Notif_TypeName(net_type),
2146 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
2147 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
2151 #define VARITEM(stringc,floatc,args) \
2152 if((stringcount == stringc) && (floatcount == floatc)) \
2153 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
2154 EIGHT_VARS_TO_VARARGS_VARLIST
2156 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
2159 // WOCOVA = Without Counts Or Variable Arguments
2160 void Send_Notification_WOCOVA(
2161 float broadcast, entity client,
2162 float net_type, float net_name,
2163 string s1, string s2, string s3, string s4,
2164 float f1, float f2, float f3, float f4)
2166 entity notif = Get_Notif_Ent(net_type, net_name);
2168 #ifdef NOTIFICATIONS_DEBUG
2169 Debug_Notification(sprintf(
2170 "Send_Notification_WOCOVA(%s, %s, %s);\n",
2173 Get_Notif_BroadcastName(broadcast),
2175 Get_Notif_TypeName(net_type),
2178 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
2179 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
2183 #define VARITEM(stringc,floatc,args) \
2184 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
2185 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
2186 EIGHT_VARS_TO_VARARGS_VARLIST
2188 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
2190 #endif // ifdef SVQC