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(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 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
58 #define WRITESPECTATABLE_MSG_ONE(statement) WRITESPECTATABLE_MSG_ONE_VARNAME(oldmsg_entity, statement)
59 #define WRITESPECTATABLE(msg,statement) if(msg == MSG_ONE) { WRITESPECTATABLE_MSG_ONE(statement); } else statement float WRITESPECTATABLE_workaround = 0
62 // do nothing for the other programs, they don't need cvars (those are just for the clients)
63 #define ADD_CSQC_AUTOCVAR(name)
68 If BELOW negative maxplayers, you dropped a place lower
69 If below 0, you are tied for that place
70 If above 0, you are holding that place alone
71 If above positive maxplayers, you moved up a place
73 float Should_Print_Score_Pos
75 string Read_Score_Pos(float num)
80 float Form_Score_Pos(entity player)
85 // ====================================
86 // Notifications List and Information
87 // ====================================
88 /*(name,strnum,flnum,args,cpid,cennor,cengen,infargs,hudargs,icon,infnor,infgen)
89 List of all notifications (including identifiers and display information)
90 Format: name, strnum, flnum, args, *hudargs, *icon, *CPID, *durcnt, normal, gentle, *infargs, *hudargs, *icon, *infnor, *infgen
91 Asterisked fields are not present in all notification types.
94 Number of STRING arguments (so that networking knows how many to send/receive)
95 Number of FLOAT arguments (so that networking knows how many to send/receive)
96 Arguments for sprintf(string, args), if no args needed then use ""
98 Hudargs: XPND2(STRING, STRING): arguments for names in notify messages
99 Icon: STRING: icon string name for the hud notify panel, "" if no icon is used
101 CPID: FLOAT: centerprint ID number (CPID_*), NO_CPID if no CPID is needed
102 Duration/Countdown: XPND2(FLOAT, FLOAT): extra arguments for centerprint messages
104 CPID: FLOAT: centerprint ID number (CPID_*), NO_CPID if no CPID is needed
105 Normal message (string for sprintf when gentle messages are NOT enabled)
106 Gentle message (string for sprintf when gentle messages ARE enabled)
108 Infargs: notify message args for sprintf(string, args), if no args needed then use ""
109 Hudargs: XPND2(STRING, STRING): arguments for names in notify messages
110 Icon: STRING: icon string name for the hud notify panel, "" if no icon is used
111 Infnor: STRING: normal message for info message
112 Infgen: STRING: gentle message for info message
114 Messages with ^F1, ^BG, ^TC, etc etc in them will replace those strings
115 with colors according to the cvars the user has chosen. This allows for
116 users to create unique color profiles for their HUD, giving more customization
117 options to HUD designers and end users who want such a feature.
119 Check out the function calls for string CCR(...) and
120 string TCR(...) to better understand how these codes work.
122 Guidlines (please try and follow these):
123 -ALWAYS start the string with a color, preferably background.
124 -ALWAYS reset a color after a name (this way they don't set it for the whole string).
125 -NEVER re-declare an event twice.
126 -NEVER add or remove fields from the format, it SHOULD already work.
127 -MSG_INFO messages must ALWAYS end with a new line: \n
128 -Be clean and simple with your notification naming,
129 nothing too long for the name field... Abbreviations are your friend. :D
130 -Keep the spacing as clean as possible... if the arguments are abnormally long,
131 it's okay to go out of line a bit... but try and keep it clean still.
132 -Sort the notifications in the most appropriate order for their tasks.
133 TODO: ? centerprint IDs are given priority based on their order (first being highest priority going downwards)
134 -ARIRE unir frk jvgu lbhe bja zbgure. (gvc sbe zvxrrhfn) -- Don't pay attention to this ^_^
137 // weaponorder[f1].netname
139 #define MULTITEAM_INFO(prefix,teams,strnum,flnum,args,hudargs,icon,normal,gentle) \
140 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))) \
141 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))) \
143 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))) \
146 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))) \
148 #define MSG_INFO_NOTIFICATIONS \
149 MSG_INFO_NOTIF(INFO_EMPTY, 0, 0, NO_STR_ARG, XPND2("", ""), "", "", "") \
150 MULTITEAM_INFO(INFO_SCORES_, 4, 0, 0, NO_STR_ARG, XPND2("", ""), "", _("^TC^TT ^BGteam scores!\n"), "") \
151 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"), "") \
152 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"), "") \
153 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"), "") \
154 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"), "") \
155 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"), "") \
156 MULTITEAM_INFO(INFO_CTF_FLAGRETURN_TIMEOUT_, 2, 0, 0, NO_STR_ARG, XPND2("", ""), "", _("^BGThe ^TC^TT^BG flag has returned to the base\n"), "") \
157 MULTITEAM_INFO(INFO_CTF_PICKUP_, 2, 1, 0, s1, XPND2(s1, ""), "notify_%s_taken", _("^BG%s^BG got the ^TC^TT^BG flag\n"), "") \
158 MULTITEAM_INFO(INFO_CTF_RETURN_, 2, 1, 0, s1, XPND2(s1, ""), "notify_%s_returned", _("^BG%s^BG returned the ^TC^TT^BG flag\n"), "") \
159 MULTITEAM_INFO(INFO_CTF_LOST_, 2, 1, 0, s1, XPND2(s1, ""), "notify_%s_lost", _("^BG%s^BG lost the ^TC^TT^BG flag\n"), "") \
160 MULTITEAM_INFO(INFO_CTF_CAPTURE_, 2, 1, 0, s1, XPND2(s1, ""), "notify_%s_captured", _("^BG%s^BG captured the ^TC^TT^BG flag\n"), "") \
161 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"), "") \
162 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"), "") \
163 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"), "")
165 #define MULTITEAM_CENTER(prefix,teams,strnum,flnum,args,cpid,durcnt,normal,gentle) \
166 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))) \
167 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))) \
169 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))) \
172 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))) \
174 #define MSG_CENTER_NOTIFICATIONS \
175 MSG_CENTER_NOTIF(CENTER_EMPTY, 0, 0, NO_STR_ARG, NO_CPID, XPND2(0, 0), "", "") \
176 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."), "") \
177 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."), "") \
178 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"), "") \
179 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"), "") \
180 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"), "") \
181 MSG_CENTER_NOTIF(CENTER_CTF_PASS_REQUESTING, 1, 0, s1, CPID_CTF_PASS, XPND2(0, 0), _("^BGRequesting %s^BG to pass you the flag"), "") \
182 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"), "") \
183 MULTITEAM_CENTER(CENTER_CTF_RETURN_, 2, 0, 0, NO_STR_ARG, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYou returned the ^TC^TT^BG flag!"), "") \
184 MULTITEAM_CENTER(CENTER_CTF_CAPTURE_, 2, 0, 0, NO_STR_ARG, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYou captured the ^TC^TT^BG flag!"), "") \
185 MULTITEAM_CENTER(CENTER_CTF_PICKUP_, 2, 0, 0, NO_STR_ARG, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGYou got the ^TC^TT^BG flag!"), "") \
186 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!"), "") \
187 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!"), "") \
188 MSG_CENTER_NOTIF(CENTER_CTF_PICKUP_ENEMY, 1, 0, s1, CPID_CTF_LOWPRIO, XPND2(0, 0), _("^BGThe %senemy^BG got your flag! Retrieve it!"), "") \
189 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!"), "") \
190 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!"), "") \
191 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!"), "") \
192 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."), "")
194 #define MSG_WEAPON_NOTIFICATIONS \
195 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"), "")
197 #define MSG_DEATH_NOTIFICATIONS \
198 MSG_DEATH_NOTIF(DEATH_SELF_CUSTOM, 2, 0, XPND2(s1, s2), NO_CPID, _("^K1You were %s, %s"), "", \
199 NO_STR_ARG, XPND2(s1, ""), "notify_death", _("^FG%s^K1\n"), "") \
200 MSG_DEATH_NOTIF(DEATH_SELF_GENERIC, 1, 0, NO_STR_ARG, NO_CPID, _("^K1Watch your step!"), "", \
201 NO_STR_ARG, XPND2(s1, ""), "notify_void", _("^FG%s^K1\n"), "") \
202 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!"), \
203 NO_STR_ARG, XPND2("", ""), "notify_selfkill", _("^FG%s^K1\n"), "") \
204 MSG_DEATH_NOTIF(DEATH_SELF_SUICIDE, 1, 0, NO_STR_ARG, NO_CPID, _("^K1You committed suicide!"), _("^K1You ended it all!"), \
205 s1, XPND2(s1, ""), "notify_selfkill", _("^FG%s^K1 couldn't take it anymore\n"), "") \
206 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..."), \
207 NO_STR_ARG, XPND2("", ""), "notify_outofammo", _("^FG%s^K1\n"), "") \
208 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"), \
209 NO_STR_ARG, XPND2("", ""), "notify_death", _("^FG%s^K1\n"), "") \
210 MSG_DEATH_NOTIF(DEATH_SELF_CAMP, 1, 0, NO_STR_ARG, NO_CPID, _("^K1Die camper!"), _("^K1Reconsider your tactics, camper!"), \
211 NO_STR_ARG, XPND2(s1, ""), "notify_camping", _("^FG%s^K1\n"), "") \
212 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!"), \
213 NO_STR_ARG, XPND2("", ""), "", _("^FG%s^K1\n"), "") \
214 MSG_DEATH_NOTIF(DEATH_SELF_TEAMCHANGE, 0, 1, DEATH_TEAM, NO_CPID, _("^BGYou are now on: %s"), "", \
215 NO_STR_ARG, XPND2("", ""), "", _("^FG%s^K1\n"), "") \
216 MSG_DEATH_NOTIF(DEATH_SELF_AUTOTEAMCHANGE, 0, 1, DEATH_TEAM, NO_CPID, _("^BGYou have been moved into a different team\nYou are now on: %s"), "", \
217 NO_STR_ARG, XPND2("", ""), "", _("^FG%s^K1\n"), "") \
218 MSG_DEATH_NOTIF(DEATH_SELF_FALL, 0, 0, NO_STR_ARG, NO_CPID, _("^K1You hit the ground with a crunch!"), "", \
219 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")) \
220 MSG_DEATH_NOTIF(DEATH_SELF_DROWN, 1, 0, NO_STR_ARG, NO_CPID, _("^K1You couldn't catch your breath in time!"), "", \
221 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")) \
222 MSG_DEATH_NOTIF(DEATH_SELF_LAVA, 1, 0, NO_STR_ARG, NO_CPID, _("^K1You couldn't stand the heat!"), "", \
223 NO_STR_ARG, XPND2("", ""), "notify_lava", _("^FG%s^K1 turned into hot slag\n"), _("^FG%s^K1 found a hot place\n")) \
224 MSG_DEATH_NOTIF(DEATH_SELF_SLIME, 1, 0, NO_STR_ARG, NO_CPID, _("^K1You melted away in slime!"), "", \
225 NO_STR_ARG, XPND2("", ""), "notify_slime", _("^FG%s^K1 was slimed\n"), "") \
226 MSG_DEATH_NOTIF(DEATH_SELF_SHOOTING_STAR, 0, 0, NO_STR_ARG, NO_CPID, _("^K1You became a shooting star!"), "", \
227 NO_STR_ARG, XPND2("", ""), "notify_shootingstar", _("^FG%s^K1\n"), "") \
228 MSG_DEATH_NOTIF(DEATH_SELF_SWAMP, 0, 0, NO_STR_ARG, NO_CPID, _("^K1You got stuck in a swamp!"), "", \
229 NO_STR_ARG, XPND2("", ""), "", _("^FG%s^K1\n"), "") \
230 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"), \
231 NO_STR_ARG, XPND2("", ""), "", "", "") \
232 MSG_DEATH_NOTIF(DEATH_MURDER_FRAGGED, 1, 0, s1, NO_CPID, _("^K1You were fragged by ^BG%s"), _("^K1You were scored against by ^BG%s"), \
233 NO_STR_ARG, XPND2("", ""), "", "", "") \
234 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"), \
235 NO_STR_ARG, XPND2("", ""), "", "", "") \
236 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!"), \
237 NO_STR_ARG, XPND2("", ""), "", "", "") \
238 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"), \
239 NO_STR_ARG, XPND2("", ""), "", "", "") \
240 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"), \
241 NO_STR_ARG, XPND2("", ""), "", "", "") \
242 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"), \
243 NO_STR_ARG, XPND2("", ""), "", "", "") \
244 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!"), \
245 NO_STR_ARG, XPND2("", ""), "", "", "") \
246 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"), \
247 NO_STR_ARG, XPND2("", ""), "", "", "") \
248 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"), \
249 NO_STR_ARG, XPND2("", ""), "", "", "") \
250 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"), \
251 NO_STR_ARG, XPND2("", ""), "", "", "") \
252 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"), \
253 NO_STR_ARG, XPND2("", ""), "", "", "") \
254 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"), \
255 NO_STR_ARG, XPND2("", ""), "", "", "") \
256 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"), \
257 NO_STR_ARG, XPND2("", ""), "", "", "") \
258 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"), \
259 NO_STR_ARG, XPND2("", ""), "", "", "") \
260 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!"), \
261 NO_STR_ARG, XPND2("", ""), "", "", "") \
263 // ====================================
264 // Initialization/Create Declarations
265 // ====================================
267 #define NOTIF_FIRST 1
268 #define NOTIF_MAX 1024 // limit of recursive functions with ACCUMULATE_FUNCTION
269 float NOTIF_INFO_COUNT;
270 float NOTIF_CENTER_COUNT;
271 float NOTIF_WEAPON_COUNT;
272 float NOTIF_DEATH_COUNT;
273 float NOTIF_CPID_COUNT;
275 #define MSG_INFO_NOTIF(name,strnum,flnum,args,icon,normal,gentle) \
276 ADD_CSQC_AUTOCVAR(name) \
278 void RegisterNotification_##name() \
280 SET_FIELD_COUNT(name, NOTIF_FIRST, NOTIF_INFO_COUNT) \
281 CHECK_MAX_COUNT(name, NOTIF_MAX, NOTIF_INFO_COUNT, "notifications") \
283 ACCUMULATE_FUNCTION(RegisterNotifications, RegisterNotification_##name)
285 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
286 ADD_CSQC_AUTOCVAR(name) \
289 void RegisterNotification_##name() \
291 SET_FIELD_COUNT(name, NOTIF_FIRST, NOTIF_CENTER_COUNT) \
292 SET_FIELD_COUNT(cpid, NOTIF_FIRST, NOTIF_CPID_COUNT) \
293 CHECK_MAX_COUNT(name, NOTIF_MAX, NOTIF_CENTER_COUNT, "notifications") \
295 ACCUMULATE_FUNCTION(RegisterNotifications, RegisterNotification_##name)
297 #define MSG_WEAPON_NOTIF(name,strnum,flnum,args,normal,gentle) \
298 ADD_CSQC_AUTOCVAR(name) \
300 void RegisterNotification_##name() \
302 SET_FIELD_COUNT(name, NOTIF_FIRST, NOTIF_WEAPON_COUNT) \
303 CHECK_MAX_COUNT(name, NOTIF_MAX, NOTIF_WEAPON_COUNT, "notifications") \
305 ACCUMULATE_FUNCTION(RegisterNotifications, RegisterNotification_##name)
307 #define MSG_DEATH_NOTIF(name,strnum,flnum,args,cpid,cennor,cengen,infargs,hudargs,icon,infnor,infgen) \
308 ADD_CSQC_AUTOCVAR(name) \
310 void RegisterNotification_##name() \
312 SET_FIELD_COUNT(name, NOTIF_FIRST, NOTIF_DEATH_COUNT) \
313 CHECK_MAX_COUNT(name, NOTIF_MAX, NOTIF_DEATH_COUNT, "notifications") \
315 ACCUMULATE_FUNCTION(RegisterNotifications, RegisterNotification_##name)
317 // NOW we actually activate the declarations
318 MSG_INFO_NOTIFICATIONS
319 MSG_CENTER_NOTIFICATIONS
320 MSG_WEAPON_NOTIFICATIONS
321 MSG_DEATH_NOTIFICATIONS
322 #undef MSG_INFO_NOTIF
323 #undef MSG_CENTER_NOTIF
324 #undef MSG_WEAPON_NOTIF
325 #undef MSG_DEATH_NOTIF
327 // ======================
328 // Supporting Functions
329 // ======================
331 // select between the normal or the gentle message string based on client (or server) settings
332 string normal_or_gentle(string normal, string gentle)
336 if(autocvar_cl_gentle || autocvar_cl_gentle_messages)
338 if(autocvar_sv_gentle)
340 return ((gentle != "") ? gentle : normal);
348 float notif_stringcount(string s1, string s2)
351 if(s1 != NO_STR_ARG) ++stringcount;
352 if(s2 != NO_STR_ARG) ++stringcount;
356 float notif_floatcount(float f1, float f2, float f3)
359 if(f1 != NO_FL_ARG) ++floatcount;
360 if(f2 != NO_FL_ARG) ++floatcount;
361 if(f3 != NO_FL_ARG) ++floatcount;
365 // get the actual name of a notification and return it as a string
366 string Get_Field_Value(float field, float net_type, float net_name)
370 #define GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) \
371 if(field == F_NAME) { output = VAR_TO_TEXT(name); } \
372 else if(field == F_STRNUM) { output = ftos(strnum); } \
373 else if(field == F_FLNUM) { output = ftos(flnum); }
379 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
380 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } }
381 MSG_INFO_NOTIFICATIONS
382 #undef MSG_INFO_NOTIF
387 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
388 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } }
389 MSG_CENTER_NOTIFICATIONS
390 #undef MSG_CENTER_NOTIF
395 #define MSG_WEAPON_NOTIF(name,strnum,flnum,args,normal,gentle) \
396 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } }
397 MSG_WEAPON_NOTIFICATIONS
398 #undef MSG_WEAPON_NOTIF
403 #define MSG_DEATH_NOTIF(name,strnum,flnum,args,cpid,cennor,cengen,infargs,hudargs,icon,infnor,infgen) \
404 { NOTIF_MATCH(name, net_name) { GET_FIELD_VALUE_OUTPUT(field,name,strnum,flnum) } }
405 MSG_DEATH_NOTIFICATIONS
406 #undef MSG_DEATH_NOTIF
411 #undef GET_FIELD_VALUE_OUTPUT
416 string TCR(string input, string teamcolor, string teamtext)
418 input = strreplace("^TC", teamcolor, input);
419 input = strreplace("^TT", teamtext, input);
423 // color code replace, place inside of sprintf and parse the string
424 string CCR(string input)
426 // foreground/normal colors
427 input = strreplace("^F1", "^2", input); // primary priority (important names, etc)
428 input = strreplace("^F2", "^3", input); // secondary priority (items, locations, numbers, etc)
431 input = strreplace("^K1", "^1", input); // "bad" or "dangerous" text (death messages against you, kill notifications, etc)
432 input = strreplace("^K2", "^3", input); // similar to above, but less important... OR, a highlight out of above message type
433 input = strreplace("^K3", "^4", input); // "good" or "beneficial" text (you fragging someone, etc)
436 input = strreplace("^BG", "^7", input); // neutral/unimportant text
437 input = strreplace("^N", "^7", input); // "none"-- reset to white...
442 // =============================
443 // Debug/Maintenance Functions
444 // =============================
446 #define NOTIF_Write(type,name,text) fputs(fh, (sprintf("seta %s 1 // %s - %s\n", name, type, strreplace("\n", "\\n", text))))
447 void Dump_Notifications(float fh)
449 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) { NOTIF_Write("MSG_INFO", VAR_TO_TEXT(name), normal); }
450 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) { NOTIF_Write("MSG_CENTER", VAR_TO_TEXT(name), normal); }
451 #define MSG_WEAPON_NOTIF(name,strnum,flnum,args,normal,gentle) { NOTIF_Write("MSG_WEAPON", VAR_TO_TEXT(name), normal); }
452 #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); }
453 MSG_INFO_NOTIFICATIONS
454 MSG_CENTER_NOTIFICATIONS
455 MSG_WEAPON_NOTIFICATIONS
456 MSG_DEATH_NOTIFICATIONS
457 #undef MSG_INFO_NOTIF
458 #undef MSG_CENTER_NOTIF
459 #undef MSG_WEAPON_NOTIF
460 #undef MSG_DEATH_NOTIF
465 // ===============================
466 // Frontend Notification Pushing
467 // ===============================
470 #define KN_MAX_ENTRIES 10
472 float killnotify_times[KN_MAX_ENTRIES];
473 string killnotify_icon[KN_MAX_ENTRIES];
474 string killnotify_attackers[KN_MAX_ENTRIES];
475 string killnotify_victims[KN_MAX_ENTRIES];
476 // 0 = "Y [used by] X", 1 = "X [did action to] Y"
477 void HUD_Notify_Push(string icon, string attacker, string victim)
482 if (kn_index == -1) { kn_index = KN_MAX_ENTRIES-1; }
483 killnotify_times[kn_index] = time;
486 if(killnotify_icon[kn_index]) { strunzone(killnotify_icon[kn_index]); }
487 killnotify_icon[kn_index] = strzone(icon);
490 if(killnotify_attackers[kn_index]) { strunzone(killnotify_attackers[kn_index]); }
491 killnotify_attackers[kn_index] = strzone(attacker);
494 if(killnotify_victims[kn_index]) { strunzone(killnotify_victims[kn_index]); }
495 killnotify_victims[kn_index] = strzone(victim);
499 void Local_Notification(float net_type, float net_name, string s1, string s2, float f1, float f2, float f3)
505 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
506 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
508 print(sprintf(CCR(normal_or_gentle(normal, gentle)), args)); \
509 if(strtolower(icon) != "") { HUD_Notify_Push(icon, hudargs); } \
511 MSG_INFO_NOTIFICATIONS
512 #undef MSG_INFO_NOTIF
517 #define MSG_CENTER_NOTIF(name,strnum,flnum,args,cpid,durcnt,normal,gentle) \
518 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
520 centerprint_generic(HANDLE_CPID(cpid), sprintf(CCR(normal_or_gentle(normal, gentle)), args), durcnt); \
522 MSG_CENTER_NOTIFICATIONS
523 #undef MSG_CENTER_NOTIF
528 #define MSG_WEAPON_NOTIF(name,strnum,flnum,args,normal,gentle) \
529 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
531 print("unhandled\n"); \
533 MSG_WEAPON_NOTIFICATIONS
534 #undef MSG_WEAPON_NOTIF
539 #define MSG_DEATH_NOTIF(name,strnum,flnum,args,cpid,cennor,cengen,infargs,hudargs,icon,infnor,infgen) \
540 { NOTIF_MATCH(name, net_name) CHECK_AUTOCVAR(name) \
542 centerprint_generic(HANDLE_CPID(cpid), sprintf(CCR(normal_or_gentle(cennor, cengen)), args), 0, 0); \
544 MSG_DEATH_NOTIFICATIONS
545 #undef MSG_DEATH_NOTIF
553 // =========================
554 // Notification Networking
555 // =========================
558 void Read_Notification(void)
560 float net_type = ReadByte();
561 float net_name = ReadShort();
563 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
564 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
566 Local_Notification(net_type, net_name,
567 ((stringcount >= 1) ? ReadString() : ""),
568 ((stringcount == 2) ? ReadString() : ""),
569 ((floatcount >= 1) ? ReadLong() : 0),
570 ((floatcount >= 2) ? ReadLong() : 0),
571 ((floatcount == 3) ? ReadLong() : 0));
576 void Send_Notification(entity client, float broadcast, float net_type, float net_name, string s1, string s2, float f1, float f2, float f3)
578 if(net_type && net_name)
580 //print("notification: ", Get_Field_Value(F_NAME, net_type, net_name), ": ", ftos(net_name), ".\n");
582 float stringcount = stof(Get_Field_Value(F_STRNUM, net_type, net_name));
583 float floatcount = stof(Get_Field_Value(F_FLNUM, net_type, net_name));
585 if(notif_stringcount(s1, s2) > stringcount) { backtrace("Too many string arguments for notification!\n"); return; }
586 if(notif_floatcount(f1, f2, f3) > floatcount) { backtrace("Too many float arguments for notification!\n"); return; }
588 if(broadcast == MSG_ONE)
590 if(client && (clienttype(client) == CLIENTTYPE_REAL) && (client.flags & FL_CLIENT))
592 // personal/direct notification sent to ONE person and their spectators
594 WRITESPECTATABLE_MSG_ONE({
595 WriteByte(MSG_ONE, SVC_TEMPENTITY);
596 WriteByte(MSG_ONE, TE_CSQC_NOTIFICATION);
597 WriteByte(MSG_ONE, net_type);
598 WriteShort(MSG_ONE, net_name);
599 if(stringcount >= 1) { WriteString(MSG_ONE, s1); }
600 if(stringcount == 2) { WriteString(MSG_ONE, s2); }
601 if(floatcount >= 1) { WriteLong(MSG_ONE, f1); }
602 if(floatcount >= 2) { WriteLong(MSG_ONE, f2); }
603 if(floatcount == 3) { WriteLong(MSG_ONE, f3); }
607 else if(broadcast == MSG_ALL)
609 // global notification sent to EVERYONE
610 WriteByte(MSG_ALL, SVC_TEMPENTITY);
611 WriteByte(MSG_ALL, TE_CSQC_NOTIFICATION);
612 WriteByte(MSG_ALL, net_type);
613 WriteShort(MSG_ALL, net_name);
614 if(stringcount >= 1) { WriteString(MSG_ALL, s1); }
615 if(stringcount == 2) { WriteString(MSG_ALL, s2); }
616 if(floatcount >= 1) { WriteLong(MSG_ALL, f1); }
617 if(floatcount >= 2) { WriteLong(MSG_ALL, f2); }
618 if(floatcount == 3) { WriteLong(MSG_ALL, f3); }
620 else { backtrace("Unknown MSG_ type to write with!\n"); }
622 if(!server_is_local && (net_type == MSG_INFO))
624 #define MSG_INFO_NOTIF(name,strnum,flnum,args,hudargs,icon,normal,gentle) \
625 { NOTIF_MATCH(name, net_name) { print(sprintf(CCR(normal_or_gentle(normal, gentle)), args)); } }
626 MSG_INFO_NOTIFICATIONS
627 #undef MSG_INFO_NOTIF
629 #define MSG_DEATH_NOTIF(name,strnum,flnum,args,cpid,cennor,cengen,infargs,hudargs,icon,infnor,infgen) \
630 { NOTIF_MATCH(name, net_name) { print(sprintf(CCR(normal_or_gentle(infnor, infgen)), infargs)); } }
631 MSG_DEATH_NOTIFICATIONS
632 #undef MSG_DEATH_NOTIF
635 else { backtrace("Incorrect usage of Send_Notification!\n"); }
638 void Send_Notification_ToTeam(float targetteam, entity except, float net_type, float net_name, string s1, string s2, float f1, float f2, float f3)
641 FOR_EACH_REALCLIENT(tmp_entity)
643 if(tmp_entity.classname == STR_PLAYER)
644 if(tmp_entity.team == targetteam)
645 if(tmp_entity != except)
647 Send_Notification(tmp_entity, MSG_ONE, net_type, net_name, s1, s2, f1, f2, f3);
652 // WARNING: use this ONLY if you need exceptions or want to exclude spectators, otherwise use Send_Notification(world, MSG_ALL, ...)
653 void Send_Notification_ToAll(entity except, float spectators, float net_type, float net_name, string s1, string s2, float f1, float f2, float f3)
656 FOR_EACH_REALCLIENT(tmp_entity)
658 if((tmp_entity.classname == STR_PLAYER) || spectators)
659 if(tmp_entity != except)
661 Send_Notification(tmp_entity, MSG_ONE, net_type, net_name, s1, s2, f1, f2, f3);
667 // =============================
668 // LEGACY NOTIFICATION SYSTEMS
669 // =============================
671 void Send_KillNotification(string s1, string s2, string s3, float msg, float type)
673 WriteByte(MSG_ALL, SVC_TEMPENTITY);
674 WriteByte(MSG_ALL, TE_CSQC_KILLNOTIFY);
675 WriteString(MSG_ALL, s1);
676 WriteString(MSG_ALL, s2);
677 WriteString(MSG_ALL, s3);
678 WriteShort(MSG_ALL, msg);
679 WriteByte(MSG_ALL, type);
682 // Function is used to send a generic centerprint whose content CSQC gets to decide (gentle version or not in the below cases)
683 void Send_CSQC_KillCenterprint(entity e, string s1, string s2, float msg, float type)
685 if (clienttype(e) == CLIENTTYPE_REAL)
688 WRITESPECTATABLE_MSG_ONE({
689 WriteByte(MSG_ONE, SVC_TEMPENTITY);
690 WriteByte(MSG_ONE, TE_CSQC_KILLCENTERPRINT);
691 WriteString(MSG_ONE, s1);
692 WriteString(MSG_ONE, s2);
693 WriteShort(MSG_ONE, msg);
694 WriteByte(MSG_ONE, type);
699 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
701 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
704 WRITESPECTATABLE_MSG_ONE({
705 WriteByte(MSG_ONE, SVC_TEMPENTITY);
706 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
707 WriteByte(MSG_ONE, id);
708 WriteString(MSG_ONE, s);
709 if (id != 0 && s != "")
711 WriteByte(MSG_ONE, duration);
712 WriteByte(MSG_ONE, countdown_num);
717 void Send_CSQC_Centerprint_Generic_Expire(entity e, float id)
719 Send_CSQC_Centerprint_Generic(e, id, "", 1, 0);