1 // ================================================
2 // Unified notification system, written by Samual
3 // Last updated: February, 2013
4 // ================================================
6 entity Get_Notif_Ent(float net_type, float net_name)
10 case MSG_INFO: return msg_info_notifs[net_name - 1];
11 case MSG_CENTER: return msg_center_notifs[net_name - 1];
12 case MSG_WEAPON: return msg_weapon_notifs[net_name - 1];
13 case MSG_DEATH: return msg_death_notifs[net_name - 1];
15 backtrace(sprintf("Get_Notif_Ent(%d, %d): Improper net type!\n", net_type, net_name));
20 // ===============================
21 // Frontend Notification Pushing
22 // ===============================
24 void Dump_Notifications(float fh, float alsoprint)
26 #define NOTIF_WRITE(type,name,text) { \
27 notif_msg = sprintf("seta %s 1 // %s - %s\n", name, #type, strreplace("\n", "\\n", text)); \
28 fputs(fh, notif_msg); \
29 if(alsoprint) { print(strreplace("^", "^^", notif_msg)); } }
35 for(i = 0; i < NOTIF_INFO_COUNT; ++i) {
36 e = Get_Notif_Ent(MSG_INFO, i);
37 NOTIF_WRITE(MSG_INFO, e.nent_name, e.nent_string); }
39 for(i = 0; i < NOTIF_CENTER_COUNT; ++i) {
40 e = Get_Notif_Ent(MSG_CENTER, i);
41 NOTIF_WRITE(MSG_CENTER, e.nent_name, e.nent_string); }
43 for(i = 0; i < NOTIF_WEAPON_COUNT; ++i) {
44 e = Get_Notif_Ent(MSG_WEAPON, i);
45 NOTIF_WRITE(MSG_WEAPON, e.nent_name, sprintf("infoname: %s, centername: %s",
46 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name)); }
48 for(i = 0; i < NOTIF_DEATH_COUNT; ++i) {
49 e = Get_Notif_Ent(MSG_DEATH, i);
50 NOTIF_WRITE(MSG_DEATH, e.nent_name, sprintf("infoname: %s, centername: %s",
51 e.nent_msginfo.nent_name, e.nent_msgcenter.nent_name)); }
53 print(sprintf("Notification counts: MSG_INFO = %d, MSG_CENTER = %d, MSG_WEAPON = %d, MSG_DEATH = %d\n",
54 NOTIF_INFO_COUNT, NOTIF_CENTER_COUNT, NOTIF_WEAPON_COUNT, NOTIF_DEATH_COUNT));
60 #define HIT_MAX(count,funcname) if(sel_num == count) { backtrace(sprintf("%s: Hit maximum arguments!\n", funcname)); break; }
61 #define HIT_UNKNOWN(token,funcname) default: { backtrace(sprintf("%s: Hit unknown token in selected string! '%s'\n", funcname, selected)); break; }
62 string Local_Notification_sprintf(string input, string args,
63 string s1, string s2, string s3, string s4,
64 float f1, float f2, float f3, float f4)
66 #ifdef NOTIFICATIONS_DEBUG
68 sprintf("Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
69 strreplace("\n", "\\n", input),
71 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
72 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
79 for(sel_num = 0; sel_num < NOTIF_MAX_ARGS; ++sel_num) { arg_slot[sel_num] = ""; }
85 for(sel_num = 0;(args != "");)
87 selected = car(args); args = cdr(args);
88 HIT_MAX(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
89 switch(strtolower(selected))
91 #define ARG_CASE(prog,selected,result) \
93 #if (prog == ARG_BOTH) || (prog == ARG_TRIPLE) || (prog == ARG_CSQC) \
94 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
97 #if (prog == ARG_BOTH) || (prog == ARG_TRIPLE) || (prog == ARG_SVQC) \
98 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
103 HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
106 return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
110 void Local_Notification_HUD_Notify_Push(string icon, string hudargs, string s1, string s2, string s3, string s4)
114 arg_slot[0] = ""; arg_slot[1] = "";
116 for(sel_num = 0;(hudargs != "");)
118 selected = car(hudargs); hudargs = cdr(hudargs);
119 HIT_MAX(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
120 switch(strtolower(selected))
122 #define ARG_CASE(prog,selected,result) \
123 #if (prog == ARG_TRIPLE) \
124 case selected: { arg_slot[sel_num] = result; ++sel_num; break; } \
128 HIT_UNKNOWN(NOTIF_MAX_HUDARGS, "Local_Notification_HUD_Notify_Push")
131 HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
137 void Local_Notification(float net_type, float net_name, ...count)
139 // check supplied type and name for errors
140 string checkargs = "";
141 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
142 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
143 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
146 CHECKARG_TYPENAME(INFO)
147 CHECKARG_TYPENAME(CENTER)
148 CHECKARG_TYPENAME(WEAPON)
149 CHECKARG_TYPENAME(DEATH)
150 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
152 #undef CHECKARG_TYPENAME
153 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
155 entity notif = Get_Notif_Ent(net_type, net_name);
156 if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
157 if not(notif.nent_enabled) { print("Local_Notification: Entity was disabled...\n"); return; }
159 if((notif.nent_stringcount + notif.nent_floatcount) > count)
163 "Not enough arguments for Local_Notification! ",
164 "stringcount(%d) + floatcount(%d) > count(%d)\n",
165 "Check the definition and function call for accuracy...?\n"
167 notif.nent_stringcount, notif.nent_floatcount, count));
170 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
174 "Too many arguments for Local_Notification! ",
175 "stringcount(%d) + floatcount(%d) < count(%d)\n",
176 "Check the definition and function call for accuracy...?\n"
178 notif.nent_stringcount, notif.nent_floatcount, count));
182 string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
183 string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
184 string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
185 string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
186 float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
187 float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
188 float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
189 float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
191 #ifdef NOTIFICATIONS_DEBUG
193 sprintf("Local_Notification(%d, %s, %s, %s);\n",
196 sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
197 sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
207 Local_Notification_sprintf(
214 if(notif.nent_icon != "")
216 Local_Notification_HUD_Notify_Push(
230 Local_Notification_sprintf(
243 if(notif.nent_msginfo)
244 if(notif.nent_msginfo.nent_enabled)
246 Local_Notification_Without_VarArgs(
248 notif.nent_msginfo.nent_id,
249 notif.nent_msginfo.nent_stringcount,
250 notif.nent_msginfo.nent_floatcount,
255 if(notif.nent_msgcenter)
256 if(notif.nent_msgcenter.nent_enabled)
258 Local_Notification_Without_VarArgs(
260 notif.nent_msgcenter.nent_id,
261 notif.nent_msgcenter.nent_stringcount,
262 notif.nent_msgcenter.nent_floatcount,
272 void Local_Notification_Without_VarArgs(float net_type, float net_name,
273 float stringcount, float floatcount,
274 string s1, string s2, string s3, string s4,
275 float f1, float f2, float f3, float f4)
277 #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) { Local_Notification(net_type, net_name, args); return; }
278 EIGHT_VARS_TO_VARARGS_VARLIST
280 Local_Notification(net_type, net_name); // some notifications don't have any arguments at all
284 // =========================
285 // Notification Networking
286 // =========================
289 void Read_Notification(float is_new)
291 float net_type = ReadByte();
292 float net_name = ReadShort();
294 entity notif = Get_Notif_Ent(net_type, net_name);
295 if not(notif) { print("Read_Notification: Could not find notification entity!\n"); return; }
297 string s1 = ((0 < notif.nent_stringcount) ? ReadString() : "");
298 string s2 = ((1 < notif.nent_stringcount) ? ReadString() : "");
299 string s3 = ((2 < notif.nent_stringcount) ? ReadString() : "");
300 string s4 = ((3 < notif.nent_stringcount) ? ReadString() : "");
301 float f1 = ((0 < notif.nent_floatcount) ? ReadLong() : 0);
302 float f2 = ((1 < notif.nent_floatcount) ? ReadLong() : 0);
303 float f3 = ((2 < notif.nent_floatcount) ? ReadLong() : 0);
304 float f4 = ((3 < notif.nent_floatcount) ? ReadLong() : 0);
306 #ifdef NOTIFICATIONS_DEBUG
307 dprint(sprintf("Read_Notification(%d) at %f: net_name = %s.\n", is_new, time, notif.nent_name));
310 if(is_new) { Local_Notification_Without_VarArgs(net_type, net_name, notif.nent_stringcount, notif.nent_floatcount, s1, s2, s3, s4, f1, f2, f3, f4); }
315 void Notification_Remove()
318 for(i = 0; i < 4; ++i) { if(self.nent_strings[i]) { strunzone(self.nent_strings[i]); } }
322 float Write_Notification(entity client, float sf)
324 float i, send = FALSE;
326 switch(self.nent_broadcast)
328 case NOTIF_ONE: { if((client == self.nent_client) || (client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
329 case NOTIF_ONE_ONLY: { if(client == self.nent_client) { send = TRUE; } break; }
330 case NOTIF_TEAM: { if((client.team == self.nent_client.team) || (client.classname == STR_SPECTATOR && client.enemy.team == self.nent_client.team)) { send = TRUE; } break; }
331 case NOTIF_TEAM_EXCEPT: { if(((client != self.nent_client) && (client.team == self.nent_client.team) && !(client.classname == STR_SPECTATOR && client.enemy == self.nent_client))) { send = TRUE; } break; }
332 case NOTIF_ANY: { send = TRUE; break; }
333 case NOTIF_ANY_EXCEPT: { if((client != self.nent_client) && !(client.classname == STR_SPECTATOR && client.enemy == self.nent_client)) { send = TRUE; } break; }
334 default: { send = FALSE; break; }
339 WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
340 WriteByte(MSG_ENTITY, self.nent_net_type);
341 WriteShort(MSG_ENTITY, self.nent_net_name);
342 for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
343 for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
349 void Send_Notification(float broadcast, entity client,
350 float net_type, float net_name, ...count)
352 // check supplied broadcast, target, type, and name for errors
353 string checkargs = "";
354 #define CHECKARG_TYPENAME(type) case MSG_##type##: \
355 { if(!net_name || (net_name > NOTIF_##type##_COUNT)) \
356 { checkargs = sprintf("Improper name: %d!", net_name); } break; }
359 CHECKARG_TYPENAME(INFO)
360 CHECKARG_TYPENAME(CENTER)
361 CHECKARG_TYPENAME(WEAPON)
362 CHECKARG_TYPENAME(DEATH)
363 default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
365 #undef CHECKARG_TYPENAME
366 if(checkargs != "") { checkargs = strcat(checkargs, " "); }
370 case NOTIF_ONE_ONLY: { if(clienttype(client) == CLIENTTYPE_NOTACLIENT) { checkargs = sprintf("%sNo client provided!", checkargs); } break; }
371 case NOTIF_ANY_EXCEPT: { if(clienttype(client) == CLIENTTYPE_NOTACLIENT) { checkargs = sprintf("%sException can't be a non-client!", checkargs); } break; }
372 case NOTIF_ANY: { if(client) { checkargs = sprintf("%sEntity provided when world was required!", checkargs); } break; }
374 case NOTIF_TEAM_EXCEPT:
376 if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
377 else if(clienttype(client) == CLIENTTYPE_NOTACLIENT)
379 if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
380 else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
384 default: { checkargs = sprintf("%sImproper broadcast: %d!", checkargs, broadcast); break; }
386 if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
388 // retreive counts for the arguments of this notification
389 entity notif = Get_Notif_Ent(net_type, net_name);
390 if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
392 if((notif.nent_stringcount + notif.nent_floatcount) > count)
396 "Not enough arguments for Send_Notification! ",
397 "stringcount(%d) + floatcount(%d) > count(%d)\n",
398 "Check the definition and function call for accuracy...?\n"
400 notif.nent_stringcount, notif.nent_floatcount, count));
403 else if((notif.nent_stringcount + notif.nent_floatcount) < count)
407 "Too many arguments for Send_Notification! ",
408 "stringcount(%d) + floatcount(%d) < count(%d)\n",
409 "Check the definition and function call for accuracy...?\n"
411 notif.nent_stringcount, notif.nent_floatcount, count));
415 #ifdef NOTIFICATIONS_DEBUG
417 sprintf("Send_Notification(%d, %d, %s, stringcount: %d, floatcount: %d, varargs: %d);\n",
421 notif.nent_stringcount,
422 notif.nent_floatcount,
428 entity net_notif = spawn();
429 net_notif.nent_broadcast = broadcast;
430 net_notif.nent_client = client;
431 net_notif.nent_net_type = net_type;
432 net_notif.nent_net_name = net_name;
433 net_notif.nent_stringcount = notif.nent_stringcount;
434 net_notif.nent_floatcount = notif.nent_floatcount;
437 for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
438 for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
440 net_notif.think = Notification_Remove;
441 net_notif.nextthink = (time + 0.5);
443 Net_LinkEntity(net_notif, FALSE, 0, Write_Notification);
445 if((!server_is_local) && (broadcast == NOTIF_ANY || broadcast == NOTIF_ANY_EXCEPT) && (net_type != MSG_CENTER))
446 { Local_Notification_Without_VarArgs(net_type, net_name, notif.nent_stringcount, notif.nent_floatcount,
447 IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3), IFFL(0), IFFL(1), IFFL(2), IFFL(3)); }
450 void Send_Notification_Without_VarArgs(float broadcast, entity client,
451 float net_type, float net_name,
452 float stringcount, float floatcount,
453 string s1, string s2, string s3, string s4,
454 float f1, float f2, float f3, float f4)
456 #define VARITEM(stringc,floatc,args) if((stringcount == stringc) && (floatcount == floatc)) \
457 { Send_Notification(broadcast, client, net_type, net_name, args); return; }
458 EIGHT_VARS_TO_VARARGS_VARLIST
460 Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
463 void Send_Notification_Legacy_Wrapper(float broadcast, entity client,
464 float net_type, float net_name,
465 string s1, string s2,
466 float f1, float f2, float f3)
468 entity notif = Get_Notif_Ent(net_type, net_name);
469 Send_Notification_Without_VarArgs(broadcast, client, net_type, net_name,
470 notif.nent_stringcount, notif.nent_floatcount,
471 s1, s2, "", "", f1, f2, f3, 0);
475 // =============================
476 // LEGACY NOTIFICATION SYSTEMS
477 // =============================
479 void Send_CSQC_Centerprint_Generic(entity e, float id, string s, float duration, float countdown_num)
481 if ((clienttype(e) == CLIENTTYPE_REAL) && (e.flags & FL_CLIENT))
484 WRITESPECTATABLE_MSG_ONE({
485 WriteByte(MSG_ONE, SVC_TEMPENTITY);
486 WriteByte(MSG_ONE, TE_CSQC_CENTERPRINT_GENERIC);
487 WriteByte(MSG_ONE, id);
488 WriteString(MSG_ONE, s);
489 if (id != 0 && s != "")
491 WriteByte(MSG_ONE, duration);
492 WriteByte(MSG_ONE, countdown_num);
497 void Send_CSQC_Centerprint_Generic_Expire(entity e, float id)
499 Send_CSQC_Centerprint_Generic(e, id, "", 1, 0);