]> git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - qcsrc/common/notifications/all.qh
Merge branch 'master' into z411/bai-server
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / notifications / all.qh
1 #pragma once
2
3 #include <common/command/_mod.qh>
4
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>
10
11 // Operator for bold notifications
12 #define BOLD_OPERATOR "^BOLD"
13
14 /** main types/groups of notifications */
15 ENUMCLASS(MSG)
16         /** "Global" AND "personal" announcer messages */
17         CASE(MSG, ANNCE)
18         /** "Global" information messages */
19         CASE(MSG, INFO)
20         /** "Personal" centerprint messages */
21         CASE(MSG, CENTER)
22         /** Subcall MSG_INFO and/or MSG_CENTER notifications */
23         CASE(MSG, MULTI)
24         /** Choose which subcall wrapper to activate */
25         CASE(MSG, CHOICE)
26         /** Kill centerprint message @deprecated */
27         CASE(MSG, CENTER_KILL)
28         /** Medal notification */
29         CASE(MSG, MEDAL)
30 ENUMCLASS_END(MSG)
31
32 string Get_Notif_TypeName(MSG net_type)
33 {
34         switch (net_type)
35         {
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";
42         }
43         LOG_WARNF("Get_Notif_TypeName(%d): Improper net type!", ORDINAL(net_type));
44         return "";
45 }
46
47 ENUMCLASS(CPID)
48         CASE(CPID, ASSAULT_ROLE)
49         CASE(CPID, ROUND)
50         CASE(CPID, CAMPCHECK)
51         CASE(CPID, CTF_CAPSHIELD)
52         CASE(CPID, CTF_LOWPRIO)
53         CASE(CPID, CTF_PASS)
54         CASE(CPID, STALEMATE)
55         CASE(CPID, NADES)
56         CASE(CPID, IDLING)
57         CASE(CPID, ITEM)
58         CASE(CPID, PREVENT_JOIN)
59         CASE(CPID, KEEPAWAY)
60         CASE(CPID, KEEPAWAY_WARN)
61         CASE(CPID, KEYHUNT)
62         CASE(CPID, KEYHUNT_OTHER)
63         CASE(CPID, LMS)
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)
69         CASE(CPID, MOTD)
70         CASE(CPID, NIX)
71         CASE(CPID, ONSLAUGHT)
72         CASE(CPID, ONS_CAPSHIELD)
73         CASE(CPID, OVERTIME)
74         CASE(CPID, POWERUP)
75         CASE(CPID, RACE_FINISHLAP)
76         CASE(CPID, TEAMCHANGE)
77         CASE(CPID, TIMEOUT)
78         CASE(CPID, TIMEIN)
79         CASE(CPID, VEHICLES)
80         CASE(CPID, VEHICLES_OTHER)
81         /** always last */
82         CASE(CPID, LAST)
83 ENUMCLASS_END(CPID)
84
85 USING(Notification, entity);
86
87 // used for notification system multi-team identifiers
88 #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)))
89 #define APP_NUM(num, prefix) ((num) ? APP_TEAM_NUM(num, prefix) : prefix##_NEUTRAL)
90
91 #define EIGHT_VARS_TO_VARARGS_VARLIST \
92         VARITEM(1, 0, s1) \
93         VARITEM(2, 0, XPD(s1, s2)) \
94         VARITEM(3, 0, XPD(s1, s2, s3)) \
95         VARITEM(4, 0, XPD(s1, s2, s3, s4)) \
96         VARITEM(0, 1, f1) \
97         VARITEM(1, 1, XPD(s1, f1)) \
98         VARITEM(2, 1, XPD(s1, s2, f1)) \
99         VARITEM(3, 1, XPD(s1, s2, s3, f1)) \
100         VARITEM(4, 1, XPD(s1, s2, s3, s4, f1)) \
101         VARITEM(0, 2, XPD(f1, f2)) \
102         VARITEM(1, 2, XPD(s1, f1, f2)) \
103         VARITEM(2, 2, XPD(s1, s2, f1, f2)) \
104         VARITEM(3, 2, XPD(s1, s2, s3, f1, f2)) \
105         VARITEM(4, 2, XPD(s1, s2, s3, s4, f1, f2)) \
106         VARITEM(0, 3, XPD(f1, f2, f3)) \
107         VARITEM(1, 3, XPD(s1, f1, f2, f3)) \
108         VARITEM(2, 3, XPD(s1, s2, f1, f2, f3)) \
109         VARITEM(3, 3, XPD(s1, s2, s3, f1, f2, f3)) \
110         VARITEM(4, 3, XPD(s1, s2, s3, s4, f1, f2, f3)) \
111         VARITEM(0, 4, XPD(f1, f2, f3, f4)) \
112         VARITEM(1, 4, XPD(s1, f1, f2, f3, f4)) \
113         VARITEM(2, 4, XPD(s1, s2, f1, f2, f3, f4)) \
114         VARITEM(3, 4, XPD(s1, s2, s3, f1, f2, f3, f4)) \
115         VARITEM(4, 4, XPD(s1, s2, s3, s4, f1, f2, f3, f4))
116
117 void Destroy_All_Notifications();
118 void Create_Notification_Entity(entity notif,
119         float var_default,
120         float var_cvar,
121         MSG typeId,
122         string namestring,
123         int teamnum);
124 void Create_Notification_Entity_Annce(entity notif,
125                                                                                 float var_cvar,
126                                                                                 string namestring,
127                                                                                 /* MSG_ANNCE */
128                                                                                 float channel,
129                                                                                 string snd,
130                                                                                 float vol,
131                                                                                 float position,
132                                                                                 float queuetime);
133
134 void Create_Notification_Entity_InfoCenter(entity notif,
135                                                                                         float var_cvar,
136                                                                                         string namestring,
137                                                                                         int strnum,
138                                                                                         int flnum,
139                                                                                         /* MSG_INFO & MSG_CENTER */
140                                                                                         string args,
141                                                                                         string hudargs,
142                                                                                         string icon,
143                                                                                         CPID cpid,
144                                                                                         string durcnt,
145                                                                                         string normal,
146                                                                                         string gentle);
147
148 void Create_Notification_Entity_Multi(entity notif,
149                                                                                 float var_cvar,
150                                                                                 string namestring,
151                                                                                 /* MSG_MULTI */
152                                                                                 Notification anncename,
153                                                                                 Notification infoname,
154                                                                                 Notification centername);
155
156 void Create_Notification_Entity_Choice(entity notif,
157                                                                                 float var_cvar,
158                                                                                 string namestring,
159                                                                                 /* MSG_CHOICE */
160                                                                                 float challow_def,
161                                                                                 float challow_var,
162                                                                                 MSG chtype,
163                                                                                 Notification optiona,
164                                                                                 Notification optionb);
165
166 void Create_Notification_Entity_Medal(entity notif,
167                                                                                 float var_cvar,
168                                                                                 string namestring,
169                                                                                 /* MSG_MEDAL */
170                                                                                 string icon,
171                                                                                 Notification anncename);
172
173 void Dump_Notifications(int fh, bool alsoprint);
174
175 #define DEFAULT_FILENAME "notifications_dump.cfg"
176 // NOTE: dumpeffectinfo, dumpnotifs, dumpturrets and dumpweapons use similar code
177 GENERIC_COMMAND(dumpnotifs, "Dump all notifications into " DEFAULT_FILENAME, false)
178 {
179         switch (request)
180         {
181                 case CMD_REQUEST_COMMAND:
182                 {
183                         #ifdef GAMEQC
184                         string filename = argv(1);
185                         bool alsoprint = false;
186                         if (filename == "")
187                         {
188                                 filename = DEFAULT_FILENAME;
189                                 alsoprint = false;
190                         }
191                         else if (filename == "-")
192                         {
193                                 filename = DEFAULT_FILENAME;
194                                 alsoprint = true;
195                         }
196                         int fh = fopen(filename, FILE_WRITE);
197                         if (fh >= 0)
198                         {
199                                 Dump_Notifications(fh, alsoprint);
200                                 LOG_INFOF("Dumping notifications... File located in ^2data/data/%s^7.", filename);
201                                 fclose(fh);
202                         }
203                         else
204                         {
205                                 LOG_INFOF("^1Error: ^7Could not open file '%s'!", filename);
206                         }
207                         #else
208                         LOG_INFO("Notification dump command only works with cl_cmd and sv_cmd.");
209                         #endif
210                         return;
211                 }
212                 default:
213                 case CMD_REQUEST_USAGE:
214                 {
215 <<<<<<< HEAD
216                         LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " dumpnotifs [filename]");
217                         LOG_HELP("  Where 'filename' is the file to write (default is notifications_dump.cfg),");
218 =======
219                         LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " dumpnotifs [<filename>]");
220                         LOG_HELPF("  Where <filename> is the file to write (default is %s),", DEFAULT_FILENAME);
221 >>>>>>> master
222                         LOG_HELP("  if supplied with '-' output to console as well as default,");
223                         LOG_HELP("  if left blank, it will only write to default.");
224                         return;
225                 }
226         }
227 }
228 #undef DEFAULT_FILENAME
229
230 #ifdef NOTIFICATIONS_DEBUG
231 bool autocvar_notification_debug = false;
232 void Debug_Notification(string input)
233 {
234         switch (autocvar_notification_debug)
235         {
236                 case 1: { LOG_TRACE(input); break; }
237                 case 2: { LOG_INFO(input); break; }
238         }
239 }
240 #endif
241
242 void Local_Notification(MSG net_type, Notification net_name, ...count);
243 /** glue for networking, forwards to `Local_Notification` */
244 void Local_Notification_WOVA(
245         MSG net_type, Notification net_name,
246         float stringcount, float floatcount,
247         string s1, string s2, string s3, string s4,
248         float f1, float f2, float f3, float f4);
249
250 #ifdef CSQC
251 string prev_soundfile;
252 float prev_soundtime;
253 #endif
254
255 #ifdef SVQC
256 IntrusiveList g_notifications;
257 STATIC_INIT(g_notifications) { g_notifications = IL_NEW(); }
258 #endif
259
260 #ifdef SVQC
261 ENUMCLASS(NOTIF)
262         /** send to one client and their spectators */
263         CASE(NOTIF, ONE)
264         /** send ONLY to one client */
265         CASE(NOTIF, ONE_ONLY)
266         /** send only to X team and their spectators */
267         CASE(NOTIF, TEAM)
268         /** send only to X team and their spectators, except for Y person and their spectators */
269         CASE(NOTIF, TEAM_EXCEPT)
270         /** send only to X team; don't include spectators */
271         CASE(NOTIF, TEAM_ONLY)
272         /** send to team X team except for Y person; don't include spectators */
273         CASE(NOTIF, TEAM_ONLY_EXCEPT)
274         /** send to everyone */
275         CASE(NOTIF, ALL)
276         /** send to everyone except X person and their spectators */
277         CASE(NOTIF, ALL_EXCEPT)
278         /** send to all spectators **/
279         CASE(NOTIF, ALL_SPEC)
280 ENUMCLASS_END(NOTIF)
281
282 string Get_Notif_BroadcastName(NOTIF broadcast)
283 {
284         switch (broadcast)
285         {
286                 case NOTIF_ONE: return "NOTIF_ONE";
287                 case NOTIF_ONE_ONLY: return "NOTIF_ONE_ONLY";
288                 case NOTIF_ALL_SPEC: return "NOTIF_ALL_SPEC";
289                 case NOTIF_ALL_EXCEPT: return "NOTIF_ALL_EXCEPT";
290                 case NOTIF_ALL: return "NOTIF_ALL";
291                 case NOTIF_TEAM: return "NOTIF_TEAM";
292                 case NOTIF_TEAM_EXCEPT: return "NOTIF_TEAM_EXCEPT";
293                 case NOTIF_TEAM_ONLY: return "NOTIF_TEAM_ONLY";
294                 case NOTIF_TEAM_ONLY_EXCEPT: return "NOTIF_TEAM_ONLY_EXCEPT";
295         }
296         LOG_WARNF("Get_Notif_BroadcastName(%d): Improper broadcast!", broadcast);
297         return "";
298 }
299
300 void Kill_Notification(
301         NOTIF broadcast, entity client,
302         MSG net_type, CPID net_name);
303 void Send_Notification(
304         NOTIF broadcast, entity client,
305         MSG net_type, Notification net_name,
306         ...count);
307 void Send_Notification_WOVA(
308         NOTIF broadcast, entity client,
309         MSG net_type, Notification net_name,
310         float stringcount, float floatcount,
311         string s1, string s2, string s3, string s4,
312         float f1, float f2, float f3, float f4);
313 void Send_Notification_WOCOVA(
314         NOTIF broadcast, entity client,
315         MSG net_type, Notification net_name,
316         string s1, string s2, string s3, string s4,
317         float f1, float f2, float f3, float f4);
318 #endif
319
320 // ===========================
321 //  Special CVAR Declarations
322 // ===========================
323
324 // MAKE SURE THIS IS ALWAYS SYNCHRONIZED WITH THE DUMP
325 // NOTIFICATIONS FUNCTION IN THE .QC FILE!
326
327 #define NOTIF_ADD_AUTOCVAR(name,defaultvalue) float autocvar_notification_##name = defaultvalue;
328
329 float autocvar_notification_show_location = false;
330 string autocvar_notification_show_location_string = ""; //_(" at the %s");
331 float autocvar_notification_show_sprees = true;
332 float autocvar_notification_show_sprees_info = 3; // 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker
333 float autocvar_notification_show_sprees_info_newline = true;
334 float autocvar_notification_show_sprees_info_specialonly = true;
335 float autocvar_notification_errors_are_fatal = true;
336 #ifdef SVQC
337 float autocvar_notification_lifetime_runtime = 0.5;
338 float autocvar_notification_lifetime_mapload = 10;
339 #endif
340
341 #ifdef SVQC
342 void Notification_GetCvars(entity this, entity store);
343 float autocvar_notification_server_allows_location = 1; // 0 = no, 1 = yes
344 #else
345 float autocvar_notification_item_centerprinttime = 1.5;
346
347 // 0 = no, 1 = yes, 2 = forced on for all MSG_INFO notifs
348 // DISABLED IN CODE, BUT ENABLED IN CONFIG FOR COMPATIBILITY WITH OLD CLIENTS
349 float autocvar_notification_allow_chatboxprint = 0;
350
351 float autocvar_notification_show_sprees_center = true;
352 float autocvar_notification_show_sprees_center_specialonly = true;
353 #endif
354
355
356 // ============================
357 //  Notification Argument List
358 // ============================
359 /*
360  These arguments get replaced with the Local_Notification_sprintf
361  and other such functions found in all.qc to supply data
362  from networked notifications to their usage in sprintf... It
363  allows for more dynamic data to be inferred by the local
364  notification parser, so that the server does not have to network
365  anything too crazy on a per-client/per-situation basis.
366
367  Pay attention to the CSQC/SVQC relations, some of these are redefined
368  in slightly different ways for different programs, this is because the
369  server does a more conservative approach to the notifs than the client.
370
371  All arguments are swapped into strings, so be sure that your
372  sprintf usage matches with proper %s placement.
373
374  Argument descriptions:
375         s1-s4: string arguments to be literally swapped into sprintf
376         s2loc: s2 string of locations of deaths or other events
377         s3loc: s3 string of locations of deaths or other events
378         f1-f4: float arguments expanded into strings to be swapped into sprintf
379         f1p2dec: f1 float to string with 2 decimal places
380         f2p2dec: f2 float to string with 2 decimal places
381         f2primsec: f2 float primary or secondary selection for weapons
382         f3primsec: f3 float primary or secondary selection for weapons
383         f1secs: count_seconds of f1
384         f1points: point or points depending on f1
385         f1ord: count_ordinal of f1
386         f1time: process_time of f1
387         f1race_time: mmssss of f1
388         f2race_time: mmssss of f2
389         race_col: color of race time/position (i.e. good or bad)
390         race_diff: show time difference between f2 and f3
391         missing_teams: show which teams still need players
392         pass_key: find the keybind for "passing" or "dropping" in CTF game mode
393         nade_key: find the keybind for nade throwing
394         frag_ping: show the ping of a player
395         frag_stats: show health/armor/ping of a player
396         frag_pos: show score status and position in the match of a player
397         spree_cen: centerprint notif for kill spree/how many kills they have
398         spree_inf: info notif for kill spree/how many kills they have
399         spree_end: placed at the end of murder messages to show ending of sprees
400         spree_lost: placed at the end of suicide messages to show losing of sprees
401         item_wepname: return full name of a weapon from weaponid
402         item_wepammo: ammo display for weapon from f1 and f2
403         item_centime: amount of time to display weapon message in centerprint
404         item_buffname: return full name of a buff from buffid
405         death_team: show the full name of the team a player is switching from
406         minigame1_name: return human readable name of a minigame from its id(s1)
407         minigame1_d: return descriptor name of a minigame from its id(s1)
408 */
409
410 const float NOTIF_MAX_ARGS = 7;
411 const float NOTIF_MAX_HUDARGS = 2;
412 const float NOTIF_MAX_DURCNT = 2;
413
414 #ifdef CSQC
415 const int NOTIF_QUEUE_MAX = 10;
416 entity notif_queue_entity[NOTIF_QUEUE_MAX];
417 MSG notif_queue_type[NOTIF_QUEUE_MAX];
418 float notif_queue_time[NOTIF_QUEUE_MAX];
419 float notif_queue_f1[NOTIF_QUEUE_MAX];
420
421 float notif_queue_next_time;
422 int notif_queue_length;
423
424 void Local_Notification_Queue_Process();
425 #endif
426
427 string arg_slot[NOTIF_MAX_ARGS];
428
429 const float ARG_CS_SV_HA = 1; // enabled on CSQC, SVQC, and Hudargs
430 const float ARG_CS_SV_DC = 2; // enabled on CSQC, SVQC, and durcnt centerprint
431 const float ARG_CS_SV = 3; // enabled on CSQC and SVQC
432 const float ARG_CS = 4; // unique result to CSQC
433 const float ARG_SV = 5; // unique result to SVQC
434 const float ARG_DC = 6; // unique result to durcnt/centerprint
435
436 // todo possible idea.... declare how many floats/strings each arg needs, and then dynamically increment the input
437 // this way, we don't need to have duplicates like i.e. s2loc and s3loc?
438
439 string BUFF_NAME(int i);
440
441 #define NOTIF_ARGUMENT_LIST \
442         ARG_CASE(ARG_CS_SV_HA,  "s1",            s1) \
443         ARG_CASE(ARG_CS_SV_HA,  "s2",            s2) \
444         ARG_CASE(ARG_CS_SV_HA,  "s3",            s3) \
445         ARG_CASE(ARG_CS_SV_HA,  "s4",            s4) \
446         ARG_CASE(ARG_CS_SV,     "s2loc",         ((autocvar_notification_show_location && (s2 != "")) ? sprintf(( ((tmp_s = autocvar_notification_show_location_string) != "") ? tmp_s : _(" (near %s)") ), s2) : "")) \
447         ARG_CASE(ARG_CS_SV,     "s3loc",         ((autocvar_notification_show_location && (s3 != "")) ? sprintf(( ((tmp_s = autocvar_notification_show_location_string) != "") ? tmp_s : _(" (near %s)") ), s3) : "")) \
448         ARG_CASE(ARG_CS_SV_DC,  "f1",            ftos(f1)) \
449         ARG_CASE(ARG_CS_SV_DC,  "f2",            ftos(f2)) \
450         ARG_CASE(ARG_CS_SV,     "f3",            ftos(f3)) \
451         ARG_CASE(ARG_CS_SV,     "f4",            ftos(f4)) \
452         ARG_CASE(ARG_CS_SV,     "f1dtime",       ftos_decimals(TIME_DECODE(f1), 2)) \
453         ARG_CASE(ARG_CS_SV,     "f2dtime",       ftos_decimals(TIME_DECODE(f2), 2)) \
454         ARG_CASE(ARG_CS,        "f2primsec",     (f2 ? _("secondary") : _("primary"))) \
455         ARG_CASE(ARG_CS,        "f3primsec",     (f3 ? _("secondary") : _("primary"))) \
456         ARG_CASE(ARG_CS,        "f1secs",        count_seconds(f1)) \
457         ARG_CASE(ARG_CS,        "f1points",      (f1 == 1 ? _("point") : _("points"))) \
458         ARG_CASE(ARG_CS_SV,     "f1ord",         count_ordinal(f1)) \
459         ARG_CASE(ARG_CS_SV,     "f1time",        process_time(2, f1)) \
460         ARG_CASE(ARG_CS_SV_HA,  "f1race_time",   mmssss(f1)) \
461         ARG_CASE(ARG_CS_SV_HA,  "f2race_time",   mmssss(f2)) \
462         ARG_CASE(ARG_CS_SV_HA,  "f3race_time",   mmssss(f3)) \
463         ARG_CASE(ARG_CS_SV,     "race_col",      CCR(((f1 == 1) ? "^F1" : "^F2"))) \
464         ARG_CASE(ARG_CS_SV,     "race_diff",     ((f2 > f3) ? sprintf(CCR("^1[+%s]"), mmssss(f2 - f3)) : sprintf(CCR("^2[-%s]"), mmssss(f3 - f2)))) \
465         ARG_CASE(ARG_CS,        "missing_teams", notif_arg_missing_teams(f1)) \
466         ARG_CASE(ARG_CS,        "pass_key",      getcommandkey(_("drop flag"), "+use")) \
467         ARG_CASE(ARG_CS,        "nade_key",      getcommandkey(_("throw nade"), "dropweapon")) \
468         ARG_CASE(ARG_CS,        "join_key",      getcommandkey(_("jump"), "+jump")) \
469         ARG_CASE(ARG_CS,        "frag_ping",     notif_arg_frag_ping(true, f2)) \
470         ARG_CASE(ARG_CS,        "frag_stats",    notif_arg_frag_stats(f2, f3, f4)) \
471         ARG_CASE(ARG_CS,        "frag_pos",      notif_arg_frag_pos(f2)) \
472         ARG_CASE(ARG_CS,        "spree_cen",     (autocvar_notification_show_sprees ? notif_arg_spree_cen(f1) : "")) \
473         ARG_CASE(ARG_CS_SV,     "spree_inf",     (autocvar_notification_show_sprees ? notif_arg_spree_inf(1, input, s2, f2) : "")) \
474         ARG_CASE(ARG_CS_SV,     "spree_end",     (autocvar_notification_show_sprees ? notif_arg_spree_inf(-1, "", "", f1) : "")) \
475         ARG_CASE(ARG_CS_SV,     "spree_lost",    (autocvar_notification_show_sprees ? notif_arg_spree_inf(-2, "", "", f1) : "")) \
476         ARG_CASE(ARG_CS_SV,     "item_wepname",  REGISTRY_GET(Weapons, f1).m_name) \
477         ARG_CASE(ARG_CS_SV,     "item_buffname", BUFF_NAME(f1)) \
478         ARG_CASE(ARG_CS_SV,     "f3buffname",    BUFF_NAME(f3)) \
479         ARG_CASE(ARG_CS_SV,     "item_wepammo",  (f2 > 0 ? notif_arg_item_wepammo(f1, f2) : "")) \
480         ARG_CASE(ARG_DC,        "item_centime",  ftos(autocvar_notification_item_centerprinttime)) \
481         ARG_CASE(ARG_SV,        "death_team",    Team_ColoredFullName(f1)) \
482         ARG_CASE(ARG_CS,        "death_team",    Team_ColoredFullName(f1 - 1)) \
483         ARG_CASE(ARG_CS_SV_HA,  "minigame1_name",find(NULL,netname,s1).descriptor.message) \
484         ARG_CASE(ARG_CS_SV_HA,  "minigame1_d",   find(NULL,netname,s1).descriptor.netname)
485
486 #define NOTIF_HIT_MAX(count,funcname) MACRO_BEGIN \
487         if(sel_num == count) { backtrace(sprintf("%s: Hit maximum arguments!\n", funcname)); break; } \
488 MACRO_END
489
490 #define NOTIF_HIT_UNKNOWN(token,funcname) { backtrace(sprintf("%s: Hit unknown token in selected string! '%s'\n", funcname, selected)); break; }
491
492 #define KILL_SPREE_LIST \
493         SPREE_ITEM(3, 03, _("TRIPLE FRAG! "), _("%s^K1 made a TRIPLE FRAG! %s^BG"), _("%s^K1 made a TRIPLE SCORE! %s^BG")) \
494         SPREE_ITEM(5, 05, _("RAGE! "), _("%s^K1 unlocked RAGE! %s^BG"), _("%s^K1 made FIVE SCORES IN A ROW! %s^BG")) \
495         SPREE_ITEM(10, 10, _("MASSACRE! "), _("%s^K1 started a MASSACRE! %s^BG"), _("%s^K1 made TEN SCORES IN A ROW! %s^BG")) \
496         SPREE_ITEM(15, 15, _("MAYHEM! "), _("%s^K1 executed MAYHEM! %s^BG"), _("%s^K1 made FIFTEEN SCORES IN A ROW! %s^BG")) \
497
498 #ifdef CSQC
499 string notif_arg_frag_pos(int score)
500 {
501         entity pl;
502         int place = 1;
503         string str, color, tail;
504         bool tied = false;
505         
506         for(pl = players.sort_next; pl; pl = pl.sort_next) {
507                 if(pl.team == NUM_SPECTATOR) continue;
508                 if(pl.(scores(SP_SCORE)) == score) break;
509                 ++place;
510         }
511         
512         entity prev = pl.sort_prev;
513         entity next = pl.sort_next;
514         if(prev && prev.(scores(SP_SCORE)) == score) {
515                 tied = true;
516                 --place; // We're tied always for the best place
517         }
518         if(next && next.(scores(SP_SCORE)) == score) {
519                 tied = true;
520         }
521         
522         switch(place) {
523                 case 1:
524                         color = "^4";
525                         break;
526                 case 2:
527                         color = "^1";
528                         break;
529                 case 3:
530                         color = "^3";
531                         break;
532                 default:
533                         color = "";
534         }
535         
536         switch(place % 10) {
537                 case 1:
538                         tail = "st";
539                         break;
540                 case 2:
541                         tail = "nd";
542                         break;
543                 case 3:
544                         tail = "rd";
545                         break;
546                 default:
547                         tail = "th";
548         }
549         
550         str = strcat(color, ftos(place), tail);
551         if(tied)
552                 return strcat("Tied for ", str);
553         else
554                 return str;
555 }
556
557 string notif_arg_frag_ping(bool newline, float fping)
558 {
559         string s = newline ? "\n" : " ";
560         if (fping < 0)
561                 return sprintf(CCR(_("%s(^F1Bot^BG)")), s);
562         else
563                 return sprintf(CCR(_("%s(Ping ^F1%d^BG)")), s, fping);
564 }
565
566 string notif_arg_frag_stats(float fhealth, float farmor, float fping)
567 {
568         string s = notif_arg_frag_ping(false, fping);
569         if (fhealth > 1)
570                 return sprintf(CCR(_("\n(Health ^1%d^BG / Armor ^2%d^BG)%s")), fhealth, farmor, s);
571         else
572                 return sprintf(CCR(_("\n(^F4Dead^BG)%s")), s);
573 }
574
575 string notif_arg_missing_teams(float f1)
576 {
577         return strcat(
578                 ((f1 & BIT(0)) ? strcat(Team_ColoredFullName(NUM_TEAM_1), (f1 >> 1) ? ", " : "") : ""),
579                 ((f1 & BIT(1)) ? strcat(Team_ColoredFullName(NUM_TEAM_2), (f1 >> 2) ? ", " : "") : ""),
580                 ((f1 & BIT(2)) ? strcat(Team_ColoredFullName(NUM_TEAM_3), (f1 >> 3) ? ", " : "") : ""),
581                 ((f1 & BIT(3)) ?        Team_ColoredFullName(NUM_TEAM_4)                         : "")
582         );
583 }
584
585 string notif_arg_spree_cen(float spree)
586 {
587         // 0 = off, 1 = target (but only for first victim) and attacker
588         if(autocvar_notification_show_sprees_center)
589         {
590                 if(spree > 1)
591                 {
592                         #define SPREE_ITEM(counta,countb,center,normal,gentle) \
593                                 case counta: { return normal_or_gentle(center, sprintf(_("%d score spree! "), spree)); }
594
595                         switch(spree)
596                         {
597                                 KILL_SPREE_LIST
598                                 default:
599                                 {
600                                         if (!autocvar_notification_show_sprees_center_specialonly)
601                                         {
602                                                 return
603                                                         sprintf(
604                                                                 normal_or_gentle(
605                                                                         _("%d frag spree! "),
606                                                                         _("%d score spree! ")
607                                                                 ),
608                                                                 spree);
609                                         }
610                                         else { return ""; } // don't show spree information if it isn't an achievement
611                                 }
612                         }
613
614                         #undef SPREE_ITEM
615                 }
616                 else if(spree == -1) // first blood
617                 {
618                         return normal_or_gentle(_("First blood! "), _("First score! "));
619                 }
620                 else if(spree == -2) // first victim
621                 {
622                         return normal_or_gentle(_("First victim! "), _("First casualty! "));
623                 }
624         }
625         return "";
626 }
627 #endif
628
629 string notif_arg_spree_inf(float type, string input, string player, float spree)
630 {
631         switch(type)
632         {
633                 case 1: // attacker kill spree
634                 {
635                         // 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker
636                         // this conditional (& 2) is true for 2 and 3
637                         if(autocvar_notification_show_sprees_info & 2)
638                         {
639                                 #ifdef CSQC
640                                 string spree_newline =
641                                         ( autocvar_notification_show_sprees_info_newline ?
642                                                 ((substring(input, 0, 1) == "\{3}") ? "\n\{3}" : "\n") : "" );
643                                 #else
644                                 string spree_newline =
645                                         (autocvar_notification_show_sprees_info_newline ? "\n" : "");
646                                 #endif
647
648                                 if(spree > 1)
649                                 {
650                                         #define SPREE_ITEM(counta,countb,center,normal,gentle) \
651                                                 case counta: { return sprintf(CCR(normal_or_gentle(normal, gentle)), player, spree_newline); }
652
653                                         switch(spree)
654                                         {
655                                                 KILL_SPREE_LIST
656                                                 default:
657                                                 {
658                                                         if (!autocvar_notification_show_sprees_info_specialonly)
659                                                         {
660                                                                 return
661                                                                         sprintf(
662                                                                                 CCR(normal_or_gentle(
663                                                                                         _("%s^K1 has %d frags in a row! %s^BG"),
664                                                                                         _("%s^K1 made %d scores in a row! %s^BG")
665                                                                                 )),
666                                                                                 player,
667                                                                                 spree,
668                                                                                 spree_newline
669                                                                         );
670                                                         }
671                                                         else { return ""; } // don't show spree information if it isn't an achievement
672                                                 }
673                                         }
674
675                                         #undef SPREE_ITEM
676                                 }
677                                 else if(spree == -1) // firstblood
678                                 {
679                                         return
680                                                 sprintf(
681                                                         CCR(normal_or_gentle(
682                                                                 _("%s^K1 drew first blood! %s^BG"),
683                                                                 _("%s^K1 got the first score! %s^BG")
684                                                         )),
685                                                         player,
686                                                         spree_newline
687                                                 );
688                                 }
689                         }
690                         break;
691                 }
692
693                 case -1: // kill spree ended
694                 {
695                         if((spree > 1) && (autocvar_notification_show_sprees_info & 1))
696                         {
697                                 return
698                                         sprintf(normal_or_gentle(
699                                                 _(", ending their %d frag spree"),
700                                                 _(", ending their %d score spree")
701                                                 ),
702                                                 spree
703                                         );
704                         }
705                         break;
706                 }
707
708                 case -2: // kill spree lost
709                 {
710                         if((spree > 1) && (autocvar_notification_show_sprees_info & 1))
711                         {
712                                 return
713                                         sprintf(normal_or_gentle(
714                                                 _(", losing their %d frag spree"),
715                                                 _(", losing their %d score spree")
716                                                 ),
717                                                 spree
718                                         );
719                         }
720                         break;
721                 }
722         }
723         return "";
724 }
725
726 string notif_arg_item_wepammo(float f1, float f2)
727 {
728         string ammoitems = "";
729         Weapon wep = REGISTRY_GET(Weapons, f1);
730         switch (wep.ammo_type)
731         {
732                 case RES_SHELLS:  ammoitems = ITEM_Shells.m_name;      break;
733                 case RES_BULLETS: ammoitems = ITEM_Bullets.m_name;     break;
734                 case RES_ROCKETS: ammoitems = ITEM_Rockets.m_name;     break;
735                 case RES_CELLS:   ammoitems = ITEM_Cells.m_name;       break;
736                 case RES_PLASMA:  ammoitems = ITEM_Plasma.m_name;      break;
737                 case RES_FUEL:    ammoitems = ITEM_JetpackFuel.m_name; break;
738                 default: return ""; // doesn't use ammo
739         }
740         return sprintf(_(" with %d %s"), f2, ammoitems);
741 }
742
743
744 // ====================================
745 //  Initialization/Create Declarations
746 // ====================================
747
748 // common notification entity values
749 .int nent_default;
750 .bool nent_enabled;
751 .MSG nent_type;
752 .string nent_name;
753 .int nent_stringcount;
754 .int nent_floatcount;
755 .int nent_teamnum;
756
757 // MSG_ANNCE entity values
758 .int nent_channel;
759 .string nent_snd;
760 .float nent_vol;
761 .float nent_position;
762 .float nent_queuetime;
763
764 // MSG_INFO and MSG_CENTER entity values
765 .string nent_args; // used by both
766 .string nent_hudargs; // used by info
767 .string nent_icon; // used by info
768 .CPID nent_cpid; // used by center
769 .string nent_durcnt; // used by center
770 .string nent_string; // used by both
771
772 // MSG_MULTI entity values
773 .entity nent_msgannce;
774 .entity nent_msginfo;
775 .entity nent_msgcenter;
776
777 // MSG_CHOICE entity values
778 .float nent_challow_def;
779 .float nent_challow_var;
780 .entity nent_optiona;
781 .entity nent_optionb;
782
783 // networked notification entity values
784 #ifdef SVQC
785 .NOTIF nent_broadcast;
786 #endif
787 .entity nent_client;
788 .MSG nent_net_type;
789 .float nent_net_name;
790 .string nent_strings[4];
791 .float nent_floats[4];
792
793 #define ACVNN(name) autocvar_notification_##name
794
795 REGISTRY(Notifications, BITS(11))
796 REGISTER_REGISTRY(Notifications)
797 REGISTRY_SORT(Notifications);
798
799 REGISTRY_DEFINE_GET(Notifications, NULL)
800 STATIC_INIT(Notifications) { FOREACH(Notifications, true, it.m_id = i); }
801 REGISTRY_CHECK(Notifications)
802
803 const int NOTIF_CHOICE_MAX = 20;
804 // NOTE: a team choice is actually made of 4 choices (one per team) with the same nent_choice_idx
805 // thus they are counted as 1 in nent_choice_count
806 int nent_choice_count = 0;
807 .int nent_choice_idx;
808 .int msg_choice_choices[NOTIF_CHOICE_MAX]; // set on each player containing MSG_CHOICE choices
809 // initialization error detection
810 bool notif_error;
811 bool notif_global_error;
812
813 STATIC_INIT_LATE(Notif_Choices)
814 {
815         if (nent_choice_count > NOTIF_CHOICE_MAX)
816                 LOG_FATALF("Too many MSG_CHOICE notifications (%d), hit NOTIF_CHOICE_MAX (%d) limit",
817                         nent_choice_count, NOTIF_CHOICE_MAX);
818 }
819
820 string Get_Notif_CvarName(Notification notif)
821 {
822         if(!notif.nent_teamnum)
823                 return notif.nent_name;
824         return substring(notif.nent_name, 0, -strlen(Static_Team_ColorName(notif.nent_teamnum)) - 2);
825 }
826
827 Notification Get_Notif_Ent(MSG net_type, int net_name)
828 {
829         Notification it = REGISTRY_GET(Notifications, net_name);
830         if (it.nent_type != net_type) {
831                 LOG_WARNF("Get_Notif_Ent(%s (%d), %s (%d)): Improper net type '%s'!",
832                         Get_Notif_TypeName(net_type), net_type,
833                         it.registered_id, net_name,
834                         Get_Notif_TypeName(it.nent_type)
835                 );
836                 return NULL;
837         }
838         return it;
839 }
840
841 <<<<<<< HEAD
842 #define MSG_ANNCE_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, sound, channel, volume, position, queuetime) \
843         MSG_ANNCE_NOTIF_(teamnum, ANNCE_##name, ANNCE_##cvarname, defaultvalue, sound, channel, volume, position, queuetime)
844
845 #define MSG_ANNCE_NOTIF(name, defaultvalue, sound, channel, volume, position, queuetime) \
846 =======
847 #define MSG_ANNCE_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, sound, channel, volume, position) \
848         MSG_ANNCE_NOTIF_(teamnum, ANNCE_##name, ANNCE_##cvarname, defaultvalue, sound, channel, volume, position)
849
850 #define MSG_ANNCE_NOTIF(name, defaultvalue, sound, channel, volume, position) \
851 >>>>>>> master
852         NOTIF_ADD_AUTOCVAR(ANNCE_##name, defaultvalue) \
853         MSG_ANNCE_NOTIF_(0, ANNCE_##name, ANNCE_##name, defaultvalue, sound, channel, volume, position, queuetime)
854
855 #define MSG_ANNCE_NOTIF_(teamnum, name, cvarname, defaultvalue, sound, channel, volume, position, queuetime) \
856         REGISTER(Notifications, name, m_id, new_pure(msg_annce_notification)) { \
857                 Create_Notification_Entity      (this, defaultvalue, ACVNN(cvarname), MSG_ANNCE, strtoupper(#name), teamnum); \
858                 Create_Notification_Entity_Annce(this, ACVNN(cvarname), strtoupper(#name), \
859                         channel,    /* channel   */ \
860                         sound,      /* snd       */ \
861                         volume,     /* vol       */ \
862                         position,   /* position  */ \
863                         queuetime); /* queuetime */ \
864         }
865
866 #define MSG_INFO_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
867         MSG_INFO_NOTIF_(teamnum, INFO_##name, INFO_##cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle)
868
869 #define MSG_INFO_NOTIF(name, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
870         NOTIF_ADD_AUTOCVAR(INFO_##name, defaultvalue) \
871         MSG_INFO_NOTIF_(0, INFO_##name, INFO_##name, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle)
872
873 #define MSG_INFO_NOTIF_(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, hudargs, icon, normal, gentle) \
874         REGISTER(Notifications, name, m_id, new_pure(msg_info_notification)) { \
875                 Create_Notification_Entity           (this, defaultvalue, ACVNN(cvarname), MSG_INFO, strtoupper(#name), teamnum); \
876                 Create_Notification_Entity_InfoCenter(this, ACVNN(cvarname), strtoupper(#name), strnum, flnum, \
877                         args,     /* args    */ \
878                         hudargs,  /* hudargs */ \
879                         icon,     /* icon    */ \
880                         CPID_Null,/* cpid    */ \
881                         "",       /* durcnt  */ \
882                         normal,   /* normal  */ \
883                         gentle);  /* gentle  */ \
884         }
885
886 .string nent_iconargs;
887 #define MULTIICON_INFO(name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle) \
888         MULTIICON_INFO_(INFO_##name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle)
889 #define MULTIICON_INFO_(name, defaultvalue, strnum, flnum, args, hudargs, iconargs, icon, normal, gentle) \
890         NOTIF_ADD_AUTOCVAR(name, defaultvalue) \
891         REGISTER(Notifications, name, m_id, new_pure(msg_info_notification)) { \
892                 Create_Notification_Entity           (this, defaultvalue, ACVNN(name), MSG_INFO, strtoupper(#name), 0); \
893                 Create_Notification_Entity_InfoCenter(this, ACVNN(name), strtoupper(#name), strnum, flnum, \
894                         args,     /* args    */ \
895                         hudargs,  /* hudargs */ \
896                         icon,     /* icon    */ \
897                         CPID_Null,/* cpid    */ \
898                         "",       /* durcnt  */ \
899                         normal,   /* normal  */ \
900                         gentle);  /* gentle  */ \
901                 this.nent_iconargs = iconargs; \
902         }
903
904 #define MSG_CENTER_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
905         MSG_CENTER_NOTIF_(teamnum, CENTER_##name, CENTER_##cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle)
906
907 #define MSG_CENTER_NOTIF(name, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
908         NOTIF_ADD_AUTOCVAR(CENTER_##name, defaultvalue) \
909         MSG_CENTER_NOTIF_(0, CENTER_##name, CENTER_##name, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle)
910
911 #define MSG_CENTER_NOTIF_(teamnum, name, cvarname, defaultvalue, strnum, flnum, args, cpid, durcnt, normal, gentle) \
912         REGISTER(Notifications, name, m_id, new_pure(msg_center_notification)) { \
913                 Create_Notification_Entity           (this, defaultvalue, ACVNN(cvarname), MSG_CENTER, strtoupper(#name), teamnum); \
914                 Create_Notification_Entity_InfoCenter(this, ACVNN(cvarname), strtoupper(#name), strnum, flnum, \
915                         args,    /* args    */ \
916                         "",      /* hudargs */ \
917                         "",      /* icon    */ \
918                         cpid,    /* cpid    */ \
919                         durcnt,  /* durcnt  */ \
920                         normal,  /* normal  */ \
921                         gentle); /* gentle  */ \
922         }
923
924 #define MSG_MULTI_NOTIF(name, defaultvalue, anncename, infoname, centername) \
925         NOTIF_ADD_AUTOCVAR(name, defaultvalue) \
926         REGISTER(Notifications, name, m_id, new_pure(msg_multi_notification)) { \
927                 Create_Notification_Entity      (this, defaultvalue, ACVNN(name), MSG_MULTI, strtoupper(#name), 0); \
928                 Create_Notification_Entity_Multi(this, ACVNN(name), strtoupper(#name), \
929                         anncename,   /* anncename  */ \
930                         infoname,    /* infoname   */ \
931                         centername); /* centername */ \
932         }
933
934 #define MSG_CHOICE_NOTIF_TEAM(teamnum, name, cvarname, defaultvalue, challow, chtype, optiona, optionb) \
935         MSG_CHOICE_NOTIF_(teamnum, CHOICE_##name, CHOICE_##cvarname, defaultvalue, challow, chtype, optiona, optionb)
936
937 #define MSG_CHOICE_NOTIF(name, defaultvalue, challow, chtype, optiona, optionb) \
938         NOTIF_ADD_AUTOCVAR(CHOICE_##name, defaultvalue) \
939         NOTIF_ADD_AUTOCVAR(CHOICE_##name##_ALLOWED, challow) \
940         MSG_CHOICE_NOTIF_(0, CHOICE_##name, CHOICE_##name, defaultvalue, challow, chtype, optiona, optionb)
941
942 #define MSG_CHOICE_NOTIF_(teamnum, name, cvarname, defaultvalue, challow, chtype, optiona, optionb) \
943         REGISTER(Notifications, name, m_id, new_pure(msg_choice_notification)) { \
944                 this.nent_choice_idx = nent_choice_count; \
945                 if (!teamnum || teamnum == NUM_TEAM_4) \
946                         nent_choice_count++; \
947                 Create_Notification_Entity       (this, defaultvalue, ACVNN(cvarname), MSG_CHOICE, strtoupper(#name), teamnum); \
948                 Create_Notification_Entity_Choice(this, ACVNN(cvarname), strtoupper(#name), \
949                         challow,                                 /* challow_def */ \
950                         autocvar_notification_##cvarname##_ALLOWED,  /* challow_var */ \
951                         chtype,                                  /* chtype      */ \
952                         optiona,                                 /* optiona     */ \
953                         optionb);                                /* optionb     */ \
954         }
955         
956 #define MSG_MEDAL_NOTIF(name, defaultvalue, icon, anncename) \
957         NOTIF_ADD_AUTOCVAR(MEDAL_##name, defaultvalue) \
958         MSG_MEDAL_NOTIF_(0, MEDAL_##name, MEDAL_##name, defaultvalue, icon, anncename)
959
960 #define MSG_MEDAL_NOTIF_(teamnum, name, cvarname, defaultvalue, icon, anncename) \
961         REGISTER(Notifications, name, m_id, new_pure(msg_medal_notification)) { \
962                 Create_Notification_Entity      (this, defaultvalue, ACVNN(cvarname), MSG_MEDAL, strtoupper(#name), teamnum); \
963                 Create_Notification_Entity_Medal(this, ACVNN(cvarname), strtoupper(#name), \
964                         icon, \
965                         anncename); \
966         }
967
968 REGISTRY_BEGIN(Notifications)
969 {
970         notif_global_error = false;
971 }
972
973 REGISTRY_END(Notifications)
974 {
975         if (!notif_global_error) return;
976         // shit happened... stop the loading of the program now if this is unacceptable
977         if (autocvar_notification_errors_are_fatal)
978                 LOG_FATAL("Notification initialization failed! Read above and fix the errors!");
979         else
980                 LOG_SEVERE("Notification initialization failed! Read above and fix the errors!");
981 }
982
983 #ifdef CSQC
984 .int cvar_value;
985 void ReplicateVars(bool would_destroy)
986 {
987         if (!would_destroy)
988                 FOREACH(Notifications, it.nent_type == MSG_CHOICE && (!it.nent_teamnum || it.nent_teamnum == NUM_TEAM_1), {
989                         string cvarname = strcat("notification_", Get_Notif_CvarName(it));
990                         // NOTE: REPLICATE_SIMPLE can return;
991                         REPLICATE_SIMPLE(it.cvar_value, cvarname);
992                 });
993 }
994 #endif
995
996 #include "all.inc"