// ================================================
// Unified notification system, written by Samual
-// Last updated: June, 2013
+// Last updated: August, 2013
// ================================================
string Get_Notif_TypeName(float net_type)
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
}
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;
}
float typeid,
float nameid,
string namestring,
- float anncename,
- float infoname,
- float centername,
- float channel,
+ float strnum,
+ float flnum,
+ /* MSG_ANNCE */
+ float channel,
string snd,
float vol,
float position,
- float strnum,
- float flnum,
+ /* MSG_INFO & MSG_CENTER */
string args,
string hudargs,
string icon,
string durcnt,
string normal,
string gentle,
- float challow,
+ /* 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:
}
}
notif.nent_default = var_default;
- notif.nent_name = strzone(namestring);
+ notif.nent_enabled = (1 <= var_cvar);
notif.nent_type = typeid;
notif.nent_id = nameid;
- notif.nent_enabled = (1 <= var_cvar);
-
- typestring = Get_Notif_TypeName(typeid);
+ notif.nent_name = strzone(namestring);
+
+ string typestring = Get_Notif_TypeName(typeid);
// Other pre-notif-setup requisites
notif_error = FALSE;
default:
{
- error(sprintf(
+ print(sprintf(
strcat(
"^1NOTIFICATION WITH IMPROPER TYPE: ",
"^7net_type = %d, net_name = %s.\n"
break;
}
}
- notif.nent_challow = challow; // 0: never allowed, 1: allowed in warmup, 2: always allowed
+ 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);
- print(sprintf("INIT NOTIF DEBUG: %d %d\n", notif.nent_stringcount, notif.nent_floatcount));
- print(sprintf("^ optiona: %s %s : %d %d\n",
- Get_Notif_TypeName(notif.nent_optiona.nent_type),
- notif.nent_optiona.nent_name,
- notif.nent_optiona.nent_stringcount,
- notif.nent_optiona.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;
+ default:
+ {
+ print(sprintf(
+ strcat(
+ "^1NOTIFICATION WITH IMPROPER TYPE: ",
+ "^7net_type = %d, net_name = %s.\n"
+ ),
+ typeid,
+ namestring
+ ));
+ notif_error = TRUE;
+ break;
+ }
}
// now check to see if any errors happened
sprintf("notification_%s", msg_choice_notifs[i].nent_name)
);
}
-
- GetCvars_handleFloat(get_cvars_s, get_cvars_f, FRAG_VERBOSE, "notification_frag_verbose");
}
#endif
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) { \
notif_msg = \
sprintf( \
e = Get_Notif_Ent(MSG_CHOICE, i);
if not(e) { backtrace("Dump_Notifications(): Missing notification entity!\n"); return; }
- NOTIF_WRITE_ENTITY(
- "Notification control cvar: 0 = off, 1 = trigger option A subcall, 2 = trigger option B subcall"
+ 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"
);
}
"(You can also set this cvar to 2 to force ALL notifications to be printed to the chatbox)"
);
- NOTIF_WRITE_HARDCODED(
- "ctf_capture_verbose", "0",
- "Show extra information when someone captures a flag"
- );
-
- NOTIF_WRITE_HARDCODED(
- "ctf_pickup_enemy_verbose", "0",
- "Show extra information if an enemy picks up a flag"
- );
-
- NOTIF_WRITE_HARDCODED(
- "ctf_pickup_team_verbose", "0",
- "Show extra information if a team mate picks up a flag"
- );
-
NOTIF_WRITE_HARDCODED(
"debug", "0",
"Print extra debug information on all notification function calls "
"If a notification fails upon initialization, cause a Host_Error to stop the program"
);
- NOTIF_WRITE_HARDCODED(
- "frag_verbose", "1",
- "Show extra information when you frag someone (or when you are fragged"
- );
-
NOTIF_WRITE_HARDCODED(
"item_centerprinttime", "1.5",
"How long to show item information centerprint messages (like 'You got the Electro' or such)"
"Amount of time that notification entities last on the server during runtime (In seconds)"
);
- NOTIF_WRITE_HARDCODED(
- "server_allows_frag_verbose", "1",
- "Server side cvar for showing extra information in frag messages... 0 = no extra frag information, "
- "1 = frag information only in warmup, 2 = frag information allowed all the time"
- );
-
NOTIF_WRITE_HARDCODED(
"server_allows_location", "1",
"Server side cvar for allowing death messages to show location information too"
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; }
-
- 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.nent_enabled)
+ if(checkargs != "")
{
#ifdef NOTIFICATIONS_DEBUG
Debug_Notification(sprintf(
- "Local_Notification(%s, %s): Entity was disabled...\n",
+ "Local_Notification(%s, %d, ...);\n",
Get_Notif_TypeName(net_type),
- notif.nent_name
+ Get_Notif_Ent(net_type, net_name).nent_name
));
#endif
+ backtrace(sprintf("Incorrect usage of Local_Notification: %s\n", checkargs));
return;
}
-
- if((notif.nent_stringcount + notif.nent_floatcount) > count)
+
+ // retreive entity of this notification
+ entity notif = Get_Notif_Ent(net_type, net_name);
+ if not(notif)
{
- backtrace(sprintf(
- strcat(
- "Not enough arguments for Local_Notification(%s, %s, ...)! ",
- "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
+ #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;
}
- else if((notif.nent_stringcount + notif.nent_floatcount) < count)
+
+ // check if the notification is enabled
+ if not(notif.nent_enabled)
{
- backtrace(sprintf(
- strcat(
- "Too many arguments for Local_Notification(%s, %s, ...)! ",
- "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
+ #ifdef NOTIFICATIONS_DEBUG
+ Debug_Notification(sprintf(
+ "Local_Notification(%s, %s, ...): Entity was disabled...\n",
+ Get_Notif_TypeName(net_type),
+ notif.nent_name
));
+ #endif
return;
}
));
#endif
+ if((notif.nent_stringcount + notif.nent_floatcount) > count)
+ {
+ backtrace(sprintf(
+ strcat(
+ "Not enough arguments for Local_Notification(%s, %s, ...)! ",
+ "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
+ ));
+ return;
+ }
+ else if((notif.nent_stringcount + notif.nent_floatcount) < count)
+ {
+ backtrace(sprintf(
+ strcat(
+ "Too many arguments for Local_Notification(%s, %s, ...)! ",
+ "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
+ ));
+ return;
+ }
+
switch(net_type)
{
case MSG_ANNCE:
{
entity found_choice;
- if(notif.nent_challow && (warmup_stage || (notif.nent_challow == 2)))
+ if(notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2)))
{
switch(cvar_string(sprintf("notification_%s", notif.nent_name)))
{
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
Debug_Notification(sprintf(
- "Kill_Notification(%d, '%s', %s, %d);\n",
- broadcast,
+ "Kill_Notification(%s, '%s', %s, %d);\n",
+ Get_Notif_BroadcastName(broadcast),
client.netname,
(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;
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) : "");
#ifdef NOTIFICATIONS_DEBUG
Debug_Notification(sprintf(
- "Send_Notification(%d, %s, %s, %s, %s);\n",
- broadcast,
- Get_Notif_TypeName(net_type),
- notif.nent_name,
+ "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)
));
{
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;
}
if(net_type == MSG_CHOICE)
{
- // float verbose_allowed = (autocvar_notification_server_allows_frag_verbose && ((autocvar_notification_server_allows_frag_verbose == 2) || warmup_stage));
- // THIS GETS TRICKY... now we have to cycle through each possible player (checking broadcast)nent_challow
+ // 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
entity found_choice;
#define RECURSE_FROM_CHOICE(ent,action) \
- if(notif.nent_challow && (warmup_stage || (notif.nent_challow == 2))) \
+ if(notif.nent_challow_var && (warmup_stage || (notif.nent_challow_var == 2))) \
{ \
switch(ent.msg_choice_choices[net_name]) \
{ \
#ifdef NOTIFICATIONS_DEBUG
entity notif = Get_Notif_Ent(net_type, net_name);
Debug_Notification(sprintf(
- "Send_Notification_WOVA(%d, %s, %d, %d, %d, %s, %s);\n",
- broadcast,
- Get_Notif_TypeName(net_type),
- notif.nent_name,
+ "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)),
#ifdef NOTIFICATIONS_DEBUG
Debug_Notification(sprintf(
- "Send_Notification_WOCOVA(%d, %s, %s, %s, %s);\n",
- broadcast,
- Get_Notif_TypeName(net_type),
- notif.nent_name,
+ "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)
));