3 #include <common/command/_mod.qh>
5 #include <common/constants.qh>
6 #include <common/teams.qh>
7 #include <common/util.qh>
10 #include <client/autocvars.qh>
13 /** main types/groups of notifications */
15 /** "Global" AND "personal" announcer messages */
17 /** "Global" information messages */
19 /** "Personal" centerprint messages */
21 /** Subcall MSG_INFO and/or MSG_CENTER notifications */
23 /** Choose which subcall wrapper to activate */
25 /** Kill centerprint message @deprecated */
26 CASE(MSG, CENTER_KILL)
29 string Get_Notif_TypeName(MSG net_type)
33 case MSG_ANNCE: return "MSG_ANNCE";
34 case MSG_INFO: return "MSG_INFO";
35 case MSG_CENTER: return "MSG_CENTER";
36 case MSG_MULTI: return "MSG_MULTI";
37 case MSG_CHOICE: return "MSG_CHOICE";
39 LOG_WARNF("Get_Notif_TypeName(%d): Improper net type!", ORDINAL(net_type));
44 CASE(CPID, ASSAULT_ROLE)
47 CASE(CPID, CTF_CAPSHIELD)
48 CASE(CPID, CTF_LOWPRIO)
54 CASE(CPID, PREVENT_JOIN)
56 CASE(CPID, KEEPAWAY_WARN)
58 CASE(CPID, KEYHUNT_OTHER)
60 CASE(CPID, MISSING_TEAMS)
61 CASE(CPID, MISSING_PLAYERS)
62 CASE(CPID, INSTAGIB_FINDAMMO)
66 CASE(CPID, ONS_CAPSHIELD)
69 CASE(CPID, RACE_FINISHLAP)
70 CASE(CPID, TEAMCHANGE)
74 CASE(CPID, VEHICLES_OTHER)
79 USING(Notification, entity);
81 // used for notification system multi-team identifiers
82 #define APP_TEAM_NUM(num, prefix) ((num == NUM_TEAM_1) ? prefix##_RED : ((num == NUM_TEAM_2) ? prefix##_BLUE : ((num == NUM_TEAM_3) ? prefix##_YELLOW : prefix##_PINK)))
83 #define APP_NUM(num, prefix) ((num) ? APP_TEAM_NUM(num, prefix) : prefix##_NEUTRAL)
85 #define EIGHT_VARS_TO_VARARGS_VARLIST \
87 VARITEM(2, 0, XPD(s1, s2)) \
88 VARITEM(3, 0, XPD(s1, s2, s3)) \
89 VARITEM(4, 0, XPD(s1, s2, s3, s4)) \
91 VARITEM(1, 1, XPD(s1, f1)) \
92 VARITEM(2, 1, XPD(s1, s2, f1)) \
93 VARITEM(3, 1, XPD(s1, s2, s3, f1)) \
94 VARITEM(4, 1, XPD(s1, s2, s3, s4, f1)) \
95 VARITEM(0, 2, XPD(f1, f2)) \
96 VARITEM(1, 2, XPD(s1, f1, f2)) \
97 VARITEM(2, 2, XPD(s1, s2, f1, f2)) \
98 VARITEM(3, 2, XPD(s1, s2, s3, f1, f2)) \
99 VARITEM(4, 2, XPD(s1, s2, s3, s4, f1, f2)) \
100 VARITEM(0, 3, XPD(f1, f2, f3)) \
101 VARITEM(1, 3, XPD(s1, f1, f2, f3)) \
102 VARITEM(2, 3, XPD(s1, s2, f1, f2, f3)) \
103 VARITEM(3, 3, XPD(s1, s2, s3, f1, f2, f3)) \
104 VARITEM(4, 3, XPD(s1, s2, s3, s4, f1, f2, f3)) \
105 VARITEM(0, 4, XPD(f1, f2, f3, f4)) \
106 VARITEM(1, 4, XPD(s1, f1, f2, f3, f4)) \
107 VARITEM(2, 4, XPD(s1, s2, f1, f2, f3, f4)) \
108 VARITEM(3, 4, XPD(s1, s2, s3, f1, f2, f3, f4)) \
109 VARITEM(4, 4, XPD(s1, s2, s3, s4, f1, f2, f3, f4))
111 void Destroy_All_Notifications();
112 void Create_Notification_Entity(entity notif,
118 void Create_Notification_Entity_Annce(entity notif,
127 void Create_Notification_Entity_InfoCenter(entity notif,
132 /* MSG_INFO & MSG_CENTER */
141 void Create_Notification_Entity_Multi(entity notif,
145 Notification anncename,
146 Notification infoname,
147 Notification centername);
149 void Create_Notification_Entity_Choice(entity notif,
156 Notification optiona,
157 Notification optionb);
159 void Dump_Notifications(int fh, bool alsoprint);
161 GENERIC_COMMAND(dumpnotifs, "Dump all notifications into notifications_dump.txt")
165 case CMD_REQUEST_COMMAND:
168 string filename = argv(1);
169 bool alsoprint = false;
172 filename = "notifications_dump.cfg";
175 else if (filename == "-")
177 filename = "notifications_dump.cfg";
180 int fh = fopen(filename, FILE_WRITE);
183 Dump_Notifications(fh, alsoprint);
184 LOG_INFOF("Dumping notifications... File located in ^2data/data/%s^7.", filename);
189 LOG_INFOF("^1Error: ^7Could not open file '%s'!", filename);
192 LOG_INFO(_("Notification dump command only works with cl_cmd and sv_cmd."));
197 case CMD_REQUEST_USAGE:
199 LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " dumpnotifs [filename]");
200 LOG_INFO(" Where 'filename' is the file to write (default is notifications_dump.cfg),");
201 LOG_INFO(" if supplied with '-' output to console as well as default,");
202 LOG_INFO(" if left blank, it will only write to default.");
208 #ifdef NOTIFICATIONS_DEBUG
209 bool autocvar_notification_debug = false;
210 void Debug_Notification(string input)
212 switch (autocvar_notification_debug)
214 case 1: { LOG_TRACE(input); break; }
215 case 2: { LOG_INFO(input); break; }
220 void Local_Notification(MSG net_type, Notification net_name, ...count);
221 /** glue for networking, forwards to `Local_Notification` */
222 void Local_Notification_WOVA(
223 MSG net_type, Notification net_name,
224 float stringcount, float floatcount,
225 string s1, string s2, string s3, string s4,
226 float f1, float f2, float f3, float f4);
229 string prev_soundfile;
230 float prev_soundtime;
234 IntrusiveList g_notifications;
235 STATIC_INIT(g_notifications) { g_notifications = IL_NEW(); }
240 /** send to one client and their spectators */
242 /** send ONLY to one client */
243 CASE(NOTIF, ONE_ONLY)
244 /** send only to X team and their spectators */
246 /** send only to X team and their spectators, except for Y person and their spectators */
247 CASE(NOTIF, TEAM_EXCEPT)
248 /** send to everyone */
250 /** send to everyone except X person and their spectators */
251 CASE(NOTIF, ALL_EXCEPT)
254 string Get_Notif_BroadcastName(NOTIF broadcast)
258 case NOTIF_ONE: return "NOTIF_ONE";
259 case NOTIF_ONE_ONLY: return "NOTIF_ONE_ONLY";
260 case NOTIF_ALL_EXCEPT: return "NOTIF_ALL_EXCEPT";
261 case NOTIF_ALL: return "NOTIF_ALL";
262 case NOTIF_TEAM: return "NOTIF_TEAM";
263 case NOTIF_TEAM_EXCEPT: return "NOTIF_TEAM_EXCEPT";
265 LOG_WARNF("Get_Notif_BroadcastName(%d): Improper broadcast!", broadcast);
269 void Kill_Notification(
270 NOTIF broadcast, entity client,
271 MSG net_type, CPID net_name);
272 void Send_Notification(
273 NOTIF broadcast, entity client,
274 MSG net_type, Notification net_name,
276 void Send_Notification_WOVA(
277 NOTIF broadcast, entity client,
278 MSG net_type, Notification net_name,
279 float stringcount, float floatcount,
280 string s1, string s2, string s3, string s4,
281 float f1, float f2, float f3, float f4);
282 void Send_Notification_WOCOVA(
283 NOTIF broadcast, entity client,
284 MSG net_type, Notification net_name,
285 string s1, string s2, string s3, string s4,
286 float f1, float f2, float f3, float f4);
289 // ===========================
290 // Special CVAR Declarations
291 // ===========================
293 // MAKE SURE THIS IS ALWAYS SYNCHRONIZED WITH THE DUMP
294 // NOTIFICATIONS FUNCTION IN THE .QC FILE!
296 #define NOTIF_ADD_AUTOCVAR(name,default) float autocvar_notification_##name = default;
298 float autocvar_notification_show_location = false;
299 string autocvar_notification_show_location_string = ""; //_(" at the %s");
300 float autocvar_notification_show_sprees = true;
301 float autocvar_notification_show_sprees_info = 3; // 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker
302 float autocvar_notification_show_sprees_info_newline = true;
303 float autocvar_notification_show_sprees_info_specialonly = true;
304 float autocvar_notification_errors_are_fatal = true;
306 float autocvar_notification_lifetime_runtime = 0.5;
307 float autocvar_notification_lifetime_mapload = 10;
312 void Notification_GetCvars(entity this);
313 float autocvar_notification_server_allows_location = 1; // 0 = no, 1 = yes
315 float autocvar_notification_item_centerprinttime = 1.5;
317 // 0 = no, 1 = yes, 2 = forced on for all MSG_INFO notifs
318 // DISABLED IN CODE, BUT ENABLED IN CONFIG FOR COMPATIBILITY WITH OLD CLIENTS
319 float autocvar_notification_allow_chatboxprint = 0;
321 float autocvar_notification_show_sprees_center = true;
322 float autocvar_notification_show_sprees_center_specialonly = true;
326 // ============================
327 // Notification Argument List
328 // ============================
330 These arguments get replaced with the Local_Notification_sprintf
331 and other such functions found in all.qc to supply data
332 from networked notifications to their usage in sprintf... It
333 allows for more dynamic data to be inferred by the local
334 notification parser, so that the server does not have to network
335 anything too crazy on a per-client/per-situation basis.
337 Pay attention to the CSQC/SVQC relations, some of these are redefined
338 in slightly different ways for different programs, this is because the
339 server does a more conservative approach to the notifs than the client.
341 All arguments are swapped into strings, so be sure that your
342 sprintf usage matches with proper %s placement.
344 Argument descriptions:
345 s1-s4: string arguments to be literally swapped into sprintf
346 s2loc: s2 string of locations of deaths or other events
347 s3loc: s3 string of locations of deaths or other events
348 f1-f4: float arguments expanded into strings to be swapped into sprintf
349 f1p2dec: f1 float to string with 2 decimal places
350 f2p2dec: f2 float to string with 2 decimal places
351 f2primsec: f2 float primary or secondary selection for weapons
352 f3primsec: f3 float primary or secondary selection for weapons
353 f1secs: count_seconds of f1
354 f1points: point or points depending on f1
355 f1ord: count_ordinal of f1
356 f1time: process_time of f1
357 f1race_time: mmssss of f1
358 f2race_time: mmssss of f2
359 race_col: color of race time/position (i.e. good or bad)
360 race_diff: show time difference between f2 and f3
361 missing_teams: show which teams still need players
362 pass_key: find the keybind for "passing" or "dropping" in CTF game mode
363 nade_key: find the keybind for nade throwing
364 frag_ping: show the ping of a player
365 frag_stats: show health/armor/ping of a player
366 frag_pos: show score status and position in the match of a player
367 spree_cen: centerprint notif for kill spree/how many kills they have
368 spree_inf: info notif for kill spree/how many kills they have
369 spree_end: placed at the end of murder messages to show ending of sprees
370 spree_lost: placed at the end of suicide messages to show losing of sprees
371 item_wepname: return full name of a weapon from weaponid
372 item_wepammo: ammo display for weapon from string
373 item_centime: amount of time to display weapon message in centerprint
374 item_buffname: return full name of a buff from buffid
375 death_team: show the full name of the team a player is switching from
376 minigame1_name: return human readable name of a minigame from its id(s1)
377 minigame1_d: return descriptor name of a minigame from its id(s1)
380 const float NOTIF_MAX_ARGS = 7;
381 const float NOTIF_MAX_HUDARGS = 2;
382 const float NOTIF_MAX_DURCNT = 2;
384 string arg_slot[NOTIF_MAX_ARGS];
386 const float ARG_CS_SV_HA = 1; // enabled on CSQC, SVQC, and Hudargs
387 const float ARG_CS_SV_DC = 2; // enabled on CSQC, SVQC, and durcnt centerprint
388 const float ARG_CS_SV = 3; // enabled on CSQC and SVQC
389 const float ARG_CS = 4; // unique result to CSQC
390 const float ARG_SV = 5; // unique result to SVQC
391 const float ARG_DC = 6; // unique result to durcnt/centerprint
393 // todo possible idea.... declare how many floats/strings each arg needs, and then dynamically increment the input
394 // this way, we don't need to have duplicates like i.e. s2loc and s3loc?
396 string BUFF_NAME(int i);
398 #define NOTIF_ARGUMENT_LIST \
399 ARG_CASE(ARG_CS_SV_HA, "s1", s1) \
400 ARG_CASE(ARG_CS_SV_HA, "s2", s2) \
401 ARG_CASE(ARG_CS_SV_HA, "s3", s3) \
402 ARG_CASE(ARG_CS_SV_HA, "s4", s4) \
403 ARG_CASE(ARG_CS_SV, "s2loc", ((autocvar_notification_show_location && (s2 != "")) ? sprintf(( ((tmp_s = autocvar_notification_show_location_string) != "") ? tmp_s : _(" (near %s)") ), s2) : "")) \
404 ARG_CASE(ARG_CS_SV, "s3loc", ((autocvar_notification_show_location && (s3 != "")) ? sprintf(( ((tmp_s = autocvar_notification_show_location_string) != "") ? tmp_s : _(" (near %s)") ), s3) : "")) \
405 ARG_CASE(ARG_CS_SV_DC, "f1", ftos(f1)) \
406 ARG_CASE(ARG_CS_SV_DC, "f2", ftos(f2)) \
407 ARG_CASE(ARG_CS_SV, "f3", ftos(f3)) \
408 ARG_CASE(ARG_CS_SV, "f4", ftos(f4)) \
409 ARG_CASE(ARG_CS_SV, "f1dtime", ftos_decimals(TIME_DECODE(f1), 2)) \
410 ARG_CASE(ARG_CS_SV, "f2dtime", ftos_decimals(TIME_DECODE(f2), 2)) \
411 ARG_CASE(ARG_CS, "f2primsec", (f2 ? _("secondary") : _("primary"))) \
412 ARG_CASE(ARG_CS, "f3primsec", (f3 ? _("secondary") : _("primary"))) \
413 ARG_CASE(ARG_CS, "f1secs", count_seconds(f1)) \
414 ARG_CASE(ARG_CS, "f1points", (f1 == 1 ? _("point") : _("points"))) \
415 ARG_CASE(ARG_CS_SV, "f1ord", count_ordinal(f1)) \
416 ARG_CASE(ARG_CS_SV, "f1time", process_time(2, f1)) \
417 ARG_CASE(ARG_CS_SV_HA, "f1race_time", mmssss(f1)) \
418 ARG_CASE(ARG_CS_SV_HA, "f2race_time", mmssss(f2)) \
419 ARG_CASE(ARG_CS_SV_HA, "f3race_time", mmssss(f3)) \
420 ARG_CASE(ARG_CS_SV, "race_col", CCR(((f1 == 1) ? "^F1" : "^F2"))) \
421 ARG_CASE(ARG_CS_SV, "race_diff", ((f2 > f3) ? sprintf(CCR("^1[+%s]"), mmssss(f2 - f3)) : sprintf(CCR("^2[-%s]"), mmssss(f3 - f2)))) \
422 ARG_CASE(ARG_CS, "missing_teams", notif_arg_missing_teams(f1)) \
423 ARG_CASE(ARG_CS, "pass_key", getcommandkey(_("drop flag"), "+use")) \
424 ARG_CASE(ARG_CS, "nade_key", getcommandkey(_("throw nade"), "dropweapon")) \
425 ARG_CASE(ARG_CS, "frag_ping", notif_arg_frag_ping(true, f2)) \
426 ARG_CASE(ARG_CS, "frag_stats", notif_arg_frag_stats(f2, f3, f4)) \
427 /*ARG_CASE(ARG_CS, "frag_pos", ((Should_Print_Score_Pos(f1)) ? sprintf("\n^BG%s", Read_Score_Pos(f1)) : ""))*/ \
428 ARG_CASE(ARG_CS, "spree_cen", (autocvar_notification_show_sprees ? notif_arg_spree_cen(f1) : "")) \
429 ARG_CASE(ARG_CS_SV, "spree_inf", (autocvar_notification_show_sprees ? notif_arg_spree_inf(1, input, s2, f2) : "")) \
430 ARG_CASE(ARG_CS_SV, "spree_end", (autocvar_notification_show_sprees ? notif_arg_spree_inf(-1, "", "", f1) : "")) \
431 ARG_CASE(ARG_CS_SV, "spree_lost", (autocvar_notification_show_sprees ? notif_arg_spree_inf(-2, "", "", f1) : "")) \
432 ARG_CASE(ARG_CS_SV, "item_wepname", Weapons_from(f1).m_name) \
433 ARG_CASE(ARG_CS_SV, "item_buffname", BUFF_NAME(f1)) \
434 ARG_CASE(ARG_CS_SV, "f3buffname", BUFF_NAME(f3)) \
435 ARG_CASE(ARG_CS_SV, "item_wepammo", (s1 != "" ? sprintf(_(" with %s"), s1) : "")) \
436 ARG_CASE(ARG_DC, "item_centime", ftos(autocvar_notification_item_centerprinttime)) \
437 ARG_CASE(ARG_SV, "death_team", Team_ColoredFullName(f1)) \
438 ARG_CASE(ARG_CS, "death_team", Team_ColoredFullName(f1 - 1)) \
439 ARG_CASE(ARG_CS_SV_HA, "minigame1_name",find(NULL,netname,s1).descriptor.message) \
440 ARG_CASE(ARG_CS_SV_HA, "minigame1_d", find(NULL,netname,s1).descriptor.netname)
442 #define NOTIF_HIT_MAX(count,funcname) MACRO_BEGIN { \
443 if(sel_num == count) { backtrace(sprintf("%s: Hit maximum arguments!\n", funcname)); break; } \
445 #define NOTIF_HIT_UNKNOWN(token,funcname) { backtrace(sprintf("%s: Hit unknown token in selected string! '%s'\n", funcname, selected)); break; }
447 #define KILL_SPREE_LIST \
448 SPREE_ITEM(3, 03, _("TRIPLE FRAG! "), _("%s^K1 made a TRIPLE FRAG! %s^BG"), _("%s^K1 made a TRIPLE SCORE! %s^BG")) \
449 SPREE_ITEM(5, 05, _("RAGE! "), _("%s^K1 unlocked RAGE! %s^BG"), _("%s^K1 made FIVE SCORES IN A ROW! %s^BG")) \
450 SPREE_ITEM(10, 10, _("MASSACRE! "), _("%s^K1 started a MASSACRE! %s^BG"), _("%s^K1 made TEN SCORES IN A ROW! %s^BG")) \
451 SPREE_ITEM(15, 15, _("MAYHEM! "), _("%s^K1 executed MAYHEM! %s^BG"), _("%s^K1 made FIFTEEN SCORES IN A ROW! %s^BG")) \
452 SPREE_ITEM(20, 20, _("BERSERKER! "), _("%s^K1 is a BERSERKER! %s^BG"), _("%s^K1 made TWENTY SCORES IN A ROW! %s^BG")) \
453 SPREE_ITEM(25, 25, _("CARNAGE! "), _("%s^K1 inflicts CARNAGE! %s^BG"), _("%s^K1 made TWENTY FIVE SCORES IN A ROW! %s^BG")) \
454 SPREE_ITEM(30, 30, _("ARMAGEDDON! "), _("%s^K1 unleashes ARMAGEDDON! %s^BG"), _("%s^K1 made THIRTY SCORES IN A ROW! %s^BG"))
457 string notif_arg_frag_ping(bool newline, float fping)
459 string s = newline ? "\n" : " ";
461 return sprintf(CCR(_("%s(^F1Bot^BG)")), s);
463 return sprintf(CCR(_("%s(Ping ^F1%d^BG)")), s, fping);
466 string notif_arg_frag_stats(float fhealth, float farmor, float fping)
468 string s = notif_arg_frag_ping(false, fping);
470 return sprintf(CCR(_("\n(Health ^1%d^BG / Armor ^2%d^BG)%s")), fhealth, farmor, s);
472 return sprintf(CCR(_("\n(^F4Dead^BG)%s")), s);
475 string notif_arg_missing_teams(float f1)
478 ((f1 & BIT(0)) ? strcat(Team_ColoredFullName(NUM_TEAM_1), (f1 >> 1) ? ", " : "") : ""),
479 ((f1 & BIT(1)) ? strcat(Team_ColoredFullName(NUM_TEAM_2), (f1 >> 2) ? ", " : "") : ""),
480 ((f1 & BIT(2)) ? strcat(Team_ColoredFullName(NUM_TEAM_3), (f1 >> 3) ? ", " : "") : ""),
481 ((f1 & BIT(3)) ? Team_ColoredFullName(NUM_TEAM_4) : "")
485 string notif_arg_spree_cen(float spree)
487 // 0 = off, 1 = target (but only for first victim) and attacker
488 if(autocvar_notification_show_sprees_center)
492 #define SPREE_ITEM(counta,countb,center,normal,gentle) \
493 case counta: { return normal_or_gentle(center, sprintf(_("%d score spree! "), spree)); }
500 if (!autocvar_notification_show_sprees_center_specialonly)
505 _("%d frag spree! "),
506 _("%d score spree! ")
510 else { return ""; } // don't show spree information if it isn't an achievement
516 else if(spree == -1) // first blood
518 return normal_or_gentle(_("First blood! "), _("First score! "));
520 else if(spree == -2) // first victim
522 return normal_or_gentle(_("First victim! "), _("First casualty! "));
529 string notif_arg_spree_inf(float type, string input, string player, float spree)
533 case 1: // attacker kill spree
535 // 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker
536 // this conditional (& 2) is true for 2 and 3
537 if(autocvar_notification_show_sprees_info & 2)
540 string spree_newline =
541 ( autocvar_notification_show_sprees_info_newline ?
542 ((substring(input, 0, 1) == "\{3}") ? "\n\{3}" : "\n") : "" );
544 string spree_newline =
545 (autocvar_notification_show_sprees_info_newline ? "\n" : "");
550 #define SPREE_ITEM(counta,countb,center,normal,gentle) \
551 case counta: { return sprintf(CCR(normal_or_gentle(normal, gentle)), player, spree_newline); }
558 if (!autocvar_notification_show_sprees_info_specialonly)
562 CCR(normal_or_gentle(
563 _("%s^K1 has %d frags in a row! %s^BG"),
564 _("%s^K1 made %d scores in a row! %s^BG")
571 else { return ""; } // don't show spree information if it isn't an achievement
577 else if(spree == -1) // firstblood
581 CCR(normal_or_gentle(
582 _("%s^K1 drew first blood! %s^BG"),
583 _("%s^K1 got the first score! %s^BG")
593 case -1: // kill spree ended
595 if((spree > 1) && (autocvar_notification_show_sprees_info & 1))
598 sprintf(normal_or_gentle(
599 _(", ending their %d frag spree"),
600 _(", ending their %d score spree")
608 case -2: // kill spree lost
610 if((spree > 1) && (autocvar_notification_show_sprees_info & 1))
613 sprintf(normal_or_gentle(
614 _(", losing their %d frag spree"),
615 _(", losing their %d score spree")
627 // ====================================
628 // Initialization/Create Declarations
629 // ====================================
631 // common notification entity values
636 .int nent_stringcount;
637 .int nent_floatcount;
640 // MSG_ANNCE entity values
644 .float nent_position;
646 // MSG_INFO and MSG_CENTER entity values
647 .string nent_args; // used by both
648 .string nent_hudargs; // used by info
649 .string nent_icon; // used by info
650 .CPID nent_cpid; // used by center
651 .string nent_durcnt; // used by center
652 .string nent_string; // used by both
654 // MSG_MULTI entity values
655 .entity nent_msgannce;
656 .entity nent_msginfo;
657 .entity nent_msgcenter;
659 // MSG_CHOICE entity values
660 .float nent_challow_def;
661 .float nent_challow_var;
662 .entity nent_optiona;
663 .entity nent_optionb;
665 // networked notification entity values
667 .NOTIF nent_broadcast;
671 .float nent_net_name;
672 .string nent_strings[4];
673 .float nent_floats[4];
675 #define ACVNN(name) autocvar_notification_##name
677 REGISTRY(Notifications, BITS(11))
678 REGISTER_REGISTRY(Notifications)
679 REGISTRY_SORT(Notifications); STATIC_INIT(Notifications) { FOREACH(Notifications, true, it.m_id = i); }
680 REGISTRY_CHECK(Notifications)
682 const int NOTIF_CHOICE_MAX = 50;
683 int nent_choice_count = 0;
684 .int nent_choice_idx;
685 .int msg_choice_choices[NOTIF_CHOICE_MAX]; // set on each player containing MSG_CHOICE choices
686 // initialization error detection
688 bool notif_global_error;
690 STATIC_INIT_LATE(Notif_Choices) {
692 FOREACH(Notifications, it.nent_type == MSG_CHOICE, { c++; });
693 if (c > NOTIF_CHOICE_MAX) {
694 LOG_FATALF("Too many MSG_CHOICE notifications (%d)", c);
698 string Get_Notif_CvarName(Notification notif)
700 if(!notif.nent_teamnum)
701 return notif.nent_name;
702 return substring(notif.nent_name, 0, -strlen(Static_Team_ColorName(notif.nent_teamnum)) - 2);
705 Notification Get_Notif_Ent(MSG net_type, int net_name)
707 Notification it = _Notifications_from(net_name, NULL);
708 if (it.nent_type != net_type) {
709 LOG_WARNF("Get_Notif_Ent(%s (%d), %s (%d)): Improper net type '%s'!",
710 Get_Notif_TypeName(net_type), net_type,
711 it.registered_id, net_name,
712 Get_Notif_TypeName(it.nent_type)
719 #define MSG_ANNCE_NOTIF_TEAM(teamnum, name, cvarname, default, sound, channel, volume, position) \
720 MSG_ANNCE_NOTIF_(teamnum, ANNCE_##name, ANNCE_##cvarname, default, sound, channel, volume, position)
722 #define MSG_ANNCE_NOTIF(name, default, sound, channel, volume, position) \
723 NOTIF_ADD_AUTOCVAR(ANNCE_##name, default) \
724 MSG_ANNCE_NOTIF_(0, ANNCE_##name, ANNCE_##name, default, sound, channel, volume, position)
726 #define MSG_ANNCE_NOTIF_(teamnum, name, cvarname, default, sound, channel, volume, position) \
727 REGISTER(Notifications, name, m_id, new_pure(msg_annce_notification)) { \
728 Create_Notification_Entity (this, default, ACVNN(cvarname), MSG_ANNCE, strtoupper(#name), teamnum); \
729 Create_Notification_Entity_Annce(this, ACVNN(cvarname), strtoupper(#name), \
730 channel, /* channel */ \
733 position); /* position */ \
736 #define MSG_INFO_NOTIF_TEAM(teamnum, name, cvarname, default, strnum, flnum, args, hudargs, icon, normal, gentle) \
737 MSG_INFO_NOTIF_(teamnum, INFO_##name, INFO_##cvarname, default, strnum, flnum, args, hudargs, icon, normal, gentle)
739 #define MSG_INFO_NOTIF(name, default, strnum, flnum, args, hudargs, icon, normal, gentle) \
740 NOTIF_ADD_AUTOCVAR(INFO_##name, default) \
741 MSG_INFO_NOTIF_(0, INFO_##name, INFO_##name, default, strnum, flnum, args, hudargs, icon, normal, gentle)
743 #define MSG_INFO_NOTIF_(teamnum, name, cvarname, default, strnum, flnum, args, hudargs, icon, normal, gentle) \
744 REGISTER(Notifications, name, m_id, new_pure(msg_info_notification)) { \
745 Create_Notification_Entity (this, default, ACVNN(cvarname), MSG_INFO, strtoupper(#name), teamnum); \
746 Create_Notification_Entity_InfoCenter(this, ACVNN(cvarname), strtoupper(#name), strnum, flnum, \
748 hudargs, /* hudargs */ \
750 CPID_Null,/* cpid */ \
752 normal, /* normal */ \
753 gentle); /* gentle */ \
756 .string nent_iconargs;
757 #define MULTIICON_INFO(name, default, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle) \
758 MULTIICON_INFO_(INFO_##name, default, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle)
759 #define MULTIICON_INFO_(name, default, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle) \
760 NOTIF_ADD_AUTOCVAR(name, default) \
761 REGISTER(Notifications, name, m_id, new_pure(msg_info_notification)) { \
762 Create_Notification_Entity (this, default, ACVNN(name), MSG_INFO, strtoupper(#name), 0); \
763 Create_Notification_Entity_InfoCenter(this, ACVNN(name), strtoupper(#name), strnum, flnum, \
765 hudargs, /* hudargs */ \
767 CPID_Null,/* cpid */ \
769 normal, /* normal */ \
770 gentle); /* gentle */ \
771 this.nent_iconargs = iconargs; \
774 #define MSG_CENTER_NOTIF_TEAM(teamnum, name, cvarname, default, strnum, flnum, args, cpid, durcnt, normal, gentle) \
775 MSG_CENTER_NOTIF_(teamnum, CENTER_##name, CENTER_##cvarname, default, strnum, flnum, args, cpid, durcnt, normal, gentle)
777 #define MSG_CENTER_NOTIF(name, default, strnum, flnum, args, cpid, durcnt, normal, gentle) \
778 NOTIF_ADD_AUTOCVAR(CENTER_##name, default) \
779 MSG_CENTER_NOTIF_(0, CENTER_##name, CENTER_##name, default, strnum, flnum, args, cpid, durcnt, normal, gentle)
781 #define MSG_CENTER_NOTIF_(teamnum, name, cvarname, default, strnum, flnum, args, cpid, durcnt, normal, gentle) \
782 REGISTER(Notifications, name, m_id, new_pure(msg_center_notification)) { \
783 Create_Notification_Entity (this, default, ACVNN(cvarname), MSG_CENTER, strtoupper(#name), teamnum); \
784 Create_Notification_Entity_InfoCenter(this, ACVNN(cvarname), strtoupper(#name), strnum, flnum, \
789 durcnt, /* durcnt */ \
790 normal, /* normal */ \
791 gentle); /* gentle */ \
794 #define MSG_MULTI_NOTIF(name, default, anncename, infoname, centername) \
795 NOTIF_ADD_AUTOCVAR(name, default) \
796 REGISTER(Notifications, name, m_id, new_pure(msg_multi_notification)) { \
797 Create_Notification_Entity (this, default, ACVNN(name), MSG_MULTI, strtoupper(#name), 0); \
798 Create_Notification_Entity_Multi(this, ACVNN(name), strtoupper(#name), \
799 anncename, /* anncename */ \
800 infoname, /* infoname */ \
801 centername); /* centername */ \
804 #define MSG_CHOICE_NOTIF_TEAM(teamnum, name, cvarname, default, challow, chtype, optiona, optionb) \
805 MSG_CHOICE_NOTIF_(teamnum, CHOICE_##name, CHOICE_##cvarname, default, challow, chtype, optiona, optionb)
807 #define MSG_CHOICE_NOTIF(name, default, challow, chtype, optiona, optionb) \
808 NOTIF_ADD_AUTOCVAR(CHOICE_##name, default) \
809 NOTIF_ADD_AUTOCVAR(CHOICE_##name##_ALLOWED, challow) \
810 MSG_CHOICE_NOTIF_(0, CHOICE_##name, CHOICE_##name, default, challow, chtype, optiona, optionb)
812 #define MSG_CHOICE_NOTIF_(teamnum, name, cvarname, default, challow, chtype, optiona, optionb) \
813 REGISTER(Notifications, name, m_id, new_pure(msg_choice_notification)) { \
814 this.nent_choice_idx = nent_choice_count++; \
815 Create_Notification_Entity (this, default, ACVNN(cvarname), MSG_CHOICE, strtoupper(#name), teamnum); \
816 Create_Notification_Entity_Choice(this, ACVNN(cvarname), strtoupper(#name), \
817 challow, /* challow_def */ \
818 autocvar_notification_##cvarname##_ALLOWED, /* challow_var */ \
819 chtype, /* chtype */ \
820 optiona, /* optiona */ \
821 optionb); /* optionb */ \
824 REGISTRY_BEGIN(Notifications)
826 notif_global_error = false;
829 REGISTRY_END(Notifications)
831 if (!notif_global_error) return;
832 // shit happened... stop the loading of the program now if this is unacceptable
833 if (autocvar_notification_errors_are_fatal)
834 LOG_FATAL("Notification initialization failed! Read above and fix the errors!");
836 LOG_SEVERE("Notification initialization failed! Read above and fix the errors!");