// ================================================
// Unified notification system, written by Samual
-// Last updated: March, 2013
+// Last updated: August, 2013
// ================================================
string Get_Notif_TypeName(float net_type)
{
switch(net_type)
{
+ case MSG_ANNCE: return "MSG_ANNCE";
case MSG_INFO: return "MSG_INFO";
case MSG_CENTER: return "MSG_CENTER";
case MSG_CENTER_CPID: return "MSG_CENTER_CPID";
case MSG_MULTI: return "MSG_MULTI";
+ case MSG_CHOICE: return "MSG_CHOICE";
}
backtrace(sprintf("Get_Notif_TypeName(%d): Improper net type!\n", net_type));
return "";
{
switch(net_type)
{
+ case MSG_ANNCE: return msg_annce_notifs[net_name - 1];
case MSG_INFO: return msg_info_notifs[net_name - 1];
case MSG_CENTER: return msg_center_notifs[net_name - 1];
case MSG_MULTI: return msg_multi_notifs[net_name - 1];
+ case MSG_CHOICE: return msg_choice_notifs[net_name - 1];
}
backtrace(sprintf("Get_Notif_Ent(%d, %d): Improper net type!\n", net_type, net_name));
return world;
}
+#ifdef SVQC
+#ifdef NOTIFICATIONS_DEBUG
+string Get_Notif_BroadcastName(float broadcast)
+{
+ switch(broadcast)
+ {
+ case NOTIF_ONE: return "NOTIF_ONE";
+ case NOTIF_ONE_ONLY: return "NOTIF_ONE_ONLY";
+ case NOTIF_ALL_EXCEPT: return "NOTIF_ALL_EXCEPT";
+ case NOTIF_ALL: return "NOTIF_ALL";
+ case NOTIF_TEAM: return "NOTIF_TEAM";
+ case NOTIF_TEAM_EXCEPT: return "NOTIF_TEAM_EXCEPT";
+ }
+ backtrace(sprintf("Get_Notif_BroadcastName(%d): Improper broadcast!\n", broadcast));
+ return "";
+}
+#endif
+#endif
+
string Notification_CheckArgs_TypeName(float net_type, float net_name)
{
// check supplied type and name for errors
{ checkargs = sprintf("Improper name: %d!", net_name); } break; }
switch(net_type)
{
+ CHECKARG_TYPENAME(ANNCE)
CHECKARG_TYPENAME(INFO)
CHECKARG_TYPENAME(CENTER)
CHECKARG_TYPENAME(MULTI)
+ CHECKARG_TYPENAME(CHOICE)
default: { checkargs = sprintf("Improper type: %d!", checkargs, net_type); break; }
}
#undef CHECKARG_TYPENAME
}
case NOTIF_TEAM:
+ {
+ if not(teamplay)
+ { checkargs = sprintf("%sTeamplay not active!", checkargs); }
+ //else if not(client.team) { checkargs = sprintf("%sNo team provided!", checkargs); }
+ break;
+ }
+
case NOTIF_TEAM_EXCEPT:
{
- if not(teamplay) { checkargs = sprintf("%sTeamplay not active!", checkargs); }
+ if not(teamplay)
+ { checkargs = sprintf("%sTeamplay not active!", checkargs); }
else if(IS_NOT_A_CLIENT(client))
- {
- if(broadcast == NOTIF_TEAM) { checkargs = sprintf("%sNo client provided!", checkargs); }
- else { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
- }
+ { checkargs = sprintf("%sException can't be a non-client!", checkargs); }
break;
}
}
return checkargs;
}
+
+float Notification_ShouldSend(float broadcast, entity to_client, entity other_client)
+{
+ switch(broadcast)
+ {
+ case NOTIF_ONE: // send to one client and their spectator
+ {
+ if(
+ (to_client == other_client)
+ ||
+ (
+ IS_SPEC(to_client)
+ &&
+ (to_client.enemy == other_client)
+ )
+ ) { return TRUE; }
+ break;
+ }
+ case NOTIF_ONE_ONLY: // send ONLY to one client
+ {
+ if(to_client == other_client) { return TRUE; }
+ break;
+ }
+ case NOTIF_TEAM: // send only to X team and their spectators
+ {
+ if(
+ (to_client.team == other_client.team)
+ ||
+ (
+ IS_SPEC(to_client)
+ &&
+ (to_client.enemy.team == other_client.team)
+ )
+ ) { return TRUE; }
+ break;
+ }
+ case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
+ {
+ if(
+ (to_client != other_client)
+ &&
+ (
+ (to_client.team == other_client.team)
+ ||
+ (
+ IS_SPEC(to_client)
+ &&
+ (
+ (to_client.enemy != other_client)
+ &&
+ (to_client.enemy.team == other_client.team)
+ )
+ )
+ )
+ ) { return TRUE; }
+ break;
+ }
+ case NOTIF_ALL: // send to everyone
+ {
+ return TRUE;
+ }
+ case NOTIF_ALL_EXCEPT: // send to everyone except X person and their spectators
+ {
+ if(
+ (to_client != other_client)
+ &&
+ !(
+ IS_SPEC(to_client)
+ &&
+ (to_client.enemy == other_client)
+ )
+ ) { return TRUE; }
+ break;
+ }
+ }
+ return FALSE;
+}
+
#endif
// ===============================
void Destroy_Notification_Entity(entity notif)
{
if(notif.nent_name != "") { strunzone(notif.nent_name); }
+ if(notif.nent_snd != "") { strunzone(notif.nent_snd); }
if(notif.nent_args != "") { strunzone(notif.nent_args); }
if(notif.nent_hudargs != "") { strunzone(notif.nent_hudargs); }
if(notif.nent_icon != "") { strunzone(notif.nent_icon); }
Destroy_Notification_Entity(notif); \
}
- // kill all networked notifications
+ // kill all networked notifications and centerprints
#ifdef SVQC
Kill_Notification(NOTIF_ALL, world, 0, 0);
+ #else
+ reset_centerprint_messages();
#endif
// kill all real notification entities
+ DESTROY_LOOP(MSG_ANNCE, NOTIF_ANNCE_COUNT)
DESTROY_LOOP(MSG_INFO, NOTIF_INFO_COUNT)
DESTROY_LOOP(MSG_CENTER, NOTIF_CENTER_COUNT)
DESTROY_LOOP(MSG_MULTI, NOTIF_MULTI_COUNT)
+ DESTROY_LOOP(MSG_CHOICE, NOTIF_CHOICE_COUNT)
#undef DESTROY_LOOP
}
string Process_Notif_Line(
- float msg_is_info,
+ float typeid,
float chat,
string input,
string notiftype,
string notifname,
string stringtype)
{
- if(msg_is_info)
+ #ifdef CSQC
+ if(typeid == MSG_INFO)
{
- #ifdef CSQC
if((chat && autocvar_notification_allow_chatboxprint)
|| (autocvar_notification_allow_chatboxprint == 2))
{
if(substring(input, (strlen(input) - 1), 1) == "\{3}")
{ input = substring(input, 0, (strlen(input) - 1)); }
}
- #endif
- if(substring(input, (strlen(input) - 1), 1) != "\n")
- {
- print(sprintf(
- strcat(
- "^1MISSING/BROKEN NEW LINE AT END OF NOTIFICATION: ",
- "^7net_type = %s, net_name = %s, string = %s.\n"
- ),
- notiftype,
- notifname,
- stringtype
- ));
- notif_error = TRUE;
- return strcat(input, "\n");
- }
}
+ #endif
+
+ // done to both MSG_INFO and MSG_CENTER
+ if(substring(input, (strlen(input) - 1), 1) == "\n")
+ {
+ print(sprintf(
+ strcat(
+ "^1TRAILING NEW LINE AT END OF NOTIFICATION: ",
+ "^7net_type = %s, net_name = %s, string = %s.\n"
+ ),
+ notiftype,
+ notifname,
+ stringtype
+ ));
+ notif_error = TRUE;
+ input = substring(input, 1, (strlen(input) - 1));
+ }
+
return input;
}
float typeid,
float nameid,
string namestring,
- float infoname,
- float centername,
float strnum,
float flnum,
+ /* MSG_ANNCE */
+ float channel,
+ string snd,
+ float vol,
+ float position,
+ /* MSG_INFO & MSG_CENTER */
string args,
string hudargs,
string icon,
string durcnt,
string normal,
string gentle,
- float msg_is_info,
- float msg_is_multi)
+ /* MSG_MULTI */
+ float anncename,
+ float infoname,
+ float centername,
+ /* MSG_CHOICE */
+ float challow_def,
+ float challow_var,
+ float chtype,
+ float optiona,
+ float optionb)
{
// =====================
// Global Entity Setup
// =====================
entity notif = spawn();
- string typestring = "";
switch(typeid)
{
+ case MSG_ANNCE:
+ {
+ msg_annce_notifs[nameid - 1] = notif;
+ notif.classname = "msg_annce_notification";
+ break;
+ }
case MSG_INFO:
{
- typestring = "MSG_INFO";
msg_info_notifs[nameid - 1] = notif;
notif.classname = "msg_info_notification";
break;
}
case MSG_CENTER:
{
- typestring = "MSG_CENTER";
msg_center_notifs[nameid - 1] = notif;
notif.classname = "msg_center_notification";
break;
}
case MSG_MULTI:
{
- typestring = "MSG_MULTI";
msg_multi_notifs[nameid - 1] = notif;
- notif.classname = "MSG_MULTI_notification";
+ notif.classname = "msg_multi_notification";
+ break;
+ }
+ case MSG_CHOICE:
+ {
+ msg_choice_notifs[nameid - 1] = notif;
+ notif.classname = "msg_choice_notification";
break;
}
}
}
notif.nent_default = var_default;
- notif.nent_name = strzone(namestring);
- notif.nent_id = nameid;
notif.nent_enabled = (1 <= var_cvar);
+ notif.nent_type = typeid;
+ notif.nent_id = nameid;
+ notif.nent_name = strzone(namestring);
+
+ string typestring = Get_Notif_TypeName(typeid);
// Other pre-notif-setup requisites
notif_error = FALSE;
// ====================
// Notification Setup
// ====================
- if(msg_is_multi)
+ switch(typeid)
{
- // Set MSG_MULTI string/float counts
- if((infoname == NO_MSG) && (centername == NO_MSG))
- {
- print(sprintf(
- strcat(
- "^1NOTIFICATION WITH NO SUBCALLS: ",
- "^7net_type = %s, net_name = %s.\n"
- ),
- typestring,
- namestring
- ));
- notif_error = TRUE;
- }
- else
+ case MSG_ANNCE:
{
- float infoname_stringcount = 0, infoname_floatcount = 0;
- float centername_stringcount = 0, centername_floatcount = 0;
-
- if(infoname != NO_MSG)
- {
- notif.nent_msginfo = msg_info_notifs[infoname - 1];
- infoname_stringcount = notif.nent_msginfo.nent_stringcount;
- infoname_floatcount = notif.nent_msginfo.nent_floatcount;
- }
-
- if(centername != NO_MSG)
+ // Set MSG_ANNCE information and handle precaching
+ #ifdef CSQC
+ if not(GENTLE && (var_cvar == 1))
{
- notif.nent_msgcenter = msg_center_notifs[centername - 1];
- centername_stringcount = notif.nent_msgcenter.nent_stringcount;
- centername_floatcount = notif.nent_msgcenter.nent_floatcount;
+ if(snd != "")
+ {
+ if(notif.nent_enabled)
+ {
+ precache_sound(sprintf("announcer/%s/%s.wav", autocvar_cl_announcer, snd));
+ notif.nent_channel = channel;
+ notif.nent_snd = strzone(snd);
+ notif.nent_vol = vol;
+ notif.nent_position = position;
+ }
+ }
+ else
+ {
+ print(sprintf(
+ strcat(
+ "^1NOTIFICATION WITH NO SOUND: ",
+ "^7net_type = %s, net_name = %s.\n"
+ ),
+ typestring,
+ namestring
+ ));
+ notif_error = TRUE;
+ }
}
-
- // set the requirements of THIS notification to the totals of its subcalls
- notif.nent_stringcount = max(infoname_stringcount, centername_stringcount);
- notif.nent_floatcount = max(infoname_floatcount, centername_floatcount);
- }
- }
- else
- {
- // Set MSG_INFO and MSG_CENTER string/float counts
- notif.nent_stringcount = strnum;
- notif.nent_floatcount = flnum;
-
- // Only initialize arguments if we're either a client or on a dedicated server
- #ifdef SVQC
- float should_process_args = server_is_dedicated;
- #else
- float should_process_args = TRUE;
- #endif
+ else { notif.nent_enabled = FALSE; }
+ #else
+ notif.nent_enabled = FALSE;
+ #endif
- if(should_process_args)
+ break;
+ }
+
+ case MSG_INFO:
+ case MSG_CENTER:
{
- // ========================
- // Process Main Arguments
- // ========================
- if(strnum + flnum)
+ // Set MSG_INFO and MSG_CENTER string/float counts
+ notif.nent_stringcount = strnum;
+ notif.nent_floatcount = flnum;
+
+ // Only initialize arguments if we're either a client or on a dedicated server
+ #ifdef SVQC
+ float should_process_args = server_is_dedicated;
+ #else
+ float should_process_args = TRUE;
+ #endif
+
+ if(should_process_args)
{
- if(args != "")
+ // ========================
+ // Process Main Arguments
+ // ========================
+ if(strnum + flnum)
+ {
+ if(args != "")
+ {
+ notif.nent_args = strzone(
+ Process_Notif_Args(1, args, typestring, namestring));
+ }
+ else if((hudargs == "") && (durcnt ==""))
+ {
+ print(sprintf(
+ strcat(
+ "^1NOTIFICATION HAS ARG COUNTS BUT NO ARGS OR HUDARGS OR DURCNT: ",
+ "^7net_type = %s, net_name = %s, strnum = %d, flnum = %d\n"
+ ),
+ typestring,
+ namestring,
+ strnum,
+ flnum
+ ));
+ notif_error = TRUE;
+ }
+ }
+ else if(args != "")
{
notif.nent_args = strzone(
Process_Notif_Args(1, args, typestring, namestring));
}
- else if((hudargs == "") && (durcnt ==""))
+
+
+ // =======================================
+ // Process HUD and Centerprint Arguments
+ // Only processed on CSQC, as these
+ // args are only for HUD features.
+ // =======================================
+ #ifdef CSQC
+ if(hudargs != "")
+ {
+ notif.nent_hudargs = strzone(
+ Process_Notif_Args(2, hudargs, typestring, namestring));
+
+ if(icon != "") { notif.nent_icon = strzone(icon); }
+ else
+ {
+ print(sprintf(
+ strcat(
+ "^1NOTIFICATION HAS HUDARGS BUT NO ICON: ",
+ "^7net_type = %s, net_name = %s.\n"
+ ),
+ typestring,
+ namestring
+ ));
+ notif_error = TRUE;
+ }
+ }
+ else if(icon != "")
{
print(sprintf(
strcat(
- "^1NOTIFICATION HAS ARG COUNTS BUT NO ARGS OR HUDARGS OR DURCNT: ",
- "^7net_type = %s, net_name = %s, strnum = %d, flnum = %d\n"
+ "^1NOTIFICATION HAS ICON BUT NO HUDARGS: ",
+ "^7net_type = %s, net_name = %s.\n"
),
typestring,
- namestring,
- strnum,
- flnum
+ namestring
));
notif_error = TRUE;
}
- }
- else if(args != "")
- {
- notif.nent_args = strzone(
- Process_Notif_Args(1, args, typestring, namestring));
- }
+
+ if(durcnt != "")
+ {
+ notif.nent_durcnt = strzone(
+ Process_Notif_Args(3, durcnt, typestring, namestring));
+
+ if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
+ else
+ {
+ print(sprintf(
+ strcat(
+ "^1NOTIFICATION HAS DURCNT BUT NO CPID: ",
+ "^7net_type = %s, net_name = %s.\n"
+ ),
+ typestring,
+ namestring
+ ));
+ notif_error = TRUE;
+ }
+ }
+ else if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
+ #endif
- // =======================================
- // Process HUD and Centerprint Arguments
- // Only processed on CSQC, as these
- // args are only for HUD features.
- // =======================================
- #ifdef CSQC
- if(hudargs != "")
- {
- notif.nent_hudargs = strzone(
- Process_Notif_Args(2, hudargs, typestring, namestring));
-
- if(icon != "") { notif.nent_icon = strzone(icon); }
- else
+ // ======================
+ // Process Notif String
+ // ======================
+ #define SET_NOTIF_STRING(string,stringname) \
+ notif.nent_string = strzone(CCR( \
+ Process_Notif_Line( \
+ typeid, \
+ (var_cvar > 1), \
+ string, \
+ typestring, \
+ namestring, \
+ stringname \
+ )) \
+ );
+
+ if(GENTLE)
+ {
+ if(gentle != "") { SET_NOTIF_STRING(gentle, "GENTLE") }
+ else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
+ }
+ else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
+
+ #undef SET_NOTIF_STRING
+
+ // Check to make sure a string was chosen
+ if(notif.nent_string == "")
{
print(sprintf(
strcat(
- "^1NOTIFICATION HAS HUDARGS BUT NO ICON: ",
+ "^1EMPTY NOTIFICATION: ",
"^7net_type = %s, net_name = %s.\n"
),
typestring,
notif_error = TRUE;
}
}
- else if(icon != "")
+
+ break;
+ }
+
+ case MSG_MULTI:
+ {
+ // Set MSG_MULTI string/float counts
+ if((anncename == NO_MSG) && (infoname == NO_MSG) && (centername == NO_MSG))
{
print(sprintf(
strcat(
- "^1NOTIFICATION HAS ICON BUT NO HUDARGS: ",
+ "^1NOTIFICATION WITH NO SUBCALLS: ",
"^7net_type = %s, net_name = %s.\n"
),
typestring,
));
notif_error = TRUE;
}
-
- if(durcnt != "")
+ else
{
- notif.nent_durcnt = strzone(
- Process_Notif_Args(3, durcnt, typestring, namestring));
-
- if(cpid != NO_MSG) { notif.nent_cpid = cpid; }
- else
+ // announcements don't actually need any arguments, so lets not even count them.
+ if(anncename != NO_MSG) { notif.nent_msgannce = msg_annce_notifs[anncename - 1]; }
+
+ float infoname_stringcount = 0, infoname_floatcount = 0;
+ float centername_stringcount = 0, centername_floatcount = 0;
+
+ if(infoname != NO_MSG)
{
- print(sprintf(
- strcat(
- "^1NOTIFICATION HAS DURCNT BUT NO CPID: ",
- "^7net_type = %s, net_name = %s.\n"
- ),
- typestring,
- namestring
- ));
- notif_error = TRUE;
+ notif.nent_msginfo = msg_info_notifs[infoname - 1];
+ infoname_stringcount = notif.nent_msginfo.nent_stringcount;
+ infoname_floatcount = notif.nent_msginfo.nent_floatcount;
}
- }
- else if(cpid != NO_CPID) { notif.nent_cpid = cpid; }
- #endif
-
-
- // ======================
- // Process Notif String
- // ======================
- #define SET_NOTIF_STRING(string,stringname) \
- notif.nent_string = strzone(CCR( \
- Process_Notif_Line( \
- msg_is_info, \
- (var_cvar > 1), \
- string, \
- typestring, \
- namestring, \
- stringname \
- )) \
- );
-
- if(GENTLE)
- {
- if(gentle != "") { SET_NOTIF_STRING(gentle, "GENTLE") }
- else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
+
+ if(centername != NO_MSG)
+ {
+ notif.nent_msgcenter = msg_center_notifs[centername - 1];
+ centername_stringcount = notif.nent_msgcenter.nent_stringcount;
+ centername_floatcount = notif.nent_msgcenter.nent_floatcount;
+ }
+
+ // set the requirements of THIS notification to the totals of its subcalls
+ notif.nent_stringcount = max(infoname_stringcount, centername_stringcount);
+ notif.nent_floatcount = max(infoname_floatcount, centername_floatcount);
}
- else if(normal != "") { SET_NOTIF_STRING(normal, "NORMAL") }
- #undef SET_NOTIF_STRING
+ break;
+ }
- // Check to make sure a string was chosen
- if(notif.nent_string == "")
+ case MSG_CHOICE:
+ {
+ if((chtype == NO_MSG) || (optiona == NO_MSG) || (optionb == NO_MSG))
{
print(sprintf(
strcat(
- "^1EMPTY NOTIFICATION: ",
+ "^1NOTIFICATION IS MISSING CHOICE PARAMS: ",
"^7net_type = %s, net_name = %s.\n"
),
typestring,
));
notif_error = TRUE;
}
+ else
+ {
+ switch(chtype)
+ {
+ case MSG_ANNCE:
+ {
+ notif.nent_optiona = msg_annce_notifs[optiona - 1];
+ notif.nent_optionb = msg_annce_notifs[optionb - 1];
+ break;
+ }
+ case MSG_INFO:
+ {
+ notif.nent_optiona = msg_info_notifs[optiona - 1];
+ notif.nent_optionb = msg_info_notifs[optionb - 1];
+ break;
+ }
+ case MSG_CENTER:
+ {
+ notif.nent_optiona = msg_center_notifs[optiona - 1];
+ notif.nent_optionb = msg_center_notifs[optionb - 1];
+ break;
+ }
+ case MSG_MULTI:
+ {
+ notif.nent_optiona = msg_multi_notifs[optiona - 1];
+ notif.nent_optionb = msg_multi_notifs[optionb - 1];
+ break;
+ }
+ case MSG_CHOICE: // should we REALLY allow nested options?...
+ {
+ notif.nent_optiona = msg_choice_notifs[optiona - 1];
+ notif.nent_optionb = msg_choice_notifs[optionb - 1];
+ break;
+ }
+
+ default:
+ {
+ error(sprintf(
+ strcat(
+ "^1NOTIFICATION WITH IMPROPER TYPE: ",
+ "^7net_type = %d, net_name = %s.\n"
+ ),
+ typeid,
+ namestring
+ ));
+ notif_error = TRUE;
+ break;
+ }
+ }
+ notif.nent_challow_def = challow_def; // 0: never allowed, 1: allowed in warmup, 2: always allowed
+ notif.nent_challow_var = challow_var; // 0: never allowed, 1: allowed in warmup, 2: always allowed
+ notif.nent_stringcount = max(notif.nent_optiona.nent_stringcount, notif.nent_optionb.nent_stringcount);
+ notif.nent_floatcount = max(notif.nent_optiona.nent_floatcount, notif.nent_optionb.nent_floatcount);
+
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Create_Notification_Entity(...): MSG_CHOICE: %s\n%s\n%s\n",
+ notif.nent_name,
+ sprintf(
+ "^ optiona: %s %s : %d %d",
+ Get_Notif_TypeName(notif.nent_optiona.nent_type),
+ notif.nent_optiona.nent_name,
+ notif.nent_optiona.nent_stringcount,
+ notif.nent_optiona.nent_floatcount
+ ),
+ sprintf(
+ "^ optionb: %s %s : %d %d",
+ Get_Notif_TypeName(notif.nent_optionb.nent_type),
+ notif.nent_optionb.nent_name,
+ notif.nent_optionb.nent_stringcount,
+ notif.nent_optionb.nent_floatcount
+ )
+ ));
+ #endif
+ }
+ break;
}
+
+ default: print("DAFUQ?\n"); notif_error = TRUE; break;
}
// now check to see if any errors happened
}
-// =========================================
-// Cvar Handling With 'dumpnotifs' Command
-// =========================================
+// ===============
+// Cvar Handling
+// ===============
-void Dump_Notifications(float fh, float alsoprint)
+// used by MSG_CHOICE to build list of choices
+#ifdef SVQC
+void Notification_GetCvars(void)
{
- #define NOTIF_WRITE(a) { \
- fputs(fh, a); \
+ float i;
+ for(i = 0; i <= NOTIF_CHOICE_COUNT; ++i)
+ {
+ GetCvars_handleFloat(
+ get_cvars_s,
+ get_cvars_f,
+ msg_choice_choices[i],
+ sprintf("notification_%s", msg_choice_notifs[i].nent_name)
+ );
+ }
+
+ GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
+}
+#endif
+
+// used to output notifications.cfg file
+void Dump_Notifications(float fh, float alsoprint)
+{
+ #define NOTIF_WRITE(a) { \
+ fputs(fh, a); \
if(alsoprint) { print(a); } }
- #define NOTIF_WRITE_ENTITY(name,default,description) { \
+ #define NOTIF_WRITE_ENTITY(description) { \
notif_msg = \
sprintf( \
"seta notification_%s \"%d\" \"%s\"\n", \
- name, default, description \
+ e.nent_name, e.nent_default, description \
+ ); \
+ NOTIF_WRITE(notif_msg) }
+ #define NOTIF_WRITE_ENTITY_CHOICE(descriptiona,descriptionb) { \
+ notif_msg = \
+ sprintf( \
+ "seta notification_%s \"%d\" \"%s\"\n" \
+ "seta notification_%s_ALLOWED \"%d\" \"%s\"\n", \
+ e.nent_name, e.nent_default, descriptiona, \
+ e.nent_name, e.nent_challow_def, descriptionb \
); \
NOTIF_WRITE(notif_msg) }
#define NOTIF_WRITE_HARDCODED(cvar,default,description) { \
// This is not necessary, and does not matter if they vary between config versions,
// it is just a semi-helpful tool for those who want to manually change their user settings.
+ NOTIF_WRITE(sprintf("\n// MSG_ANNCE notifications (count = %d):\n", NOTIF_ANNCE_COUNT));
+ for(i = 1; i <= NOTIF_ANNCE_COUNT; ++i)
+ {
+ e = Get_Notif_Ent(MSG_ANNCE, i);
+ if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
+
+ NOTIF_WRITE_ENTITY(
+ "Notification control cvar: 0 = disabled, 1 = enabled if gentle mode is off, 2 = always enabled)"
+ );
+ }
+
NOTIF_WRITE(sprintf("\n// MSG_INFO notifications (count = %d):\n", NOTIF_INFO_COUNT));
for(i = 1; i <= NOTIF_INFO_COUNT; ++i)
{
e = Get_Notif_Ent(MSG_INFO, i);
if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
- NOTIF_WRITE_ENTITY(e.nent_name, e.nent_default, "Notification control cvar: 0 = off, 1 = print to console, 2 = print to console and chatbox (if notification_allow_chatboxprint is enabled)");
+
+ NOTIF_WRITE_ENTITY(
+ "Notification control cvar: 0 = off, 1 = print to console, "
+ "2 = print to console and chatbox (if notification_allow_chatboxprint is enabled)"
+ );
}
NOTIF_WRITE(sprintf("\n// MSG_CENTER notifications (count = %d):\n", NOTIF_CENTER_COUNT));
{
e = Get_Notif_Ent(MSG_CENTER, i);
if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
- NOTIF_WRITE_ENTITY(e.nent_name, e.nent_default, "Notification control cvar: 0 = off, 1 = centerprint");
+
+ NOTIF_WRITE_ENTITY(
+ "Notification control cvar: 0 = off, 1 = centerprint"
+ );
}
NOTIF_WRITE(sprintf("\n// MSG_MULTI notifications (count = %d):\n", NOTIF_MULTI_COUNT));
{
e = Get_Notif_Ent(MSG_MULTI, i);
if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
- NOTIF_WRITE_ENTITY(e.nent_name, e.nent_default, "Notification control cvar: 0 = off, 1 = trigger subcalls");
+
+ NOTIF_WRITE_ENTITY(
+ "Notification control cvar: 0 = off, 1 = trigger subcalls"
+ );
+ }
+
+ NOTIF_WRITE(sprintf("\n// MSG_CHOICE notifications (count = %d):\n", NOTIF_CHOICE_COUNT));
+ for(i = 1; i <= NOTIF_CHOICE_COUNT; ++i)
+ {
+ e = Get_Notif_Ent(MSG_CHOICE, i);
+ if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
+
+ NOTIF_WRITE_ENTITY_CHOICE(
+ "Notification control cvar: 0 = off, 1 = trigger option A subcall, 2 = trigger option B subcall",
+ "Notification control cvar: 0 = off, 1 = allowed in warmup mode, 2 = always allowed"
+ );
}
// edit these to match whichever cvars are used for specific notification options
NOTIF_WRITE("\n// HARD CODED notification variables:\n");
- NOTIF_WRITE_HARDCODED("allow_chatboxprint", "1", "Allow notifications to be printed to chat box by setting notification cvar to 2 (You can also set this cvar to 2 to force ALL notifications to be printed to the chatbox)");
- NOTIF_WRITE_HARDCODED("show_location", "0", "Append location information to MSG_INFO death/kill messages");
- NOTIF_WRITE_HARDCODED("show_location_string", "", "Replacement string piped into sprintf, so you can do different messages like this: ' at the %s' or ' (near %s)'");
- NOTIF_WRITE_HARDCODED("show_sprees", "1", "Print information about sprees in death/kill messages");
- NOTIF_WRITE_HARDCODED("show_sprees_center", "1", "Show spree information in MSG_CENTER messages... 0 = off, 1 = target (but only for first victim) and attacker");
- NOTIF_WRITE_HARDCODED("show_sprees_center_specialonly", "1", "Don't show spree information in MSG_CENTER messages if it isn't an achievement");
- NOTIF_WRITE_HARDCODED("show_sprees_info", "3", "Show spree information in MSG_INFO messages... 0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker");
- NOTIF_WRITE_HARDCODED("show_sprees_info_newline", "1", "Show attacker spree information for MSG_INFO messages on a separate line than the death notification itself");
- NOTIF_WRITE_HARDCODED("show_sprees_info_specialonly", "1", "Don't show attacker spree information in MSG_INFO messages if it isn't an achievement");
- NOTIF_WRITE_HARDCODED("item_centerprinttime", "1.5", "How long to show item information centerprint messages (like 'You got the Electro' or such)");
- NOTIF_WRITE_HARDCODED("errors_are_fatal", "1", "If a notification fails upon initialization, cause a Host_Error to stop the program");
- NOTIF_WRITE_HARDCODED("ctf_pickup_team_verbose", "0", "Show extra information if a team mate picks up a flag");
- NOTIF_WRITE_HARDCODED("ctf_pickup_enemy_verbose", "0", "Show extra information if an enemy picks up a flag");
- NOTIF_WRITE_HARDCODED("ctf_capture_verbose", "0", "Show extra information when someone captures a flag");
- NOTIF_WRITE_HARDCODED("frag_verbose", "1", "Show extra information when you frag someone (or when you are fragged");
- NOTIF_WRITE_HARDCODED("lifetime_runtime", "0.5", "Amount of time that notification entities last on the server during runtime (In seconds)");
- NOTIF_WRITE_HARDCODED("lifetime_mapload", "10", "Amount of time that notification entities last immediately at mapload (in seconds) to help prevent notifications from being lost on early init (like gamestart countdown)");
+
+ NOTIF_WRITE_HARDCODED(
+ "allow_chatboxprint", "1",
+ "Allow notifications to be printed to chat box by setting notification cvar to 2 "
+ "(You can also set this cvar to 2 to force ALL notifications to be printed to the chatbox)"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "debug", "0",
+ "Print extra debug information on all notification function calls "
+ "(Requires -DNOTIFICATIONS_DEBUG flag to be enabled on QCSRC compilation)... "
+ "0 = disabled, 1 = dprint, 2 = print"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "errors_are_fatal", "1",
+ "If a notification fails upon initialization, cause a Host_Error to stop the program"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "item_centerprinttime", "1.5",
+ "How long to show item information centerprint messages (like 'You got the Electro' or such)"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "lifetime_mapload", "10",
+ "Amount of time that notification entities last immediately at mapload (in seconds) "
+ "to help prevent notifications from being lost on early init (like gamestart countdown)"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "lifetime_runtime", "0.5",
+ "Amount of time that notification entities last on the server during runtime (In seconds)"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "server_allows_location", "1",
+ "Server side cvar for allowing death messages to show location information too"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "show_location", "0",
+ "Append location information to MSG_INFO death/kill messages"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "show_location_string", "",
+ "Replacement string piped into sprintf, "
+ "so you can do different messages like this: ' at the %s' or ' (near %s)'"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "show_sprees", "1",
+ "Print information about sprees in death/kill messages"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "show_sprees_center", "1",
+ "Show spree information in MSG_CENTER messages... "
+ "0 = off, 1 = target (but only for first victim) and attacker"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "show_sprees_center_specialonly", "1",
+ "Don't show spree information in MSG_CENTER messages if it isn't an achievement"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "show_sprees_info", "3",
+ "Show spree information in MSG_INFO messages... "
+ "0 = off, 1 = target only, 2 = attacker only, 3 = target and attacker"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "show_sprees_info_newline", "1",
+ "Show attacker spree information for MSG_INFO messages on a separate line than the death notification itself"
+ );
+
+ NOTIF_WRITE_HARDCODED(
+ "show_sprees_info_specialonly", "1",
+ "Don't show attacker spree information in MSG_INFO messages if it isn't an achievement"
+ );
NOTIF_WRITE(sprintf(
strcat(
"\n// Notification counts (total = %d): ",
- "MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d\n"
+ "MSG_ANNCE = %d, MSG_INFO = %d, MSG_CENTER = %d, MSG_MULTI = %d, MSG_CHOICE = %d\n"
),
(
+ NOTIF_ANNCE_COUNT +
NOTIF_INFO_COUNT +
NOTIF_CENTER_COUNT +
- NOTIF_MULTI_COUNT
- ),
+ NOTIF_MULTI_COUNT +
+ NOTIF_CHOICE_COUNT
+ ),
+ NOTIF_ANNCE_COUNT,
NOTIF_INFO_COUNT,
NOTIF_CENTER_COUNT,
- NOTIF_MULTI_COUNT
+ NOTIF_MULTI_COUNT,
+ NOTIF_CHOICE_COUNT
));
return;
#undef NOTIF_WRITE
}
-#ifdef SVQC
-void Notification_GetCvars()
-{
- GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
-}
-#endif
-
// ===============================
// Frontend Notification Pushing
// ===============================
+#ifdef NOTIFICATIONS_DEBUG
+void Debug_Notification(string input)
+{
+ switch(autocvar_notification_debug)
+ {
+ case 1: { dprint(input); break; }
+ case 2: { print(input); break; }
+ }
+}
+#endif
+
string Local_Notification_sprintf(
string input, string args,
string s1, string s2, string s3, string s4,
float f1, float f2, float f3, float f4)
{
#ifdef NOTIFICATIONS_DEBUG
- dprint(sprintf(
+ Debug_Notification(sprintf(
"Local_Notification_sprintf('%s^7', '%s', %s, %s);\n",
- strreplace("\n", "\\n", input),
+ MakeConsoleSafe(input),
args,
- strreplace("\n", "\\n", sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
+ MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
));
#endif
default: NOTIF_HIT_UNKNOWN(NOTIF_MAX_ARGS, "Local_Notification_sprintf")
}
}
- return sprintf(input, arg_slot[0], arg_slot[1], arg_slot[2], arg_slot[3], arg_slot[4], arg_slot[5], arg_slot[6]);
+ return sprintf(
+ strcat(input, "\n"),
+ arg_slot[0],
+ arg_slot[1],
+ arg_slot[2],
+ arg_slot[3],
+ arg_slot[4],
+ arg_slot[5],
+ arg_slot[6]
+ );
}
#ifdef CSQC
+void Local_Notification_sound(
+ float soundchannel, string soundfile,
+ float soundvolume, float soundposition)
+{
+ if((soundfile != prev_soundfile) || (time >= (prev_soundtime + autocvar_cl_announcer_antispam)))
+ {
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Local_Notification_sound(world, %f, '%s', %f, %f);\n",
+ soundchannel,
+ sprintf(
+ "announcer/%s/%s.wav",
+ autocvar_cl_announcer,
+ soundfile
+ ),
+ soundvolume,
+ soundposition
+ ));
+ #endif
+
+ sound(
+ world,
+ soundchannel,
+ sprintf(
+ "announcer/%s/%s.wav",
+ autocvar_cl_announcer,
+ soundfile
+ ),
+ soundvolume,
+ soundposition
+ );
+
+ if(prev_soundfile) { strunzone(prev_soundfile); }
+ prev_soundfile = strzone(soundfile);
+ prev_soundtime = time;
+ }
+ else
+ {
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ strcat(
+ "Local_Notification_sound(world, %f, '%s', %f, %f) ",
+ "^1BLOCKED BY ANTISPAM:^7 prevsnd: '%s', timediff: %f, limit: %f\n"
+ ),
+ soundchannel,
+ sprintf(
+ "announcer/%s/%s.wav",
+ autocvar_cl_announcer,
+ soundfile
+ ),
+ soundvolume,
+ soundposition,
+ prev_soundfile,
+ (time - prev_soundtime),
+ autocvar_cl_announcer_antispam
+ ));
+ #endif
+ }
+}
+
void Local_Notification_HUD_Notify_Push(
string icon, string hudargs,
string s1, string s2, string s3, string s4)
}
}
#ifdef NOTIFICATIONS_DEBUG
- dprint(sprintf(
+ Debug_Notification(sprintf(
"Local_Notification_HUD_Notify_Push('%s^7', '%s', %s, %s);\n",
icon,
hudargs,
- strreplace("\n", "\\n", sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
- strreplace("\n", "\\n", sprintf("'%s^7', '%s^7'", stof(arg_slot[0]), stof(arg_slot[1])))
+ MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
+ MakeConsoleSafe(sprintf("'%s^7', '%s^7'", stof(arg_slot[0]), stof(arg_slot[1])))
));
#endif
HUD_Notify_Push(icon, arg_slot[0], arg_slot[1]);
}
}
#ifdef NOTIFICATIONS_DEBUG
- dprint(sprintf(
+ Debug_Notification(sprintf(
"Local_Notification_centerprint_generic('%s^7', '%s', %d, %d, %d, %d);\n",
- strreplace("\n", "\\n", input),
+ MakeConsoleSafe(input),
durcnt,
f1, f2,
- stof(arg_slot[0]), stof(arg_slot[1])
+ stof(arg_slot[0]),
+ stof(arg_slot[1])
));
#endif
centerprint_generic(cpid, input, stof(arg_slot[0]), stof(arg_slot[1]));
void Local_Notification(float net_type, float net_name, ...count)
{
+ // check if this should be aborted
+ if(net_name == NOTIF_ABORT)
+ {
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Local_Notification(%s, %s, ...);\n",
+ Get_Notif_TypeName(net_type),
+ "NOTIF_ABORT"
+ ));
+ #endif
+ return;
+ }
+
// check supplied type and name for errors
string checkargs = Notification_CheckArgs_TypeName(net_type, net_name);
- if(checkargs != "") { backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs)); return; }
+ if(checkargs != "")
+ {
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Local_Notification(%s, %d, ...);\n",
+ Get_Notif_TypeName(net_type),
+ Get_Notif_Ent(net_type, net_name).nent_name
+ ));
+ #endif
+ backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs));
+ return;
+ }
+ // retreive entity of this notification
entity notif = Get_Notif_Ent(net_type, net_name);
- if not(notif) { backtrace("Local_Notification: Could not find notification entity!\n"); return; }
+ if not(notif)
+ {
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Local_Notification(%s, %d, ...);\n",
+ Get_Notif_TypeName(net_type),
+ net_name
+ ));
+ #endif
+ backtrace("Local_Notification: Could not find notification entity!\n");
+ return;
+ }
- #ifdef NOTIFICATIONS_DEBUG
+ // check if the notification is enabled
if not(notif.nent_enabled)
{
- dprint(sprintf(
- "Local_Notification(%s, %s): Entity was disabled...\n",
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Local_Notification(%s, %s, ...): Entity was disabled...\n",
Get_Notif_TypeName(net_type),
notif.nent_name
));
+ #endif
return;
}
+
+ string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
+ string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
+ string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
+ string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
+ float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
+ float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
+ float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
+ float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
+
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Local_Notification(%s, %s, %s, %s);\n",
+ Get_Notif_TypeName(net_type),
+ notif.nent_name,
+ MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
+ sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
+ ));
#endif
if((notif.nent_stringcount + notif.nent_floatcount) > count)
"stringcount(%d) + floatcount(%d) > count(%d)\n",
"Check the definition and function call for accuracy...?\n"
),
- Get_Notif_TypeName(net_type), notif.nent_name,
- notif.nent_stringcount, notif.nent_floatcount, count
+ Get_Notif_TypeName(net_type),
+ notif.nent_name,
+ notif.nent_stringcount,
+ notif.nent_floatcount,
+ count
));
return;
}
"stringcount(%d) + floatcount(%d) < count(%d)\n",
"Check the definition and function call for accuracy...?\n"
),
- Get_Notif_TypeName(net_type), notif.nent_name,
- notif.nent_stringcount, notif.nent_floatcount, count
+ Get_Notif_TypeName(net_type),
+ notif.nent_name,
+ notif.nent_stringcount,
+ notif.nent_floatcount,
+ count
));
return;
}
-
- string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
- string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
- string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
- string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
- float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
- float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
- float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
- float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
-
- #ifdef NOTIFICATIONS_DEBUG
- dprint(sprintf(
- "Local_Notification(%s, %s, %s, %s);\n",
- Get_Notif_TypeName(net_type),
- notif.nent_name,
- strreplace("\n", "\\n", sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
- sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
- ));
- #endif
switch(net_type)
{
+ case MSG_ANNCE:
+ {
+ #ifdef CSQC
+ Local_Notification_sound(
+ notif.nent_channel,
+ notif.nent_snd,
+ notif.nent_vol,
+ notif.nent_position
+ );
+ #else
+ backtrace("MSG_ANNCE on server?... Please notify Samual immediately!\n");
+ #endif
+ break;
+ }
+
case MSG_INFO:
{
print(
f1, f2, f3, f4);
}
#ifdef CSQC
+ if(notif.nent_msgannce)
+ if(notif.nent_msgannce.nent_enabled)
+ {
+ Local_Notification_WOVA(
+ MSG_ANNCE,
+ notif.nent_msgannce.nent_id,
+ 0, 0,
+ "", "", "", "",
+ 0, 0, 0, 0);
+ }
if(notif.nent_msgcenter)
if(notif.nent_msgcenter.nent_enabled)
{
#endif
break;
}
+
+ case MSG_CHOICE:
+ {
+ entity found_choice;
+
+ if(notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2)))
+ {
+ switch(cvar_string(sprintf("notification_%s", notif.nent_name)))
+ {
+ case 1: found_choice = notif.nent_optiona; break;
+ case 2: found_choice = notif.nent_optionb; break;
+ default: return; // not enabled anyway
+ }
+ }
+ else { found_choice = notif.nent_optiona; }
+
+ Local_Notification_WOVA(
+ found_choice.nent_type,
+ found_choice.nent_id,
+ found_choice.nent_stringcount,
+ found_choice.nent_floatcount,
+ s1, s2, s3, s4,
+ f1, f2, f3, f4);
+ }
}
}
if(net_type == MSG_CENTER_CPID)
{
#ifdef NOTIFICATIONS_DEBUG
- dprint(sprintf(
+ Debug_Notification(sprintf(
"Read_Notification(%d) at %f: net_type = %s, net_name = %d\n",
is_new,
time,
}
else
{
- print(sprintf(
+ backtrace(sprintf(
"Read_Notification(%d) at %f: ^1TRIED TO KILL NO_CPID CENTERPRINT!\n",
is_new,
time
if not(notif) { backtrace("Read_Notification: Could not find notification entity!\n"); return; }
#ifdef NOTIFICATIONS_DEBUG
- dprint(sprintf(
+ Debug_Notification(sprintf(
"Read_Notification(%d) at %f: net_type = %s, net_name = %s\n",
is_new,
time,
#ifdef SVQC
void Net_Notification_Remove()
{
- if not(self) { dprint(sprintf("Net_Notification_Remove() at %f: Missing self!?\n", time)); return; }
+ if not(self) { backtrace(sprintf("Net_Notification_Remove() at %f: Missing self!?\n", time)); return; }
#ifdef NOTIFICATIONS_DEBUG
- dprint(sprintf(
+ Debug_Notification(sprintf(
"Net_Notification_Remove() at %f: %s '%s - %s' notification\n",
time,
((self.nent_net_name == -1) ? "Killed" : "Removed"),
float Net_Write_Notification(entity client, float sf)
{
- float i, send = FALSE;
-
- switch(self.nent_broadcast)
+ if(Notification_ShouldSend(self.nent_broadcast, client, self.nent_client))
{
- case NOTIF_ONE: // send to one client and their spectator
- {
- if(
- (client == self.nent_client)
- ||
- (
- (client.classname == STR_SPECTATOR)
- &&
- (client.enemy == self.nent_client)
- )
- ) { send = TRUE; }
- break;
- }
- case NOTIF_ONE_ONLY: // send ONLY to one client
- {
- if(client == self.nent_client) { send = TRUE; }
- break;
- }
- case NOTIF_TEAM: // send only to X team and their spectators
- {
- if(
- (client.team == self.nent_client.team)
- ||
- (
- (client.classname == STR_SPECTATOR)
- &&
- (client.enemy.team == self.nent_client.team)
- )
- ) { send = TRUE; }
- break;
- }
- case NOTIF_TEAM_EXCEPT: // send only to X team and their spectators, except for Y person and their spectators
- {
- if(
- (client != self.nent_client)
- &&
- (
- (client.team == self.nent_client.team)
- ||
- (
- (client.classname == STR_SPECTATOR)
- &&
- (
- (client.enemy != self.nent_client)
- &&
- (client.enemy.team == self.nent_client.team)
- )
- )
- )
- ) { send = TRUE; }
- break;
- }
- case NOTIF_ALL: // send to everyone
- {
- send = TRUE;
- break;
- }
- case NOTIF_ALL_EXCEPT: // send to everyone except X person and their spectators
- {
- if(
- (client != self.nent_client)
- &&
- !(
- (client.classname == STR_SPECTATOR)
- &&
- (client.enemy == self.nent_client)
- )
- ) { send = TRUE; }
- break;
- }
- default: { send = FALSE; break; }
- }
-
- if(send)
- {
+ float i;
WriteByte(MSG_ENTITY, ENT_CLIENT_NOTIFICATION);
WriteByte(MSG_ENTITY, self.nent_net_type);
WriteShort(MSG_ENTITY, self.nent_net_name);
for(i = 0; i < self.nent_stringcount; ++i) { WriteString(MSG_ENTITY, self.nent_strings[i]); }
for(i = 0; i < self.nent_floatcount; ++i) { WriteLong(MSG_ENTITY, self.nent_floats[i]); }
+ return TRUE;
}
-
- return send;
+ else { return FALSE; }
}
void Kill_Notification(
float broadcast, entity client,
float net_type, float net_name)
{
- string checkargs = Notification_CheckArgs(broadcast, client, 1, 1);
- if(checkargs != "") { backtrace(sprintf("Incorrect usage of Kill_Notification: %s\n", checkargs)); return; }
-
#ifdef NOTIFICATIONS_DEBUG
- dprint(sprintf(
- "Kill_Notification(%d, '%s', %d, %d);\n",
- broadcast,
+ Debug_Notification(sprintf(
+ "Kill_Notification(%s, '%s', %s, %d);\n",
+ Get_Notif_BroadcastName(broadcast),
client.netname,
- net_type,
+ (net_type ? Get_Notif_TypeName(net_type) : "0"),
net_name
));
#endif
+
+ string checkargs = Notification_CheckArgs(broadcast, client, 1, 1);
+ if(checkargs != "") { backtrace(sprintf("Incorrect usage of Kill_Notification: %s\n", checkargs)); return; }
entity notif, net_notif;
float killed_cpid = NO_CPID;
{
entity notif = Get_Notif_Ent(net_type, net_name);
if not(notif) { backtrace("Kill_Notification: Could not find notification entity!\n"); return; }
- killed_cpid = notif.nent_cpid;
+
+ if(notif.nent_cpid)
+ killed_cpid = notif.nent_cpid;
+ else
+ killed_cpid = NO_CPID;
}
else
{
{
if(net_type)
{
- if(killed_cpid != NO_CPID)
+ if((killed_cpid != NO_CPID) && (notif.nent_net_type == MSG_CENTER))
{
if(notif.owner.nent_cpid == killed_cpid)
{
float net_type, float net_name,
...count)
{
+ // check if this should be aborted
+ if(net_name == NOTIF_ABORT)
+ {
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Send_Notification(%s, '%s', %s, %s, ...);\n",
+ Get_Notif_BroadcastName(broadcast),
+ client.classname,
+ Get_Notif_TypeName(net_type),
+ "NOTIF_ABORT"
+ ));
+ #endif
+ return;
+ }
+
// check supplied broadcast, target, type, and name for errors
string checkargs = Notification_CheckArgs(broadcast, client, net_type, net_name);
- if(checkargs != "") { backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs)); return; }
+ if(checkargs != "")
+ {
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Send_Notification(%s, '%s', %s, %s, ...);\n",
+ Get_Notif_BroadcastName(broadcast),
+ client.classname,
+ Get_Notif_TypeName(net_type),
+ Get_Notif_Ent(net_type, net_name).nent_name
+ ));
+ #endif
+ backtrace(sprintf("Incorrect usage of Send_Notification: %s\n", checkargs));
+ return;
+ }
- // retreive counts for the arguments of this notification
+ // retreive entity of this notification
entity notif = Get_Notif_Ent(net_type, net_name);
- if not(notif) { backtrace("Send_Notification: Could not find notification entity!\n"); return; }
+ if not(notif)
+ {
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Send_Notification(%s, '%s', %s, %d, ...);\n",
+ Get_Notif_BroadcastName(broadcast),
+ client.classname,
+ Get_Notif_TypeName(net_type),
+ net_name
+ ));
+ #endif
+ backtrace("Send_Notification: Could not find notification entity!\n");
+ return;
+ }
+
+ string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
+ string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
+ string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
+ string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
+ float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
+ float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
+ float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
+ float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
+
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Send_Notification(%s, %s, %s);\n",
+ sprintf(
+ "%s, '%s', %s, %s",
+ Get_Notif_BroadcastName(broadcast),
+ client.classname,
+ Get_Notif_TypeName(net_type),
+ notif.nent_name
+ ),
+ MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
+ sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
+ ));
+ #endif
if((notif.nent_stringcount + notif.nent_floatcount) > count)
{
backtrace(sprintf(
strcat(
- "Not enough arguments for Send_Notification(%d, %s, %s, ...)! ",
+ "Not enough arguments for Send_Notification(%s, ...)! ",
"stringcount(%d) + floatcount(%d) > count(%d)\n",
"Check the definition and function call for accuracy...?\n"
),
- broadcast, Get_Notif_TypeName(net_type), notif.nent_name,
- notif.nent_stringcount, notif.nent_floatcount, count
+ sprintf(
+ "%s, '%s', %s, %s",
+ Get_Notif_BroadcastName(broadcast),
+ client.classname,
+ Get_Notif_TypeName(net_type),
+ notif.nent_name
+ ),
+ notif.nent_stringcount,
+ notif.nent_floatcount,
+ count
));
return;
}
{
backtrace(sprintf(
strcat(
- "Too many arguments for Send_Notification(%d, %s, %s, ...)! ",
+ "Too many arguments for Send_Notification(%s, ...)! ",
"stringcount(%d) + floatcount(%d) < count(%d)\n",
"Check the definition and function call for accuracy...?\n"
),
- broadcast, Get_Notif_TypeName(net_type), notif.nent_name,
- notif.nent_stringcount, notif.nent_floatcount, count
+ sprintf(
+ "%s, '%s', %s, %s",
+ Get_Notif_BroadcastName(broadcast),
+ client.classname,
+ Get_Notif_TypeName(net_type),
+ notif.nent_name
+ ),
+ notif.nent_stringcount,
+ notif.nent_floatcount,
+ count
));
return;
}
- #ifdef NOTIFICATIONS_DEBUG
- string s1 = ((0 < notif.nent_stringcount) ? ...(0, string) : "");
- string s2 = ((1 < notif.nent_stringcount) ? ...(1, string) : "");
- string s3 = ((2 < notif.nent_stringcount) ? ...(2, string) : "");
- string s4 = ((3 < notif.nent_stringcount) ? ...(3, string) : "");
- float f1 = ((0 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 0), float) : 0);
- float f2 = ((1 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 1), float) : 0);
- float f3 = ((2 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 2), float) : 0);
- float f4 = ((3 < notif.nent_floatcount) ? ...((notif.nent_stringcount + 3), float) : 0);
- dprint(sprintf(
- "Send_Notification(%d, %s, %s, %s, %s);\n",
- broadcast,
- Get_Notif_TypeName(net_type),
- notif.nent_name,
- strreplace("\n", "\\n", sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
- sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
- ));
- #endif
-
- entity net_notif = spawn();
- net_notif.owner = notif;
- net_notif.classname = "net_notification";
- net_notif.nent_broadcast = broadcast;
- net_notif.nent_client = client;
- net_notif.nent_net_type = net_type;
- net_notif.nent_net_name = net_name;
- net_notif.nent_stringcount = notif.nent_stringcount;
- net_notif.nent_floatcount = notif.nent_floatcount;
-
- float i;
- for(i = 0; i < net_notif.nent_stringcount; ++i) { net_notif.nent_strings[i] = strzone(...(i, string)); }
- for(i = 0; i < net_notif.nent_floatcount; ++i) { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
-
- net_notif.think = Net_Notification_Remove;
- net_notif.nextthink =
- ((time > autocvar_notification_lifetime_mapload)
- ?
- (time + autocvar_notification_lifetime_runtime)
- :
- autocvar_notification_lifetime_mapload
- );
-
- Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
-
- if(server_is_dedicated && (broadcast == NOTIF_ALL || broadcast == NOTIF_ALL_EXCEPT) && (net_type != MSG_CENTER))
+ if(
+ server_is_dedicated
+ &&
+ (
+ broadcast == NOTIF_ALL
+ ||
+ broadcast == NOTIF_ALL_EXCEPT
+ )
+ &&
+ !(
+ net_type == MSG_ANNCE
+ ||
+ net_type == MSG_CENTER
+ )
+ )
{
Local_Notification_WOVA(
net_type, net_name,
notif.nent_stringcount,
notif.nent_floatcount,
- IFSTR(0), IFSTR(1), IFSTR(2), IFSTR(3),
- IFFL(0), IFFL(1), IFFL(2), IFFL(3));
+ s1, s2, s3, s4,
+ f1, f2, f3, f4);
+ }
+
+ if(net_type == MSG_CHOICE)
+ {
+ // THIS GETS TRICKY... now we have to cycle through each possible player (checking broadcast)
+ // and then do an individual NOTIF_ONE_ONLY recursive call for each one depending on their option...
+ // It's slow, but it's better than the alternatives:
+ // 1. Constantly networking all info and letting client decide
+ // 2. Manually handling each separate call on per-usage basis (See old CTF usage of verbose)
+ entity found_choice;
+
+ #define RECURSE_FROM_CHOICE(ent,action) \
+ if(notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2))) \
+ { \
+ switch(ent.msg_choice_choices[net_name]) \
+ { \
+ case 1: found_choice = notif.nent_optiona; break; \
+ case 2: found_choice = notif.nent_optionb; break; \
+ default: action; \
+ } \
+ } \
+ else { found_choice = notif.nent_optiona; } \
+ Send_Notification_WOVA( \
+ NOTIF_ONE_ONLY, \
+ ent, \
+ found_choice.nent_type, \
+ found_choice.nent_id, \
+ found_choice.nent_stringcount, \
+ found_choice.nent_floatcount, \
+ s1, s2, s3, s4, \
+ f1, f2, f3, f4);
+
+ switch(broadcast)
+ {
+ case NOTIF_ONE_ONLY: // we can potentially save processing power with this broadcast method
+ {
+ if(IS_REAL_CLIENT(client))
+ { RECURSE_FROM_CHOICE(client, return) }
+ break;
+ }
+ default:
+ {
+ entity to;
+ FOR_EACH_REALCLIENT(to)
+ { if(Notification_ShouldSend(broadcast, to, client))
+ { RECURSE_FROM_CHOICE(to, continue) } }
+ break;
+ }
+ }
+ }
+ else
+ {
+ entity net_notif = spawn();
+ net_notif.owner = notif;
+ net_notif.classname = "net_notification";
+ net_notif.nent_broadcast = broadcast;
+ net_notif.nent_client = client;
+ net_notif.nent_net_type = net_type;
+ net_notif.nent_net_name = net_name;
+ net_notif.nent_stringcount = notif.nent_stringcount;
+ net_notif.nent_floatcount = notif.nent_floatcount;
+
+ float i;
+ for(i = 0; i < net_notif.nent_stringcount; ++i)
+ { net_notif.nent_strings[i] = strzone(...(i, string)); }
+ for(i = 0; i < net_notif.nent_floatcount; ++i)
+ { net_notif.nent_floats[i] = ...((net_notif.nent_stringcount + i), float); }
+
+ net_notif.think = Net_Notification_Remove;
+ net_notif.nextthink =
+ ((time > autocvar_notification_lifetime_mapload)
+ ?
+ (time + autocvar_notification_lifetime_runtime)
+ :
+ autocvar_notification_lifetime_mapload
+ );
+
+ Net_LinkEntity(net_notif, FALSE, 0, Net_Write_Notification);
}
}
// WOVA = Without Variable Arguments
void Send_Notification_WOVA(
+ float broadcast, entity client,
+ float net_type, float net_name,
+ float stringcount, float floatcount,
+ string s1, string s2, string s3, string s4,
+ float f1, float f2, float f3, float f4)
+{
+ #ifdef NOTIFICATIONS_DEBUG
+ entity notif = Get_Notif_Ent(net_type, net_name);
+ Debug_Notification(sprintf(
+ "Send_Notification_WOVA(%s, %d, %d, %s, %s);\n",
+ sprintf(
+ "%s, '%s', %s, %s",
+ Get_Notif_BroadcastName(broadcast),
+ client.classname,
+ Get_Notif_TypeName(net_type),
+ notif.nent_name
+ ),
+ stringcount,
+ floatcount,
+ MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
+ sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
+ ));
+ #endif
+
+ #define VARITEM(stringc,floatc,args) \
+ if((stringcount == stringc) && (floatcount == floatc)) \
+ { Send_Notification(broadcast, client, net_type, net_name, args); return; }
+ EIGHT_VARS_TO_VARARGS_VARLIST
+ #undef VARITEM
+ Send_Notification(broadcast, client, net_type, net_name); // some notifications don't have any arguments at all
+}
+
+// WOCOVA = Without Counts Or Variable Arguments
+void Send_Notification_WOCOVA(
float broadcast, entity client,
float net_type, float net_name,
string s1, string s2, string s3, string s4,
entity notif = Get_Notif_Ent(net_type, net_name);
#ifdef NOTIFICATIONS_DEBUG
- dprint(sprintf(
- "Send_Notification_WOVA(%d, %s, %s, %s, %s - %d %d);\n",
- broadcast,
- Get_Notif_TypeName(net_type),
- notif.nent_name,
- sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4),
- sprintf("%d, %d, %d, %d", f1, f2, f3, f4),
- notif.nent_stringcount, notif.nent_floatcount
+ Debug_Notification(sprintf(
+ "Send_Notification_WOCOVA(%s, %s, %s);\n",
+ sprintf(
+ "%s, '%s', %s, %s",
+ Get_Notif_BroadcastName(broadcast),
+ client.classname,
+ Get_Notif_TypeName(net_type),
+ notif.nent_name
+ ),
+ MakeConsoleSafe(sprintf("'%s^7', '%s^7', '%s^7', '%s^7'", s1, s2, s3, s4)),
+ sprintf("%d, %d, %d, %d", f1, f2, f3, f4)
));
#endif
projects / xonotic / xonotic-data.pk3dir.git / blobdiff