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)
28 /** Medal notification */
32 string Get_Notif_TypeName(MSG net_type)
36 case MSG_ANNCE: return "MSG_ANNCE";
37 case MSG_INFO: return "MSG_INFO";
38 case MSG_CENTER: return "MSG_CENTER";
39 case MSG_MULTI: return "MSG_MULTI";
40 case MSG_CHOICE: return "MSG_CHOICE";
41 case MSG_MEDAL: return "MSG_MEDAL";
43 LOG_WARNF("Get_Notif_TypeName(%d): Improper net type!", ORDINAL(net_type));
46 //LegendGuard adds CASE(CPID, SURVIVAL) after RACE_FINISHLAP from Mario/survival 15-02-2021
48 CASE(CPID, ASSAULT_ROLE)
51 CASE(CPID, CTF_CAPSHIELD)
52 CASE(CPID, CTF_LOWPRIO)
58 CASE(CPID, PREVENT_JOIN)
60 CASE(CPID, KEEPAWAY_WARN)
62 CASE(CPID, KEYHUNT_OTHER)
64 CASE(CPID, MISSING_TEAMS)
65 CASE(CPID, MISSING_PLAYERS)
66 CASE(CPID, MISSING_READY)
67 CASE(CPID, INSTAGIB_FINDAMMO)
68 CASE(CPID, CAMPAIGN_MESSAGE)
72 CASE(CPID, ONS_CAPSHIELD)
75 CASE(CPID, RACE_FINISHLAP)
77 CASE(CPID, TEAMCHANGE)
81 CASE(CPID, VEHICLES_OTHER)
86 USING(Notification, entity);
88 // used for notification system multi-team identifiers
89 #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)))
90 #define APP_NUM(num, prefix) ((num) ? APP_TEAM_NUM(num, prefix) : prefix##_NEUTRAL)
92 #define EIGHT_VARS_TO_VARARGS_VARLIST \
94 VARITEM(2, 0, XPD(s1, s2)) \
95 VARITEM(3, 0, XPD(s1, s2, s3)) \
96 VARITEM(4, 0, XPD(s1, s2, s3, s4)) \
98 VARITEM(1, 1, XPD(s1, f1)) \
99 VARITEM(2, 1, XPD(s1, s2, f1)) \
100 VARITEM(3, 1, XPD(s1, s2, s3, f1)) \
101 VARITEM(4, 1, XPD(s1, s2, s3, s4, f1)) \
102 VARITEM(0, 2, XPD(f1, f2)) \
103 VARITEM(1, 2, XPD(s1, f1, f2)) \
104 VARITEM(2, 2, XPD(s1, s2, f1, f2)) \
105 VARITEM(3, 2, XPD(s1, s2, s3, f1, f2)) \
106 VARITEM(4, 2, XPD(s1, s2, s3, s4, f1, f2)) \
107 VARITEM(0, 3, XPD(f1, f2, f3)) \
108 VARITEM(1, 3, XPD(s1, f1, f2, f3)) \
109 VARITEM(2, 3, XPD(s1, s2, f1, f2, f3)) \
110 VARITEM(3, 3, XPD(s1, s2, s3, f1, f2, f3)) \
111 VARITEM(4, 3, XPD(s1, s2, s3, s4, f1, f2, f3)) \
112 VARITEM(0, 4, XPD(f1, f2, f3, f4)) \
113 VARITEM(1, 4, XPD(s1, f1, f2, f3, f4)) \
114 VARITEM(2, 4, XPD(s1, s2, f1, f2, f3, f4)) \
115 VARITEM(3, 4, XPD(s1, s2, s3, f1, f2, f3, f4)) \
116 VARITEM(4, 4, XPD(s1, s2, s3, s4, f1, f2, f3, f4))
118 void Destroy_All_Notifications();
119 void Create_Notification_Entity(entity notif,
125 void Create_Notification_Entity_Annce(entity notif,
135 void Create_Notification_Entity_InfoCenter(entity notif,
140 /* MSG_INFO & MSG_CENTER */
149 void Create_Notification_Entity_Multi(entity notif,
153 Notification anncename,
154 Notification infoname,
155 Notification centername);
157 void Create_Notification_Entity_Choice(entity notif,
164 Notification optiona,
165 Notification optionb);
167 void Create_Notification_Entity_Medal(entity notif,
172 Notification anncename);
174 void Dump_Notifications(int fh, bool alsoprint);
176 #define DEFAULT_FILENAME "notifications_dump.cfg"
177 // NOTE: dumpeffectinfo, dumpnotifs, dumpturrets and dumpweapons use similar code
178 GENERIC_COMMAND(dumpnotifs, "Dump all notifications into " DEFAULT_FILENAME, false)
182 case CMD_REQUEST_COMMAND:
185 string filename = argv(1);
186 bool alsoprint = false;
189 filename = DEFAULT_FILENAME;
192 else if (filename == "-")
194 filename = DEFAULT_FILENAME;
197 int fh = fopen(filename, FILE_WRITE);
200 Dump_Notifications(fh, alsoprint);
201 LOG_INFOF("Dumping notifications... File located in ^2data/data/%s^7.", filename);
206 LOG_INFOF("^1Error: ^7Could not open file '%s'!", filename);
209 LOG_INFO("Notification dump command only works with cl_cmd and sv_cmd.");
214 case CMD_REQUEST_USAGE:
216 LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " dumpnotifs [<filename>]");
217 LOG_HELPF(" Where <filename> is the file to write (default is %s),", DEFAULT_FILENAME);
218 LOG_HELP(" if supplied with '-' output to console as well as default,");
219 LOG_HELP(" if left blank, it will only write to default.");
224 #undef DEFAULT_FILENAME
226 #ifdef NOTIFICATIONS_DEBUG
227 bool autocvar_notification_debug = false;
228 void Debug_Notification(string input)
230 switch (autocvar_notification_debug)
232 case 1: { LOG_TRACE(input); break; }
233 case 2: { LOG_INFO(input); break; }
238 void Local_Notification(MSG net_type, Notification net_name, ...count);
239 /** glue for networking, forwards to `Local_Notification` */
240 void Local_Notification_WOVA(
241 MSG net_type, Notification net_name,
242 float stringcount, float floatcount,
243 string s1, string s2, string s3, string s4,
244 float f1, float f2, float f3, float f4);
247 string prev_soundfile;
248 float prev_soundtime;
252 IntrusiveList g_notifications;
253 STATIC_INIT(g_notifications) { g_notifications = IL_NEW(); }
258 /** send to one client and their spectators */
260 /** send ONLY to one client */
261 CASE(NOTIF, ONE_ONLY)
262 /** send only to X team and their spectators */
264 /** send only to X team and their spectators, except for Y person and their spectators */
265 CASE(NOTIF, TEAM_EXCEPT)
266 /** send only to X team; don't include spectators */
267 CASE(NOTIF, TEAM_ONLY)
268 /** send to team X team except for Y person; don't include spectators */
269 CASE(NOTIF, TEAM_ONLY_EXCEPT)
270 /** send to everyone */
272 /** send to everyone except X person and their spectators */
273 CASE(NOTIF, ALL_EXCEPT)
274 /** send to all spectators **/
275 CASE(NOTIF, ALL_SPEC)
278 string Get_Notif_BroadcastName(NOTIF broadcast)
282 case NOTIF_ONE: return "NOTIF_ONE";
283 case NOTIF_ONE_ONLY: return "NOTIF_ONE_ONLY";
284 case NOTIF_ALL_SPEC: return "NOTIF_ALL_SPEC";
285 case NOTIF_ALL_EXCEPT: return "NOTIF_ALL_EXCEPT";
286 case NOTIF_ALL: return "NOTIF_ALL";
287 case NOTIF_TEAM: return "NOTIF_TEAM";
288 case NOTIF_TEAM_EXCEPT: return "NOTIF_TEAM_EXCEPT";
289 case NOTIF_TEAM_ONLY: return "NOTIF_TEAM_ONLY";
290 case NOTIF_TEAM_ONLY_EXCEPT: return "NOTIF_TEAM_ONLY_EXCEPT";
292 LOG_WARNF("Get_Notif_BroadcastName(%d): Improper broadcast!", broadcast);
296 void Kill_Notification(
297 NOTIF broadcast, entity client,
298 MSG net_type, CPID net_name);
299 void Send_Notification(
300 NOTIF broadcast, entity client,
301 MSG net_type, Notification net_name,
303 void Send_Notification_WOVA(
304 NOTIF broadcast, entity client,
305 MSG net_type, Notification net_name,
306 float stringcount, float floatcount,
307 string s1, string s2, string s3, string s4,
308 float f1, float f2, float f3, float f4);
309 void Send_Notification_WOCOVA(
310 NOTIF broadcast, entity client,
311 MSG net_type, Notification net_name,
312 string s1, string s2, string s3, string s4,
313 float f1, float f2, float f3, float f4);
316 // ===========================
317 // Special CVAR Declarations
318 // ===========================
320 // MAKE SURE THIS IS ALWAYS SYNCHRONIZED WITH THE DUMP
321 // NOTIFICATIONS FUNCTION IN THE .QC FILE!
323 #define NOTIF_ADD_AUTOCVAR(name,defaultvalue) float autocvar_notification_##name = defaultvalue;
325 float autocvar_notification_show_location = false;
326 string autocvar_notification_show_location_string = ""; //_(" at the %s");
327 float autocvar_notification_show_sprees = true;
328 float autocvar_notification_show_sprees_info = 3; // 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker
329 float autocvar_notification_show_sprees_info_newline = true;
330 float autocvar_notification_show_sprees_info_specialonly = true;
331 float autocvar_notification_errors_are_fatal = true;
333 float autocvar_notification_lifetime_runtime = 0.5;
334 float autocvar_notification_lifetime_mapload = 10;
338 void Notification_GetCvars(entity this, entity store);
339 float autocvar_notification_server_allows_location = 1; // 0 = no, 1 = yes
341 float autocvar_notification_item_centerprinttime = 1.5;
343 // 0 = no, 1 = yes, 2 = forced on for all MSG_INFO notifs
344 // DISABLED IN CODE, BUT ENABLED IN CONFIG FOR COMPATIBILITY WITH OLD CLIENTS
345 float autocvar_notification_allow_chatboxprint = 0;
347 float autocvar_notification_show_sprees_center = true;
348 float autocvar_notification_show_sprees_center_specialonly = true;
352 // ============================
353 // Notification Argument List
354 // ============================
356 These arguments get replaced with the Local_Notification_sprintf
357 and other such functions found in all.qc to supply data
358 from networked notifications to their usage in sprintf... It
359 allows for more dynamic data to be inferred by the local
360 notification parser, so that the server does not have to network
361 anything too crazy on a per-client/per-situation basis.
363 Pay attention to the CSQC/SVQC relations, some of these are redefined
364 in slightly different ways for different programs, this is because the
365 server does a more conservative approach to the notifs than the client.
367 All arguments are swapped into strings, so be sure that your
368 sprintf usage matches with proper %s placement.
370 Argument descriptions:
371 s1-s4: string arguments to be literally swapped into sprintf
372 s2loc: s2 string of locations of deaths or other events
373 s3loc: s3 string of locations of deaths or other events
374 f1-f4: float arguments expanded into strings to be swapped into sprintf
375 f1p2dec: f1 float to string with 2 decimal places
376 f2p2dec: f2 float to string with 2 decimal places
377 f2primsec: f2 float primary or secondary selection for weapons
378 f3primsec: f3 float primary or secondary selection for weapons
379 f1secs: count_seconds of f1
380 f1points: point or points depending on f1
381 f1ord: count_ordinal of f1
382 f1time: process_time of f1
383 f1race_time: mmssss of f1
384 f2race_time: mmssss of f2
385 race_col: color of race time/position (i.e. good or bad)
386 race_diff: show time difference between f2 and f3
387 missing_teams: show which teams still need players
388 pass_key: find the keybind for "passing" or "dropping" in CTF game mode
389 nade_key: find the keybind for nade throwing
390 frag_ping: show the ping of a player
391 frag_stats: show health/armor/ping of a player
392 frag_pos: show score status and position in the match of a player
393 spree_cen: centerprint notif for kill spree/how many kills they have
394 spree_inf: info notif for kill spree/how many kills they have
395 spree_end: placed at the end of murder messages to show ending of sprees
396 spree_lost: placed at the end of suicide messages to show losing of sprees
397 item_wepname: return full name of a weapon from weaponid
398 item_wepammo: ammo display for weapon from f1 and f2
399 item_centime: amount of time to display weapon message in centerprint
400 item_buffname: return full name of a buff from buffid
401 death_team: show the full name of the team a player is switching from
402 minigame1_name: return human readable name of a minigame from its id(s1)
403 minigame1_d: return descriptor name of a minigame from its id(s1)
406 const float NOTIF_MAX_ARGS = 7;
407 const float NOTIF_MAX_HUDARGS = 2;
408 const float NOTIF_MAX_DURCNT = 2;
411 const int NOTIF_QUEUE_MAX = 10;
412 entity notif_queue_entity[NOTIF_QUEUE_MAX];
413 MSG notif_queue_type[NOTIF_QUEUE_MAX];
414 float notif_queue_time[NOTIF_QUEUE_MAX];
415 float notif_queue_f1[NOTIF_QUEUE_MAX];
417 float notif_queue_next_time;
418 int notif_queue_length;
420 void Local_Notification_Queue_Process();
423 string arg_slot[NOTIF_MAX_ARGS];
425 const float ARG_CS_SV_HA = 1; // enabled on CSQC, SVQC, and Hudargs
426 const float ARG_CS_SV_DC = 2; // enabled on CSQC, SVQC, and durcnt centerprint
427 const float ARG_CS_SV = 3; // enabled on CSQC and SVQC
428 const float ARG_CS = 4; // unique result to CSQC
429 const float ARG_SV = 5; // unique result to SVQC
430 const float ARG_DC = 6; // unique result to durcnt/centerprint
432 // todo possible idea.... declare how many floats/strings each arg needs, and then dynamically increment the input
433 // this way, we don't need to have duplicates like i.e. s2loc and s3loc?
435 string BUFF_NAME(int i);
437 #define NOTIF_ARGUMENT_LIST \
438 ARG_CASE(ARG_CS_SV_HA, "s1", s1) \
439 ARG_CASE(ARG_CS_SV_HA, "s2", s2) \
440 ARG_CASE(ARG_CS_SV_HA, "s3", s3) \
441 ARG_CASE(ARG_CS_SV_HA, "s4", s4) \
442 ARG_CASE(ARG_CS_SV, "s2loc", ((autocvar_notification_show_location && (s2 != "")) ? sprintf(( ((tmp_s = autocvar_notification_show_location_string) != "") ? tmp_s : _(" (near %s)") ), s2) : "")) \
443 ARG_CASE(ARG_CS_SV, "s3loc", ((autocvar_notification_show_location && (s3 != "")) ? sprintf(( ((tmp_s = autocvar_notification_show_location_string) != "") ? tmp_s : _(" (near %s)") ), s3) : "")) \
444 ARG_CASE(ARG_CS_SV_DC, "f1", ftos(f1)) \
445 ARG_CASE(ARG_CS_SV_DC, "f2", ftos(f2)) \
446 ARG_CASE(ARG_CS_SV, "f3", ftos(f3)) \
447 ARG_CASE(ARG_CS_SV, "f4", ftos(f4)) \
448 ARG_CASE(ARG_CS_SV, "f1dtime", ftos_decimals(TIME_DECODE(f1), 2)) \
449 ARG_CASE(ARG_CS_SV, "f2dtime", ftos_decimals(TIME_DECODE(f2), 2)) \
450 ARG_CASE(ARG_CS, "f2primsec", (f2 ? _("secondary") : _("primary"))) \
451 ARG_CASE(ARG_CS, "f3primsec", (f3 ? _("secondary") : _("primary"))) \
452 ARG_CASE(ARG_CS, "f1secs", count_seconds(f1)) \
453 ARG_CASE(ARG_CS, "f1points", (f1 == 1 ? _("point") : _("points"))) \
454 ARG_CASE(ARG_CS_SV, "f1ord", count_ordinal(f1)) \
455 ARG_CASE(ARG_CS_SV, "f1time", process_time(2, f1)) \
456 ARG_CASE(ARG_CS_SV_HA, "f1race_time", mmssss(f1)) \
457 ARG_CASE(ARG_CS_SV_HA, "f2race_time", mmssss(f2)) \
458 ARG_CASE(ARG_CS_SV_HA, "f3race_time", mmssss(f3)) \
459 ARG_CASE(ARG_CS_SV, "race_col", CCR(((f1 == 1) ? "^F1" : "^F2"))) \
460 ARG_CASE(ARG_CS_SV, "race_diff", ((f2 > f3) ? sprintf(CCR("^1[+%s]"), mmssss(f2 - f3)) : sprintf(CCR("^2[-%s]"), mmssss(f3 - f2)))) \
461 ARG_CASE(ARG_CS, "missing_teams", notif_arg_missing_teams(f1)) \
462 ARG_CASE(ARG_CS, "pass_key", getcommandkey(_("drop flag"), "+use")) \
463 ARG_CASE(ARG_CS, "nade_key", getcommandkey(_("throw nade"), "dropweapon")) \
464 ARG_CASE(ARG_CS, "join_key", getcommandkey(_("jump"), "+jump")) \
465 ARG_CASE(ARG_CS, "frag_ping", notif_arg_frag_ping(true, f2)) \
466 ARG_CASE(ARG_CS, "frag_stats", notif_arg_frag_stats(f2, f3, f4)) \
467 ARG_CASE(ARG_CS, "frag_pos", notif_arg_frag_pos(f2)) \
468 ARG_CASE(ARG_CS, "spree_cen", (autocvar_notification_show_sprees ? notif_arg_spree_cen(f1) : "")) \
469 ARG_CASE(ARG_CS_SV, "spree_inf", (autocvar_notification_show_sprees ? notif_arg_spree_inf(1, input, s2, f2) : "")) \
470 ARG_CASE(ARG_CS_SV, "spree_end", (autocvar_notification_show_sprees ? notif_arg_spree_inf(-1, "", "", f1) : "")) \
471 ARG_CASE(ARG_CS_SV, "spree_lost", (autocvar_notification_show_sprees ? notif_arg_spree_inf(-2, "", "", f1) : "")) \
472 ARG_CASE(ARG_CS_SV, "item_wepname", REGISTRY_GET(Weapons, f1).m_name) \
473 ARG_CASE(ARG_CS_SV, "item_buffname", BUFF_NAME(f1)) \
474 ARG_CASE(ARG_CS_SV, "f3buffname", BUFF_NAME(f3)) \
475 ARG_CASE(ARG_CS_SV, "item_wepammo", (f2 > 0 ? notif_arg_item_wepammo(f1, f2) : "")) \
476 ARG_CASE(ARG_DC, "item_centime", ftos(autocvar_notification_item_centerprinttime)) \
477 ARG_CASE(ARG_SV, "death_team", Team_ColoredFullName(f1)) \
478 ARG_CASE(ARG_CS, "death_team", Team_ColoredFullName(f1 - 1)) \
479 ARG_CASE(ARG_CS_SV_HA, "minigame1_name",find(NULL,netname,s1).descriptor.message) \
480 ARG_CASE(ARG_CS_SV_HA, "minigame1_d", find(NULL,netname,s1).descriptor.netname)
482 #define NOTIF_HIT_MAX(count,funcname) MACRO_BEGIN \
483 if(sel_num == count) { backtrace(sprintf("%s: Hit maximum arguments!\n", funcname)); break; } \
486 #define NOTIF_HIT_UNKNOWN(token,funcname) { backtrace(sprintf("%s: Hit unknown token in selected string! '%s'\n", funcname, selected)); break; }
488 #define KILL_SPREE_LIST \
489 SPREE_ITEM(3, 03, _("TRIPLE FRAG! "), _("%s^K1 made a TRIPLE FRAG! %s^BG"), _("%s^K1 made a TRIPLE SCORE! %s^BG")) \
490 SPREE_ITEM(5, 05, _("RAGE! "), _("%s^K1 unlocked RAGE! %s^BG"), _("%s^K1 made FIVE SCORES IN A ROW! %s^BG")) \
491 SPREE_ITEM(10, 10, _("MASSACRE! "), _("%s^K1 started a MASSACRE! %s^BG"), _("%s^K1 made TEN SCORES IN A ROW! %s^BG")) \
492 SPREE_ITEM(15, 15, _("MAYHEM! "), _("%s^K1 executed MAYHEM! %s^BG"), _("%s^K1 made FIFTEEN SCORES IN A ROW! %s^BG")) \
495 string notif_arg_frag_pos(int score)
499 string str, color, tail;
502 for(pl = players.sort_next; pl; pl = pl.sort_next) {
503 if(pl.team == NUM_SPECTATOR) continue;
504 if(pl.(scores(SP_SCORE)) == score) break;
508 entity prev = pl.sort_prev;
509 entity next = pl.sort_next;
510 if(prev && prev.(scores(SP_SCORE)) == score) {
512 --place; // We're tied always for the best place
514 if(next && next.(scores(SP_SCORE)) == score) {
546 str = strcat(color, ftos(place), tail);
548 return strcat("Tied for ", str);
553 string notif_arg_frag_ping(bool newline, float fping)
555 string s = newline ? "\n" : " ";
557 return sprintf(CCR(_("%s(^F1Bot^BG)")), s);
559 return sprintf(CCR(_("%s(Ping ^F1%d^BG)")), s, fping);
562 string notif_arg_frag_stats(float fhealth, float farmor, float fping)
564 string s = notif_arg_frag_ping(false, fping);
566 return sprintf(CCR(_("\n(Health ^1%d^BG / Armor ^2%d^BG)%s")), fhealth, farmor, s);
568 return sprintf(CCR(_("\n(^F4Dead^BG)%s")), s);
571 string notif_arg_missing_teams(float f1)
574 ((f1 & BIT(0)) ? strcat(Team_ColoredFullName(NUM_TEAM_1), (f1 >> 1) ? ", " : "") : ""),
575 ((f1 & BIT(1)) ? strcat(Team_ColoredFullName(NUM_TEAM_2), (f1 >> 2) ? ", " : "") : ""),
576 ((f1 & BIT(2)) ? strcat(Team_ColoredFullName(NUM_TEAM_3), (f1 >> 3) ? ", " : "") : ""),
577 ((f1 & BIT(3)) ? Team_ColoredFullName(NUM_TEAM_4) : "")
581 string notif_arg_spree_cen(float spree)
583 // 0 = off, 1 = target (but only for first victim) and attacker
584 if(autocvar_notification_show_sprees_center)
588 #define SPREE_ITEM(counta,countb,center,normal,gentle) \
589 case counta: { return normal_or_gentle(center, sprintf(_("%d score spree! "), spree)); }
596 if (!autocvar_notification_show_sprees_center_specialonly)
601 _("%d frag spree! "),
602 _("%d score spree! ")
606 else { return ""; } // don't show spree information if it isn't an achievement
612 else if(spree == -1) // first blood
614 return normal_or_gentle(_("First blood! "), _("First score! "));
616 else if(spree == -2) // first victim
618 return normal_or_gentle(_("First victim! "), _("First casualty! "));
625 string notif_arg_spree_inf(float type, string input, string player, float spree)
629 case 1: // attacker kill spree
631 // 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker
632 // this conditional (& 2) is true for 2 and 3
633 if(autocvar_notification_show_sprees_info & 2)
636 string spree_newline =
637 ( autocvar_notification_show_sprees_info_newline ?
638 ((substring(input, 0, 1) == "\{3}") ? "\n\{3}" : "\n") : "" );
640 string spree_newline =
641 (autocvar_notification_show_sprees_info_newline ? "\n" : "");
646 #define SPREE_ITEM(counta,countb,center,normal,gentle) \
647 case counta: { return sprintf(CCR(normal_or_gentle(normal, gentle)), player, spree_newline); }
654 if (!autocvar_notification_show_sprees_info_specialonly)
658 CCR(normal_or_gentle(
659 _("%s^K1 has %d frags in a row! %s^BG"),
660 _("%s^K1 made %d scores in a row! %s^BG")
667 else { return ""; } // don't show spree information if it isn't an achievement
673 else if(spree == -1) // firstblood
677 CCR(normal_or_gentle(
678 _("%s^K1 drew first blood! %s^BG"),
679 _("%s^K1 got the first score! %s^BG")
689 case -1: // kill spree ended
691 if((spree > 1) && (autocvar_notification_show_sprees_info & 1))
694 sprintf(normal_or_gentle(
695 _(", ending their %d frag spree"),
696 _(", ending their %d score spree")
704 case -2: // kill spree lost
706 if((spree > 1) && (autocvar_notification_show_sprees_info & 1))
709 sprintf(normal_or_gentle(
710 _(", losing their %d frag spree"),
711 _(", losing their %d score spree")
722 string notif_arg_item_wepammo(float f1, float f2)
724 string ammoitems = "";
725 Weapon wep = REGISTRY_GET(Weapons, f1);
726 switch (wep.ammo_type)
728 case RES_SHELLS: ammoitems = ITEM_Shells.m_name; break;
729 case RES_BULLETS: ammoitems = ITEM_Bullets.m_name; break;
730 case RES_ROCKETS: ammoitems = ITEM_Rockets.m_name; break;
731 case RES_CELLS: ammoitems = ITEM_Cells.m_name; break;
732 case RES_PLASMA: ammoitems = ITEM_Plasma.m_name; break;
733 case RES_FUEL: ammoitems = ITEM_JetpackFuel.m_name; break;
734 default: return ""; // doesn't use ammo
736 return sprintf(_(" with %d %s"), f2, ammoitems);
740 // ====================================
741 // Initialization/Create Declarations
742 // ====================================
744 // common notification entity values
749 .int nent_stringcount;
750 .int nent_floatcount;
753 // MSG_ANNCE entity values
757 .float nent_position;
758 .float nent_queuetime;
760 // MSG_INFO and MSG_CENTER entity values
761 .string nent_args; // used by both
762 .string nent_hudargs; // used by info
763 .string nent_icon; // used by info
764 .CPID nent_cpid; // used by center
765 .string nent_durcnt; // used by center
766 .string nent_string; // used by both
768 // MSG_MULTI entity values
769 .entity nent_msgannce;
770 .entity nent_msginfo;
771 .entity nent_msgcenter;
773 // MSG_CHOICE entity values
774 .float nent_challow_def;
775 .float nent_challow_var;
776 .entity nent_optiona;
777 .entity nent_optionb;
779 // networked notification entity values
781 .NOTIF nent_broadcast;
785 .float nent_net_name;
786 .string nent_strings[4];
787 .float nent_floats[4];
789 #define ACVNN(name) autocvar_notification_##name
791 REGISTRY(Notifications, BITS(11))
792 REGISTER_REGISTRY(Notifications)
793 REGISTRY_SORT(Notifications);
795 REGISTRY_DEFINE_GET(Notifications, NULL)
796 STATIC_INIT(Notifications) { FOREACH(Notifications, true, it.m_id = i); }
797 REGISTRY_CHECK(Notifications)
799 const int NOTIF_CHOICE_MAX = 20;
800 // NOTE: a team choice is actually made of 4 choices (one per team) with the same nent_choice_idx
801 // thus they are counted as 1 in nent_choice_count
802 int nent_choice_count = 0;
803 .int nent_choice_idx;
804 .int msg_choice_choices[NOTIF_CHOICE_MAX]; // set on each player containing MSG_CHOICE choices
805 // initialization error detection
807 bool notif_global_error;
809 STATIC_INIT_LATE(Notif_Choices)
811 if (nent_choice_count > NOTIF_CHOICE_MAX)
812 LOG_FATALF("Too many MSG_CHOICE notifications (%d), hit NOTIF_CHOICE_MAX (%d) limit",
813 nent_choice_count, NOTIF_CHOICE_MAX);
816 string Get_Notif_CvarName(Notification notif)
818 if(!notif.nent_teamnum)
819 return notif.nent_name;
820 return substring(notif.nent_name, 0, -strlen(Static_Team_ColorName(notif.nent_teamnum)) - 2);
823 Notification Get_Notif_Ent(MSG net_type, int net_name)
825 Notification it = REGISTRY_GET(Notifications, net_name);
826 if (it.nent_type != net_type) {
827 LOG_WARNF("Get_Notif_Ent(%s (%d), %s (%d)): Improper net type '%s'!",
828 Get_Notif_TypeName(net_type), net_type,
829 it.registered_id, net_name,
830 Get_Notif_TypeName(it.nent_type)
837 #define MSG_ANNCE_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, sound, channel, volume, position, queuetime) \
838 MSG_ANNCE_NOTIF_(teamnum, ANNCE_##name, ANNCE_##cvarname, defaultvalue, sound, channel, volume, position, queuetime)
840 #define MSG_ANNCE_NOTIF(name, defaultvalue, sound, channel, volume, position, queuetime) \
841 NOTIF_ADD_AUTOCVAR(ANNCE_##name, defaultvalue) \
842 MSG_ANNCE_NOTIF_(0, ANNCE_##name, ANNCE_##name, defaultvalue, sound, channel, volume, position, queuetime)
844 #define MSG_ANNCE_NOTIF_(teamnum, name, cvarname, defaultvalue, sound, channel, volume, position, queuetime) \
845 REGISTER(Notifications, name, m_id, new_pure(msg_annce_notification)) { \
846 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_ANNCE, strtoupper(#name), teamnum); \
847 Create_Notification_Entity_Annce(this, ACVNN(cvarname), strtoupper(#name), \
848 channel, /* channel */ \
851 position, /* position */ \
852 queuetime); /* queuetime */ \
855 #define MSG_INFO_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
856 MSG_INFO_NOTIF_(teamnum, INFO_##name, INFO_##cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle)
858 #define MSG_INFO_NOTIF(name, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
859 NOTIF_ADD_AUTOCVAR(INFO_##name, defaultvalue) \
860 MSG_INFO_NOTIF_(0, INFO_##name, INFO_##name, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle)
862 #define MSG_INFO_NOTIF_(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
863 REGISTER(Notifications, name, m_id, new_pure(msg_info_notification)) { \
864 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_INFO, strtoupper(#name), teamnum); \
865 Create_Notification_Entity_InfoCenter(this, ACVNN(cvarname), strtoupper(#name), strnum, flnum, \
867 hudargs, /* hudargs */ \
869 CPID_Null,/* cpid */ \
871 normal, /* normal */ \
872 gentle); /* gentle */ \
875 .string nent_iconargs;
876 #define MULTIICON_INFO(name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle) \
877 MULTIICON_INFO_(INFO_##name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle)
878 #define MULTIICON_INFO_(name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle) \
879 NOTIF_ADD_AUTOCVAR(name, defaultvalue) \
880 REGISTER(Notifications, name, m_id, new_pure(msg_info_notification)) { \
881 Create_Notification_Entity (this, defaultvalue, ACVNN(name), MSG_INFO, strtoupper(#name), 0); \
882 Create_Notification_Entity_InfoCenter(this, ACVNN(name), strtoupper(#name), strnum, flnum, \
884 hudargs, /* hudargs */ \
886 CPID_Null,/* cpid */ \
888 normal, /* normal */ \
889 gentle); /* gentle */ \
890 this.nent_iconargs = iconargs; \
893 #define MSG_CENTER_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
894 MSG_CENTER_NOTIF_(teamnum, CENTER_##name, CENTER_##cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle)
896 #define MSG_CENTER_NOTIF(name, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
897 NOTIF_ADD_AUTOCVAR(CENTER_##name, defaultvalue) \
898 MSG_CENTER_NOTIF_(0, CENTER_##name, CENTER_##name, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle)
900 #define MSG_CENTER_NOTIF_(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
901 REGISTER(Notifications, name, m_id, new_pure(msg_center_notification)) { \
902 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_CENTER, strtoupper(#name), teamnum); \
903 Create_Notification_Entity_InfoCenter(this, ACVNN(cvarname), strtoupper(#name), strnum, flnum, \
908 durcnt, /* durcnt */ \
909 normal, /* normal */ \
910 gentle); /* gentle */ \
913 #define MSG_MULTI_NOTIF(name, defaultvalue, anncename, infoname, centername) \
914 NOTIF_ADD_AUTOCVAR(name, defaultvalue) \
915 REGISTER(Notifications, name, m_id, new_pure(msg_multi_notification)) { \
916 Create_Notification_Entity (this, defaultvalue, ACVNN(name), MSG_MULTI, strtoupper(#name), 0); \
917 Create_Notification_Entity_Multi(this, ACVNN(name), strtoupper(#name), \
918 anncename, /* anncename */ \
919 infoname, /* infoname */ \
920 centername); /* centername */ \
923 #define MSG_CHOICE_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, challow, chtype, optiona, optionb) \
924 MSG_CHOICE_NOTIF_(teamnum, CHOICE_##name, CHOICE_##cvarname, defaultvalue, challow, chtype, optiona, optionb)
926 #define MSG_CHOICE_NOTIF(name, defaultvalue, challow, chtype, optiona, optionb) \
927 NOTIF_ADD_AUTOCVAR(CHOICE_##name, defaultvalue) \
928 NOTIF_ADD_AUTOCVAR(CHOICE_##name##_ALLOWED, challow) \
929 MSG_CHOICE_NOTIF_(0, CHOICE_##name, CHOICE_##name, defaultvalue, challow, chtype, optiona, optionb)
931 #define MSG_CHOICE_NOTIF_(teamnum, name, cvarname, defaultvalue, challow, chtype, optiona, optionb) \
932 REGISTER(Notifications, name, m_id, new_pure(msg_choice_notification)) { \
933 this.nent_choice_idx = nent_choice_count; \
934 if (!teamnum || teamnum == NUM_TEAM_4) \
935 nent_choice_count++; \
936 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_CHOICE, strtoupper(#name), teamnum); \
937 Create_Notification_Entity_Choice(this, ACVNN(cvarname), strtoupper(#name), \
938 challow, /* challow_def */ \
939 autocvar_notification_##cvarname##_ALLOWED, /* challow_var */ \
940 chtype, /* chtype */ \
941 optiona, /* optiona */ \
942 optionb); /* optionb */ \
945 #define MSG_MEDAL_NOTIF(name, defaultvalue, icon, anncename) \
946 NOTIF_ADD_AUTOCVAR(MEDAL_##name, defaultvalue) \
947 MSG_MEDAL_NOTIF_(0, MEDAL_##name, MEDAL_##name, defaultvalue, icon, anncename)
949 #define MSG_MEDAL_NOTIF_(teamnum, name, cvarname, defaultvalue, icon, anncename) \
950 REGISTER(Notifications, name, m_id, new_pure(msg_medal_notification)) { \
951 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_MEDAL, strtoupper(#name), teamnum); \
952 Create_Notification_Entity_Medal(this, ACVNN(cvarname), strtoupper(#name), \
957 REGISTRY_BEGIN(Notifications)
959 notif_global_error = false;
962 REGISTRY_END(Notifications)
964 if (!notif_global_error) return;
965 // shit happened... stop the loading of the program now if this is unacceptable
966 if (autocvar_notification_errors_are_fatal)
967 LOG_FATAL("Notification initialization failed! Read above and fix the errors!");
969 LOG_SEVERE("Notification initialization failed! Read above and fix the errors!");
974 void ReplicateVars(bool would_destroy)
977 FOREACH(Notifications, it.nent_type == MSG_CHOICE && (!it.nent_teamnum || it.nent_teamnum == NUM_TEAM_1), {
978 string cvarname = strcat("notification_", Get_Notif_CvarName(it));
979 // NOTE: REPLICATE_SIMPLE can return;
980 REPLICATE_SIMPLE(it.cvar_value, cvarname);