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";
40 LOG_WARNF("Get_Notif_TypeName(%d): Improper net type!", ORDINAL(net_type));
45 CASE(CPID, ASSAULT_ROLE)
48 CASE(CPID, CTF_CAPSHIELD)
49 CASE(CPID, CTF_LOWPRIO)
55 CASE(CPID, PREVENT_JOIN)
57 CASE(CPID, KEEPAWAY_WARN)
59 CASE(CPID, KEYHUNT_OTHER)
61 CASE(CPID, MISSING_TEAMS)
62 CASE(CPID, MISSING_PLAYERS)
63 CASE(CPID, INSTAGIB_FINDAMMO)
64 CASE(CPID, CAMPAIGN_MESSAGE)
68 CASE(CPID, ONS_CAPSHIELD)
71 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,
129 void Create_Notification_Entity_InfoCenter(entity notif,
134 /* MSG_INFO & MSG_CENTER */
143 void Create_Notification_Entity_Multi(entity notif,
147 Notification anncename,
148 Notification infoname,
149 Notification centername);
151 void Create_Notification_Entity_Choice(entity notif,
158 Notification optiona,
159 Notification optionb);
161 void Dump_Notifications(int fh, bool alsoprint);
163 GENERIC_COMMAND(dumpnotifs, "Dump all notifications into notifications_dump.txt", false)
167 case CMD_REQUEST_COMMAND:
170 string filename = argv(1);
171 bool alsoprint = false;
174 filename = "notifications_dump.cfg";
177 else if (filename == "-")
179 filename = "notifications_dump.cfg";
182 int fh = fopen(filename, FILE_WRITE);
185 Dump_Notifications(fh, alsoprint);
186 LOG_INFOF("Dumping notifications... File located in ^2data/data/%s^7.", filename);
191 LOG_INFOF("^1Error: ^7Could not open file '%s'!", filename);
194 LOG_INFO(_("Notification dump command only works with cl_cmd and sv_cmd."));
199 case CMD_REQUEST_USAGE:
201 LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " dumpnotifs [filename]");
202 LOG_HELP(" Where 'filename' is the file to write (default is notifications_dump.cfg),");
203 LOG_HELP(" if supplied with '-' output to console as well as default,");
204 LOG_HELP(" if left blank, it will only write to default.");
210 #ifdef NOTIFICATIONS_DEBUG
211 bool autocvar_notification_debug = false;
212 void Debug_Notification(string input)
214 switch (autocvar_notification_debug)
216 case 1: { LOG_TRACE(input); break; }
217 case 2: { LOG_INFO(input); break; }
222 void Local_Notification(MSG net_type, Notification net_name, ...count);
223 /** glue for networking, forwards to `Local_Notification` */
224 void Local_Notification_WOVA(
225 MSG net_type, Notification net_name,
226 float stringcount, float floatcount,
227 string s1, string s2, string s3, string s4,
228 float f1, float f2, float f3, float f4);
231 string prev_soundfile;
232 float prev_soundtime;
236 IntrusiveList g_notifications;
237 STATIC_INIT(g_notifications) { g_notifications = IL_NEW(); }
242 /** send to one client and their spectators */
244 /** send ONLY to one client */
245 CASE(NOTIF, ONE_ONLY)
246 /** send only to X team and their spectators */
248 /** send only to X team and their spectators, except for Y person and their spectators */
249 CASE(NOTIF, TEAM_EXCEPT)
250 /** send to everyone */
252 /** send to everyone except X person and their spectators */
253 CASE(NOTIF, ALL_EXCEPT)
256 string Get_Notif_BroadcastName(NOTIF broadcast)
260 case NOTIF_ONE: return "NOTIF_ONE";
261 case NOTIF_ONE_ONLY: return "NOTIF_ONE_ONLY";
262 case NOTIF_ALL_EXCEPT: return "NOTIF_ALL_EXCEPT";
263 case NOTIF_ALL: return "NOTIF_ALL";
264 case NOTIF_TEAM: return "NOTIF_TEAM";
265 case NOTIF_TEAM_EXCEPT: return "NOTIF_TEAM_EXCEPT";
267 LOG_WARNF("Get_Notif_BroadcastName(%d): Improper broadcast!", broadcast);
271 void Kill_Notification(
272 NOTIF broadcast, entity client,
273 MSG net_type, CPID net_name);
274 void Send_Notification(
275 NOTIF broadcast, entity client,
276 MSG net_type, Notification net_name,
278 void Send_Notification_WOVA(
279 NOTIF broadcast, entity client,
280 MSG net_type, Notification net_name,
281 float stringcount, float floatcount,
282 string s1, string s2, string s3, string s4,
283 float f1, float f2, float f3, float f4);
284 void Send_Notification_WOCOVA(
285 NOTIF broadcast, entity client,
286 MSG net_type, Notification net_name,
287 string s1, string s2, string s3, string s4,
288 float f1, float f2, float f3, float f4);
291 // ===========================
292 // Special CVAR Declarations
293 // ===========================
295 // MAKE SURE THIS IS ALWAYS SYNCHRONIZED WITH THE DUMP
296 // NOTIFICATIONS FUNCTION IN THE .QC FILE!
298 #define NOTIF_ADD_AUTOCVAR(name,defaultvalue) float autocvar_notification_##name = defaultvalue;
300 float autocvar_notification_show_location = false;
301 string autocvar_notification_show_location_string = ""; //_(" at the %s");
302 float autocvar_notification_show_sprees = true;
303 float autocvar_notification_show_sprees_info = 3; // 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker
304 float autocvar_notification_show_sprees_info_newline = true;
305 float autocvar_notification_show_sprees_info_specialonly = true;
306 float autocvar_notification_errors_are_fatal = true;
308 float autocvar_notification_lifetime_runtime = 0.5;
309 float autocvar_notification_lifetime_mapload = 10;
313 void Notification_GetCvars(entity this, entity store);
314 float autocvar_notification_server_allows_location = 1; // 0 = no, 1 = yes
316 float autocvar_notification_item_centerprinttime = 1.5;
318 // 0 = no, 1 = yes, 2 = forced on for all MSG_INFO notifs
319 // DISABLED IN CODE, BUT ENABLED IN CONFIG FOR COMPATIBILITY WITH OLD CLIENTS
320 float autocvar_notification_allow_chatboxprint = 0;
322 float autocvar_notification_show_sprees_center = true;
323 float autocvar_notification_show_sprees_center_specialonly = true;
327 // ============================
328 // Notification Argument List
329 // ============================
331 These arguments get replaced with the Local_Notification_sprintf
332 and other such functions found in all.qc to supply data
333 from networked notifications to their usage in sprintf... It
334 allows for more dynamic data to be inferred by the local
335 notification parser, so that the server does not have to network
336 anything too crazy on a per-client/per-situation basis.
338 Pay attention to the CSQC/SVQC relations, some of these are redefined
339 in slightly different ways for different programs, this is because the
340 server does a more conservative approach to the notifs than the client.
342 All arguments are swapped into strings, so be sure that your
343 sprintf usage matches with proper %s placement.
345 Argument descriptions:
346 s1-s4: string arguments to be literally swapped into sprintf
347 s2loc: s2 string of locations of deaths or other events
348 s3loc: s3 string of locations of deaths or other events
349 f1-f4: float arguments expanded into strings to be swapped into sprintf
350 f1p2dec: f1 float to string with 2 decimal places
351 f2p2dec: f2 float to string with 2 decimal places
352 f2primsec: f2 float primary or secondary selection for weapons
353 f3primsec: f3 float primary or secondary selection for weapons
354 f1secs: count_seconds of f1
355 f1points: point or points depending on f1
356 f1ord: count_ordinal of f1
357 f1time: process_time of f1
358 f1race_time: mmssss of f1
359 f2race_time: mmssss of f2
360 race_col: color of race time/position (i.e. good or bad)
361 race_diff: show time difference between f2 and f3
362 missing_teams: show which teams still need players
363 pass_key: find the keybind for "passing" or "dropping" in CTF game mode
364 nade_key: find the keybind for nade throwing
365 frag_ping: show the ping of a player
366 frag_stats: show health/armor/ping of a player
367 frag_pos: show score status and position in the match of a player
368 spree_cen: centerprint notif for kill spree/how many kills they have
369 spree_inf: info notif for kill spree/how many kills they have
370 spree_end: placed at the end of murder messages to show ending of sprees
371 spree_lost: placed at the end of suicide messages to show losing of sprees
372 item_wepname: return full name of a weapon from weaponid
373 item_wepammo: ammo display for weapon from f1 and f2
374 item_centime: amount of time to display weapon message in centerprint
375 item_buffname: return full name of a buff from buffid
376 death_team: show the full name of the team a player is switching from
377 minigame1_name: return human readable name of a minigame from its id(s1)
378 minigame1_d: return descriptor name of a minigame from its id(s1)
381 const float NOTIF_MAX_ARGS = 7;
382 const float NOTIF_MAX_HUDARGS = 2;
383 const float NOTIF_MAX_DURCNT = 2;
385 string arg_slot[NOTIF_MAX_ARGS];
387 const float ARG_CS_SV_HA = 1; // enabled on CSQC, SVQC, and Hudargs
388 const float ARG_CS_SV_DC = 2; // enabled on CSQC, SVQC, and durcnt centerprint
389 const float ARG_CS_SV = 3; // enabled on CSQC and SVQC
390 const float ARG_CS = 4; // unique result to CSQC
391 const float ARG_SV = 5; // unique result to SVQC
392 const float ARG_DC = 6; // unique result to durcnt/centerprint
394 // todo possible idea.... declare how many floats/strings each arg needs, and then dynamically increment the input
395 // this way, we don't need to have duplicates like i.e. s2loc and s3loc?
397 string BUFF_NAME(int i);
399 #define NOTIF_ARGUMENT_LIST \
400 ARG_CASE(ARG_CS_SV_HA, "s1", s1) \
401 ARG_CASE(ARG_CS_SV_HA, "s2", s2) \
402 ARG_CASE(ARG_CS_SV_HA, "s3", s3) \
403 ARG_CASE(ARG_CS_SV_HA, "s4", s4) \
404 ARG_CASE(ARG_CS_SV, "s2loc", ((autocvar_notification_show_location && (s2 != "")) ? sprintf(( ((tmp_s = autocvar_notification_show_location_string) != "") ? tmp_s : _(" (near %s)") ), s2) : "")) \
405 ARG_CASE(ARG_CS_SV, "s3loc", ((autocvar_notification_show_location && (s3 != "")) ? sprintf(( ((tmp_s = autocvar_notification_show_location_string) != "") ? tmp_s : _(" (near %s)") ), s3) : "")) \
406 ARG_CASE(ARG_CS_SV_DC, "f1", ftos(f1)) \
407 ARG_CASE(ARG_CS_SV_DC, "f2", ftos(f2)) \
408 ARG_CASE(ARG_CS_SV, "f3", ftos(f3)) \
409 ARG_CASE(ARG_CS_SV, "f4", ftos(f4)) \
410 ARG_CASE(ARG_CS_SV, "f1dtime", ftos_decimals(TIME_DECODE(f1), 2)) \
411 ARG_CASE(ARG_CS_SV, "f2dtime", ftos_decimals(TIME_DECODE(f2), 2)) \
412 ARG_CASE(ARG_CS, "f2primsec", (f2 ? _("secondary") : _("primary"))) \
413 ARG_CASE(ARG_CS, "f3primsec", (f3 ? _("secondary") : _("primary"))) \
414 ARG_CASE(ARG_CS, "f1secs", count_seconds(f1)) \
415 ARG_CASE(ARG_CS, "f1points", (f1 == 1 ? _("point") : _("points"))) \
416 ARG_CASE(ARG_CS_SV, "f1ord", count_ordinal(f1)) \
417 ARG_CASE(ARG_CS_SV, "f1time", process_time(2, f1)) \
418 ARG_CASE(ARG_CS_SV_HA, "f1race_time", mmssss(f1)) \
419 ARG_CASE(ARG_CS_SV_HA, "f2race_time", mmssss(f2)) \
420 ARG_CASE(ARG_CS_SV_HA, "f3race_time", mmssss(f3)) \
421 ARG_CASE(ARG_CS_SV, "race_col", CCR(((f1 == 1) ? "^F1" : "^F2"))) \
422 ARG_CASE(ARG_CS_SV, "race_diff", ((f2 > f3) ? sprintf(CCR("^1[+%s]"), mmssss(f2 - f3)) : sprintf(CCR("^2[-%s]"), mmssss(f3 - f2)))) \
423 ARG_CASE(ARG_CS, "missing_teams", notif_arg_missing_teams(f1)) \
424 ARG_CASE(ARG_CS, "pass_key", getcommandkey(_("drop flag"), "+use")) \
425 ARG_CASE(ARG_CS, "nade_key", getcommandkey(_("throw nade"), "dropweapon")) \
426 ARG_CASE(ARG_CS, "join_key", getcommandkey(_("jump"), "+jump")) \
427 ARG_CASE(ARG_CS, "frag_ping", notif_arg_frag_ping(true, f2)) \
428 ARG_CASE(ARG_CS, "frag_stats", notif_arg_frag_stats(f2, f3, f4)) \
429 /*ARG_CASE(ARG_CS, "frag_pos", ((Should_Print_Score_Pos(f1)) ? sprintf("\n^BG%s", Read_Score_Pos(f1)) : ""))*/ \
430 ARG_CASE(ARG_CS, "spree_cen", (autocvar_notification_show_sprees ? notif_arg_spree_cen(f1) : "")) \
431 ARG_CASE(ARG_CS_SV, "spree_inf", (autocvar_notification_show_sprees ? notif_arg_spree_inf(1, input, s2, f2) : "")) \
432 ARG_CASE(ARG_CS_SV, "spree_end", (autocvar_notification_show_sprees ? notif_arg_spree_inf(-1, "", "", f1) : "")) \
433 ARG_CASE(ARG_CS_SV, "spree_lost", (autocvar_notification_show_sprees ? notif_arg_spree_inf(-2, "", "", f1) : "")) \
434 ARG_CASE(ARG_CS_SV, "item_wepname", REGISTRY_GET(Weapons, f1).m_name) \
435 ARG_CASE(ARG_CS_SV, "item_buffname", BUFF_NAME(f1)) \
436 ARG_CASE(ARG_CS_SV, "f3buffname", BUFF_NAME(f3)) \
437 ARG_CASE(ARG_CS_SV, "item_wepammo", (f2 > 0 ? notif_arg_item_wepammo(f1, f2) : "")) \
438 ARG_CASE(ARG_DC, "item_centime", ftos(autocvar_notification_item_centerprinttime)) \
439 ARG_CASE(ARG_SV, "death_team", Team_ColoredFullName(f1)) \
440 ARG_CASE(ARG_CS, "death_team", Team_ColoredFullName(f1 - 1)) \
441 ARG_CASE(ARG_CS_SV_HA, "minigame1_name",find(NULL,netname,s1).descriptor.message) \
442 ARG_CASE(ARG_CS_SV_HA, "minigame1_d", find(NULL,netname,s1).descriptor.netname)
444 #define NOTIF_HIT_MAX(count,funcname) MACRO_BEGIN \
445 if(sel_num == count) { backtrace(sprintf("%s: Hit maximum arguments!\n", funcname)); break; } \
448 #define NOTIF_HIT_UNKNOWN(token,funcname) { backtrace(sprintf("%s: Hit unknown token in selected string! '%s'\n", funcname, selected)); break; }
450 #define KILL_SPREE_LIST \
451 SPREE_ITEM(3, 03, _("TRIPLE FRAG! "), _("%s^K1 made a TRIPLE FRAG! %s^BG"), _("%s^K1 made a TRIPLE SCORE! %s^BG")) \
452 SPREE_ITEM(5, 05, _("RAGE! "), _("%s^K1 unlocked RAGE! %s^BG"), _("%s^K1 made FIVE SCORES IN A ROW! %s^BG")) \
453 SPREE_ITEM(10, 10, _("MASSACRE! "), _("%s^K1 started a MASSACRE! %s^BG"), _("%s^K1 made TEN SCORES IN A ROW! %s^BG")) \
454 SPREE_ITEM(15, 15, _("MAYHEM! "), _("%s^K1 executed MAYHEM! %s^BG"), _("%s^K1 made FIFTEEN SCORES IN A ROW! %s^BG")) \
455 SPREE_ITEM(20, 20, _("BERSERKER! "), _("%s^K1 is a BERSERKER! %s^BG"), _("%s^K1 made TWENTY SCORES IN A ROW! %s^BG")) \
456 SPREE_ITEM(25, 25, _("CARNAGE! "), _("%s^K1 inflicts CARNAGE! %s^BG"), _("%s^K1 made TWENTY FIVE SCORES IN A ROW! %s^BG")) \
457 SPREE_ITEM(30, 30, _("ARMAGEDDON! "), _("%s^K1 unleashes ARMAGEDDON! %s^BG"), _("%s^K1 made THIRTY SCORES IN A ROW! %s^BG"))
460 string notif_arg_frag_ping(bool newline, float fping)
462 string s = newline ? "\n" : " ";
464 return sprintf(CCR(_("%s(^F1Bot^BG)")), s);
466 return sprintf(CCR(_("%s(Ping ^F1%d^BG)")), s, fping);
469 string notif_arg_frag_stats(float fhealth, float farmor, float fping)
471 string s = notif_arg_frag_ping(false, fping);
473 return sprintf(CCR(_("\n(Health ^1%d^BG / Armor ^2%d^BG)%s")), fhealth, farmor, s);
475 return sprintf(CCR(_("\n(^F4Dead^BG)%s")), s);
478 string notif_arg_missing_teams(float f1)
481 ((f1 & BIT(0)) ? strcat(Team_ColoredFullName(NUM_TEAM_1), (f1 >> 1) ? ", " : "") : ""),
482 ((f1 & BIT(1)) ? strcat(Team_ColoredFullName(NUM_TEAM_2), (f1 >> 2) ? ", " : "") : ""),
483 ((f1 & BIT(2)) ? strcat(Team_ColoredFullName(NUM_TEAM_3), (f1 >> 3) ? ", " : "") : ""),
484 ((f1 & BIT(3)) ? Team_ColoredFullName(NUM_TEAM_4) : "")
488 string notif_arg_spree_cen(float spree)
490 // 0 = off, 1 = target (but only for first victim) and attacker
491 if(autocvar_notification_show_sprees_center)
495 #define SPREE_ITEM(counta,countb,center,normal,gentle) \
496 case counta: { return normal_or_gentle(center, sprintf(_("%d score spree! "), spree)); }
503 if (!autocvar_notification_show_sprees_center_specialonly)
508 _("%d frag spree! "),
509 _("%d score spree! ")
513 else { return ""; } // don't show spree information if it isn't an achievement
519 else if(spree == -1) // first blood
521 return normal_or_gentle(_("First blood! "), _("First score! "));
523 else if(spree == -2) // first victim
525 return normal_or_gentle(_("First victim! "), _("First casualty! "));
532 string notif_arg_spree_inf(float type, string input, string player, float spree)
536 case 1: // attacker kill spree
538 // 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker
539 // this conditional (& 2) is true for 2 and 3
540 if(autocvar_notification_show_sprees_info & 2)
543 string spree_newline =
544 ( autocvar_notification_show_sprees_info_newline ?
545 ((substring(input, 0, 1) == "\{3}") ? "\n\{3}" : "\n") : "" );
547 string spree_newline =
548 (autocvar_notification_show_sprees_info_newline ? "\n" : "");
553 #define SPREE_ITEM(counta,countb,center,normal,gentle) \
554 case counta: { return sprintf(CCR(normal_or_gentle(normal, gentle)), player, spree_newline); }
561 if (!autocvar_notification_show_sprees_info_specialonly)
565 CCR(normal_or_gentle(
566 _("%s^K1 has %d frags in a row! %s^BG"),
567 _("%s^K1 made %d scores in a row! %s^BG")
574 else { return ""; } // don't show spree information if it isn't an achievement
580 else if(spree == -1) // firstblood
584 CCR(normal_or_gentle(
585 _("%s^K1 drew first blood! %s^BG"),
586 _("%s^K1 got the first score! %s^BG")
596 case -1: // kill spree ended
598 if((spree > 1) && (autocvar_notification_show_sprees_info & 1))
601 sprintf(normal_or_gentle(
602 _(", ending their %d frag spree"),
603 _(", ending their %d score spree")
611 case -2: // kill spree lost
613 if((spree > 1) && (autocvar_notification_show_sprees_info & 1))
616 sprintf(normal_or_gentle(
617 _(", losing their %d frag spree"),
618 _(", losing their %d score spree")
629 string notif_arg_item_wepammo(float f1, float f2)
631 string ammoitems = "";
632 Weapon wep = REGISTRY_GET(Weapons, f1);
633 switch (wep.ammo_type)
635 case RES_SHELLS: ammoitems = ITEM_Shells.m_name; break;
636 case RES_BULLETS: ammoitems = ITEM_Bullets.m_name; break;
637 case RES_ROCKETS: ammoitems = ITEM_Rockets.m_name; break;
638 case RES_CELLS: ammoitems = ITEM_Cells.m_name; break;
639 case RES_PLASMA: ammoitems = ITEM_Plasma.m_name; break;
640 case RES_FUEL: ammoitems = ITEM_JetpackFuel.m_name; break;
641 default: return ""; // doesn't use ammo
643 return sprintf(_(" with %d %s"), f2, ammoitems);
647 // ====================================
648 // Initialization/Create Declarations
649 // ====================================
651 // common notification entity values
656 .int nent_stringcount;
657 .int nent_floatcount;
660 // MSG_ANNCE entity values
664 .float nent_position;
666 // MSG_INFO and MSG_CENTER entity values
667 .string nent_args; // used by both
668 .string nent_hudargs; // used by info
669 .string nent_icon; // used by info
670 .CPID nent_cpid; // used by center
671 .string nent_durcnt; // used by center
672 .string nent_string; // used by both
674 // MSG_MULTI entity values
675 .entity nent_msgannce;
676 .entity nent_msginfo;
677 .entity nent_msgcenter;
679 // MSG_CHOICE entity values
680 .float nent_challow_def;
681 .float nent_challow_var;
682 .entity nent_optiona;
683 .entity nent_optionb;
685 // networked notification entity values
687 .NOTIF nent_broadcast;
691 .float nent_net_name;
692 .string nent_strings[4];
693 .float nent_floats[4];
695 #define ACVNN(name) autocvar_notification_##name
697 REGISTRY(Notifications, BITS(11))
698 REGISTER_REGISTRY(Notifications)
699 REGISTRY_SORT(Notifications);
701 REGISTRY_DEFINE_GET(Notifications, NULL)
702 STATIC_INIT(Notifications) { FOREACH(Notifications, true, it.m_id = i); }
703 REGISTRY_CHECK(Notifications)
705 const int NOTIF_CHOICE_MAX = 20;
706 // NOTE: a team choice is actually made of 4 choices (one per team) with the same nent_choice_idx
707 // thus they are counted as 1 in nent_choice_count
708 int nent_choice_count = 0;
709 .int nent_choice_idx;
710 .int msg_choice_choices[NOTIF_CHOICE_MAX]; // set on each player containing MSG_CHOICE choices
711 // initialization error detection
713 bool notif_global_error;
715 STATIC_INIT_LATE(Notif_Choices)
717 if (nent_choice_count > NOTIF_CHOICE_MAX)
718 LOG_FATALF("Too many MSG_CHOICE notifications (%d), hit NOTIF_CHOICE_MAX (%d) limit",
719 nent_choice_count, NOTIF_CHOICE_MAX);
722 string Get_Notif_CvarName(Notification notif)
724 if(!notif.nent_teamnum)
725 return notif.nent_name;
726 return substring(notif.nent_name, 0, -strlen(Static_Team_ColorName(notif.nent_teamnum)) - 2);
729 Notification Get_Notif_Ent(MSG net_type, int net_name)
731 Notification it = REGISTRY_GET(Notifications, net_name);
732 if (it.nent_type != net_type) {
733 LOG_WARNF("Get_Notif_Ent(%s (%d), %s (%d)): Improper net type '%s'!",
734 Get_Notif_TypeName(net_type), net_type,
735 it.registered_id, net_name,
736 Get_Notif_TypeName(it.nent_type)
743 #define MSG_ANNCE_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, sound, channel, volume, position) \
744 MSG_ANNCE_NOTIF_(teamnum, ANNCE_##name, ANNCE_##cvarname, defaultvalue, sound, channel, volume, position)
746 #define MSG_ANNCE_NOTIF(name, defaultvalue, sound, channel, volume, position) \
747 NOTIF_ADD_AUTOCVAR(ANNCE_##name, defaultvalue) \
748 MSG_ANNCE_NOTIF_(0, ANNCE_##name, ANNCE_##name, defaultvalue, sound, channel, volume, position)
750 #define MSG_ANNCE_NOTIF_(teamnum, name, cvarname, defaultvalue, sound, channel, volume, position) \
751 REGISTER(Notifications, name, m_id, new_pure(msg_annce_notification)) { \
752 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_ANNCE, strtoupper(#name), teamnum); \
753 Create_Notification_Entity_Annce(this, ACVNN(cvarname), strtoupper(#name), \
754 channel, /* channel */ \
757 position); /* position */ \
760 #define MSG_INFO_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
761 MSG_INFO_NOTIF_(teamnum, INFO_##name, INFO_##cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle)
763 #define MSG_INFO_NOTIF(name, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
764 NOTIF_ADD_AUTOCVAR(INFO_##name, defaultvalue) \
765 MSG_INFO_NOTIF_(0, INFO_##name, INFO_##name, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle)
767 #define MSG_INFO_NOTIF_(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
768 REGISTER(Notifications, name, m_id, new_pure(msg_info_notification)) { \
769 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_INFO, strtoupper(#name), teamnum); \
770 Create_Notification_Entity_InfoCenter(this, ACVNN(cvarname), strtoupper(#name), strnum, flnum, \
772 hudargs, /* hudargs */ \
774 CPID_Null,/* cpid */ \
776 normal, /* normal */ \
777 gentle); /* gentle */ \
780 .string nent_iconargs;
781 #define MULTIICON_INFO(name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle) \
782 MULTIICON_INFO_(INFO_##name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle)
783 #define MULTIICON_INFO_(name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle) \
784 NOTIF_ADD_AUTOCVAR(name, defaultvalue) \
785 REGISTER(Notifications, name, m_id, new_pure(msg_info_notification)) { \
786 Create_Notification_Entity (this, defaultvalue, ACVNN(name), MSG_INFO, strtoupper(#name), 0); \
787 Create_Notification_Entity_InfoCenter(this, ACVNN(name), strtoupper(#name), strnum, flnum, \
789 hudargs, /* hudargs */ \
791 CPID_Null,/* cpid */ \
793 normal, /* normal */ \
794 gentle); /* gentle */ \
795 this.nent_iconargs = iconargs; \
798 #define MSG_CENTER_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
799 MSG_CENTER_NOTIF_(teamnum, CENTER_##name, CENTER_##cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle)
801 #define MSG_CENTER_NOTIF(name, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
802 NOTIF_ADD_AUTOCVAR(CENTER_##name, defaultvalue) \
803 MSG_CENTER_NOTIF_(0, CENTER_##name, CENTER_##name, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle)
805 #define MSG_CENTER_NOTIF_(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
806 REGISTER(Notifications, name, m_id, new_pure(msg_center_notification)) { \
807 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_CENTER, strtoupper(#name), teamnum); \
808 Create_Notification_Entity_InfoCenter(this, ACVNN(cvarname), strtoupper(#name), strnum, flnum, \
813 durcnt, /* durcnt */ \
814 normal, /* normal */ \
815 gentle); /* gentle */ \
818 #define MSG_MULTI_NOTIF(name, defaultvalue, anncename, infoname, centername) \
819 NOTIF_ADD_AUTOCVAR(name, defaultvalue) \
820 REGISTER(Notifications, name, m_id, new_pure(msg_multi_notification)) { \
821 Create_Notification_Entity (this, defaultvalue, ACVNN(name), MSG_MULTI, strtoupper(#name), 0); \
822 Create_Notification_Entity_Multi(this, ACVNN(name), strtoupper(#name), \
823 anncename, /* anncename */ \
824 infoname, /* infoname */ \
825 centername); /* centername */ \
828 #define MSG_CHOICE_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, challow, chtype, optiona, optionb) \
829 MSG_CHOICE_NOTIF_(teamnum, CHOICE_##name, CHOICE_##cvarname, defaultvalue, challow, chtype, optiona, optionb)
831 #define MSG_CHOICE_NOTIF(name, defaultvalue, challow, chtype, optiona, optionb) \
832 NOTIF_ADD_AUTOCVAR(CHOICE_##name, defaultvalue) \
833 NOTIF_ADD_AUTOCVAR(CHOICE_##name##_ALLOWED, challow) \
834 MSG_CHOICE_NOTIF_(0, CHOICE_##name, CHOICE_##name, defaultvalue, challow, chtype, optiona, optionb)
836 #define MSG_CHOICE_NOTIF_(teamnum, name, cvarname, defaultvalue, challow, chtype, optiona, optionb) \
837 REGISTER(Notifications, name, m_id, new_pure(msg_choice_notification)) { \
838 this.nent_choice_idx = nent_choice_count; \
839 if (!teamnum || teamnum == NUM_TEAM_4) \
840 nent_choice_count++; \
841 Create_Notification_Entity (this, defaultvalue, ACVNN(cvarname), MSG_CHOICE, strtoupper(#name), teamnum); \
842 Create_Notification_Entity_Choice(this, ACVNN(cvarname), strtoupper(#name), \
843 challow, /* challow_def */ \
844 autocvar_notification_##cvarname##_ALLOWED, /* challow_var */ \
845 chtype, /* chtype */ \
846 optiona, /* optiona */ \
847 optionb); /* optionb */ \
850 REGISTRY_BEGIN(Notifications)
852 notif_global_error = false;
855 REGISTRY_END(Notifications)
857 if (!notif_global_error) return;
858 // shit happened... stop the loading of the program now if this is unacceptable
859 if (autocvar_notification_errors_are_fatal)
860 LOG_FATAL("Notification initialization failed! Read above and fix the errors!");
862 LOG_SEVERE("Notification initialization failed! Read above and fix the errors!");
867 void ReplicateVars(bool would_destroy)
870 FOREACH(Notifications, it.nent_type == MSG_CHOICE && (!it.nent_teamnum || it.nent_teamnum == NUM_TEAM_1), {
871 string cvarname = strcat("notification_", Get_Notif_CvarName(it));
872 // NOTE: REPLICATE_SIMPLE can return;
873 REPLICATE_SIMPLE(it.cvar_value, cvarname);