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
130 Kill_Notification(NOTIF_ALL, world, 0, 0);
133 // kill all real notification entities
134 DESTROY_LOOP(MSG_INFO, NOTIF_INFO_COUNT)
135 DESTROY_LOOP(MSG_CENTER, NOTIF_CENTER_COUNT)
136 DESTROY_LOOP(MSG_MULTI, NOTIF_MULTI_COUNT)
140 string Process_Notif_Line(
151 if((chat && autocvar_notification_allow_chatboxprint)
152 || (autocvar_notification_allow_chatboxprint == 2))
154 // pass 1: add ETX char at beginning of line
155 input = strcat("\{3}", input);
157 // pass 2: add ETX char at end of each new line (so that
158 // messages with multiple lines are put through chatbox too)
159 input = strreplace("\n", "\n\{3}", input);
161 // pass 3: strip trailing ETX char
162 if(substring(input, (strlen(input) - 1), 1) == "\{3}")
163 { input = substring(input, 0, (strlen(input) - 1)); }
166 if(substring(input, (strlen(input) - 1), 1) != "\n")
170 "^1MISSING/BROKEN NEW LINE AT END OF NOTIFICATION: ",
171 "^7net_type = %s, net_name = %s, string = %s.\n"
178 return strcat(input, "\n");
184 string Process_Notif_Args(
190 string selected, remaining = args;
193 for(;(remaining != "");)
195 selected = car(remaining); remaining = cdr(remaining);
199 case 1: // normal args
201 if(sel_num == NOTIF_MAX_ARGS)
205 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
206 "^7net_type = %s, net_name = %s, max args = %d.\n"
216 switch(strtolower(selected))
218 #define ARG_CASE(prog,selected,result) \
219 #if (prog != ARG_DC) \
220 case selected: { ++sel_num; break; } \
228 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
229 "^7net_type = %s, net_name = %s, args arg = '%s'.\n"
243 if(sel_num == NOTIF_MAX_HUDARGS)
247 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
248 "^7net_type = %s, net_name = %s, max hudargs = %d.\n"
258 switch(strtolower(selected))
260 #define ARG_CASE(prog,selected,result) \
261 #if (prog == ARG_CS_SV_HA) \
262 case selected: { ++sel_num; break; } \
270 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
271 "^7net_type = %s, net_name = %s, hudargs arg = '%s'.\n"
285 if(sel_num == NOTIF_MAX_DURCNT)
289 "^1NOTIFICATION HAS TOO MANY ARGUMENTS: ",
290 "^7net_type = %s, net_name = %s, max durcnt = %d.\n"
300 switch(strtolower(selected))
302 #define ARG_CASE(prog,selected,result) \
303 #if (prog == ARG_CS_SV_DC) || (prog == ARG_DC) \
304 case selected: { ++sel_num; break; } \
310 if(ftos(stof(selected)) != "") { ++sel_num; }
315 "^1NOTIFICATION WITH UNKNOWN TOKEN IN ARGUMENT STRING: ",
316 "^7net_type = %s, net_name = %s, durcnt arg = '%s'.\n"
334 void Create_Notification_Entity(
354 // =====================
355 // Global Entity Setup
356 // =====================
357 entity notif = spawn();
358 string typestring = "";
363 typestring = "MSG_INFO";
364 msg_info_notifs[nameid - 1] = notif;
365 notif.classname = "msg_info_notification";
370 typestring = "MSG_CENTER";
371 msg_center_notifs[nameid - 1] = notif;
372 notif.classname = "msg_center_notification";
377 typestring = "MSG_MULTI";
378 msg_multi_notifs[nameid - 1] = notif;
379 notif.classname = "MSG_MULTI_notification";
387 "^1NOTIFICATION WITH IMPROPER TYPE: ",
388 "^7net_type = %d, net_name = %s.\n"
393 return; // It's not possible to recover from this one
396 notif.nent_default = var_default;
397 notif.nent_name = strzone(namestring);
398 notif.nent_id = nameid;
399 notif.nent_enabled = (1 <= var_cvar);
401 // Other pre-notif-setup requisites
404 // ====================
405 // Notification Setup
406 // ====================
409 // Set MSG_MULTI string/float counts
410 if((infoname == NO_MSG) && (centername == NO_MSG))
414 "^1NOTIFICATION WITH NO SUBCALLS: ",
415 "^7net_type = %s, net_name = %s.\n"
424 float infoname_stringcount = 0, infoname_floatcount = 0;
425 float centername_stringcount = 0, centername_floatcount = 0;
427 if(infoname != NO_MSG)
429 notif.nent_msginfo = msg_info_notifs[infoname - 1];
430 infoname_stringcount = notif.nent_msginfo.nent_stringcount;
431 infoname_floatcount = notif.nent_msginfo.nent_floatcount;
434 if(centername != NO_MSG)
436 notif.nent_msgcenter = msg_center_notifs[centername - 1];
437 centername_stringcount = notif.nent_msgcenter.nent_stringcount;
438 centername_floatcount = notif.nent_msgcenter.nent_floatcount;
441 // set the requirements of THIS notification to the totals of its subcalls
442 notif.nent_stringcount = max(infoname_stringcount, centername_stringcount);
443 notif.nent_floatcount = max(infoname_floatcount, centername_floatcount);
448 // Set MSG_INFO and MSG_CENTER string/float counts
449 notif.nent_stringcount = strnum;
450 notif.nent_floatcount = flnum;
452 // Only initialize arguments if we're either a client or on a dedicated server
454 float should_process_args = server_is_dedicated;
456 float should_process_args = TRUE;
459 if(should_process_args)
461 // ========================
462 // Process Main Arguments
463 // ========================
468 notif.nent_args = strzone(
469 Process_Notif_Args(1, args, typestring, namestring));
471 else if((hudargs == "") && (durcnt ==""))
475 "^1NOTIFICATION HAS ARG COUNTS BUT NO ARGS OR HUDARGS OR DURCNT: ",
476 "^7net_type = %s, net_name = %s, strnum = %d, flnum = %d\n"
488 notif.nent_args = strzone(
489 Process_Notif_Args(1, args, typestring, namestring));
493 // =======================================
494 // Process HUD and Centerprint Arguments
495 // Only processed on CSQC, as these
496 // args are only for HUD features.
497 // =======================================
501 notif.nent_hudargs = strzone(
502 Process_Notif_Args(2, hudargs, typestring, namestring));
504 if(icon != "") { notif.nent_icon = strzone(icon); }
509 "^1NOTIFICATION HAS HUDARGS BUT NO ICON: ",
510 "^7net_type = %s, net_name = %s.\n"
522 "^1NOTIFICATION HAS ICON BUT NO HUDARGS: ",
523 "^7net_type = %s, net_name = %s.\n"
533 notif.nent_durcnt = strzone(
534 Process_Notif_Args(3, durcnt, typestring, namestring));
536 if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
541 "^1NOTIFICATION HAS DURCNT BUT NO CPID: ",
542 "^7net_type = %s, net_name = %s.\n"
550 else if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
554 // ======================
555 // Process Notif String
556 // ======================
557 #define SET_NOTIF_STRING(string,stringname) \
558 notif.nent_string = strzone(CCR( \
559 Process_Notif_Line( \
571 if(gentle != "") { SET_NOTIF_STRING(gentle, "GENTLE") }
572 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
574 else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
576 #undef SET_NOTIF_STRING
578 // Check to make sure a string was chosen
579 if(notif.nent_string == "")
583 "^1EMPTY NOTIFICATION: ",
584 "^7net_type = %s, net_name = %s.\n"
594 // now check to see if any errors happened
597 notif.nent_enabled = FALSE; // disable the notification so it can't cause trouble
598 notif_global_error = TRUE; // throw the red flag that an error happened on init
603 // =========================================
604 // Cvar Handling With 'dumpnotifs' Command
605 // =========================================
607 void Dump_Notifications(float fh, float alsoprint)
609 #define NOTIF_WRITE(a) { \
611 if(alsoprint) { print(a); } }
612 #define NOTIF_WRITE_ENTITY(name,default,description) { \
615 "seta notification_%s \"%d\" \"%s\"\n", \
616 name, default, description \
618 NOTIF_WRITE(notif_msg) }
619 #define NOTIF_WRITE_HARDCODED(cvar,default,description) { \
622 "seta notification_%s \"%s\" \"%s\"\n", \
623 cvar, default, description \
625 NOTIF_WRITE(notif_msg) }
631 // Note: This warning only applies to the notifications.cfg file that is output...
633 // You ARE supposed to manually edit this function to add i.e. hard coded
634 // notification variables for mutators or game modes or such and then
635 // regenerate the notifications.cfg file from the new code.
637 NOTIF_WRITE("// ********************************************** //\n");
638 NOTIF_WRITE("// ** WARNING - DO NOT MANUALLY EDIT THIS FILE ** //\n");
639 NOTIF_WRITE("// ** ** //\n");
640 NOTIF_WRITE("// ** This file is automatically generated ** //\n");
641 NOTIF_WRITE("// ** by code with the command 'dumpnotifs'. ** //\n");
642 NOTIF_WRITE("// ** ** //\n");
643 NOTIF_WRITE("// ** If you add a new notification, please ** //\n");
644 NOTIF_WRITE("// ** regenerate this file with that command ** //\n");
645 NOTIF_WRITE("// ** making sure that the output matches ** //\n");
646 NOTIF_WRITE("// ** with the lists and defaults in code. ** //\n");
647 NOTIF_WRITE("// ** ** //\n");
648 NOTIF_WRITE("// ********************************************** //\n");
650 // These notifications will also append their string as a comment...
651 // This is not necessary, and does not matter if they vary between config versions,
652 // it is just a semi-helpful tool for those who want to manually change their user settings.
654 NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT));
655 for(i = 1; i <= NOTIF_INFO_COUNT; ++i)
657 e = Get_Notif_Ent(MSG_INFO, i);
658 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
659 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)");
662 NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
663 for(i = 1; i <= NOTIF_CENTER_COUNT; ++i)
665 e = Get_Notif_Ent(MSG_CENTER, i);
666 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
667 NOTIF_WRITE_ENTITY(e.nent_name, e.nent_default, "Notification control cvar: 0 = off, 1 = centerprint");
670 NOTIF_WRITE(sprintf("\n// MSG_MULTI notifications (count = %d):\n", NOTIF_MULTI_COUNT));
671 for(i = 1; i <= NOTIF_MULTI_COUNT; ++i)
673 e = Get_Notif_Ent(MSG_MULTI, i);
674 if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
675 NOTIF_WRITE_ENTITY(e.nent_name, e.nent_default, "Notification control cvar: 0 = off, 1 = trigger subcalls");
678 // edit these to match whichever cvars are used for specific notification options
679 NOTIF_WRITE("\n// HARD CODED notification variables:\n");
680 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)");
681 NOTIF_WRITE_HARDCODED("ctf_capture_verbose", "0", "Show extra information when someone captures a flag");
682 NOTIF_WRITE_HARDCODED("ctf_pickup_enemy_verbose", "0", "Show extra information if an enemy picks up a flag");
683 NOTIF_WRITE_HARDCODED("ctf_pickup_team_verbose", "0", "Show extra information if a team mate picks up a flag");
684 NOTIF_WRITE_HARDCODED("errors_are_fatal", "1", "If a notification fails upon initialization, cause a Host_Error to stop the program");
685 NOTIF_WRITE_HARDCODED("frag_verbose", "1", "Show extra information when you frag someone (or when you are fragged");
686 NOTIF_WRITE_HARDCODED("item_centerprinttime", "1.5", "How long to show item information centerprint messages (like 'You got the Electro' or such)");
687 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)");
688 NOTIF_WRITE_HARDCODED("lifetime_runtime", "0.5", "Amount of time that notification entities last on the server during runtime (In seconds)");
689 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");
690 NOTIF_WRITE_HARDCODED("server_allows_location", "1", "Server side cvar for allowing death messages to show location information too");
691 NOTIF_WRITE_HARDCODED("show_location", "0", "Append location information to MSG_INFO death/kill messages");
692 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)'");
693 NOTIF_WRITE_HARDCODED("show_sprees", "1", "Print information about sprees in death/kill messages");
694 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");
695 NOTIF_WRITE_HARDCODED("show_sprees_center_specialonly", "1", "Don't show spree information in MSG_CENTER messages if it isn't an achievement");
696 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");
697 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");
698 NOTIF_WRITE_HARDCODED("show_sprees_info_specialonly", "1", "Don't show attacker spree information in MSG_INFO messages if it isn't an achievement");
702 "\n// Notification counts (total = %d): ",
703 "MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d\n"
716 #undef NOTIF_WRITE_HARDCODED
717 #undef NOTIF_WRITE_ENTITY
722 void Notification_GetCvars()
724 GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
729 // ===============================
730 // Frontend Notification Pushing
731 // ===============================
733 string Local_Notification_sprintf(
734 string input, string args,
735 string s1, string s2, string s3, string s4,
736 float f1, float f2, float f3, float f4)
738 #ifdef NOTIFICATIONS_DEBUG
740 "Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
741 MakeConsoleSafe(input),
743 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
744 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
750 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
754 for(sel_num = 0;(args != "");)
756 selected = car(args); args = cdr(args);
757 NOTIF_HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
758 switch(strtolower(selected))
760 #define ARG_CASE(prog,selected,result) \
762 #if (prog != ARG_SV) && (prog != ARG_DC) \
763 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
766 #if (prog != ARG_CS) && (prog != ARG_DC) \
767 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
772 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
775 return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
779 void Local_Notification_HUD_Notify_Push(
780 string icon, string hudargs,
781 string s1, string s2, string s3, string s4)
785 arg_slot[0] = ""; arg_slot[1] = "";
787 for(sel_num = 0;(hudargs != "");)
789 selected = car(hudargs); hudargs = cdr(hudargs);
790 NOTIF_HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
791 switch(strtolower(selected))
793 #define ARG_CASE(prog,selected,result) \
794 #if (prog == ARG_CS_SV_HA) \
795 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
799 default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
802 #ifdef NOTIFICATIONS_DEBUG
804 "Local_Notification_HUD_Notify_Push('%s^7', '%s', %s, %s);\n",
807 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
808 MakeConsoleSafe(sprintf("'%s^7', '%s^7'", stof(arg_slot[0]), stof(arg_slot[1])))
811 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
814 void Local_Notification_centerprint_generic(
815 string input, string durcnt,
816 float cpid, float f1, float f2)
820 arg_slot[0] = ""; arg_slot[1] = "";
822 for(sel_num = 0;(durcnt != "");)
824 selected = car(durcnt); durcnt = cdr(durcnt);
825 NOTIF_HIT_MAX(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic")
826 switch(strtolower(selected))
828 #define ARG_CASE(prog,selected,result) \
829 #if (prog == ARG_CS_SV_DC) || (prog == ARG_DC) \
830 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
836 if(ftos(stof(selected)) != "") { arg_slot[sel_num] = selected; ++sel_num; }
837 else { NOTIF_HIT_UNKNOWN(NOTIF_MAX_DURCNT, "Local_Notification_centerprint_generic") }
842 #ifdef NOTIFICATIONS_DEBUG
844 "Local_Notification_centerprint_generic('%s^7', '%s', %d, %d, %d, %d);\n",
845 MakeConsoleSafe(input),
848 stof(arg_slot[0]), stof(arg_slot[1])
851 centerprint_generic(cpid, input, stof(arg_slot[0]), stof(arg_slot[1]));
855 void Local_Notification(float net_type, float net_name, ...count)
857 // check supplied type and name for errors
858 string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
859 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
861 entity notif = Get_Notif_Ent(net_type, net_name);
862 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
864 #ifdef NOTIFICATIONS_DEBUG
865 if not(notif.nent_enabled)
868 "Local_Notification(%s, %s): Entity was disabled...\n",
869 Get_Notif_TypeName(net_type),
876 if((notif.nent_stringcount + notif.nent_floatcount) > count)
880 "Not enough arguments for Local_Notification(%s, %s, ...)! ",
881 "stringcount(%d) + floatcount(%d) > count(%d)\n",
882 "Check the definition and function call for accuracy...?\n"
884 Get_Notif_TypeName(net_type), notif.nent_name,
885 notif.nent_stringcount, notif.nent_floatcount, count
889 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
893 "Too many arguments for Local_Notification(%s, %s, ...)! ",
894 "stringcount(%d) + floatcount(%d) < count(%d)\n",
895 "Check the definition and function call for accuracy...?\n"
897 Get_Notif_TypeName(net_type), notif.nent_name,
898 notif.nent_stringcount, notif.nent_floatcount, count
903 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
904 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
905 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
906 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
907 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
908 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
909 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
910 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
912 #ifdef NOTIFICATIONS_DEBUG
914 "Local_Notification(%s, %s, %s, %s);\n",
915 Get_Notif_TypeName(net_type),
917 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
918 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
927 Local_Notification_sprintf(
934 if(notif.nent_icon != "")
936 Local_Notification_HUD_Notify_Push(
948 Local_Notification_centerprint_generic(
949 Local_Notification_sprintf(
963 if(notif.nent_msginfo)
964 if(notif.nent_msginfo.nent_enabled)
966 Local_Notification_WOVA(
968 notif.nent_msginfo.nent_id,
969 notif.nent_msginfo.nent_stringcount,
970 notif.nent_msginfo.nent_floatcount,
975 if(notif.nent_msgcenter)
976 if(notif.nent_msgcenter.nent_enabled)
978 Local_Notification_WOVA(
980 notif.nent_msgcenter.nent_id,
981 notif.nent_msgcenter.nent_stringcount,
982 notif.nent_msgcenter.nent_floatcount,
992 // WOVA = Without Variable Arguments
993 void Local_Notification_WOVA(
994 float net_type, float net_name,
995 float stringcount, float floatcount,
996 string s1, string s2, string s3, string s4,
997 float f1, float f2, float f3, float f4)
999 #define VARITEM(stringc,floatc,args) \
1000 if((stringcount == stringc) && (floatcount == floatc)) \
1001 { Local_Notification(net_type, net_name, args); return; }
1002 EIGHT_VARS_TO_VARARGS_VARLIST
1004 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
1008 // =========================
1009 // Notification Networking
1010 // =========================
1013 void Read_Notification(float is_new)
1015 float net_type = ReadByte();
1016 float net_name = ReadShort();
1020 if(net_type == MSG_CENTER_CPID)
1022 #ifdef NOTIFICATIONS_DEBUG
1024 "Read_Notification(%d) at %f: net_type = %s, net_name = %d\n",
1027 Get_Notif_TypeName(net_type),
1034 if(net_name == 0) { reset_centerprint_messages(); }
1035 else if(net_name != NO_CPID)
1037 // in this case, net_name IS the cpid we want to kill
1038 centerprint_generic(net_name, "", 0, 0);
1043 "Read_Notification(%d) at %f: ^1TRIED TO KILL NO_CPID CENTERPRINT!\n",
1052 notif = Get_Notif_Ent(net_type, net_name);
1053 if not(notif) { backtrace("Read_Notification: Could not find notification entity!\n"); return; }
1055 #ifdef NOTIFICATIONS_DEBUG
1057 "Read_Notification(%d) at %f: net_type = %s, net_name = %s\n",
1060 Get_Notif_TypeName(net_type),
1065 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
1066 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
1067 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
1068 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
1069 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
1070 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
1071 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
1072 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
1076 Local_Notification_WOVA(
1078 notif.nent_stringcount,
1079 notif.nent_floatcount,
1088 void Net_Notification_Remove()
1090 if not(self) { backtrace(sprintf("Net_Notification_Remove() at %f: Missing self!?\n", time)); return; }
1092 #ifdef NOTIFICATIONS_DEBUG
1094 "Net_Notification_Remove() at %f: %s '%s - %s' notification\n",
1096 ((self.nent_net_name == -1) ? "Killed" : "Removed"),
1097 Get_Notif_TypeName(self.nent_net_type),
1098 self.owner.nent_name
1103 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
1107 float Net_Write_Notification(entity client, float sf)
1109 float i, send = FALSE;
1111 switch(self.nent_broadcast)
1113 case NOTIF_ONE: // send to one client and their spectator
1116 (client == self.nent_client)
1121 (client.enemy == self.nent_client)
1126 case NOTIF_ONE_ONLY: // send ONLY to one client
1128 if(client == self.nent_client) { send = TRUE; }
1131 case NOTIF_TEAM: // send only to X team and their spectators
1134 (client.team == self.nent_client.team)
1139 (client.enemy.team == self.nent_client.team)
1144 case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
1147 (client != self.nent_client)
1150 (client.team == self.nent_client.team)
1156 (client.enemy != self.nent_client)
1158 (client.enemy.team == self.nent_client.team)
1165 case NOTIF_ALL: // send to everyone
1170 case NOTIF_ALL_EXCEPT: // send to everyone except X person and their spectators
1173 (client != self.nent_client)
1178 (client.enemy == self.nent_client)
1183 default: { send = FALSE; break; }
1188 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
1189 WriteByte(MSG_ENTITY, self.nent_net_type);
1190 WriteShort(MSG_ENTITY, self.nent_net_name);
1191 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
1192 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
1198 void Kill_Notification(
1199 float broadcast, entity client,
1200 float net_type, float net_name)
1202 string checkargs = Notification_CheckArgs(broadcast, client, 1, 1);
1203 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Kill_Notification: %s\n", checkargs)); return; }
1205 #ifdef NOTIFICATIONS_DEBUG
1207 "Kill_Notification(%d, '%s', %s, %d);\n",
1210 Get_Notif_TypeName(net_type),
1215 entity notif, net_notif;
1216 float killed_cpid = NO_CPID;
1222 killed_cpid = 0; // kill ALL centerprints
1230 entity notif = Get_Notif_Ent(net_type, net_name);
1231 if not(notif) { backtrace("Kill_Notification: Could not find notification entity!\n"); return; }
1234 killed_cpid = notif.nent_cpid;
1236 killed_cpid = NO_CPID;
1240 killed_cpid = 0; // kill ALL centerprints
1245 case MSG_CENTER_CPID:
1247 killed_cpid = net_name;
1252 if(killed_cpid != NO_CPID)
1254 net_notif = spawn();
1255 net_notif.classname = "net_kill_notification";
1256 net_notif.nent_broadcast = broadcast;
1257 net_notif.nent_client = client;
1258 net_notif.nent_net_type = MSG_CENTER_CPID;
1259 net_notif.nent_net_name = killed_cpid;
1260 Net_LinkEntity(net_notif, FALSE, autocvar_notification_lifetime_runtime, Net_Write_Notification);
1263 for(notif = world; (notif = find(notif, classname, "net_notification"));)
1267 if(killed_cpid != NO_CPID)
1269 if(notif.owner.nent_cpid == killed_cpid)
1271 notif.nent_net_name = -1;
1272 notif.nextthink = time;
1274 else { continue; } // we ARE looking for a specific CPID, don't kill everything else too
1276 else if(notif.nent_net_type == net_type)
1280 if(notif.nent_net_name == net_name) { notif.nent_net_name = -1; notif.nextthink = time; }
1281 else { continue; } // we ARE looking for a certain net_name, don't kill everything else too
1283 else { notif.nent_net_name = -1; notif.nextthink = time; }
1285 else { continue; } // we ARE looking for a certain net_type, don't kill everything else too
1287 else { notif.nent_net_name = -1; notif.nextthink = time; }
1291 void Send_Notification(
1292 float broadcast, entity client,
1293 float net_type, float net_name,
1296 // check supplied broadcast, target, type, and name for errors
1297 string checkargs = Notification_CheckArgs(broadcast, client, net_type, net_name);
1298 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
1300 // retreive counts for the arguments of this notification
1301 entity notif = Get_Notif_Ent(net_type, net_name);
1302 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
1304 if((notif.nent_stringcount + notif.nent_floatcount) > count)
1308 "Not enough arguments for Send_Notification(%d, %s, %s, ...)! ",
1309 "stringcount(%d) + floatcount(%d) > count(%d)\n",
1310 "Check the definition and function call for accuracy...?\n"
1312 broadcast, Get_Notif_TypeName(net_type), notif.nent_name,
1313 notif.nent_stringcount, notif.nent_floatcount, count
1317 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
1321 "Too many arguments for Send_Notification(%d, %s, %s, ...)! ",
1322 "stringcount(%d) + floatcount(%d) < count(%d)\n",
1323 "Check the definition and function call for accuracy...?\n"
1325 broadcast, Get_Notif_TypeName(net_type), notif.nent_name,
1326 notif.nent_stringcount, notif.nent_floatcount, count
1331 #ifdef NOTIFICATIONS_DEBUG
1332 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
1333 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
1334 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
1335 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
1336 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
1337 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
1338 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
1339 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
1341 "Send_Notification(%d, %s, %s, %s, %s);\n",
1343 Get_Notif_TypeName(net_type),
1345 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1346 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1350 entity net_notif = spawn();
1351 net_notif.owner = notif;
1352 net_notif.classname = "net_notification";
1353 net_notif.nent_broadcast = broadcast;
1354 net_notif.nent_client = client;
1355 net_notif.nent_net_type = net_type;
1356 net_notif.nent_net_name = net_name;
1357 net_notif.nent_stringcount = notif.nent_stringcount;
1358 net_notif.nent_floatcount = notif.nent_floatcount;
1361 for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
1362 for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
1364 net_notif.think = Net_Notification_Remove;
1365 net_notif.nextthink =
1366 ((time > autocvar_notification_lifetime_mapload)
1368 (time + autocvar_notification_lifetime_runtime)
1370 autocvar_notification_lifetime_mapload
1373 Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
1375 if(server_is_dedicated && (broadcast == NOTIF_ALL || broadcast == NOTIF_ALL_EXCEPT) && (net_type != MSG_CENTER))
1377 Local_Notification_WOVA(
1379 notif.nent_stringcount,
1380 notif.nent_floatcount,
1381 IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3),
1382 IFFL(0), IFFL(1), IFFL(2), IFFL(3));
1386 // WOVA = Without Variable Arguments
1387 void Send_Notification_WOVA(
1388 float broadcast, entity client,
1389 float net_type, float net_name,
1390 string s1, string s2, string s3, string s4,
1391 float f1, float f2, float f3, float f4)
1393 entity notif = Get_Notif_Ent(net_type, net_name);
1395 #ifdef NOTIFICATIONS_DEBUG
1397 "Send_Notification_WOVA(%d, %s, %s, %s, %s);\n",
1399 Get_Notif_TypeName(net_type),
1401 MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
1402 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
1406 #define VARITEM(stringc,floatc,args) \
1407 if((notif.nent_stringcount == stringc) && (notif.nent_floatcount == floatc)) \
1408 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
1409 EIGHT_VARS_TO_VARARGS_VARLIST
1411 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
1413 #endif // ifdef SVQC