1 // ================================================
2 // Unified notification system, written by Samual
3 // Last updated: March, 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 // used by restartnotifs command to initialize notifications
104 void Destroy_Notification_Entity(entity notif)
106 if(notif.nent_name != "") { strunzone(notif.nent_name); }
107 if(notif.nent_args != "") { strunzone(notif.nent_args); }
108 if(notif.nent_hudargs != "") { strunzone(notif.nent_hudargs); }
109 if(notif.nent_icon != "") { strunzone(notif.nent_icon); }
110 if(notif.nent_durcnt != "") { strunzone(notif.nent_durcnt); }
111 if(notif.nent_string != "") { strunzone(notif.nent_string); }
115 void Destroy_All_Notifications(void)
120 #define DESTROY_LOOP(type,count) \
121 for(i = 1; i <= count; ++i) \
123 notif = Get_Notif_Ent(type, i); \
124 if not(notif) { backtrace("Destroy_All_Notifications(): Missing notification entity!\n"); return; } \
125 Destroy_Notification_Entity(notif); \
128 // kill all networked notifications and centerprints
130 Kill_Notification(NOTIF_ALL, world, 0, 0);
132 reset_centerprint_messages();
135 // kill all real notification entities
136 DESTROY_LOOP(MSG_INFO, NOTIF_INFO_COUNT)
137 DESTROY_LOOP(MSG_CENTER, NOTIF_CENTER_COUNT)
138 DESTROY_LOOP(MSG_MULTI, NOTIF_MULTI_COUNT)
142 string Process_Notif_Line(
153 if((chat && autocvar_notification_allow_chatboxprint)
154 || (autocvar_notification_allow_chatboxprint == 2))
156 // pass 1: add ETX char at beginning of line
157 input = strcat("\{3}", input);
159 // pass 2: add ETX char at end of each new line (so that
160 // messages with multiple lines are put through chatbox too)
161 input = strreplace("\n", "\n\{3}", input);
163 // pass 3: strip trailing ETX char
164 if(substring(input, (strlen(input) - 1), 1) == "\{3}")
165 { input = substring(input, 0, (strlen(input) - 1)); }
168 if(substring(input, (strlen(input) - 1), 1) != "\n")
172 "^1MISSING/BROKEN NEW LINE AT END OF NOTIFICATION: ",
173 "^7net_type = %s, net_name = %s, string = %s.\n"
180 return strcat(input, "\n");
186 string Process_Notif_Args(
192 string selected, remaining = args;
195 for(;(remaining != "");)
197 selected = car(remaining); remaining = cdr(remaining);
201 case 1: // normal args
203 if(sel_num == NOTIF_MAX_ARGS)
207 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
208 "^7net_type = %s, net_name = %s, max args = %d.\n"
218 switch(strtolower(selected))
220 #define ARG_CASE(prog,selected,result) \
221 #if (prog != ARG_DC) \
222 case selected: { ++sel_num; break; } \
230 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
231 "^7net_type = %s, net_name = %s, args arg = '%s'.\n"
245 if(sel_num == NOTIF_MAX_HUDARGS)
249 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
250 "^7net_type = %s, net_name = %s, max hudargs = %d.\n"
260 switch(strtolower(selected))
262 #define ARG_CASE(prog,selected,result) \
263 #if (prog == ARG_CS_SV_HA) \
264 case selected: { ++sel_num; break; } \
272 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
273 "^7net_type = %s, net_name = %s, hudargs arg = '%s'.\n"
287 if(sel_num == NOTIF_MAX_DURCNT)
291 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
292 "^7net_type = %s, net_name = %s, max durcnt = %d.\n"
302 switch(strtolower(selected))
304 #define ARG_CASE(prog,selected,result) \
305 #if (prog == ARG_CS_SV_DC) || (prog == ARG_DC) \
306 case selected: { ++sel_num; break; } \
312 if(ftos(stof(selected)) != "") { ++sel_num; }
317 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
318 "^7net_type = %s, net_name = %s, durcnt arg = '%s'.\n"
336 void Create_Notification_Entity(
356 // =====================
357 // Global Entity Setup
358 // =====================
359 entity notif = spawn();
360 string typestring = "";
365 typestring = "MSG_INFO";
366 msg_info_notifs[nameid - 1] = notif;
367 notif.classname = "msg_info_notification";
372 typestring = "MSG_CENTER";
373 msg_center_notifs[nameid - 1] = notif;
374 notif.classname = "msg_center_notification";
379 typestring = "MSG_MULTI";
380 msg_multi_notifs[nameid - 1] = notif;
381 notif.classname = "MSG_MULTI_notification";
389 "^1NOTIFICATION WITH IMPROPER TYPE: ",
390 "^7net_type = %d, net_name = %s.\n"
395 return; // It's not possible to recover from this one
398 notif.nent_default = var_default;
399 notif.nent_name = strzone(namestring);
400 notif.nent_id = nameid;
401 notif.nent_enabled = (1 <= var_cvar);
403 // Other pre-notif-setup requisites
406 // ====================
407 // Notification Setup
408 // ====================
411 // Set MSG_MULTI string/float counts
412 if((infoname == NO_MSG) && (centername == NO_MSG))
416 "^1NOTIFICATION WITH NO SUBCALLS: ",
417 "^7net_type = %s, net_name = %s.\n"
426 float infoname_stringcount = 0, infoname_floatcount = 0;
427 float centername_stringcount = 0, centername_floatcount = 0;
429 if(infoname != NO_MSG)
431 notif.nent_msginfo = msg_info_notifs[infoname - 1];
432 infoname_stringcount = notif.nent_msginfo.nent_stringcount;
433 infoname_floatcount = notif.nent_msginfo.nent_floatcount;
436 if(centername != NO_MSG)
438 notif.nent_msgcenter = msg_center_notifs[centername - 1];
439 centername_stringcount = notif.nent_msgcenter.nent_stringcount;
440 centername_floatcount = notif.nent_msgcenter.nent_floatcount;
443 // set the requirements of THIS notification to the totals of its subcalls
444 notif.nent_stringcount = max(infoname_stringcount, centername_stringcount);
445 notif.nent_floatcount = max(infoname_floatcount, centername_floatcount);
450 // Set MSG_INFO and MSG_CENTER string/float counts
451 notif.nent_stringcount = strnum;
452 notif.nent_floatcount = flnum;
454 // Only initialize arguments if we're either a client or on a dedicated server
456 float should_process_args = server_is_dedicated;
458 float should_process_args = TRUE;
461 if(should_process_args)
463 // ========================
464 // Process Main Arguments
465 // ========================
470 notif.nent_args = strzone(
471 Process_Notif_Args(1, args, typestring, namestring));
473 else if((hudargs == "") && (durcnt ==""))
477 "^1NOTIFICATION HAS ARG COUNTS BUT NO ARGS OR HUDARGS OR DURCNT: ",
478 "^7net_type = %s, net_name = %s, strnum = %d, flnum = %d\n"
490 notif.nent_args = strzone(
491 Process_Notif_Args(1, args, typestring, namestring));
495 // =======================================
496 // Process HUD and Centerprint Arguments
497 // Only processed on CSQC, as these
498 // args are only for HUD features.
499 // =======================================
503 notif.nent_hudargs = strzone(
504 Process_Notif_Args(2, hudargs, typestring, namestring));
506 if(icon != "") { notif.nent_icon = strzone(icon); }
511 "^1NOTIFICATION HAS HUDARGS BUT NO ICON: ",
512 "^7net_type = %s, net_name = %s.\n"
524 "^1NOTIFICATION HAS ICON BUT NO HUDARGS: ",
525 "^7net_type = %s, net_name = %s.\n"
535 notif.nent_durcnt = strzone(
536 Process_Notif_Args(3, durcnt, typestring, namestring));
538 if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
543 "^1NOTIFICATION HAS DURCNT BUT NO CPID: ",
544 "^7net_type = %s, net_name = %s.\n"
552 else if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
556 // ======================
557 // Process Notif String
558 // ======================
559 #define SET_NOTIF_STRING(string,stringname) \
560 notif.nent_string = strzone(CCR( \
561 Process_Notif_Line( \
573 if(gentle != "") { SET_NOTIF_STRING(gentle, "GENTLE") }
574 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
576 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
578 #undef SET_NOTIF_STRING
580 // Check to make sure a string was chosen
581 if(notif.nent_string == "")
585 "^1EMPTY NOTIFICATION: ",
586 "^7net_type = %s, net_name = %s.\n"
596 // now check to see if any errors happened
599 notif.nent_enabled = FALSE; // disable the notification so it can't cause trouble
600 notif_global_error = TRUE; // throw the red flag that an error happened on init
605 // =========================================
606 // Cvar Handling With 'dumpnotifs' Command
607 // =========================================
609 void Dump_Notifications(float fh, float alsoprint)
611 #define NOTIF_WRITE(a) { \
613 if(alsoprint) { print(a); } }
614 #define NOTIF_WRITE_ENTITY(name,default,description) { \
617 "seta notification_%s \"%d\" \"%s\"\n", \
618 name, default, description \
620 NOTIF_WRITE(notif_msg) }
621 #define NOTIF_WRITE_HARDCODED(cvar,default,description) { \
624 "seta notification_%s \"%s\" \"%s\"\n", \
625 cvar, default, description \
627 NOTIF_WRITE(notif_msg) }
633 // Note: This warning only applies to the notifications.cfg file that is output...
635 // You ARE supposed to manually edit this function to add i.e. hard coded
636 // notification variables for mutators or game modes or such and then
637 // regenerate the notifications.cfg file from the new code.
639 NOTIF_WRITE("// ********************************************** //\n");
640 NOTIF_WRITE("// ** WARNING - DO NOT MANUALLY EDIT THIS FILE ** //\n");
641 NOTIF_WRITE("// ** ** //\n");
642 NOTIF_WRITE("// ** This file is automatically generated ** //\n");
643 NOTIF_WRITE("// ** by code with the command 'dumpnotifs'. ** //\n");
644 NOTIF_WRITE("// ** ** //\n");
645 NOTIF_WRITE("// ** If you add a new notification, please ** //\n");
646 NOTIF_WRITE("// ** regenerate this file with that command ** //\n");
647 NOTIF_WRITE("// ** making sure that the output matches ** //\n");
648 NOTIF_WRITE("// ** with the lists and defaults in code. ** //\n");
649 NOTIF_WRITE("// ** ** //\n");
650 NOTIF_WRITE("// ********************************************** //\n");
652 // These notifications will also append their string as a comment...
653 // This is not necessary, and does not matter if they vary between config versions,
654 // it is just a semi-helpful tool for those who want to manually change their user settings.
656 NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT));
657 for(i = 1; i <= NOTIF_INFO_COUNT; ++i)
659 e = Get_Notif_Ent(MSG_INFO, i);
660 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
661 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)");
664 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
665 for(i = 1; i <= NOTIF_CENTER_COUNT; ++i)
667 e = Get_Notif_Ent(MSG_CENTER, i);
668 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
669 NOTIF_WRITE_ENTITY(e.nent_name, e.nent_default, "Notification control cvar: 0 = off, 1 = centerprint");
672 NOTIF_WRITE(sprintf("\n// MSG_MULTI notifications (count = %d):\n", NOTIF_MULTI_COUNT));
673 for(i = 1; i <= NOTIF_MULTI_COUNT; ++i)
675 e = Get_Notif_Ent(MSG_MULTI, i);
676 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
677 NOTIF_WRITE_ENTITY(e.nent_name, e.nent_default, "Notification control cvar: 0 = off, 1 = trigger subcalls");
680 // edit these to match whichever cvars are used for specific notification options
681 NOTIF_WRITE("\n// HARD CODED notification variables:\n");
682 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)");
683 NOTIF_WRITE_HARDCODED("ctf_capture_verbose", "0", "Show extra information when someone captures a flag");
684 NOTIF_WRITE_HARDCODED("ctf_pickup_enemy_verbose", "0", "Show extra information if an enemy picks up a flag");
685 NOTIF_WRITE_HARDCODED("ctf_pickup_team_verbose", "0", "Show extra information if a team mate picks up a flag");
686 NOTIF_WRITE_HARDCODED("errors_are_fatal", "1", "If a notification fails upon initialization, cause a Host_Error to stop the program");
687 NOTIF_WRITE_HARDCODED("frag_verbose", "1", "Show extra information when you frag someone (or when you are fragged");
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("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)");
690 NOTIF_WRITE_HARDCODED("lifetime_runtime", "0.5", "Amount of time that notification entities last on the server during runtime (In seconds)");
691 NOTIF_WRITE_HARDCODED("server_allows_frag_verbose", "1", "Server side cvar for showing extra information in frag messages... 0 = no extra frag information, 1 = frag information only in warmup, 2 = frag information allowed all the time");
692 NOTIF_WRITE_HARDCODED("server_allows_location", "1", "Server side cvar for allowing death messages to show location information too");
693 NOTIF_WRITE_HARDCODED("show_location", "0", "Append location information to MSG_INFO death/kill messages");
694 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)'");
695 NOTIF_WRITE_HARDCODED("show_sprees", "1", "Print information about sprees in death/kill messages");
696 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");
697 NOTIF_WRITE_HARDCODED("show_sprees_center_specialonly", "1", "Don't show spree information in MSG_CENTER messages if it isn't an achievement");
698 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");
699 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");
700 NOTIF_WRITE_HARDCODED("show_sprees_info_specialonly", "1", "Don't show attacker spree information in MSG_INFO messages if it isn't an achievement");
704 "\n// Notification counts (total = %d): ",
705 "MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d\n"
718 #undef NOTIF_WRITE_HARDCODED
719 #undef NOTIF_WRITE_ENTITY
724 void Notification_GetCvars()
726 GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
731 // ===============================
732 // Frontend Notification Pushing
733 // ===============================
735 string Local_Notification_sprintf(
736 string input, string args,
737 string s1, string s2, string s3, string s4,
738 float f1, float f2, float f3, float f4)
740 #ifdef NOTIFICATIONS_DEBUG
742 "Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
743 MakeConsoleSafe(input),
745 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
746 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
752 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
756 for(sel_num = 0;(args != "");)
758 selected = car(args); args = cdr(args);
759 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
760 switch(strtolower(selected))
762 #define ARG_CASE(prog,selected,result) \
764 #if (prog != ARG_SV) && (prog != ARG_DC) \
765 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
768 #if (prog != ARG_CS) && (prog != ARG_DC) \
769 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
774 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
777 return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
781 void Local_Notification_HUD_Notify_Push(
782 string icon, string hudargs,
783 string s1, string s2, string s3, string s4)
787 arg_slot[0] = ""; arg_slot[1] = "";
789 for(sel_num = 0;(hudargs != "");)
791 selected = car(hudargs); hudargs = cdr(hudargs);
792 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
793 switch(strtolower(selected))
795 #define ARG_CASE(prog,selected,result) \
796 #if (prog == ARG_CS_SV_HA) \
797 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
801 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
804 #ifdef NOTIFICATIONS_DEBUG
806 "Local_Notification_HUD_Notify_Push('%s^7', '%s', %s, %s);\n",
809 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
810 MakeConsoleSafe(sprintf("'%s^7', '%s^7'", stof(arg_slot[0]), stof(arg_slot[1])))
813 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
816 void Local_Notification_centerprint_generic(
817 string input, string durcnt,
818 float cpid, float f1, float f2)
822 arg_slot[0] = ""; arg_slot[1] = "";
824 for(sel_num = 0;(durcnt != "");)
826 selected = car(durcnt); durcnt = cdr(durcnt);
827 NOTIF_HIT_MAX(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic")
828 switch(strtolower(selected))
830 #define ARG_CASE(prog,selected,result) \
831 #if (prog == ARG_CS_SV_DC) || (prog == ARG_DC) \
832 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
838 if(ftos(stof(selected)) != "") { arg_slot[sel_num] = selected; ++sel_num; }
839 else { NOTIF_HIT_UNKNOWN(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic") }
844 #ifdef NOTIFICATIONS_DEBUG
846 "Local_Notification_centerprint_generic('%s^7', '%s', %d, %d, %d, %d);\n",
847 MakeConsoleSafe(input),
850 stof(arg_slot[0]), stof(arg_slot[1])
853 centerprint_generic(cpid, input, stof(arg_slot[0]), stof(arg_slot[1]));
857 void Local_Notification(float net_type, float net_name, ...count)
859 // check supplied type and name for errors
860 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
861 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
863 entity notif = Get_Notif_Ent(net_type, net_name);
864 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
865 if not(notif.nent_enabled)
867 #ifdef NOTIFICATIONS_DEBUG
869 "Local_Notification(%s, %s): Entity was disabled...\n",
870 Get_Notif_TypeName(net_type),
877 if((notif.nent_stringcount + notif.nent_floatcount) > count)
881 "Not enough arguments for Local_Notification(%s, %s, ...)! ",
882 "stringcount(%d) + floatcount(%d) > count(%d)\n",
883 "Check the definition and function call for accuracy...?\n"
885 Get_Notif_TypeName(net_type), notif.nent_name,
886 notif.nent_stringcount, notif.nent_floatcount, count
890 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
894 "Too many arguments for Local_Notification(%s, %s, ...)! ",
895 "stringcount(%d) + floatcount(%d) < count(%d)\n",
896 "Check the definition and function call for accuracy...?\n"
898 Get_Notif_TypeName(net_type), notif.nent_name,
899 notif.nent_stringcount, notif.nent_floatcount, count
904 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
905 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
906 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
907 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
908 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
909 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
910 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
911 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
913 #ifdef NOTIFICATIONS_DEBUG
915 "Local_Notification(%s, %s, %s, %s);\n",
916 Get_Notif_TypeName(net_type),
918 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
919 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
928 Local_Notification_sprintf(
935 if(notif.nent_icon != "")
937 Local_Notification_HUD_Notify_Push(
949 Local_Notification_centerprint_generic(
950 Local_Notification_sprintf(
964 if(notif.nent_msginfo)
965 if(notif.nent_msginfo.nent_enabled)
967 Local_Notification_WOVA(
969 notif.nent_msginfo.nent_id,
970 notif.nent_msginfo.nent_stringcount,
971 notif.nent_msginfo.nent_floatcount,
976 if(notif.nent_msgcenter)
977 if(notif.nent_msgcenter.nent_enabled)
979 Local_Notification_WOVA(
981 notif.nent_msgcenter.nent_id,
982 notif.nent_msgcenter.nent_stringcount,
983 notif.nent_msgcenter.nent_floatcount,
993 // WOVA = Without Variable Arguments
994 void Local_Notification_WOVA(
995 float net_type, float net_name,
996 float stringcount, float floatcount,
997 string s1, string s2, string s3, string s4,
998 float f1, float f2, float f3, float f4)
1000 #define VARITEM(stringc,floatc,args) \
1001 if((stringcount == stringc) && (floatcount == floatc)) \
1002 { Local_Notification(net_type, net_name, args); return; }
1003 EIGHT_VARS_TO_VARARGS_VARLIST
1005 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
1009 // =========================
1010 // Notification Networking
1011 // =========================
1014 void Read_Notification(float is_new)
1016 float net_type = ReadByte();
1017 float net_name = ReadShort();
1021 if(net_type == MSG_CENTER_CPID)
1023 #ifdef NOTIFICATIONS_DEBUG
1025 "Read_Notification(%d) at %f: net_type = %s, net_name = %d\n",
1028 Get_Notif_TypeName(net_type),
1035 if(net_name == 0) { reset_centerprint_messages(); }
1036 else if(net_name != NO_CPID)
1038 // in this case, net_name IS the cpid we want to kill
1039 centerprint_generic(net_name, "", 0, 0);
1044 "Read_Notification(%d) at %f: ^1TRIED TO KILL NO_CPID CENTERPRINT!\n",
1053 notif = Get_Notif_Ent(net_type, net_name);
1054 if not(notif) { backtrace("Read_Notification: Could not find notification entity!\n"); return; }
1056 #ifdef NOTIFICATIONS_DEBUG
1058 "Read_Notification(%d) at %f: net_type = %s, net_name = %s\n",
1061 Get_Notif_TypeName(net_type),
1066 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
1067 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
1068 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
1069 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
1070 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
1071 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
1072 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
1073 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
1077 Local_Notification_WOVA(
1079 notif.nent_stringcount,
1080 notif.nent_floatcount,
1089 void Net_Notification_Remove()
1091 if not(self) { backtrace(sprintf("Net_Notification_Remove() at %f: Missing self!?\n", time)); return; }
1093 #ifdef NOTIFICATIONS_DEBUG
1095 "Net_Notification_Remove() at %f: %s '%s - %s' notification\n",
1097 ((self.nent_net_name == -1) ? "Killed" : "Removed"),
1098 Get_Notif_TypeName(self.nent_net_type),
1099 self.owner.nent_name
1104 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
1108 float Net_Write_Notification(entity client, float sf)
1110 float i, send = FALSE;
1112 switch(self.nent_broadcast)
1114 case NOTIF_ONE: // send to one client and their spectator
1117 (client == self.nent_client)
1122 (client.enemy == self.nent_client)
1127 case NOTIF_ONE_ONLY: // send ONLY to one client
1129 if(client == self.nent_client) { send = TRUE; }
1132 case NOTIF_TEAM: // send only to X team and their spectators
1135 (client.team == self.nent_client.team)
1140 (client.enemy.team == self.nent_client.team)
1145 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
1148 (client != self.nent_client)
1151 (client.team == self.nent_client.team)
1157 (client.enemy != self.nent_client)
1159 (client.enemy.team == self.nent_client.team)
1166 case NOTIF_ALL: // send to everyone
1171 case NOTIF_ALL_EXCEPT: // send to everyone except X person and their spectators
1174 (client != self.nent_client)
1179 (client.enemy == self.nent_client)
1184 default: { send = FALSE; break; }
1189 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
1190 WriteByte(MSG_ENTITY, self.nent_net_type);
1191 WriteShort(MSG_ENTITY, self.nent_net_name);
1192 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
1193 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
1199 void Kill_Notification(
1200 float broadcast, entity client,
1201 float net_type, float net_name)
1203 string checkargs = Notification_CheckArgs(broadcast, client, 1, 1);
1204 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Kill_Notification: %s\n", checkargs)); return; }
1206 #ifdef NOTIFICATIONS_DEBUG
1208 "Kill_Notification(%d, '%s', %s, %d);\n",
1211 Get_Notif_TypeName(net_type),
1216 entity notif, net_notif;
1217 float killed_cpid = NO_CPID;
1223 killed_cpid = 0; // kill ALL centerprints
1231 entity notif = Get_Notif_Ent(net_type, net_name);
1232 if not(notif) { backtrace("Kill_Notification: Could not find notification entity!\n"); return; }
1235 killed_cpid = notif.nent_cpid;
1237 killed_cpid = NO_CPID;
1241 killed_cpid = 0; // kill ALL centerprints
1246 case MSG_CENTER_CPID:
1248 killed_cpid = net_name;
1253 if(killed_cpid != NO_CPID)
1255 net_notif = spawn();
1256 net_notif.classname = "net_kill_notification";
1257 net_notif.nent_broadcast = broadcast;
1258 net_notif.nent_client = client;
1259 net_notif.nent_net_type = MSG_CENTER_CPID;
1260 net_notif.nent_net_name = killed_cpid;
1261 Net_LinkEntity(net_notif, FALSE, autocvar_notification_lifetime_runtime, Net_Write_Notification);
1264 for(notif = world; (notif = find(notif, classname, "net_notification"));)
1268 if(killed_cpid != NO_CPID)
1270 if(notif.owner.nent_cpid == killed_cpid)
1272 notif.nent_net_name = -1;
1273 notif.nextthink = time;
1275 else { continue; } // we ARE looking for a specific CPID, don't kill everything else too
1277 else if(notif.nent_net_type == net_type)
1281 if(notif.nent_net_name == net_name) { notif.nent_net_name = -1; notif.nextthink = time; }
1282 else { continue; } // we ARE looking for a certain net_name, don't kill everything else too
1284 else { notif.nent_net_name = -1; notif.nextthink = time; }
1286 else { continue; } // we ARE looking for a certain net_type, don't kill everything else too
1288 else { notif.nent_net_name = -1; notif.nextthink = time; }
1292 void Send_Notification(
1293 float broadcast, entity client,
1294 float net_type, float net_name,
1297 // check supplied broadcast, target, type, and name for errors
1298 string checkargs = Notification_CheckArgs(broadcast, client, net_type, net_name);
1299 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
1301 // retreive counts for the arguments of this notification
1302 entity notif = Get_Notif_Ent(net_type, net_name);
1303 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
1305 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1309 "Not enough arguments for Send_Notification(%d, %s, %s, ...)! ",
1310 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1311 "Check the definition and function call for accuracy...?\n"
1313 broadcast, Get_Notif_TypeName(net_type), notif.nent_name,
1314 notif.nent_stringcount, notif.nent_floatcount, count
1318 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1322 "Too many arguments for Send_Notification(%d, %s, %s, ...)! ",
1323 "stringcount(%d) + floatcount(%d) < count(%d)\n",
1324 "Check the definition and function call for accuracy...?\n"
1326 broadcast, Get_Notif_TypeName(net_type), notif.nent_name,
1327 notif.nent_stringcount, notif.nent_floatcount, count
1332 #ifdef NOTIFICATIONS_DEBUG
1333 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1334 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1335 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1336 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1337 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1338 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1339 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1340 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1342 "Send_Notification(%d, %s, %s, %s, %s);\n",
1344 Get_Notif_TypeName(net_type),
1346 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1347 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1351 entity net_notif = spawn();
1352 net_notif.owner = notif;
1353 net_notif.classname = "net_notification";
1354 net_notif.nent_broadcast = broadcast;
1355 net_notif.nent_client = client;
1356 net_notif.nent_net_type = net_type;
1357 net_notif.nent_net_name = net_name;
1358 net_notif.nent_stringcount = notif.nent_stringcount;
1359 net_notif.nent_floatcount = notif.nent_floatcount;
1362 for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
1363 for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
1365 net_notif.think = Net_Notification_Remove;
1366 net_notif.nextthink =
1367 ((time > autocvar_notification_lifetime_mapload)
1369 (time + autocvar_notification_lifetime_runtime)
1371 autocvar_notification_lifetime_mapload
1374 Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
1376 if(server_is_dedicated && (broadcast == NOTIF_ALL || broadcast == NOTIF_ALL_EXCEPT) && (net_type != MSG_CENTER))
1378 Local_Notification_WOVA(
1380 notif.nent_stringcount,
1381 notif.nent_floatcount,
1382 IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3),
1383 IFFL(0), IFFL(1), IFFL(2), IFFL(3));
1387 // WOVA = Without Variable Arguments
1388 void Send_Notification_WOVA(
1389 float broadcast, entity client,
1390 float net_type, float net_name,
1391 string s1, string s2, string s3, string s4,
1392 float f1, float f2, float f3, float f4)
1394 entity notif = Get_Notif_Ent(net_type, net_name);
1396 #ifdef NOTIFICATIONS_DEBUG
1398 "Send_Notification_WOVA(%d, %s, %s, %s, %s);\n",
1400 Get_Notif_TypeName(net_type),
1402 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1403 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1407 #define VARITEM(stringc,floatc,args) \
1408 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
1409 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
1410 EIGHT_VARS_TO_VARARGS_VARLIST
1412 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
1414 #endif // ifdef SVQC