1 // ================================================
2 // Unified notification system, written by Samual
3 // Last updated: November, 2012
4 // ================================================
6 // main types/groups of notifications
7 #define MSG_INFO 1 // "Global" information messages (sent to console, and notify panel if it has an icon)
8 #define MSG_CENTER 2 // "Personal" centerprint messages
9 #define MSG_WEAPON 3 // "Personal" weapon messages (like "You got the Nex", sent to weapon notify panel)
10 #define MSG_DEATH 4 // "Personal" AND "Global" death messages
13 #define NO_FL_ARG -12345
21 // Since this is code uses macro processors to list notifications,
22 // the normal compiler sees these checks as "constant" and throws
23 // a warning. We have to get around this by using another function.
24 #define NOTIF_MATCH(a,b) if(min(NOTIF_MAX, a) == b)
28 Acquire special information to generate for display in the
29 notification from variables networked to the client.
31 PASS_KEY: find the keybind for "passing" or "dropping" in CTF game mode
32 FRAG_SPREE: find out if the player is on a kill spree/how many kills they have
33 FRAG_PING: show the ping of a player
34 FRAG_STATS: show health/armor/ping of a player
35 FRAG_POS: show score status and position in the match of a player
36 DEATH_TEAM: show the full name of the team a player is switching from
38 string got_commandkey;
39 #define PASS_KEY ((((got_commandkey = getcommandkey("pass", "+use")) != "pass") && !(strstrofs(got_commandkey, "not bound", 0) >= 0)) ? sprintf(CCR(_(" ^F1(Press %s)")), got_commandkey) : "")
40 #define FRAG_SPREE (((f1 == 3) || (f1 == 5) || (f1 == 10) || (f1 == 15) || (f1 == 20) || (f1 == 25) || (f1 == 30)) ? sprintf(normal_or_gentle(_("%d kill spree! "), _("%d score spree! ")), f1) : "")
41 #define FRAG_PING ((f2 != BOT_PING) ? sprintf(CCR(_("\n(Ping ^2%d^BG)")), f2) : "")
42 #define FRAG_STATS sprintf(CCR(_("\n(Health ^1%d^BG / Armor ^2%d^BG)%s")), f1, f2, ((f3 != BOT_PING) ? sprintf(CCR(_(" (Ping ^2%d^BG)")), f3) : ""))
43 //#define FRAG_POS ((Should_Print_Score_Pos(f1)) ? sprintf("\n^BG%s", Read_Score_Pos(f1)) : "")
44 #define DEATH_TEAM Team_ColoredFullName(TEAM_SV_TO_CL(f1))
46 // NO_CPID normally has a variable value, so we need to check and see
47 // whether a notification uses it. If so, cancel out the centerprint ID.
48 #define HANDLE_CPID(cpid) ((min(NOTIF_MAX, cpid) == NO_CPID) ? FALSE : cpid)
50 // client-side handling of cvars
51 #define ADD_CSQC_AUTOCVAR(name) var float autocvar_notification_##name = TRUE;
52 #define CHECK_AUTOCVAR(name) if(autocvar_notification_##name)
55 // allow sending of notifications to also pass through to spectators (specifically for centerprints)
57 #define DEATH_TEAM Team_ColoredFullName(f1)
59 #define WRITESPECTATABLE_MSG_ONE_VARNAME(varname,statement) entity varname; varname = msg_entity; FOR_EACH_REALCLIENT(msg_entity) if(msg_entity == varname || (msg_entity.classname == STR_SPECTATOR && msg_entity.enemy == varname)) statement msg_entity = varname
60 #define WRITESPECTATABLE_MSG_ONE(statement) WRITESPECTATABLE_MSG_ONE_VARNAME(oldmsg_entity, statement)
61 #define WRITESPECTATABLE(msg,statement) if(msg == MSG_ONE) { WRITESPECTATABLE_MSG_ONE(statement); } else statement float WRITESPECTATABLE_workaround = 0
64 // do nothing for the other programs, they don't need cvars (those are just for the clients)
65 #define ADD_CSQC_AUTOCVAR(name)
70 If BELOW negative maxplayers, you dropped a place lower
71 If below 0, you are tied for that place
72 If above 0, you are holding that place alone
73 If above positive maxplayers, you moved up a place
75 float Should_Print_Score_Pos
77 string Read_Score_Pos(float num)
82 float Form_Score_Pos(entity player)
87 // ====================================
88 // Notifications List and Information
89 // ====================================
90 /*(name,strnum,flnum,args,cpid,cennor,cengen,infargs,hudargs,icon,infnor,infgen)
91 List of all notifications (including identifiers and display information)
92 Format: name, strnum, flnum, args, *hudargs, *icon, *CPID, *durcnt, normal, gentle, *infargs, *hudargs, *icon, *infnor, *infgen
93 Asterisked fields are not present in all notification types.
96 Number of STRING arguments (so that networking knows how many to send/receive)
97 Number of FLOAT arguments (so that networking knows how many to send/receive)
98 Arguments for sprintf(string, args), if no args needed then use ""
100 Hudargs: XPND2(STRING, STRING): arguments for names in notify messages
101 Icon: STRING: icon string name for the hud notify panel, "" if no icon is used
103 CPID: FLOAT: centerprint ID number (CPID_*), NO_CPID if no CPID is needed
104 Duration/Countdown: XPND2(FLOAT, FLOAT): extra arguments for centerprint messages
106 CPID: FLOAT: centerprint ID number (CPID_*), NO_CPID if no CPID is needed
107 Normal message (string for sprintf when gentle messages are NOT enabled)
108 Gentle message (string for sprintf when gentle messages ARE enabled)
110 Infargs: notify message args for sprintf(string, args), if no args needed then use ""
111 Hudargs: XPND2(STRING, STRING): arguments for names in notify messages
112 Icon: STRING: icon string name for the hud notify panel, "" if no icon is used
113 Infnor: STRING: normal message for info message
114 Infgen: STRING: gentle message for info message
116 Messages with ^F1, ^BG, ^TC, etc etc in them will replace those strings
117 with colors according to the cvars the user has chosen. This allows for
118 users to create unique color profiles for their HUD, giving more customization
119 options to HUD designers and end users who want such a feature.
121 Check out the function calls for string CCR(...) and
122 string TCR(...) to better understand how these codes work.
124 Guidlines (please try and follow these):
125 -ALWAYS start the string with a color, preferably background.
126 -ALWAYS reset a color after a name (this way they don't set it for the whole string).
127 -NEVER re-declare an event twice.
128 -NEVER add or remove fields from the format, it SHOULD already work.
129 -MSG_INFO messages must ALWAYS end with a new line: \n
130 -Be clean and simple with your notification naming,
131 nothing too long for the name field... Abbreviations are your friend. :D
132 -Keep the spacing as clean as possible... if the arguments are abnormally long,
133 it's okay to go out of line a bit... but try and keep it clean still.
134 -Sort the notifications in the most appropriate order for their tasks.
135 TODO: ? centerprint IDs are given priority based on their order (first being highest priority going downwards)
136 -ARIRE unir frk jvgu lbhe bja zbgure. (gvc sbe zvxrrhfn) -- Don't pay attention to this ^_^
139 // weaponorder[f1].netname
141 #define MULTITEAM_INFO(prefix,teams,strnum,flnum,args,hudargs,icon,normal,gentle) \
142 MSG_INFO_NOTIF(prefix##RED, strnum, flnum, args, hudargs, sprintf(icon, strtolower(STR_TEAM_1)), TCR(normal, COL_TEAM_1, strtoupper(STR_TEAM_1)), TCR(gentle, COL_TEAM_1, strtoupper(STR_TEAM_1))) \
143 MSG_INFO_NOTIF(prefix##BLUE, strnum, flnum, args, hudargs, sprintf(icon, strtolower(STR_TEAM_2)), TCR(normal, COL_TEAM_2, strtoupper(STR_TEAM_2)), TCR(gentle, COL_TEAM_2, strtoupper(STR_TEAM_2))) \
145 MSG_INFO_NOTIF(prefix##YELLOW, strnum, flnum, args, hudargs, sprintf(icon, strtolower(STR_TEAM_3)), TCR(normal, COL_TEAM_3, strtoupper(STR_TEAM_3)), TCR(gentle, COL_TEAM_3, strtoupper(STR_TEAM_3))) \
148 MSG_INFO_NOTIF(prefix##PINK, strnum, flnum, args, hudargs, sprintf(icon, strtolower(STR_TEAM_4)), TCR(normal, COL_TEAM_4, strtoupper(STR_TEAM_4)), TCR(gentle, COL_TEAM_4, strtoupper(STR_TEAM_4))) \
150 #define MSG_INFO_NOTIFICATIONS \
151 MSG_INFO_NOTIF(INFO_EMPTY, 0, 0, NO_STR_ARG, XPND2("", ""), "", "", "") \
152 MULTITEAM_INFO(INFO_SCORES_, 4, 0, 0, NO_STR_ARG, XPND2("", ""), "", _("^TC^TT ^BGteam scores!\n"), "") \
153 MULTITEAM_INFO(INFO_CTF_FLAGRETURN_DROPPED_, 2, 0, 0, NO_STR_ARG, XPND2("", ""), "", _("^BGThe ^TC^TT^BG flag was dropped in the base and returned itself\n"), "") \
154 MULTITEAM_INFO(INFO_CTF_FLAGRETURN_DAMAGED_, 2, 0, 0, NO_STR_ARG, XPND2("", ""), "", _("^BGThe ^TC^TT^BG flag was destroyed and returned to base\n"), "") \
155 MULTITEAM_INFO(INFO_CTF_FLAGRETURN_SPEEDRUN_, 2, 0, 1, f1/100, XPND2("", ""), "", _("^BGThe ^TC^TT^BG flag became impatient after ^F1%.2f^BG seconds and returned itself\n"), "") \
156 MULTITEAM_INFO(INFO_CTF_FLAGRETURN_NEEDKILL_, 2, 0, 0, NO_STR_ARG, XPND2("", ""), "", _("^BGThe ^TC^TT^BG flag fell somewhere it couldn't be reached and returned to base\n"), "") \
157 MULTITEAM_INFO(INFO_CTF_FLAGRETURN_ABORTRUN_, 2, 0, 0, NO_STR_ARG, XPND2("", ""), "", _("^BGThe ^TC^TT^BG flag was returned to base by its owner\n"), "") \
158 MULTITEAM_INFO(INFO_CTF_FLAGRETURN_TIMEOUT_, 2, 0, 0, NO_STR_ARG, XPND2("", ""), "", _("^BGThe ^TC^TT^BG flag has returned to the base\n"), "") \
159 MULTITEAM_INFO(INFO_CTF_PICKUP_, 2, 1, 0, s1, XPND2(s1, ""), "notify_%s_taken", _("^BG%s^BG got the ^TC^TT^BG flag\n"), "") \
160 MULTITEAM_INFO(INFO_CTF_RETURN_, 2, 1, 0, s1, XPND2(s1, ""), "notify_%s_returned", _("^BG%s^BG returned the ^TC^TT^BG flag\n"), "") \
161 MULTITEAM_INFO(INFO_CTF_LOST_, 2, 1, 0, s1, XPND2(s1, ""), "notify_%s_lost", _("^BG%s^BG lost the ^TC^TT^BG flag\n"), "") \
162 MULTITEAM_INFO(INFO_CTF_CAPTURE_, 2, 1, 0, s1, XPND2(s1, ""), "notify_%s_captured", _("^BG%s^BG captured the ^TC^TT^BG flag\n"), "") \
163 MULTITEAM_INFO(INFO_CTF_CAPTURE_TIME_, 2, 1, 1, XPND2(s1, f1/100), XPND2(s1, ""), "notify_%s_captured", _("^BG%s^BG captured the ^TC^TT^BG flag in ^F1%.2f^BG seconds\n"), "") \
164 MULTITEAM_INFO(INFO_CTF_CAPTURE_BROKEN_, 2, 2, 2, XPND4(s1, f1/100, s2, f2/100), XPND2(s1, ""), "notify_%s_captured", _("^BG%s^BG captured the ^TC^TT^BG flag in ^F1%.2f^BG seconds, breaking ^BG%s^BG's previous record of ^F2%.2f^BG seconds\n"), "") \
165 MULTITEAM_INFO(INFO_CTF_CAPTURE_UNBROKEN_, 2, 2, 2, XPND4(s1, f1/100, s2, f2/100), XPND2(s1, ""), "notify_%s_captured", _("^BG%s^BG captured the ^TC^TT^BG flag in ^F2%.2f^BG seconds, failing to break ^BG%s^BG's previous record of ^F1%.2f^BG seconds\n"), "")
167 #define MULTITEAM_CENTER(prefix,teams,strnum,flnum,args,cpid,durcnt,normal,gentle) \
168 MSG_CENTER_NOTIF(prefix##RED, strnum, flnum, args, cpid, durcnt, TCR(normal, COL_TEAM_1, strtoupper(STR_TEAM_1)), TCR(gentle, COL_TEAM_1, strtoupper(STR_TEAM_1))) \
169 MSG_CENTER_NOTIF(prefix##BLUE, strnum, flnum, args, cpid, durcnt, TCR(normal, COL_TEAM_2, strtoupper(STR_TEAM_2)), TCR(gentle, COL_TEAM_2, strtoupper(STR_TEAM_2))) \
171 MSG_CENTER_NOTIF(prefix##YELLOW, strnum, flnum, args, cpid, durcnt, TCR(normal, COL_TEAM_3, strtoupper(STR_TEAM_3)), TCR(gentle, COL_TEAM_3, strtoupper(STR_TEAM_3))) \
174 MSG_CENTER_NOTIF(prefix##PINK, strnum, flnum, args, cpid, durcnt, TCR(normal, COL_TEAM_4, strtoupper(STR_TEAM_4)), TCR(gentle, COL_TEAM_4, strtoupper(STR_TEAM_4))) \
176 #define MSG_CENTER_NOTIFICATIONS \
177 MSG_CENTER_NOTIF(CENTER_EMPTY, 0, 0, NO_STR_ARG, NO_CPID, XPND2(0, 0), "", "") \
178 MSG_CENTER_NOTIF(CENTER_CTF_CAPTURESHIELD_SHIELDED, 0, 0, NO_STR_ARG, CPID_CTF_CAPSHIELD, XPND2(0, 0), _("^BGYou are now ^F1shielded^BG from the flag\n^BGfor ^F2too many unsuccessful attempts^BG to capture.\n^BGMake some defensive scores before trying again."), "") \
179 MSG_CENTER_NOTIF(CENTER_CTF_CAPTURESHIELD_FREE, 0, 0, NO_STR_ARG, CPID_CTF_CAPSHIELD, XPND2(0, 0), _("^BGYou are now free.\n^BGFeel free to ^F2try to capture^BG the flag again\n^BGif you think you will succeed."), "") \
180 MULTITEAM_CENTER(CENTER_CTF_PASS_OTHER_, 2, 2, 0, XPND2(s1, s2), CPID_CTF_PASS, XPND2(0, 0), _("^BG%s^BG passed the ^TC^TT^BG flag to %s"), "") \
181 MULTITEAM_CENTER(CENTER_CTF_PASS_SENT_, 2, 1, 0, s1, CPID_CTF_PASS, XPND2(0, 0), _("^BGYou passed the ^TC^TT^BG flag to %s"), "") \
182 MULTITEAM_CENTER(CENTER_CTF_PASS_RECEIVED_, 2, 1, 0, s1, CPID_CTF_PASS, XPND2(0, 0), _("^BGYou received the ^TC^TT^BG flag from %s"), "") \
183 MSG_CENTER_NOTIF(CENTER_CTF_PASS_REQUESTING, 1, 0, s1, CPID_CTF_PASS, XPND2(0, 0), _("^BGRequesting %s^BG to pass you the flag"), "") \
184 MSG_CENTER_NOTIF(CENTER_CTF_PASS_REQUESTED, 1, 0, XPND2(s1, PASS_KEY), CPID_CTF_PASS, XPND2(0, 0), _("^BG%s^BG requests you to pass the flag%s"), "") \
185 MULTITEAM_CENTER(CENTER_CTF_RETURN_, 2, 0, 0, NO_STR_ARG, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYou returned the ^TC^TT^BG flag!"), "") \
186 MULTITEAM_CENTER(CENTER_CTF_CAPTURE_, 2, 0, 0, NO_STR_ARG, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYou captured the ^TC^TT^BG flag!"), "") \
187 MULTITEAM_CENTER(CENTER_CTF_PICKUP_, 2, 0, 0, NO_STR_ARG, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYou got the ^TC^TT^BG flag!"), "") \
188 MSG_CENTER_NOTIF(CENTER_CTF_PICKUP_TEAM, 1, 0, s1, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYour %steam mate^BG got the flag! Protect them!"), "") \
189 MSG_CENTER_NOTIF(CENTER_CTF_PICKUP_TEAM_VERBOSE, 2, 0, XPND3(s1, s2, s1), CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYour %steam mate (^BG%s%s)^BG got the flag! Protect them!"), "") \
190 MSG_CENTER_NOTIF(CENTER_CTF_PICKUP_ENEMY, 1, 0, s1, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGThe %senemy^BG got your flag! Retrieve it!"), "") \
191 MSG_CENTER_NOTIF(CENTER_CTF_PICKUP_ENEMY_VERBOSE, 2, 0, XPND3(s1, s2, s1), CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGThe %senemy (^BG%s%s)^BG got your flag! Retrieve it!"), "") \
192 MSG_CENTER_NOTIF(CENTER_CTF_STALEMATE_CARRIER, 0, 0, NO_STR_ARG, CPID_STALEMATE, XPND2(0, 0), _("^BGStalemate! Enemies can now see you on radar!"), "") \
193 MSG_CENTER_NOTIF(CENTER_CTF_STALEMATE_OTHER, 0, 0, NO_STR_ARG, CPID_STALEMATE, XPND2(0, 0), _("^BGStalemate! Flag carriers can now be seen by enemies on radar!"), "") \
194 MSG_CENTER_NOTIF(CENTER_CTF_FLAG_THROW_PUNISH, 0, 1, f1, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGToo many flag throws! Throwing disabled for %d seconds."), "")
196 #define MSG_WEAPON_NOTIFICATIONS \
197 MSG_WEAPON_NOTIF(DEATH_MARBLES_LOST3, 2, 1, XPND3(s1, s2, f1), _("^F1%s^BG lost their marbles against ^F1%s^BG using the ^F2%s^BG\n"), "")
199 #define MSG_DEATH_NOTIFICATIONS \
200 MSG_DEATH_NOTIF(DEATH_SELF_CUSTOM, 2, 0, XPND2(s1, s2), NO_CPID, _("^K1You were %s, %s"), "", \
201 NO_STR_ARG, XPND2(s1, ""), "notify_death", _("^FG%s^K1\n"), "") \
202 MSG_DEATH_NOTIF(DEATH_SELF_GENERIC, 1, 0, NO_STR_ARG, NO_CPID, _("^K1Watch your step!"), "", \
203 NO_STR_ARG, XPND2(s1, ""), "notify_void", _("^FG%s^K1\n"), "") \
204 MSG_DEATH_NOTIF(DEATH_SELF_SELFKILL, 0, 0, NO_STR_ARG, NO_CPID, _("^K1You killed your own dumb self!"), _("^K1You need to be more careful!"), \
205 NO_STR_ARG, XPND2("", ""), "notify_selfkill", _("^FG%s^K1\n"), "") \
206 MSG_DEATH_NOTIF(DEATH_SELF_SUICIDE, 1, 0, NO_STR_ARG, NO_CPID, _("^K1You committed suicide!"), _("^K1You ended it all!"), \
207 s1, XPND2(s1, ""), "notify_selfkill", _("^FG%s^K1 couldn't take it anymore\n"), "") \
208 MSG_DEATH_NOTIF(DEATH_SELF_NOAMMO, 0, 0, NO_STR_ARG, NO_CPID, _("^K1You were killed for running out of ammo..."), _("^K1You are respawning for running out of ammo..."), \
209 NO_STR_ARG, XPND2("", ""), "notify_outofammo", _("^FG%s^K1\n"), "") \
210 MSG_DEATH_NOTIF(DEATH_SELF_ROT, 0, 0, NO_STR_ARG, NO_CPID, _("^K1You grew too old without taking your medicine"), _("^K1You need to preserve your health"), \
211 NO_STR_ARG, XPND2("", ""), "notify_death", _("^FG%s^K1\n"), "") \
212 MSG_DEATH_NOTIF(DEATH_SELF_CAMP, 1, 0, NO_STR_ARG, NO_CPID, _("^K1Die camper!"), _("^K1Reconsider your tactics, camper!"), \
213 NO_STR_ARG, XPND2(s1, ""), "notify_camping", _("^FG%s^K1\n"), "") \
214 MSG_DEATH_NOTIF(DEATH_SELF_BETRAYAL, 0, 0, NO_STR_ARG, NO_CPID, _("^K1Don't shoot your team mates!"), _("^K1Don't go against your team mates!"), \
215 NO_STR_ARG, XPND2("", ""), "", _("^FG%s^K1\n"), "") \
216 MSG_DEATH_NOTIF(DEATH_SELF_TEAMCHANGE, 1, 1, DEATH_TEAM, NO_CPID, _("^BGYou are now on: %s"), "", \
217 XPND2(s1, DEATH_TEAM), XPND2("", ""), "", _("^FG%s^K1 switched to the %s\n"), "") \
218 MSG_DEATH_NOTIF(DEATH_SELF_AUTOTEAMCHANGE, 1, 1, DEATH_TEAM, NO_CPID, _("^BGYou have been moved into a different team\nYou are now on: %s"), "", \
219 XPND2(s1, DEATH_TEAM), XPND2("", ""), "", _("^FG%s^K1 was moved into the %s\n"), "") \
220 MSG_DEATH_NOTIF(DEATH_SELF_FALL, 0, 0, NO_STR_ARG, NO_CPID, _("^K1You hit the ground with a crunch!"), "", \
221 NO_STR_ARG, XPND2("", ""), "notify_fall", _("^FG%s^K1 hit the ground with a crunch\n"), _("^FG%s^K1 hit the ground with a bit too much force\n")) \
222 MSG_DEATH_NOTIF(DEATH_SELF_DROWN, 1, 0, NO_STR_ARG, NO_CPID, _("^K1You couldn't catch your breath in time!"), "", \
223 NO_STR_ARG, XPND2(s1, ""), "notify_water", _("^FG%s^K1 couldn't catch their breath\n"), _("^FG%s^K1 was in the water for too long\n")) \
224 MSG_DEATH_NOTIF(DEATH_SELF_LAVA, 1, 0, NO_STR_ARG, NO_CPID, _("^K1You couldn't stand the heat!"), "", \
225 NO_STR_ARG, XPND2("", ""), "notify_lava", _("^FG%s^K1 turned into hot slag\n"), _("^FG%s^K1 found a hot place\n")) \
226 MSG_DEATH_NOTIF(DEATH_SELF_SLIME, 1, 0, NO_STR_ARG, NO_CPID, _("^K1You melted away in slime!"), "", \
227 NO_STR_ARG, XPND2("", ""), "notify_slime", _("^FG%s^K1 was slimed\n"), "") \
228 MSG_DEATH_NOTIF(DEATH_SELF_SHOOTING_STAR, 0, 0, NO_STR_ARG, NO_CPID, _("^K1You became a shooting star!"), "", \
229 NO_STR_ARG, XPND2("", ""), "notify_shootingstar", _("^FG%s^K1\n"), "") \
230 MSG_DEATH_NOTIF(DEATH_SELF_SWAMP, 0, 0, NO_STR_ARG, NO_CPID, _("^K1You got stuck in a swamp!"), "", \
231 NO_STR_ARG, XPND2("", ""), "", _("^FG%s^K1\n"), "") \
232 MSG_DEATH_NOTIF(DEATH_MURDER_FRAG, 1, 1, XPND2(FRAG_SPREE, s1), NO_CPID, _("^K3%sYou fragged ^BG%s"), _("^K3%sYou scored against ^BG%s"), \
233 NO_STR_ARG, XPND2("", ""), "", "", "") \
234 MSG_DEATH_NOTIF(DEATH_MURDER_FRAGGED, 1, 0, s1, NO_CPID, _("^K1You were fragged by ^BG%s"), _("^K1You were scored against by ^BG%s"), \
235 NO_STR_ARG, XPND2("", ""), "", "", "") \
236 MSG_DEATH_NOTIF(DEATH_MURDER_TYPEFRAG, 1, 1, XPND2(FRAG_SPREE, s1), NO_CPID, _("^K1%sYou typefragged ^BG%s"), _("^K1%sYou scored against ^BG%s^K1 while they were typing"), \
237 NO_STR_ARG, XPND2("", ""), "", "", "") \
238 MSG_DEATH_NOTIF(DEATH_MURDER_TYPEFRAGGED, 1, 0, s1, NO_CPID, _("^K1You were typefragged by ^BG%s"), _("^K1You were scored against by ^BG%s^K1 while typing!"), \
239 NO_STR_ARG, XPND2("", ""), "", "", "") \
240 MSG_DEATH_NOTIF(DEATH_MURDER_FRAG_FIRST, 1, 0, s1, NO_CPID, _("^K3First blood! You fragged ^BG%s"), _("^K3First score! You scored against ^BG%s"), \
241 NO_STR_ARG, XPND2("", ""), "", "", "") \
242 MSG_DEATH_NOTIF(DEATH_MURDER_FRAGGED_FIRST, 1, 0, s1, NO_CPID, _("^K1First victim! You were fragged by ^BG%s"), _("^K1First casualty! You were scored against by ^BG%s"), \
243 NO_STR_ARG, XPND2("", ""), "", "", "") \
244 MSG_DEATH_NOTIF(DEATH_MURDER_TYPEFRAG_FIRST, 1, 0, s1, NO_CPID, _("^K1First blood! You typefragged ^BG%s"), _("^K1First score! You scored against ^BG%s^K1 while they were typing"), \
245 NO_STR_ARG, XPND2("", ""), "", "", "") \
246 MSG_DEATH_NOTIF(DEATH_MURDER_TYPEFRAGGED_FIRST, 1, 0, s1, NO_CPID, _("^K1First victim! You were typefragged by ^BG%s"), _("^K1First casualty! You were scored against by ^BG%s^K1 while typing!"), \
247 NO_STR_ARG, XPND2("", ""), "", "", "") \
248 MSG_DEATH_NOTIF(DEATH_MURDER_FRAG_VERBOSE, 1, 2, XPND3(FRAG_SPREE, s1, FRAG_PING), NO_CPID, _("^K3You fragged ^BG%s^BG%s"), _("^K3You scored against ^BG%s^BG%s"), \
249 NO_STR_ARG, XPND2("", ""), "", "", "") \
250 MSG_DEATH_NOTIF(DEATH_MURDER_FRAGGED_VERBOSE, 1, 3, XPND2(s1, FRAG_STATS), NO_CPID, _("^K1You were fragged by ^BG%s^BG%s"), _("^K1You were scored against by ^BG%s^BG%s"), \
251 NO_STR_ARG, XPND2("", ""), "", "", "") \
252 MSG_DEATH_NOTIF(DEATH_MURDER_TYPEFRAG_VERBOSE, 1, 2, XPND3(FRAG_SPREE, s1, FRAG_PING), NO_CPID, _("^K1You typefragged ^BG%s^BG%s"), _("^K1You scored against ^BG%s^K1 while they were typing^BG%s"), \
253 NO_STR_ARG, XPND2("", ""), "", "", "") \
254 MSG_DEATH_NOTIF(DEATH_MURDER_TYPEFRAGGED_VERBOSE, 1, 3, XPND2(s1, FRAG_STATS), NO_CPID, _("^K1You were typefragged by ^BG%s^BG%s"), _("^K1You were scored against by ^BG%s^K1 while typing^BG%s"), \
255 NO_STR_ARG, XPND2("", ""), "", "", "") \
256 MSG_DEATH_NOTIF(DEATH_MURDER_FRAG_FIRST_VERBOSE, 1, 1, s1, NO_CPID, _("^K3First blood! You fragged ^BG%s"), _("^K3First score! You scored against ^BG%s"), \
257 NO_STR_ARG, XPND2("", ""), "", "", "") \
258 MSG_DEATH_NOTIF(DEATH_MURDER_FRAGGED_FIRST_VERBOSE, 1, 3, s1, NO_CPID, _("^K1First victim! You were fragged by ^BG%s"), _("^K1First casualty! You were scored against by ^BG%s"), \
259 NO_STR_ARG, XPND2("", ""), "", "", "") \
260 MSG_DEATH_NOTIF(DEATH_MURDER_TYPEFRAG_FIRST_VERBOSE, 1, 1, s1, NO_CPID, _("^K1First blood! You typefragged ^BG%s"), _("^K1First score! You scored against ^BG%s^K1 while they were typing"), \
261 NO_STR_ARG, XPND2("", ""), "", "", "") \
262 MSG_DEATH_NOTIF(DEATH_MURDER_TYPEFRAGGED_FIRST_VERBOSE, 1, 3, s1, NO_CPID, _("^K1First victim! You were typefragged by ^BG%s"), _("^K1First casualty! You were scored against by ^BG%s^K1 while typing!"), \
263 NO_STR_ARG, XPND2("", ""), "", "", "") \
265 // ====================================
266 // Initialization/Create Declarations
267 // ====================================
269 #define NOTIF_FIRST 1
270 #define NOTIF_MAX 1024 // limit of recursive functions with ACCUMULATE_FUNCTION
271 float NOTIF_INFO_COUNT;
272 float NOTIF_CENTER_COUNT;
273 float NOTIF_WEAPON_COUNT;
274 float NOTIF_DEATH_COUNT;
275 float NOTIF_CPID_COUNT;
277 #define MSG_INFO_NOTIF(name,strnum,flnum,args,icon,normal,gentle) \
278 ADD_CSQC_AUTOCVAR(name) \
280 void RegisterNotification_##name() \
282 SET_FIELD_COUNT(name, NOTIF_FIRST, NOTIF_INFO_COUNT) \
283 CHECK_MAX_COUNT(name, NOTIF_MAX, NOTIF_INFO_COUNT, "notifications") \
285 ACCUMULATE_FUNCTION(RegisterNotifications, RegisterNotification_##name)
287 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
288 ADD_CSQC_AUTOCVAR(name) \
291 void RegisterNotification_##name() \
293 SET_FIELD_COUNT(name, NOTIF_FIRST, NOTIF_CENTER_COUNT) \
294 SET_FIELD_COUNT(cpid, NOTIF_FIRST, NOTIF_CPID_COUNT) \
295 CHECK_MAX_COUNT(name, NOTIF_MAX, NOTIF_CENTER_COUNT, "notifications") \
297 ACCUMULATE_FUNCTION(RegisterNotifications, RegisterNotification_##name)
299 #define MSG_WEAPON_NOTIF(name,strnum,flnum,args,normal,gentle) \
300 ADD_CSQC_AUTOCVAR(name) \
302 void RegisterNotification_##name() \
304 SET_FIELD_COUNT(name, NOTIF_FIRST, NOTIF_WEAPON_COUNT) \
305 CHECK_MAX_COUNT(name, NOTIF_MAX, NOTIF_WEAPON_COUNT, "notifications") \
307 ACCUMULATE_FUNCTION(RegisterNotifications, RegisterNotification_##name)
309 #define MSG_DEATH_NOTIF(name,strnum,flnum,args,cpid,cennor,cengen,infargs,hudargs,icon,infnor,infgen) \
310 ADD_CSQC_AUTOCVAR(name) \
312 void RegisterNotification_##name() \
314 SET_FIELD_COUNT(name, NOTIF_FIRST, NOTIF_DEATH_COUNT) \
315 CHECK_MAX_COUNT(name, NOTIF_MAX, NOTIF_DEATH_COUNT, "notifications") \
317 ACCUMULATE_FUNCTION(RegisterNotifications, RegisterNotification_##name)
319 // NOW we actually activate the declarations
320 MSG_INFO_NOTIFICATIONS
321 MSG_CENTER_NOTIFICATIONS
322 MSG_WEAPON_NOTIFICATIONS
323 MSG_DEATH_NOTIFICATIONS
324 #undef MSG_INFO_NOTIF
325 #undef MSG_CENTER_NOTIF
326 #undef MSG_WEAPON_NOTIF
327 #undef MSG_DEATH_NOTIF
329 // ======================
330 // Supporting Functions
331 // ======================
333 // select between the normal or the gentle message string based on client (or server) settings
334 string normal_or_gentle(string normal, string gentle)
338 if(autocvar_cl_gentle || autocvar_cl_gentle_messages)
340 if(autocvar_sv_gentle)
342 return ((gentle != "") ? gentle : normal);
350 float notif_stringcount(string s1, string s2)
353 if(s1 != NO_STR_ARG) ++stringcount;
354 if(s2 != NO_STR_ARG) ++stringcount;
358 float notif_floatcount(float f1, float f2, float f3)
361 if(f1 != NO_FL_ARG) ++floatcount;
362 if(f2 != NO_FL_ARG) ++floatcount;
363 if(f3 != NO_FL_ARG) ++floatcount;
367 // get the actual name of a notification and return it as a string
368 string Get_Field_Value(float field, float net_type, float net_name)
372 #define GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) \
373 if(field == F_NAME) { output = VAR_TO_TEXT(name); } \
374 else if(field == F_STRNUM) { output = ftos(strnum); } \
375 else if(field == F_FLNUM) { output = ftos(flnum); }
381 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
382 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } }
383 MSG_INFO_NOTIFICATIONS
384 #undef MSG_INFO_NOTIF
389 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
390 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } }
391 MSG_CENTER_NOTIFICATIONS
392 #undef MSG_CENTER_NOTIF
397 #define MSG_WEAPON_NOTIF(name,strnum,flnum,args,normal,gentle) \
398 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } }
399 MSG_WEAPON_NOTIFICATIONS
400 #undef MSG_WEAPON_NOTIF
405 #define MSG_DEATH_NOTIF(name,strnum,flnum,args,cpid,cennor,cengen,infargs,hudargs,icon,infnor,infgen) \
406 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } }
407 MSG_DEATH_NOTIFICATIONS
408 #undef MSG_DEATH_NOTIF
413 #undef GET_FIELD_VALUE_OUTPUT
418 string TCR(string input, string teamcolor, string teamtext)
420 input = strreplace("^TC", teamcolor, input);
421 input = strreplace("^TT", teamtext, input);
425 // color code replace, place inside of sprintf and parse the string
426 string CCR(string input)
428 // foreground/normal colors
429 input = strreplace("^F1", "^2", input); // primary priority (important names, etc)
430 input = strreplace("^F2", "^3", input); // secondary priority (items, locations, numbers, etc)
433 input = strreplace("^K1", "^1", input); // "bad" or "dangerous" text (death messages against you, kill notifications, etc)
434 input = strreplace("^K2", "^3", input); // similar to above, but less important... OR, a highlight out of above message type
435 input = strreplace("^K3", "^4", input); // "good" or "beneficial" text (you fragging someone, etc)
438 input = strreplace("^BG", "^7", input); // neutral/unimportant text
439 input = strreplace("^N", "^7", input); // "none"-- reset to white...
444 // =============================
445 // Debug/Maintenance Functions
446 // =============================
448 #define NOTIF_Write(type,name,text) fputs(fh, (sprintf("seta %s 1 // %s - %s\n", name, type, strreplace("\n", "\\n", text))))
449 void Dump_Notifications(float fh)
451 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) { NOTIF_Write("MSG_INFO", VAR_TO_TEXT(name), normal); }
452 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) { NOTIF_Write("MSG_CENTER", VAR_TO_TEXT(name), normal); }
453 #define MSG_WEAPON_NOTIF(name,strnum,flnum,args,normal,gentle) { NOTIF_Write("MSG_WEAPON", VAR_TO_TEXT(name), normal); }
454 #define MSG_DEATH_NOTIF(name,strnum,flnum,args,cpid,cennor,cengen,infargs,hudargs,icon,infnor,infgen) { NOTIF_Write("MSG_DEATH", VAR_TO_TEXT(name), infnor); }
455 MSG_INFO_NOTIFICATIONS
456 MSG_CENTER_NOTIFICATIONS
457 MSG_WEAPON_NOTIFICATIONS
458 MSG_DEATH_NOTIFICATIONS
459 #undef MSG_INFO_NOTIF
460 #undef MSG_CENTER_NOTIF
461 #undef MSG_WEAPON_NOTIF
462 #undef MSG_DEATH_NOTIF
467 // ===============================
468 // Frontend Notification Pushing
469 // ===============================
472 #define KN_MAX_ENTRIES 10
474 float killnotify_times[KN_MAX_ENTRIES];
475 string killnotify_icon[KN_MAX_ENTRIES];
476 string killnotify_attackers[KN_MAX_ENTRIES];
477 string killnotify_victims[KN_MAX_ENTRIES];
478 // 0 = "Y [used by] X", 1 = "X [did action to] Y"
479 void HUD_Notify_Push(string icon, string attacker, string victim)
484 if (kn_index == -1) { kn_index = KN_MAX_ENTRIES-1; }
485 killnotify_times[kn_index] = time;
488 if(killnotify_icon[kn_index]) { strunzone(killnotify_icon[kn_index]); }
489 killnotify_icon[kn_index] = strzone(icon);
492 if(killnotify_attackers[kn_index]) { strunzone(killnotify_attackers[kn_index]); }
493 killnotify_attackers[kn_index] = strzone(attacker);
496 if(killnotify_victims[kn_index]) { strunzone(killnotify_victims[kn_index]); }
497 killnotify_victims[kn_index] = strzone(victim);
501 void Local_Notification(float net_type, float net_name, string s1, string s2, float f1, float f2, float f3)
507 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
508 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
510 print(sprintf(CCR(normal_or_gentle(normal, gentle)), args)); \
511 if(strtolower(icon) != "") { HUD_Notify_Push(icon, hudargs); } \
513 MSG_INFO_NOTIFICATIONS
514 #undef MSG_INFO_NOTIF
519 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
520 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
522 centerprint_generic(HANDLE_CPID(cpid), sprintf(CCR(normal_or_gentle(normal, gentle)), args), durcnt); \
524 MSG_CENTER_NOTIFICATIONS
525 #undef MSG_CENTER_NOTIF
530 #define MSG_WEAPON_NOTIF(name,strnum,flnum,args,normal,gentle) \
531 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
533 print("unhandled\n"); \
535 MSG_WEAPON_NOTIFICATIONS
536 #undef MSG_WEAPON_NOTIF
541 #define MSG_DEATH_NOTIF(name,strnum,flnum,args,cpid,cennor,cengen,infargs,hudargs,icon,infnor,infgen) \
542 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
544 centerprint_generic(HANDLE_CPID(cpid), sprintf(CCR(normal_or_gentle(cennor, cengen)), args), 0, 0); \
545 print(sprintf(CCR(normal_or_gentle(infnor, infgen)), infargs)); \
546 if(strtolower(icon) != "") { HUD_Notify_Push(icon, hudargs); } \
548 MSG_DEATH_NOTIFICATIONS
549 #undef MSG_DEATH_NOTIF
557 // =========================
558 // Notification Networking
559 // =========================
562 void Read_Notification(void)
564 float net_type = ReadByte();
565 float net_name = ReadShort();
567 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
568 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
570 Local_Notification(net_type, net_name,
571 ((stringcount >= 1) ? ReadString() : ""),
572 ((stringcount == 2) ? ReadString() : ""),
573 ((floatcount >= 1) ? ReadLong() : 0),
574 ((floatcount >= 2) ? ReadLong() : 0),
575 ((floatcount == 3) ? ReadLong() : 0));
580 void Send_Notification(entity client, float broadcast, float net_type, float net_name, string s1, string s2, float f1, float f2, float f3)
582 if(net_type && net_name)
584 //print("notification: ", Get_Field_Value(F_NAME, net_type, net_name), ": ", ftos(net_name), ".\n");
586 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
587 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
589 if(notif_stringcount(s1, s2) > stringcount) { backtrace("Too many string arguments for notification!\n"); return; }
590 if(notif_floatcount(f1, f2, f3) > floatcount) { backtrace("Too many float arguments for notification!\n"); return; }
592 if(broadcast == MSG_ONE)
594 if(client && (clienttype(client) == CLIENTTYPE_REAL) && (client.flags & FL_CLIENT))
596 // personal/direct notification sent to ONE person and their spectators
598 WRITESPECTATABLE_MSG_ONE({
599 WriteByte(MSG_ONE, SVC_TEMPENTITY);
600 WriteByte(MSG_ONE, TE_CSQC_NOTIFICATION);
601 WriteByte(MSG_ONE, net_type);
602 WriteShort(MSG_ONE, net_name);
603 if(stringcount >= 1) { WriteString(MSG_ONE, s1); }
604 if(stringcount == 2) { WriteString(MSG_ONE, s2); }
605 if(floatcount >= 1) { WriteLong(MSG_ONE, f1); }
606 if(floatcount >= 2) { WriteLong(MSG_ONE, f2); }
607 if(floatcount == 3) { WriteLong(MSG_ONE, f3); }
611 else if(broadcast == MSG_ALL)
613 // global notification sent to EVERYONE
614 WriteByte(MSG_ALL, SVC_TEMPENTITY);
615 WriteByte(MSG_ALL, TE_CSQC_NOTIFICATION);
616 WriteByte(MSG_ALL, net_type);
617 WriteShort(MSG_ALL, net_name);
618 if(stringcount >= 1) { WriteString(MSG_ALL, s1); }
619 if(stringcount == 2) { WriteString(MSG_ALL, s2); }
620 if(floatcount >= 1) { WriteLong(MSG_ALL, f1); }
621 if(floatcount >= 2) { WriteLong(MSG_ALL, f2); }
622 if(floatcount == 3) { WriteLong(MSG_ALL, f3); }
624 else { backtrace("Unknown MSG_ type to write with!\n"); }
626 if(!server_is_local && (net_type == MSG_INFO))
628 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
629 { NOTIF_MATCH(name, net_name) { print(sprintf(CCR(normal_or_gentle(normal, gentle)), args)); } }
630 MSG_INFO_NOTIFICATIONS
631 #undef MSG_INFO_NOTIF
633 #define MSG_DEATH_NOTIF(name,strnum,flnum,args,cpid,cennor,cengen,infargs,hudargs,icon,infnor,infgen) \
634 { NOTIF_MATCH(name, net_name) { print(sprintf(CCR(normal_or_gentle(infnor, infgen)), infargs)); } }
635 MSG_DEATH_NOTIFICATIONS
636 #undef MSG_DEATH_NOTIF
639 else { backtrace("Incorrect usage of Send_Notification!\n"); }
642 void Send_Notification_ToTeam(float targetteam, entity except, float net_type, float net_name, string s1, string s2, float f1, float f2, float f3)
645 FOR_EACH_REALCLIENT(tmp_entity)
647 if(tmp_entity.classname == STR_PLAYER)
648 if(tmp_entity.team == targetteam)
649 if(tmp_entity != except)
651 Send_Notification(tmp_entity, MSG_ONE, net_type, net_name, s1, s2, f1, f2, f3);
656 // WARNING: use this ONLY if you need exceptions or want to exclude spectators, otherwise use Send_Notification(world, MSG_ALL, ...)
657 void Send_Notification_ToAll(entity except, float spectators, float net_type, float net_name, string s1, string s2, float f1, float f2, float f3)
660 FOR_EACH_REALCLIENT(tmp_entity)
662 if((tmp_entity.classname == STR_PLAYER) || spectators)
663 if(tmp_entity != except)
665 Send_Notification(tmp_entity, MSG_ONE, net_type, net_name, s1, s2, f1, f2, f3);
671 // =============================
672 // LEGACY NOTIFICATION SYSTEMS
673 // =============================
675 void Send_KillNotification(string s1, string s2, string s3, float msg, float type)
677 WriteByte(MSG_ALL, SVC_TEMPENTITY);
678 WriteByte(MSG_ALL, TE_CSQC_KILLNOTIFY);
679 WriteString(MSG_ALL, s1);
680 WriteString(MSG_ALL, s2);
681 WriteString(MSG_ALL, s3);
682 WriteShort(MSG_ALL, msg);
683 WriteByte(MSG_ALL, type);
686 // Function is used to send a generic centerprint whose content CSQC gets to decide (gentle version or not in the below cases)
687 void Send_CSQC_KillCenterprint(entity e, string s1, string s2, float msg, float type)
689 if (clienttype(e) == CLIENTTYPE_REAL)
692 WRITESPECTATABLE_MSG_ONE({
693 WriteByte(MSG_ONE, SVC_TEMPENTITY);
694 WriteByte(MSG_ONE, TE_CSQC_KILLCENTERPRINT);
695 WriteString(MSG_ONE, s1);
696 WriteString(MSG_ONE, s2);
697 WriteShort(MSG_ONE, msg);
698 WriteByte(MSG_ONE, type);
703 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
705 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
708 WRITESPECTATABLE_MSG_ONE({
709 WriteByte(MSG_ONE, SVC_TEMPENTITY);
710 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
711 WriteByte(MSG_ONE, id);
712 WriteString(MSG_ONE, s);
713 if (id != 0 && s != "")
715 WriteByte(MSG_ONE, duration);
716 WriteByte(MSG_ONE, countdown_num);
721 void Send_CSQC_Centerprint_Generic_Expire(entity e, float id)
723 Send_CSQC_Centerprint_Generic(e, id, "", 1, 0);