3 #include <common/command/_mod.qh>
5 #include <common/constants.qh>
6 #include <common/teams.qh>
7 #include <common/util.qh>
8 #include <common/sounds/sound.qh>
9 #include <common/weapons/all.qh>
11 // Operator for bold notifications
12 #define BOLD_OPERATOR "^BOLD"
14 /** main types/groups of notifications */
16 /** "Global" AND "personal" announcer messages */
18 /** "Global" information messages */
20 /** "Personal" centerprint messages */
22 /** Subcall MSG_INFO and/or MSG_CENTER notifications */
24 /** Choose which subcall wrapper to activate */
26 /** Kill centerprint message @deprecated */
27 CASE(MSG, CENTER_KILL)
30 string Get_Notif_TypeName(MSG net_type)
34 case MSG_ANNCE: return "MSG_ANNCE";
35 case MSG_INFO: return "MSG_INFO";
36 case MSG_CENTER: return "MSG_CENTER";
37 case MSG_MULTI: return "MSG_MULTI";
38 case MSG_CHOICE: return "MSG_CHOICE";
39 case MSG_CENTER_KILL: return "MSG_CENTER_KILL";
41 LOG_WARNF("Get_Notif_TypeName(%d): Improper net type!", ORDINAL(net_type));
46 CASE(CPID, ASSAULT_ROLE)
49 CASE(CPID, CTF_CAPSHIELD)
50 CASE(CPID, CTF_LOWPRIO)
56 CASE(CPID, PREVENT_JOIN)
58 CASE(CPID, KEEPAWAY_WARN)
60 CASE(CPID, KEYHUNT_OTHER)
62 CASE(CPID, MISSING_TEAMS)
63 CASE(CPID, MISSING_PLAYERS)
64 CASE(CPID, INSTAGIB_FINDAMMO)
67 CASE(CPID, ONS_CAPSHIELD)
70 CASE(CPID, RACE_FINISHLAP)
72 CASE(CPID, TEAMCHANGE)
76 CASE(CPID, VEHICLES_OTHER)
81 USING(Notification, entity);
83 // used for notification system multi-team identifiers
84 #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)))
85 #define APP_NUM(num, prefix) ((num) ? APP_TEAM_NUM(num, prefix) : prefix##_NEUTRAL)
87 #define EIGHT_VARS_TO_VARARGS_VARLIST \
89 VARITEM(2, 0, XPD(s1, s2)) \
90 VARITEM(3, 0, XPD(s1, s2, s3)) \
91 VARITEM(4, 0, XPD(s1, s2, s3, s4)) \
93 VARITEM(1, 1, XPD(s1, f1)) \
94 VARITEM(2, 1, XPD(s1, s2, f1)) \
95 VARITEM(3, 1, XPD(s1, s2, s3, f1)) \
96 VARITEM(4, 1, XPD(s1, s2, s3, s4, f1)) \
97 VARITEM(0, 2, XPD(f1, f2)) \
98 VARITEM(1, 2, XPD(s1, f1, f2)) \
99 VARITEM(2, 2, XPD(s1, s2, f1, f2)) \
100 VARITEM(3, 2, XPD(s1, s2, s3, f1, f2)) \
101 VARITEM(4, 2, XPD(s1, s2, s3, s4, f1, f2)) \
102 VARITEM(0, 3, XPD(f1, f2, f3)) \
103 VARITEM(1, 3, XPD(s1, f1, f2, f3)) \
104 VARITEM(2, 3, XPD(s1, s2, f1, f2, f3)) \
105 VARITEM(3, 3, XPD(s1, s2, s3, f1, f2, f3)) \
106 VARITEM(4, 3, XPD(s1, s2, s3, s4, f1, f2, f3)) \
107 VARITEM(0, 4, XPD(f1, f2, f3, f4)) \
108 VARITEM(1, 4, XPD(s1, f1, f2, f3, f4)) \
109 VARITEM(2, 4, XPD(s1, s2, f1, f2, f3, f4)) \
110 VARITEM(3, 4, XPD(s1, s2, s3, f1, f2, f3, f4)) \
111 VARITEM(4, 4, XPD(s1, s2, s3, s4, f1, f2, f3, f4))
113 void Destroy_All_Notifications();
114 void Create_Notification_Entity(entity notif,
120 void Create_Notification_Entity_Annce(entity notif,
130 void Create_Notification_Entity_InfoCenter(entity notif,
135 /* MSG_INFO & MSG_CENTER */
144 void Create_Notification_Entity_Multi(entity notif,
148 Notification anncename,
149 Notification infoname,
150 Notification centername);
152 void Create_Notification_Entity_Choice(entity notif,
159 Notification optiona,
160 Notification optionb);
162 void Dump_Notifications(int fh, bool alsoprint);
164 #define DEFAULT_FILENAME "notifications_dump.cfg"
165 // NOTE: dumpeffectinfo, dumpnotifs, dumpturrets and dumpweapons use similar code
166 GENERIC_COMMAND(dumpnotifs, "Dump all notifications into " DEFAULT_FILENAME, false)
170 case CMD_REQUEST_COMMAND:
173 string filename = argv(1);
174 bool alsoprint = false;
177 filename = DEFAULT_FILENAME;
180 else if (filename == "-")
182 filename = DEFAULT_FILENAME;
185 int fh = fopen(filename, FILE_WRITE);
188 Dump_Notifications(fh, alsoprint);
189 LOG_INFOF("Dumping notifications... File located in ^2data/data/%s^7.", filename);
194 LOG_INFOF("^1Error: ^7Could not open file '%s'!", filename);
197 LOG_INFO("Notification dump command only works with cl_cmd and sv_cmd.");
202 case CMD_REQUEST_USAGE:
204 LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " dumpnotifs [<filename>]");
205 LOG_HELPF(" Where <filename> is the file to write (default is %s),", DEFAULT_FILENAME);
206 LOG_HELP(" if supplied with '-' output to console as well as default,");
207 LOG_HELP(" if left blank, it will only write to default.");
212 #undef DEFAULT_FILENAME
214 #ifdef NOTIFICATIONS_DEBUG
215 bool autocvar_notification_debug = false;
216 void Debug_Notification(string input)
218 switch (autocvar_notification_debug)
220 case 1: { LOG_TRACE(input); break; }
221 case 2: { LOG_INFO(input); break; }
226 void Local_Notification(MSG net_type, Notification net_name, ...count);
227 /** glue for networking, forwards to `Local_Notification` */
228 void Local_Notification_WOVA(
229 MSG net_type, Notification net_name,
230 float stringcount, float floatcount,
231 string s1, string s2, string s3, string s4,
232 float f1, float f2, float f3, float f4);
235 string prev_soundfile;
236 float prev_soundtime;
240 IntrusiveList g_notifications;
241 STATIC_INIT(g_notifications) { g_notifications = IL_NEW(); }
246 /** send to one client and their spectators */
248 /** send ONLY to one client */
249 CASE(NOTIF, ONE_ONLY)
250 /** send only to X team and their spectators */
252 /** send only to X team and their spectators, except for Y person and their spectators */
253 CASE(NOTIF, TEAM_EXCEPT)
254 /** send to everyone */
256 /** send to everyone except X person and their spectators */
257 CASE(NOTIF, ALL_EXCEPT)
260 string Get_Notif_BroadcastName(NOTIF broadcast)
264 case NOTIF_ONE: return "NOTIF_ONE";
265 case NOTIF_ONE_ONLY: return "NOTIF_ONE_ONLY";
266 case NOTIF_ALL_EXCEPT: return "NOTIF_ALL_EXCEPT";
267 case NOTIF_ALL: return "NOTIF_ALL";
268 case NOTIF_TEAM: return "NOTIF_TEAM";
269 case NOTIF_TEAM_EXCEPT: return "NOTIF_TEAM_EXCEPT";
271 LOG_WARNF("Get_Notif_BroadcastName(%d): Improper broadcast!", broadcast);
275 void Kill_Notification(
276 NOTIF broadcast, entity client,
277 MSG net_type, CPID net_name);
278 void Send_Notification(
279 NOTIF broadcast, entity client,
280 MSG net_type, Notification net_name,
282 void Send_Notification_WOVA(
283 NOTIF broadcast, entity client,
284 MSG net_type, Notification net_name,
285 float stringcount, float floatcount,
286 string s1, string s2, string s3, string s4,
287 float f1, float f2, float f3, float f4);
288 void Send_Notification_WOCOVA(
289 NOTIF broadcast, entity client,
290 MSG net_type, Notification net_name,
291 string s1, string s2, string s3, string s4,
292 float f1, float f2, float f3, float f4);
295 // ===========================
296 // Special CVAR Declarations
297 // ===========================
299 // MAKE SURE THIS IS ALWAYS SYNCHRONIZED WITH THE DUMP
300 // NOTIFICATIONS FUNCTION IN THE .QC FILE!
302 #define NOTIF_ADD_AUTOCVAR(name,defaultvalue) float autocvar_notification_##name = defaultvalue;
304 float autocvar_notification_show_location = false;
305 string autocvar_notification_show_location_string = ""; //_(" at the %s");
306 float autocvar_notification_show_sprees = true;
307 float autocvar_notification_show_sprees_info = 3; // 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker
308 float autocvar_notification_show_sprees_info_newline = true;
309 float autocvar_notification_show_sprees_info_specialonly = true;
310 float autocvar_notification_errors_are_fatal = true;
312 float autocvar_notification_lifetime_runtime = 0.5;
313 float autocvar_notification_lifetime_mapload = 10;
317 void Notification_GetCvars(entity this, entity store);
318 float autocvar_notification_server_allows_location = 1; // 0 = no, 1 = yes
320 float autocvar_notification_item_centerprinttime = 1.5;
322 // 0 = no, 1 = yes, 2 = forced on for all MSG_INFO notifs
323 // DISABLED IN CODE, BUT ENABLED IN CONFIG FOR COMPATIBILITY WITH OLD CLIENTS
324 float autocvar_notification_allow_chatboxprint = 0;
326 float autocvar_notification_show_sprees_center = true;
327 float autocvar_notification_show_sprees_center_specialonly = true;
331 // ============================
332 // Notification Argument List
333 // ============================
335 These arguments get replaced with the Local_Notification_sprintf
336 and other such functions found in all.qc to supply data
337 from networked notifications to their usage in sprintf... It
338 allows for more dynamic data to be inferred by the local
339 notification parser, so that the server does not have to network
340 anything too crazy on a per-client/per-situation basis.
342 Pay attention to the CSQC/SVQC relations, some of these are redefined
343 in slightly different ways for different programs, this is because the
344 server does a more conservative approach to the notifs than the client.
346 All arguments are swapped into strings, so be sure that your
347 sprintf usage matches with proper %s placement.
349 Argument descriptions:
350 s1-s4: string arguments to be literally swapped into sprintf
351 s2loc: s2 string of locations of deaths or other events
352 s3loc: s3 string of locations of deaths or other events
353 f1-f4: float arguments expanded into strings to be swapped into sprintf
354 f1p2dec: f1 float to string with 2 decimal places
355 f2p2dec: f2 float to string with 2 decimal places
356 f2primsec: f2 float primary or secondary selection for weapons
357 f3primsec: f3 float primary or secondary selection for weapons
358 f1secs: count_seconds of f1
359 f1points: point or points depending on f1
360 f1ord: count_ordinal of f1
361 f1time: process_time of f1
362 f1race_time: TIME_ENCODED_TOSTRING of f1
363 f2race_time: TIME_ENCODED_TOSTRING of f2
364 race_col: color of race time/position (i.e. good or bad)
365 race_diff: show time difference between f2 and f3
366 missing_teams: show which teams still need players
367 pass_key: find the keybind for "passing" or "dropping" in CTF game mode
368 nade_key: find the keybind for nade throwing
369 frag_ping: show the ping of a player
370 frag_stats: show health/armor/ping of a player
371 frag_pos: show score status and position in the match of a player
372 spree_cen: centerprint notif for kill spree/how many kills they have
373 spree_inf: info notif for kill spree/how many kills they have
374 spree_end: placed at the end of murder messages to show ending of sprees
375 spree_lost: placed at the end of suicide messages to show losing of sprees
376 item_wepname: return full name of a weapon from weaponid
377 item_wepammo: ammo display for weapon from f1 and f2
378 item_centime: amount of time to display weapon message in centerprint
379 item_buffname: return full name of a buff from buffid
380 death_team: show the full name of the team a player is switching from
381 minigame1_name: return human readable name of a minigame from its id(s1)
382 minigame1_d: return descriptor name of a minigame from its id(s1)
385 const float NOTIF_MAX_ARGS = 7;
386 const float NOTIF_MAX_HUDARGS = 2;
387 const float NOTIF_MAX_DURCNT = 2;
390 const int NOTIF_QUEUE_MAX = 10;
391 entity notif_queue_entity[NOTIF_QUEUE_MAX];
392 MSG notif_queue_type[NOTIF_QUEUE_MAX];
393 float notif_queue_time[NOTIF_QUEUE_MAX];
395 float notif_queue_next_time;
396 int notif_queue_length;
398 void Local_Notification_Queue_Process();
401 string arg_slot[NOTIF_MAX_ARGS];
403 const float ARG_CS_SV_HA = 1; // enabled on CSQC, SVQC, and Hudargs
404 const float ARG_CS_SV_DC = 2; // enabled on CSQC, SVQC, and durcnt centerprint
405 const float ARG_CS_SV = 3; // enabled on CSQC and SVQC
406 const float ARG_CS = 4; // unique result to CSQC
407 const float ARG_SV = 5; // unique result to SVQC
408 const float ARG_DC = 6; // unique result to durcnt/centerprint
410 // todo possible idea.... declare how many floats/strings each arg needs, and then dynamically increment the input
411 // this way, we don't need to have duplicates like i.e. s2loc and s3loc?
413 string BUFF_NAME(int i);
415 #define NOTIF_ARGUMENT_LIST \
416 ARG_CASE(ARG_CS_SV_HA, "s1", s1) \
417 ARG_CASE(ARG_CS_SV_HA, "s2", s2) \
418 ARG_CASE(ARG_CS_SV_HA, "s3", s3) \
419 ARG_CASE(ARG_CS_SV_HA, "s4", s4) \
420 ARG_CASE(ARG_CS_SV, "s2loc", ((autocvar_notification_show_location && (s2 != "")) ? sprintf(( ((tmp_s = autocvar_notification_show_location_string) != "") ? tmp_s : _(" (near %s)") ), s2) : "")) \
421 ARG_CASE(ARG_CS_SV, "s3loc", ((autocvar_notification_show_location && (s3 != "")) ? sprintf(( ((tmp_s = autocvar_notification_show_location_string) != "") ? tmp_s : _(" (near %s)") ), s3) : "")) \
422 ARG_CASE(ARG_CS_SV_DC, "f1", ftos(f1)) \
423 ARG_CASE(ARG_CS_SV_DC, "f2", ftos(f2)) \
424 ARG_CASE(ARG_CS_SV, "f3", ftos(f3)) \
425 ARG_CASE(ARG_CS_SV, "f4", ftos(f4)) \
426 ARG_CASE(ARG_CS_SV, "f1dtime", ftos_decimals(TIME_DECODE(f1), 2)) \
427 ARG_CASE(ARG_CS_SV, "f2dtime", ftos_decimals(TIME_DECODE(f2), 2)) \
428 ARG_CASE(ARG_CS, "f2primsec", (f2 ? _("secondary") : _("primary"))) \
429 ARG_CASE(ARG_CS, "f3primsec", (f3 ? _("secondary") : _("primary"))) \
430 ARG_CASE(ARG_CS, "f1secs", count_seconds(f1)) \
431 ARG_CASE(ARG_CS, "f1points", (f1 == 1 ? _("point") : _("points"))) \
432 ARG_CASE(ARG_CS_SV, "f1ord", count_ordinal(f1)) \
433 ARG_CASE(ARG_CS_SV, "f1time", process_time(2, f1)) \
434 ARG_CASE(ARG_CS_SV_HA, "f1race_time", TIME_ENCODED_TOSTRING(f1, true)) \
435 ARG_CASE(ARG_CS_SV_HA, "f2race_time", TIME_ENCODED_TOSTRING(f2, true)) \
436 ARG_CASE(ARG_CS_SV_HA, "f3race_time", TIME_ENCODED_TOSTRING(f3, true)) \
437 ARG_CASE(ARG_CS_SV, "race_col", CCR(((f1 == 1) ? "^F1" : "^F2"))) \
438 ARG_CASE(ARG_CS_SV, "race_diff", ((f2 > f3) ? sprintf(CCR("^1[+%s]"), TIME_ENCODED_TOSTRING(f2 - f3, true)) : sprintf(CCR("^2[-%s]"), TIME_ENCODED_TOSTRING(f3 - f2, true)))) \
439 ARG_CASE(ARG_CS, "missing_teams", notif_arg_missing_teams(f1)) \
440 ARG_CASE(ARG_CS, "pass_key", getcommandkey(_("drop flag"), "+use")) \
441 ARG_CASE(ARG_CS, "nade_key", getcommandkey(_("throw nade"), "dropweapon")) \
442 ARG_CASE(ARG_CS, "join_key", getcommandkey(_("jump"), "+jump")) \
443 ARG_CASE(ARG_CS, "frag_ping", notif_arg_frag_ping(true, f2)) \
444 ARG_CASE(ARG_CS, "frag_stats", notif_arg_frag_stats(f2, f3, f4)) \
445 /*ARG_CASE(ARG_CS, "frag_pos", ((Should_Print_Score_Pos(f1)) ? sprintf("\n^BG%s", Read_Score_Pos(f1)) : ""))*/ \
446 ARG_CASE(ARG_CS, "spree_cen", (autocvar_notification_show_sprees ? notif_arg_spree_cen(f1) : "")) \
447 ARG_CASE(ARG_CS_SV, "spree_inf", (autocvar_notification_show_sprees ? notif_arg_spree_inf(1, input, s2, f2) : "")) \
448 ARG_CASE(ARG_CS_SV, "spree_end", (autocvar_notification_show_sprees ? notif_arg_spree_inf(-1, "", "", f1) : "")) \
449 ARG_CASE(ARG_CS_SV, "spree_lost", (autocvar_notification_show_sprees ? notif_arg_spree_inf(-2, "", "", f1) : "")) \
450 ARG_CASE(ARG_CS_SV, "item_wepname", REGISTRY_GET(Weapons, f1).m_name) \
451 ARG_CASE(ARG_CS_SV, "item_buffname", BUFF_NAME(f1)) \
452 ARG_CASE(ARG_CS_SV, "f3buffname", BUFF_NAME(f3)) \
453 ARG_CASE(ARG_CS_SV, "item_wepammo", (f2 > 0 ? notif_arg_item_wepammo(f1, f2) : "")) \
454 ARG_CASE(ARG_DC, "item_centime", ftos(autocvar_notification_item_centerprinttime)) \
455 ARG_CASE(ARG_SV, "death_team", Team_ColoredFullName(f1)) \
456 ARG_CASE(ARG_CS, "death_team", Team_ColoredFullName(f1 - 1)) \
457 ARG_CASE(ARG_CS_SV_HA, "minigame1_name",find(NULL,netname,s1).descriptor.message) \
458 ARG_CASE(ARG_CS_SV_HA, "minigame1_d", find(NULL,netname,s1).descriptor.netname)
460 #define NOTIF_HIT_MAX(count,funcname) MACRO_BEGIN \
461 if(sel_num == count) { backtrace(sprintf("%s: Hit maximum arguments!\n", funcname)); break; } \
464 #define NOTIF_HIT_UNKNOWN(token,funcname) { backtrace(sprintf("%s: Hit unknown token in selected string! '%s'\n", funcname, selected)); break; }
466 #define KILL_SPREE_LIST \
467 SPREE_ITEM(3, 03, _("TRIPLE FRAG! "), _("%s^K1 made a TRIPLE FRAG! %s^BG"), _("%s^K1 made a TRIPLE SCORE! %s^BG")) \
468 SPREE_ITEM(5, 05, _("RAGE! "), _("%s^K1 unlocked RAGE! %s^BG"), _("%s^K1 made FIVE SCORES IN A ROW! %s^BG")) \
469 SPREE_ITEM(10, 10, _("MASSACRE! "), _("%s^K1 started a MASSACRE! %s^BG"), _("%s^K1 made TEN SCORES IN A ROW! %s^BG")) \
470 SPREE_ITEM(15, 15, _("MAYHEM! "), _("%s^K1 executed MAYHEM! %s^BG"), _("%s^K1 made FIFTEEN SCORES IN A ROW! %s^BG")) \
471 SPREE_ITEM(20, 20, _("BERSERKER! "), _("%s^K1 is a BERSERKER! %s^BG"), _("%s^K1 made TWENTY SCORES IN A ROW! %s^BG")) \
472 SPREE_ITEM(25, 25, _("CARNAGE! "), _("%s^K1 inflicts CARNAGE! %s^BG"), _("%s^K1 made TWENTY FIVE SCORES IN A ROW! %s^BG")) \
473 SPREE_ITEM(30, 30, _("ARMAGEDDON! "), _("%s^K1 unleashes ARMAGEDDON! %s^BG"), _("%s^K1 made THIRTY SCORES IN A ROW! %s^BG"))
476 string notif_arg_frag_ping(bool newline, float fping)
478 string s = newline ? "\n" : " ";
480 return sprintf(CCR(_("%s(^F1Bot^BG)")), s);
482 return sprintf(CCR(_("%s(Ping ^F1%d^BG)")), s, fping);
485 string notif_arg_frag_stats(float fhealth, float farmor, float fping)
487 string s = notif_arg_frag_ping(false, fping);
489 return sprintf(CCR(_("\n(Health ^1%d^BG / Armor ^2%d^BG)%s")), fhealth, farmor, s);
491 return sprintf(CCR(_("\n(^F4Dead^BG)%s")), s);
494 string notif_arg_missing_teams(float f1)
497 ((f1 & BIT(0)) ? strcat(Team_ColoredFullName(NUM_TEAM_1), (f1 >> 1) ? ", " : "") : ""),
498 ((f1 & BIT(1)) ? strcat(Team_ColoredFullName(NUM_TEAM_2), (f1 >> 2) ? ", " : "") : ""),
499 ((f1 & BIT(2)) ? strcat(Team_ColoredFullName(NUM_TEAM_3), (f1 >> 3) ? ", " : "") : ""),
500 ((f1 & BIT(3)) ? Team_ColoredFullName(NUM_TEAM_4) : "")
504 string notif_arg_spree_cen(float spree)
506 // 0 = off, 1 = target (but only for first victim) and attacker
507 if(autocvar_notification_show_sprees_center)
511 #define SPREE_ITEM(counta,countb,center,normal,gentle) \
512 case counta: { return normal_or_gentle(center, sprintf(_("%d score spree! "), spree)); }
519 if (!autocvar_notification_show_sprees_center_specialonly)
524 _("%d frag spree! "),
525 _("%d score spree! ")
529 else { return ""; } // don't show spree information if it isn't an achievement
535 else if(spree == -1) // first blood
537 return normal_or_gentle(_("First blood! "), _("First score! "));
539 else if(spree == -2) // first victim
541 return normal_or_gentle(_("First victim! "), _("First casualty! "));
548 string notif_arg_spree_inf(float type, string input, string player, float spree)
552 case 1: // attacker kill spree
554 // 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker
555 // this conditional (& 2) is true for 2 and 3
556 if(autocvar_notification_show_sprees_info & 2)
559 string spree_newline =
560 ( autocvar_notification_show_sprees_info_newline ?
561 ((substring(input, 0, 1) == "\{3}") ? "\n\{3}" : "\n") : "" );
563 string spree_newline =
564 (autocvar_notification_show_sprees_info_newline ? "\n" : "");
569 #define SPREE_ITEM(counta,countb,center,normal,gentle) \
570 case counta: { return sprintf(CCR(normal_or_gentle(normal, gentle)), player, spree_newline); }
577 if (!autocvar_notification_show_sprees_info_specialonly)
581 CCR(normal_or_gentle(
582 _("%s^K1 has %d frags in a row! %s^BG"),
583 _("%s^K1 made %d scores in a row! %s^BG")
590 else { return ""; } // don't show spree information if it isn't an achievement
596 else if(spree == -1) // firstblood
600 CCR(normal_or_gentle(
601 _("%s^K1 drew first blood! %s^BG"),
602 _("%s^K1 got the first score! %s^BG")
612 case -1: // kill spree ended
614 if((spree > 1) && (autocvar_notification_show_sprees_info & 1))
617 sprintf(normal_or_gentle(
618 _(", ending their %d frag spree"),
619 _(", ending their %d score spree")
627 case -2: // kill spree lost
629 if((spree > 1) && (autocvar_notification_show_sprees_info & 1))
632 sprintf(normal_or_gentle(
633 _(", losing their %d frag spree"),
634 _(", losing their %d score spree")
645 string notif_arg_item_wepammo(float f1, float f2)
647 string ammoitems = "";
648 Weapon wep = REGISTRY_GET(Weapons, f1);
649 // TODO: registry handles
650 switch (wep.ammo_type)
652 case RES_SHELLS: ammoitems = ITEM_Shells.m_name; break;
653 case RES_BULLETS: ammoitems = ITEM_Bullets.m_name; break;
654 case RES_ROCKETS: ammoitems = ITEM_Rockets.m_name; break;
655 case RES_CELLS: ammoitems = ITEM_Cells.m_name; break;
656 case RES_PLASMA: ammoitems = ITEM_Plasma.m_name; break;
657 case RES_FUEL: ammoitems = ITEM_JetpackFuel.m_name; break;
658 default: return ""; // doesn't use ammo
660 return sprintf(_(" with %d %s"), f2, strtolower(ammoitems));
664 // ====================================
665 // Initialization/Create Declarations
666 // ====================================
668 // common notification entity values
673 .int nent_stringcount;
674 .int nent_floatcount;
677 // MSG_ANNCE entity values
681 .float nent_position;
682 .float nent_queuetime;
684 // MSG_INFO and MSG_CENTER entity values
685 .string nent_args; // used by both
686 .string nent_hudargs; // used by info
687 .string nent_icon; // used by info
688 .CPID nent_cpid; // used by center
689 .string nent_durcnt; // used by center
690 .string nent_string; // used by both
692 // MSG_MULTI entity values
693 .entity nent_msgannce;
694 .entity nent_msginfo;
695 .entity nent_msgcenter;
697 // MSG_CHOICE entity values
698 .float nent_challow_def;
699 .float nent_challow_var;
700 .entity nent_optiona;
701 .entity nent_optionb;
703 // networked notification entity values
705 .NOTIF nent_broadcast;
709 .float nent_net_name;
710 .string nent_strings[4];
711 .float nent_floats[4];
713 #define ACVNN(name) autocvar_notification_##name
715 REGISTRY(Notifications, BITS(11))
716 REGISTER_REGISTRY(Notifications)
717 REGISTRY_SORT(Notifications)
719 REGISTRY_DEFINE_GET(Notifications, NULL)
720 STATIC_INIT(Notifications) { FOREACH(Notifications, true, it.m_id = i); }
721 REGISTRY_CHECK(Notifications)
723 const int NOTIF_CHOICE_MAX = 20;
724 // NOTE: a team choice is actually made of 4 choices (one per team) with the same nent_choice_idx
725 // thus they are counted as 1 in nent_choice_count
726 int nent_choice_count = 0;
727 .int nent_choice_idx;
728 .int msg_choice_choices[NOTIF_CHOICE_MAX]; // set on each player containing MSG_CHOICE choices
729 // initialization error detection
731 bool notif_global_error;
733 STATIC_INIT_LATE(Notif_Choices)
735 if (nent_choice_count > NOTIF_CHOICE_MAX)
736 LOG_FATALF("Too many MSG_CHOICE notifications (%d), hit NOTIF_CHOICE_MAX (%d) limit",
737 nent_choice_count, NOTIF_CHOICE_MAX);
740 string Get_Notif_CvarName(Notification notif)
742 if(!notif.nent_teamnum)
743 return notif.nent_name;
744 return substring(notif.nent_name, 0, -strlen(Static_Team_ColorName(notif.nent_teamnum)) - 2);
747 Notification Get_Notif_Ent(MSG net_type, int net_name)
749 Notification it = REGISTRY_GET(Notifications, net_name);
750 if (it.nent_type != net_type) {
751 LOG_WARNF("Get_Notif_Ent(%s (%d), %s (%d)): Improper net type '%s'!",
752 Get_Notif_TypeName(net_type), net_type,
753 it.registered_id, net_name,
754 Get_Notif_TypeName(it.nent_type)
761 #define MSG_ANNCE_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, sound, channel, volume, position, queuetime) \
762 MSG_ANNCE_NOTIF_(teamnum, ANNCE_##name, ANNCE_##cvarname, defaultvalue, sound, channel, volume, position, queuetime)
764 #define MSG_ANNCE_NOTIF(name, defaultvalue, sound, channel, volume, position, queuetime) \
765 NOTIF_ADD_AUTOCVAR(ANNCE_##name, defaultvalue) \
766 MSG_ANNCE_NOTIF_(0, ANNCE_##name, ANNCE_##name, defaultvalue, sound, channel, volume, position, queuetime)
768 #define MSG_ANNCE_NOTIF_(teamnum, name, cvarname, defaultvalue, sound, channel, volume, position, queuetime) \
769 REGISTER(Notifications, name, m_id, new_pure(msg_annce_notification)) { \
770 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_ANNCE, strtoupper(#name), teamnum); \
771 Create_Notification_Entity_Annce(this, ACVNN(cvarname), strtoupper(#name), \
772 channel, /* channel */ \
775 position, /* position */ \
776 queuetime); /* queuetime */ \
779 #define MSG_INFO_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
780 MSG_INFO_NOTIF_(teamnum, INFO_##name, INFO_##cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle)
782 #define MSG_INFO_NOTIF(name, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
783 NOTIF_ADD_AUTOCVAR(INFO_##name, defaultvalue) \
784 MSG_INFO_NOTIF_(0, INFO_##name, INFO_##name, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle)
786 #define MSG_INFO_NOTIF_(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
787 REGISTER(Notifications, name, m_id, new_pure(msg_info_notification)) { \
788 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_INFO, strtoupper(#name), teamnum); \
789 Create_Notification_Entity_InfoCenter(this, ACVNN(cvarname), strtoupper(#name), strnum, flnum, \
791 hudargs, /* hudargs */ \
793 CPID_Null,/* cpid */ \
795 normal, /* normal */ \
796 gentle); /* gentle */ \
799 .string nent_iconargs;
800 #define MULTIICON_INFO(name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle) \
801 MULTIICON_INFO_(INFO_##name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle)
802 #define MULTIICON_INFO_(name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle) \
803 NOTIF_ADD_AUTOCVAR(name, defaultvalue) \
804 REGISTER(Notifications, name, m_id, new_pure(msg_info_notification)) { \
805 Create_Notification_Entity (this, defaultvalue, ACVNN(name), MSG_INFO, strtoupper(#name), 0); \
806 Create_Notification_Entity_InfoCenter(this, ACVNN(name), strtoupper(#name), strnum, flnum, \
808 hudargs, /* hudargs */ \
810 CPID_Null,/* cpid */ \
812 normal, /* normal */ \
813 gentle); /* gentle */ \
814 this.nent_iconargs = iconargs; \
817 #define MSG_CENTER_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
818 MSG_CENTER_NOTIF_(teamnum, CENTER_##name, CENTER_##cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle)
820 #define MSG_CENTER_NOTIF(name, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
821 NOTIF_ADD_AUTOCVAR(CENTER_##name, defaultvalue) \
822 MSG_CENTER_NOTIF_(0, CENTER_##name, CENTER_##name, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle)
824 #define MSG_CENTER_NOTIF_(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
825 REGISTER(Notifications, name, m_id, new_pure(msg_center_notification)) { \
826 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_CENTER, strtoupper(#name), teamnum); \
827 Create_Notification_Entity_InfoCenter(this, ACVNN(cvarname), strtoupper(#name), strnum, flnum, \
832 durcnt, /* durcnt */ \
833 normal, /* normal */ \
834 gentle); /* gentle */ \
837 #define MSG_MULTI_NOTIF(name, defaultvalue, anncename, infoname, centername) \
838 NOTIF_ADD_AUTOCVAR(name, defaultvalue) \
839 REGISTER(Notifications, name, m_id, new_pure(msg_multi_notification)) { \
840 Create_Notification_Entity (this, defaultvalue, ACVNN(name), MSG_MULTI, strtoupper(#name), 0); \
841 Create_Notification_Entity_Multi(this, ACVNN(name), strtoupper(#name), \
842 anncename, /* anncename */ \
843 infoname, /* infoname */ \
844 centername); /* centername */ \
847 #define MSG_CHOICE_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, challow, chtype, optiona, optionb) \
848 MSG_CHOICE_NOTIF_(teamnum, CHOICE_##name, CHOICE_##cvarname, defaultvalue, challow, chtype, optiona, optionb)
850 #define MSG_CHOICE_NOTIF(name, defaultvalue, challow, chtype, optiona, optionb) \
851 NOTIF_ADD_AUTOCVAR(CHOICE_##name, defaultvalue) \
852 NOTIF_ADD_AUTOCVAR(CHOICE_##name##_ALLOWED, challow) \
853 MSG_CHOICE_NOTIF_(0, CHOICE_##name, CHOICE_##name, defaultvalue, challow, chtype, optiona, optionb)
855 #define MSG_CHOICE_NOTIF_(teamnum, name, cvarname, defaultvalue, challow, chtype, optiona, optionb) \
856 REGISTER(Notifications, name, m_id, new_pure(msg_choice_notification)) { \
857 this.nent_choice_idx = nent_choice_count; \
858 if (!teamnum || teamnum == NUM_TEAM_4) \
859 nent_choice_count++; \
860 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_CHOICE, strtoupper(#name), teamnum); \
861 Create_Notification_Entity_Choice(this, ACVNN(cvarname), strtoupper(#name), \
862 challow, /* challow_def */ \
863 autocvar_notification_##cvarname##_ALLOWED, /* challow_var */ \
864 chtype, /* chtype */ \
865 optiona, /* optiona */ \
866 optionb); /* optionb */ \
869 REGISTRY_BEGIN(Notifications)
871 notif_global_error = false;
874 REGISTRY_END(Notifications)
876 if (!notif_global_error) return;
877 // shit happened... stop the loading of the program now if this is unacceptable
878 if (autocvar_notification_errors_are_fatal)
879 LOG_FATAL("Notification initialization failed! Read above and fix the errors!");
881 LOG_SEVERE("Notification initialization failed! Read above and fix the errors!");
886 void ReplicateVars(bool would_destroy)
889 FOREACH(Notifications, it.nent_type == MSG_CHOICE && (!it.nent_teamnum || it.nent_teamnum == NUM_TEAM_1), {
890 string cvarname = strcat("notification_", Get_Notif_CvarName(it));
891 // NOTE: REPLICATE_SIMPLE can return;
892 REPLICATE_SIMPLE(it.cvar_value, cvarname);