1 // ================================================
2 // Unified notification system, written by Samual
3 // Last updated: February, 2013
4 // ================================================
6 string Get_Notif_TypeName(float net_type)
10 case MSG_INFO: return "MSG_INFO";
11 case MSG_CENTER: return "MSG_CENTER";
12 case MSG_CENTER_CPID: return "MSG_CENTER_CPID";
13 case MSG_MULTI: return "MSG_MULTI";
15 backtrace(sprintf("Get_Notif_TypeName(%d): Improper net type!\n", net_type));
19 entity Get_Notif_Ent(float net_type, float net_name)
23 case MSG_INFO: return msg_info_notifs[net_name - 1];
24 case MSG_CENTER: return msg_center_notifs[net_name - 1];
25 case MSG_MULTI: return msg_multi_notifs[net_name - 1];
27 backtrace(sprintf("Get_Notif_Ent(%d, %d): Improper net type!\n", net_type, net_name));
31 string Notification_CheckArgs_TypeName(float net_type, float net_name)
33 // check supplied type and name for errors
34 string checkargs = "";
35 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
36 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
37 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
40 CHECKARG_TYPENAME(INFO)
41 CHECKARG_TYPENAME(CENTER)
42 CHECKARG_TYPENAME(MULTI)
43 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
45 #undef CHECKARG_TYPENAME
50 string Notification_CheckArgs(
51 float broadcast, entity client,
52 float net_type, float net_name)
54 // check supplied broadcast, target, type, and name for errors
55 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
56 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
62 if(IS_NOT_A_CLIENT(client))
63 { checkargs = sprintf("%sNo client provided!", checkargs); }
67 case NOTIF_ALL_EXCEPT:
69 if(IS_NOT_A_CLIENT(client))
70 { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
77 { checkargs = sprintf("%sEntity provided when world was required!", checkargs); }
82 case NOTIF_TEAM_EXCEPT:
84 if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
85 else if(IS_NOT_A_CLIENT(client))
87 if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
88 else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
93 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
99 // ===============================
100 // Initialization Core Functions
101 // ===============================
103 string Process_Notif_Line(
114 if((chat && autocvar_notification_allow_chatboxprint)
115 || (autocvar_notification_allow_chatboxprint == 2))
117 // pass 1: add ETX char at beginning of line
118 input = strcat("\{3}", input);
120 // pass 2: add ETX char at end of each new line (so that
121 // messages with multiple lines are put through chatbox too)
122 input = strreplace("\n", "\n\{3}", input);
124 // pass 3: strip trailing ETX char
125 if(substring(input, (strlen(input) - 1), 1) == "\{3}")
126 { input = substring(input, 0, (strlen(input) - 1)); }
129 if(substring(input, (strlen(input) - 1), 1) != "\n")
133 "^1MISSING/BROKEN NEW LINE AT END OF NOTIFICATION: ",
134 "^7net_type = %s, net_name = %s, string = %s.\n"
141 return strcat(input, "\n");
147 string Process_Notif_Args(
153 string selected, remaining = args;
156 for(;(remaining != "");)
158 selected = car(remaining); remaining = cdr(remaining);
162 case 1: // normal args
164 if(sel_num == NOTIF_MAX_ARGS)
168 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
169 "^7net_type = %s, net_name = %s, max args = %d.\n"
179 switch(strtolower(selected))
181 #define ARG_CASE(prog,selected,result) \
182 #if (prog != ARG_DC) \
183 case selected: { ++sel_num; break; } \
191 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
192 "^7net_type = %s, net_name = %s, args arg = '%s'.\n"
206 if(sel_num == NOTIF_MAX_HUDARGS)
210 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
211 "^7net_type = %s, net_name = %s, max hudargs = %d.\n"
221 switch(strtolower(selected))
223 #define ARG_CASE(prog,selected,result) \
224 #if (prog == ARG_CS_SV_HA) \
225 case selected: { ++sel_num; break; } \
233 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
234 "^7net_type = %s, net_name = %s, hudargs arg = '%s'.\n"
248 if(sel_num == NOTIF_MAX_DURCNT)
252 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
253 "^7net_type = %s, net_name = %s, max durcnt = %d.\n"
263 switch(strtolower(selected))
265 #define ARG_CASE(prog,selected,result) \
266 #if (prog == ARG_CS_SV_DC) || (prog == ARG_DC) \
267 case selected: { ++sel_num; break; } \
273 if(ftos(stof(selected)) != "") { ++sel_num; }
278 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
279 "^7net_type = %s, net_name = %s, durcnt arg = '%s'.\n"
297 void Create_Notification_Entity(
317 // =====================
318 // Global Entity Setup
319 // =====================
320 entity notif = spawn();
321 string typestring = "";
326 typestring = "MSG_INFO";
327 msg_info_notifs[nameid - 1] = notif;
328 notif.classname = "msg_info_notification";
333 typestring = "MSG_CENTER";
334 msg_center_notifs[nameid - 1] = notif;
335 notif.classname = "msg_center_notification";
340 typestring = "MSG_MULTI";
341 msg_multi_notifs[nameid - 1] = notif;
342 notif.classname = "MSG_MULTI_notification";
350 "^1NOTIFICATION WITH IMPROPER TYPE: ",
351 "^7net_type = %d, net_name = %s.\n"
356 return; // It's not possible to recover from this one
359 notif.nent_default = var_default;
360 notif.nent_name = strzone(namestring);
361 notif.nent_id = nameid;
362 notif.nent_enabled = (1 <= var_cvar);
364 // Other pre-notif-setup requisites
367 // ====================
368 // Notification Setup
369 // ====================
372 // Set MSG_MULTI string/float counts
373 if((infoname == NO_MSG) && (centername == NO_MSG))
377 "^1NOTIFICATION WITH NO SUBCALLS: ",
378 "^7net_type = %s, net_name = %s.\n"
387 float infoname_stringcount = 0, infoname_floatcount = 0;
388 float centername_stringcount = 0, centername_floatcount = 0;
390 if(infoname != NO_MSG)
392 notif.nent_msginfo = msg_info_notifs[infoname - 1];
393 infoname_stringcount = notif.nent_msginfo.nent_stringcount;
394 infoname_floatcount = notif.nent_msginfo.nent_floatcount;
397 if(centername != NO_MSG)
399 notif.nent_msgcenter = msg_center_notifs[centername - 1];
400 centername_stringcount = notif.nent_msgcenter.nent_stringcount;
401 centername_floatcount = notif.nent_msgcenter.nent_floatcount;
404 // set the requirements of THIS notification to the totals of its subcalls
405 notif.nent_stringcount = max(infoname_stringcount, centername_stringcount);
406 notif.nent_floatcount = max(infoname_floatcount, centername_floatcount);
411 // Set MSG_INFO and MSG_CENTER string/float counts
412 notif.nent_stringcount = strnum;
413 notif.nent_floatcount = flnum;
415 // Only initialize arguments if we're either a client or on a dedicated server
417 float should_process_args = server_is_dedicated;
419 float should_process_args = TRUE;
422 if(should_process_args)
424 // ========================
425 // Process Main Arguments
426 // ========================
431 notif.nent_args = strzone(
432 Process_Notif_Args(1, args, typestring, namestring));
434 else if((hudargs == "") && (durcnt ==""))
438 "^1NOTIFICATION HAS ARG COUNTS BUT NO ARGS OR HUDARGS OR DURCNT: ",
439 "^7net_type = %s, net_name = %s, strnum = %d, flnum = %d\n"
451 notif.nent_args = strzone(
452 Process_Notif_Args(1, args, typestring, namestring));
456 // =======================================
457 // Process HUD and Centerprint Arguments
458 // Only processed on CSQC, as these
459 // args are only for HUD features.
460 // =======================================
464 notif.nent_hudargs = strzone(
465 Process_Notif_Args(2, hudargs, typestring, namestring));
467 if(icon != "") { notif.nent_icon = strzone(icon); }
472 "^1NOTIFICATION HAS HUDARGS BUT NO ICON: ",
473 "^7net_type = %s, net_name = %s.\n"
485 "^1NOTIFICATION HAS ICON BUT NO HUDARGS: ",
486 "^7net_type = %s, net_name = %s.\n"
496 notif.nent_durcnt = strzone(
497 Process_Notif_Args(3, durcnt, typestring, namestring));
499 if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
504 "^1NOTIFICATION HAS DURCNT BUT NO CPID: ",
505 "^7net_type = %s, net_name = %s.\n"
513 else if(cpid != NO_CPID) { notif.nent_cpid = cpid; }
517 // ======================
518 // Process Notif String
519 // ======================
520 #define SET_NOTIF_STRING(string,stringname) \
521 notif.nent_string = strzone(CCR( \
522 Process_Notif_Line( \
534 if(gentle != "") { SET_NOTIF_STRING(gentle, "GENTLE") }
535 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
537 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
539 #undef SET_NOTIF_STRING
541 // Check to make sure a string was chosen
542 if(notif.nent_string == "")
546 "^1EMPTY NOTIFICATION: ",
547 "^7net_type = %s, net_name = %s.\n"
557 // now check to see if any errors happened
560 notif.nent_enabled = FALSE; // disable the notification so it can't cause trouble
561 notif_global_error = TRUE; // throw the red flag that an error happened on init
565 void Destroy_Notification_Entity(entity notif)
567 if(notif.nent_name != "") { strunzone(notif.nent_name); }
568 if(notif.nent_args != "") { strunzone(notif.nent_args); }
569 if(notif.nent_hudargs != "") { strunzone(notif.nent_hudargs); }
570 if(notif.nent_icon != "") { strunzone(notif.nent_icon); }
571 if(notif.nent_durcnt != "") { strunzone(notif.nent_durcnt); }
572 if(notif.nent_string != "") { strunzone(notif.nent_string); }
576 void Destroy_All_Notifications(void)
581 #define DESTROY_LOOP(type,count) \
582 for(i = 1; i <= count; ++i) \
584 notif = Get_Notif_Ent(type, i); \
585 if not(notif) { backtrace("Destroy_All_Notifications(): Missing notification entity!\n"); return; } \
586 Destroy_Notification_Entity(notif); \
589 // kill all networked notifications
591 Kill_Notification(NOTIF_ALL, world, 0, 0);
594 // kill all real notification entities
595 DESTROY_LOOP(MSG_INFO, NOTIF_INFO_COUNT)
596 DESTROY_LOOP(MSG_CENTER, NOTIF_CENTER_COUNT)
597 DESTROY_LOOP(MSG_MULTI, NOTIF_MULTI_COUNT)
602 // =========================================
603 // Cvar Handling With 'dumpnotifs' Command
604 // =========================================
606 void Dump_Notifications(float fh, float alsoprint)
608 #define NOTIF_WRITE(a) { \
610 if(alsoprint) { print(a); } }
611 #define NOTIF_WRITE_ENTITY(name,default,description) { \
614 "seta notification_%s \"%d\" \"%s\"\n", \
615 name, default, description \
617 NOTIF_WRITE(notif_msg) }
618 #define NOTIF_WRITE_HARDCODED(cvar,default,description) { \
621 "seta notification_%s \"%s\" \"%s\"\n", \
622 cvar, default, description \
624 NOTIF_WRITE(notif_msg) }
630 // Note: This warning only applies to the notifications.cfg file that is output...
632 // You ARE supposed to manually edit this function to add i.e. hard coded
633 // notification variables for mutators or game modes or such and then
634 // regenerate the notifications.cfg file from the new code.
636 NOTIF_WRITE("// ********************************************** //\n");
637 NOTIF_WRITE("// ** WARNING - DO NOT MANUALLY EDIT THIS FILE ** //\n");
638 NOTIF_WRITE("// ** ** //\n");
639 NOTIF_WRITE("// ** This file is automatically generated ** //\n");
640 NOTIF_WRITE("// ** by code with the command 'dumpnotifs'. ** //\n");
641 NOTIF_WRITE("// ** ** //\n");
642 NOTIF_WRITE("// ** If you add a new notification, please ** //\n");
643 NOTIF_WRITE("// ** regenerate this file with that command ** //\n");
644 NOTIF_WRITE("// ** making sure that the output matches ** //\n");
645 NOTIF_WRITE("// ** with the lists and defaults in code. ** //\n");
646 NOTIF_WRITE("// ** ** //\n");
647 NOTIF_WRITE("// ********************************************** //\n");
649 // These notifications will also append their string as a comment...
650 // This is not necessary, and does not matter if they vary between config versions,
651 // it is just a semi-helpful tool for those who want to manually change their user settings.
653 NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT));
654 for(i = 1; i <= NOTIF_INFO_COUNT; ++i)
656 e = Get_Notif_Ent(MSG_INFO, i);
657 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
658 NOTIF_WRITE_ENTITY(e.nent_name, e.nent_default, "Notification control cvar: 0 = off, 1 = print to console, 2 = print to console and chatbox (if notification_allow_chatboxprint is enabled)");
661 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
662 for(i = 1; i <= NOTIF_CENTER_COUNT; ++i)
664 e = Get_Notif_Ent(MSG_CENTER, i);
665 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
666 NOTIF_WRITE_ENTITY(e.nent_name, e.nent_default, "Notification control cvar: 0 = off, 1 = centerprint");
669 NOTIF_WRITE(sprintf("\n// MSG_MULTI notifications (count = %d):\n", NOTIF_MULTI_COUNT));
670 for(i = 1; i <= NOTIF_MULTI_COUNT; ++i)
672 e = Get_Notif_Ent(MSG_MULTI, i);
673 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
674 NOTIF_WRITE_ENTITY(e.nent_name, e.nent_default, "Notification control cvar: 0 = off, 1 = trigger subcalls");
677 // edit these to match whichever cvars are used for specific notification options
678 NOTIF_WRITE("\n// HARD CODED notification variables:\n");
679 NOTIF_WRITE_HARDCODED("allow_chatboxprint", "1", "Allow notifications to be printed to chat box by setting notification cvar to 2 (You can also set this cvar to 2 to force ALL notifications to be printed to the chatbox)");
680 NOTIF_WRITE_HARDCODED("show_location", "0", "Append location information to MSG_INFO death/kill messages");
681 NOTIF_WRITE_HARDCODED("show_location_string", "", "Replacement string piped into sprintf, so you can do different messages like this: ' at the %s' or ' (near %s)'");
682 NOTIF_WRITE_HARDCODED("show_sprees", "1", "Print information about sprees in death/kill messages");
683 NOTIF_WRITE_HARDCODED("show_sprees_center", "1", "Show spree information in MSG_CENTER messages... 0 = off, 1 = target (but only for first victim) and attacker");
684 NOTIF_WRITE_HARDCODED("show_sprees_center_specialonly", "1", "Don't show spree information in MSG_CENTER messages if it isn't an achievement");
685 NOTIF_WRITE_HARDCODED("show_sprees_info", "3", "Show spree information in MSG_INFO messages... 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker");
686 NOTIF_WRITE_HARDCODED("show_sprees_info_newline", "1", "Show attacker spree information for MSG_INFO messages on a separate line than the death notification itself");
687 NOTIF_WRITE_HARDCODED("show_sprees_info_specialonly", "1", "Don't show attacker spree information in MSG_INFO messages if it isn't an achievement");
688 NOTIF_WRITE_HARDCODED("item_centerprinttime", "1.5", "How long to show item information centerprint messages (like 'You got the Electro' or such)");
689 NOTIF_WRITE_HARDCODED("errors_are_fatal", "1", "If a notification fails upon initialization, cause a Host_Error to stop the program");
690 NOTIF_WRITE_HARDCODED("ctf_pickup_team_verbose", "0", "Show extra information if a team mate picks up a flag");
691 NOTIF_WRITE_HARDCODED("ctf_pickup_enemy_verbose", "0", "Show extra information if an enemy picks up a flag");
692 NOTIF_WRITE_HARDCODED("ctf_capture_verbose", "0", "Show extra information when someone captures a flag");
693 NOTIF_WRITE_HARDCODED("frag_verbose", "1", "Show extra information when you frag someone (or when you are fragged");
694 NOTIF_WRITE_HARDCODED("lifetime_runtime", "0.5", "Amount of time that notification entities last on the server during runtime (In seconds)");
695 NOTIF_WRITE_HARDCODED("lifetime_mapload", "10", "Amount of time that notification entities last immediately at mapload (in seconds) to help prevent notifications from being lost on early init (like gamestart countdown)");
699 "\n// Notification counts (total = %d): ",
700 "MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d\n"
713 #undef NOTIF_WRITE_HARDCODED
714 #undef NOTIF_WRITE_ENTITY
719 void Notification_GetCvars()
721 GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
726 // ===============================
727 // Frontend Notification Pushing
728 // ===============================
730 string Local_Notification_sprintf(
731 string input, string args,
732 string s1, string s2, string s3, string s4,
733 float f1, float f2, float f3, float f4)
735 #ifdef NOTIFICATIONS_DEBUG
737 "Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
738 strreplace("\n", "\\n", input),
740 strreplace("\n", "\\n", sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
741 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
747 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
751 for(sel_num = 0;(args != "");)
753 selected = car(args); args = cdr(args);
754 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
755 switch(strtolower(selected))
757 #define ARG_CASE(prog,selected,result) \
759 #if (prog != ARG_SV) && (prog != ARG_DC) \
760 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
763 #if (prog != ARG_CS) && (prog != ARG_DC) \
764 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
769 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
772 return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
776 void Local_Notification_HUD_Notify_Push(
777 string icon, string hudargs,
778 string s1, string s2, string s3, string s4)
782 arg_slot[0] = ""; arg_slot[1] = "";
784 for(sel_num = 0;(hudargs != "");)
786 selected = car(hudargs); hudargs = cdr(hudargs);
787 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
788 switch(strtolower(selected))
790 #define ARG_CASE(prog,selected,result) \
791 #if (prog == ARG_CS_SV_HA) \
792 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
796 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
799 #ifdef NOTIFICATIONS_DEBUG
801 "Local_Notification_HUD_Notify_Push('%s^7', '%s', %s, %s);\n",
804 strreplace("\n", "\\n", sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
805 strreplace("\n", "\\n", sprintf("'%s^7', '%s^7'", stof(arg_slot[0]), stof(arg_slot[1])))
808 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
811 void Local_Notification_centerprint_generic(
812 string input, string durcnt,
813 float cpid, float f1, float f2)
817 arg_slot[0] = ""; arg_slot[1] = "";
819 for(sel_num = 0;(durcnt != "");)
821 selected = car(durcnt); durcnt = cdr(durcnt);
822 NOTIF_HIT_MAX(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic")
823 switch(strtolower(selected))
825 #define ARG_CASE(prog,selected,result) \
826 #if (prog == ARG_CS_SV_DC) || (prog == ARG_DC) \
827 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
833 if(ftos(stof(selected)) != "") { arg_slot[sel_num] = selected; ++sel_num; }
834 else { NOTIF_HIT_UNKNOWN(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic") }
839 #ifdef NOTIFICATIONS_DEBUG
841 "Local_Notification_centerprint_generic('%s^7', '%s', %d, %d, %d, %d);\n",
842 strreplace("\n", "\\n", input),
845 stof(arg_slot[0]), stof(arg_slot[1])
848 centerprint_generic(cpid, input, stof(arg_slot[0]), stof(arg_slot[1]));
852 void Local_Notification(float net_type, float net_name, ...count)
854 // check supplied type and name for errors
855 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
856 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
858 entity notif = Get_Notif_Ent(net_type, net_name);
859 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
861 #ifdef NOTIFICATIONS_DEBUG
862 if not(notif.nent_enabled)
865 "Local_Notification(%s, %s): Entity was disabled...\n",
866 Get_Notif_TypeName(net_type),
873 if((notif.nent_stringcount + notif.nent_floatcount) > count)
877 "Not enough arguments for Local_Notification(%s, %s, ...)! ",
878 "stringcount(%d) + floatcount(%d) > count(%d)\n",
879 "Check the definition and function call for accuracy...?\n"
881 Get_Notif_TypeName(net_type), notif.nent_name,
882 notif.nent_stringcount, notif.nent_floatcount, count
886 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
890 "Too many arguments for Local_Notification(%s, %s, ...)! ",
891 "stringcount(%d) + floatcount(%d) < count(%d)\n",
892 "Check the definition and function call for accuracy...?\n"
894 Get_Notif_TypeName(net_type), notif.nent_name,
895 notif.nent_stringcount, notif.nent_floatcount, count
900 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
901 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
902 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
903 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
904 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
905 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
906 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
907 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
909 #ifdef NOTIFICATIONS_DEBUG
911 "Local_Notification(%s, %s, %s, %s);\n",
912 Get_Notif_TypeName(net_type),
914 strreplace("\n", "\\n", sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
915 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
924 Local_Notification_sprintf(
931 if(notif.nent_icon != "")
933 Local_Notification_HUD_Notify_Push(
945 Local_Notification_centerprint_generic(
946 Local_Notification_sprintf(
960 if(notif.nent_msginfo)
961 if(notif.nent_msginfo.nent_enabled)
963 Local_Notification_WOVA(
965 notif.nent_msginfo.nent_id,
966 notif.nent_msginfo.nent_stringcount,
967 notif.nent_msginfo.nent_floatcount,
972 if(notif.nent_msgcenter)
973 if(notif.nent_msgcenter.nent_enabled)
975 Local_Notification_WOVA(
977 notif.nent_msgcenter.nent_id,
978 notif.nent_msgcenter.nent_stringcount,
979 notif.nent_msgcenter.nent_floatcount,
989 // WOVA = Without Variable Arguments
990 void Local_Notification_WOVA(
991 float net_type, float net_name,
992 float stringcount, float floatcount,
993 string s1, string s2, string s3, string s4,
994 float f1, float f2, float f3, float f4)
996 #define VARITEM(stringc,floatc,args) \
997 if((stringcount == stringc) && (floatcount == floatc)) \
998 { Local_Notification(net_type, net_name, args); return; }
999 EIGHT_VARS_TO_VARARGS_VARLIST
1001 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
1005 // =========================
1006 // Notification Networking
1007 // =========================
1010 void Read_Notification(float is_new)
1012 float net_type = ReadByte();
1013 float net_name = ReadShort();
1017 if(net_type == MSG_CENTER_CPID)
1019 #ifdef NOTIFICATIONS_DEBUG
1021 "Read_Notification(%d) at %f: net_type = %s, net_name = %d\n",
1024 Get_Notif_TypeName(net_type),
1031 if(net_name == 0) { reset_centerprint_messages(); }
1032 else if(net_name != NO_CPID)
1034 // in this case, net_name IS the cpid we want to kill
1035 centerprint_generic(net_name, "", 0, 0);
1037 else { print("Read_Notification(%d) at %f: ^1TRIED TO KILL NO_CPID CENTERPRINT!\n"); }
1042 notif = Get_Notif_Ent(net_type, net_name);
1043 if not(notif) { backtrace("Read_Notification: Could not find notification entity!\n"); return; }
1045 #ifdef NOTIFICATIONS_DEBUG
1047 "Read_Notification(%d) at %f: net_type = %s, net_name = %s\n",
1050 Get_Notif_TypeName(net_type),
1055 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
1056 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
1057 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
1058 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
1059 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
1060 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
1061 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
1062 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
1066 Local_Notification_WOVA(
1068 notif.nent_stringcount,
1069 notif.nent_floatcount,
1078 void Net_Notification_Remove()
1080 if not(self) { dprint(sprintf("Net_Notification_Remove() at %f: Missing self!?\n", time)); return; }
1082 #ifdef NOTIFICATIONS_DEBUG
1084 "Net_Notification_Remove() at %f: %s '%s - %s' notification\n",
1086 ((self.nent_net_name == -1) ? "Killed" : "Removed"),
1087 Get_Notif_TypeName(self.nent_net_type),
1088 self.owner.nent_name
1093 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
1097 float Net_Write_Notification(entity client, float sf)
1099 float i, send = FALSE;
1101 switch(self.nent_broadcast)
1103 case NOTIF_ONE: // send to one client and their spectator
1106 (client == self.nent_client)
1109 (client.classname == STR_SPECTATOR)
1111 (client.enemy == self.nent_client)
1116 case NOTIF_ONE_ONLY: // send ONLY to one client
1118 if(client == self.nent_client) { send = TRUE; }
1121 case NOTIF_TEAM: // send only to X team and their spectators
1124 (client.team == self.nent_client.team)
1127 (client.classname == STR_SPECTATOR)
1129 (client.enemy.team == self.nent_client.team)
1134 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
1137 (client != self.nent_client)
1140 (client.team == self.nent_client.team)
1143 (client.classname == STR_SPECTATOR)
1146 (client.enemy != self.nent_client)
1148 (client.enemy.team == self.nent_client.team)
1155 case NOTIF_ALL: // send to everyone
1160 case NOTIF_ALL_EXCEPT: // send to everyone except X person and their spectators
1163 (client != self.nent_client)
1166 (client.classname == STR_SPECTATOR)
1168 (client.enemy == self.nent_client)
1173 default: { send = FALSE; break; }
1178 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
1179 WriteByte(MSG_ENTITY, self.nent_net_type);
1180 WriteShort(MSG_ENTITY, self.nent_net_name);
1181 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
1182 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
1188 void Kill_Notification(
1189 float broadcast, entity client,
1190 float net_type, float net_name)
1192 string checkargs = Notification_CheckArgs(broadcast, client, 1, 1);
1193 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Kill_Notification: %s\n", checkargs)); return; }
1195 #ifdef NOTIFICATIONS_DEBUG
1197 "Kill_Notification(%d, '%s', %d, %d);\n",
1205 entity notif, net_notif;
1206 float killed_cpid = NO_CPID;
1212 killed_cpid = 0; // kill ALL centerprints
1220 entity notif = Get_Notif_Ent(net_type, net_name);
1221 if not(notif) { backtrace("Kill_Notification: Could not find notification entity!\n"); return; }
1222 killed_cpid = notif.nent_cpid;
1226 killed_cpid = 0; // kill ALL centerprints
1231 case MSG_CENTER_CPID:
1233 killed_cpid = net_name;
1238 if(killed_cpid != NO_CPID)
1240 net_notif = spawn();
1241 net_notif.classname = "net_kill_notification";
1242 net_notif.nent_broadcast = broadcast;
1243 net_notif.nent_client = client;
1244 net_notif.nent_net_type = MSG_CENTER_CPID;
1245 net_notif.nent_net_name = killed_cpid;
1246 Net_LinkEntity(net_notif, FALSE, autocvar_notification_lifetime_runtime, Net_Write_Notification);
1249 for(notif = world; (notif = find(notif, classname, "net_notification"));)
1253 if(killed_cpid != NO_CPID)
1255 if(notif.owner.nent_cpid == killed_cpid)
1257 notif.nent_net_name = -1;
1258 notif.nextthink = time;
1260 else { continue; } // we ARE looking for a specific CPID, don't kill everything else too
1262 else if(notif.nent_net_type == net_type)
1266 if(notif.nent_net_name == net_name) { notif.nent_net_name = -1; notif.nextthink = time; }
1267 else { continue; } // we ARE looking for a certain net_name, don't kill everything else too
1269 else { notif.nent_net_name = -1; notif.nextthink = time; }
1271 else { continue; } // we ARE looking for a certain net_type, don't kill everything else too
1273 else { notif.nent_net_name = -1; notif.nextthink = time; }
1277 void Send_Notification(
1278 float broadcast, entity client,
1279 float net_type, float net_name,
1282 // check supplied broadcast, target, type, and name for errors
1283 string checkargs = Notification_CheckArgs(broadcast, client, net_type, net_name);
1284 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
1286 // retreive counts for the arguments of this notification
1287 entity notif = Get_Notif_Ent(net_type, net_name);
1288 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
1290 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1294 "Not enough arguments for Send_Notification(%d, %s, %s, ...)! ",
1295 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1296 "Check the definition and function call for accuracy...?\n"
1298 broadcast, Get_Notif_TypeName(net_type), notif.nent_name,
1299 notif.nent_stringcount, notif.nent_floatcount, count
1303 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1307 "Too many arguments for Send_Notification(%d, %s, %s, ...)! ",
1308 "stringcount(%d) + floatcount(%d) < count(%d)\n",
1309 "Check the definition and function call for accuracy...?\n"
1311 broadcast, Get_Notif_TypeName(net_type), notif.nent_name,
1312 notif.nent_stringcount, notif.nent_floatcount, count
1317 #ifdef NOTIFICATIONS_DEBUG
1318 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1319 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1320 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1321 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1322 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1323 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1324 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1325 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1327 "Send_Notification(%d, %s, %s, %s, %s);\n",
1329 Get_Notif_TypeName(net_type),
1331 strreplace("\n", "\\n", sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1332 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1336 entity net_notif = spawn();
1337 net_notif.owner = notif;
1338 net_notif.classname = "net_notification";
1339 net_notif.nent_broadcast = broadcast;
1340 net_notif.nent_client = client;
1341 net_notif.nent_net_type = net_type;
1342 net_notif.nent_net_name = net_name;
1343 net_notif.nent_stringcount = notif.nent_stringcount;
1344 net_notif.nent_floatcount = notif.nent_floatcount;
1347 for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
1348 for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
1350 net_notif.think = Net_Notification_Remove;
1351 net_notif.nextthink =
1352 ((time > autocvar_notification_lifetime_mapload)
1354 (time + autocvar_notification_lifetime_runtime)
1356 autocvar_notification_lifetime_mapload
1359 Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
1361 if(server_is_dedicated && (broadcast == NOTIF_ALL || broadcast == NOTIF_ALL_EXCEPT) && (net_type != MSG_CENTER))
1363 Local_Notification_WOVA(
1365 notif.nent_stringcount,
1366 notif.nent_floatcount,
1367 IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3),
1368 IFFL(0), IFFL(1), IFFL(2), IFFL(3));
1372 // WOVA = Without Variable Arguments
1373 void Send_Notification_WOVA(
1374 float broadcast, entity client,
1375 float net_type, float net_name,
1376 string s1, string s2, string s3, string s4,
1377 float f1, float f2, float f3, float f4)
1379 entity notif = Get_Notif_Ent(net_type, net_name);
1381 #ifdef NOTIFICATIONS_DEBUG
1383 "Send_Notification_WOVA(%d, %s, %s, %s, %s - %d %d);\n",
1385 Get_Notif_TypeName(net_type),
1387 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
1388 sprintf("%d, %d, %d, %d", f1, f2, f3, f4),
1389 notif.nent_stringcount, notif.nent_floatcount
1393 #define VARITEM(stringc,floatc,args) \
1394 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
1395 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
1396 EIGHT_VARS_TO_VARARGS_VARLIST
1398 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
1402 // =============================
1403 // LEGACY NOTIFICATION SYSTEMS
1404 // =============================
1406 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
1408 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
1411 WRITESPECTATABLE_MSG_ONE({
1412 WriteByte(MSG_ONE, SVC_TEMPENTITY);
1413 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
1414 WriteByte(MSG_ONE, id);
1415 WriteString(MSG_ONE, s);
1416 if (id != 0 && s != "")
1418 WriteByte(MSG_ONE, duration);
1419 WriteByte(MSG_ONE, countdown_num);
1424 #endif // ifdef SVQC