GitHub/amxmodx
2
0
Fork 0
mirror of https://github.com/alliedmodders/amxmodx.git synced 2024-12-25 06:15:37 +03:00
Code Issues Projects Releases Wiki Activity

amxmisc.inc: Missing charsmax, more readability, more compliance to amxmodx style

Browse Source
This commit is contained in:
Freeman-AM 2015-02-06 01:32:33 +01:00
parent a51904b13f
commit 9e5810e615
1 changed files with 248 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

437
plugins/include/amxmisc.inc
View File

@ -18,59 +18,59 @@
stock is_user_admin(id)
{
new __flags=get_user_flags(id);
return (__flags>0 && !(__flags&ADMIN_USER));
new __flags = get_user_flags(id);
return (__flags > 0 && !(__flags & ADMIN_USER));
}
stock cmd_access(id, level, cid, num, bool:accesssilent = false)
stock cmd_access(id, level, cid, num, bool:accesssilent = false)
{
new has_access = 0;
if ( id==(is_dedicated_server()?0:1) )
if (id == (is_dedicated_server() ? 0 : 1))
{
has_access = 1;
}
else if ( level==ADMIN_ADMIN )
else if (level == ADMIN_ADMIN)
{
if ( is_user_admin(id) )
if (is_user_admin(id))
{
has_access = 1;
}
}
else if ( get_user_flags(id) & level )
else if (get_user_flags(id) & level)
{
has_access = 1;
}
else if (level == ADMIN_ALL)
else if (level == ADMIN_ALL)
{
has_access = 1;
}
if ( has_access==0 )
if (has_access == 0)
{
if (!accesssilent)
{
console_print(id,"%L",id,"NO_ACC_COM");
console_print(id, "%L", id, "NO_ACC_COM");
}
return 0;
}
if (read_argc() < num)
if (read_argc() < num)
{
new hcmd[32], hinfo[128], hflag;
get_concmd(cid,hcmd,31,hflag,hinfo,127,level);
console_print(id,"%L: %s %s",id,"USAGE",hcmd,hinfo);
get_concmd(cid, hcmd, charsmax(hcmd), hflag, hinfo, charsmax(hinfo), level);
console_print(id, "%L: %s %s", id, "USAGE", hcmd, hinfo);
return 0;
}
return 1;
}
stock access(id,level)
stock access(id, level)
{
if (level==ADMIN_ADMIN)
if (level == ADMIN_ADMIN)
{
return is_user_admin(id);
}
else if (level==ADMIN_ALL)
else if (level == ADMIN_ALL)
{
return 1;
}
@ -78,66 +78,69 @@ stock access(id,level)
return (get_user_flags(id) & level);
}
/* Flags:
* 1 - obey immunity
* 2 - allow yourself
* 4 - must be alive
* 8 - can't be bot */
/**
* Flags related to cmd_target:
* 1 - obey immunity
* 2 - allow yourself
* 4 - must be alive
* 8 - can't be bot
*/
#define CMDTARGET_OBEY_IMMUNITY (1<<0)
#define CMDTARGET_ALLOW_SELF (1<<1)
#define CMDTARGET_ONLY_ALIVE (1<<2)
#define CMDTARGET_NO_BOTS (1<<3)
stock cmd_target(id,const arg[],flags = CMDTARGET_OBEY_IMMUNITY)
#define CMDTARGET_ALLOW_SELF (1<<1)
#define CMDTARGET_ONLY_ALIVE (1<<2)
#define CMDTARGET_NO_BOTS (1<<3)
stock cmd_target(id, const arg[], flags = CMDTARGET_OBEY_IMMUNITY)
{
new player = find_player("bl",arg);
if (player)
new player = find_player("bl", arg);
if (player)
{
if ( player != find_player("blj",arg) )
if (player != find_player("blj", arg))
{
console_print(id,"%L",id,"MORE_CL_MATCHT");
console_print(id, "%L", id, "MORE_CL_MATCHT");
return 0;
}
}
else if ( ( player = find_player("c",arg) )==0 && arg[0]=='#' && arg[1] )
else if ((player = find_player("c", arg)) == 0 && arg[0] == '#' && arg[1])
{
player = find_player("k",str_to_num(arg[1]));
player = find_player("k", str_to_num(arg[1]));
}
if (!player)
if (!player)
{
console_print(id,"%L",id,"CL_NOT_FOUND");
console_print(id, "%L", id, "CL_NOT_FOUND");
return 0;
}
if (flags & CMDTARGET_OBEY_IMMUNITY)
if (flags & CMDTARGET_OBEY_IMMUNITY)
{
if ((get_user_flags(player) & ADMIN_IMMUNITY) &&
((flags & CMDTARGET_ALLOW_SELF) ? (id != player) : true) )
if ((get_user_flags(player) & ADMIN_IMMUNITY) && ((flags & CMDTARGET_ALLOW_SELF) ? (id != player) : true))
{
new imname[MAX_NAME_LENGTH];
get_user_name(player,imname,31);
console_print(id,"%L",id,"CLIENT_IMM",imname);
get_user_name(player, imname, charsmax(imname));
console_print(id, "%L", id, "CLIENT_IMM", imname);
return 0;
}
}
if (flags & CMDTARGET_ONLY_ALIVE)
if (flags & CMDTARGET_ONLY_ALIVE)
{
if (!is_user_alive(player))
if (!is_user_alive(player))
{
new imname[MAX_NAME_LENGTH];
get_user_name(player,imname,31);
console_print(id,"%L",id,"CANT_PERF_DEAD",imname);
get_user_name(player, imname, charsmax(imname));
console_print(id, "%L", id, "CANT_PERF_DEAD", imname);
return 0;
}
}
if (flags & CMDTARGET_NO_BOTS)
if (flags & CMDTARGET_NO_BOTS)
{
if (is_user_bot(player))
if (is_user_bot(player))
{
new imname[MAX_NAME_LENGTH];
get_user_name(player,imname,31);
console_print(id,"%L",id,"CANT_PERF_BOT",imname);
get_user_name(player, imname, charsmax(imname));
console_print(id, "%L", id, "CANT_PERF_BOT", imname);
return 0;
}
}
return player;
}
@ -145,24 +148,26 @@ stock cmd_target(id,const arg[],flags = CMDTARGET_OBEY_IMMUNITY)
* Standard method to show activity to clients connected to the server.
* This depends on the amx_show_activity cvar. See documentation for more details.
*
* @param id The user id of the person doing the action.
* @param name The name of the person doing the action.
* @param fmt The format string to display. Do not put the "ADMIN:" prefix in this.
* @param id The user id of the person doing the action.
* @param name The name of the person doing the action.
* @param fmt The format string to display. Do not put the "ADMIN:" prefix in this.
*
* @noreturn
*/
stock show_activity( id, const name[], const fmt[], any:... )
stock show_activity(id, const name[], const fmt[], any:...)
{
static __amx_show_activity;
if (__amx_show_activity == 0)
{
__amx_show_activity = get_cvar_pointer("amx_show_activity");
// if still not found, then register the cvar as a dummy
if (__amx_show_activity == 0)
{
__amx_show_activity = register_cvar("amx_show_activity", "2", FCVAR_PROTECTED);
}
}
new prefix[10];
if (is_user_admin(id))
{
@ -174,12 +179,12 @@ stock show_activity( id, const name[], const fmt[], any:... )
}
new buffer[512];
vformat(buffer, charsmax(buffer), fmt, 4);
switch(get_pcvar_num(__amx_show_activity))
switch (get_pcvar_num(__amx_show_activity))
{
case 5: // hide name only to admins, show nothing to normal users
{
for (new i=1; i<=MaxClients; i++)
for (new i = 1; i <= MaxClients; i++)
{
if (is_user_connected(i))
{
@ -192,7 +197,7 @@ stock show_activity( id, const name[], const fmt[], any:... )
}
case 4: // show name only to admins, show nothing to normal users
{
for (new i=1; i<=MaxClients; i++)
for (new i = 1; i <= MaxClients; i++)
{
if (is_user_connected(i))
{
@ -205,7 +210,7 @@ stock show_activity( id, const name[], const fmt[], any:... )
}
case 3: // show name only to admins, hide name from normal users
{
for (new i=1; i<=MaxClients; i++)
for (new i = 1; i <= MaxClients; i++)
{
if (is_user_connected(i))
{
@ -222,29 +227,30 @@ stock show_activity( id, const name[], const fmt[], any:... )
}
case 2: // show name to all
{
client_print(0, print_chat, "%L %s: %s", LANG_PLAYER, prefix , name , buffer );
client_print(0, print_chat, "%L %s: %s", LANG_PLAYER, prefix , name , buffer);
}
case 1: // hide name to all
{
client_print(0, print_chat, "%L: %s", LANG_PLAYER, prefix, buffer );
client_print(0, print_chat, "%L: %s", LANG_PLAYER, prefix, buffer);
}
}
}
/**
* Standard method to show activity to one single client.
* Standard method to show activity to one single client.
* This is useful for messages that get pieced together by many language keys.
* This depends on the amx_show_activity cvar. See documentation for more details.
*
* @param idtarget The user id of the person to display to. 0 is invalid.
* @param idadmin The user id of the person doing the action.
* @param name The name of the person doing the action.
* @param fmt The format string to display. Do not put the "ADMIN:" prefix in this.
* @param idtarget The user id of the person to display to. 0 is invalid.
* @param idadmin The user id of the person doing the action.
* @param name The name of the person doing the action.
* @param fmt The format string to display. Do not put the "ADMIN:" prefix in this.
*
* @noreturn
*/
stock show_activity_id(idtarget, idadmin, const name[], const fmt[], any:...)
{
if (idtarget == 0 ||
!is_user_connected(idtarget) )
if (idtarget == 0 || !is_user_connected(idtarget))
{
return;
}
@ -253,7 +259,7 @@ stock show_activity_id(idtarget, idadmin, const name[], const fmt[], any:...)
if (__amx_show_activity == 0)
{
__amx_show_activity = get_cvar_pointer("amx_show_activity");
// if still not found, then register the cvar as a dummy
if (__amx_show_activity == 0)
{
@ -270,30 +276,29 @@ stock show_activity_id(idtarget, idadmin, const name[], const fmt[], any:...)
{
copy(prefix, charsmax(prefix), "PLAYER");
}
static buffer[512];
vformat(buffer, charsmax(buffer), fmt, 5);
switch(get_pcvar_num(__amx_show_activity))
switch (get_pcvar_num(__amx_show_activity))
{
case 5: // hide name only to admins, show nothing to normal users
{
if ( is_user_admin(idtarget) )
if (is_user_admin(idtarget))
{
client_print(idtarget, print_chat, "%L: %s", idtarget, prefix, buffer);
}
}
case 4: // show name only to admins, show nothing to normal users
{
if ( is_user_admin(idtarget) )
if (is_user_admin(idtarget))
{
client_print(idtarget, print_chat, "%L %s: %s", idtarget, prefix, name, buffer);
}
}
case 3: // show name only to admins, hide name from normal users
{
if ( is_user_admin(idtarget) )
if (is_user_admin(idtarget))
{
client_print(idtarget, print_chat, "%L %s: %s", idtarget, prefix, name, buffer);
}
@ -312,6 +317,7 @@ stock show_activity_id(idtarget, idadmin, const name[], const fmt[], any:...)
}
}
}
/**
* Standard method to show activity to one single client with normal language keys.
* These keys need to be in the format of standard AMXX keys:
@ -319,10 +325,12 @@ stock show_activity_id(idtarget, idadmin, const name[], const fmt[], any:...)
* ADMIN_KICK_2 = ADMIN %s: kick %s
* This depends on the amx_show_activity cvar. See documentation for more details.
*
* @param KeyWithoutName The language key that does not have the name field.
* @param KeyWithName The language key that does have the name field.
* @param __AdminName The name of the person doing the action.
* @extra Pass any extra format arguments for the language key in the variable arguments list.
* @param KeyWithoutName The language key that does not have the name field.
* @param KeyWithName The language key that does have the name field.
* @param __AdminName The name of the person doing the action.
* @extra Pass any extra format arguments for the language key in the variable arguments list.
*
* @noreturn
*/
stock show_activity_key(const KeyWithoutName[], const KeyWithName[], const ___AdminName[], any:...)
{
@ -332,26 +340,91 @@ stock show_activity_key(const KeyWithoutName[], const KeyWithName[], const ___Ad
if (__amx_show_activity == 0)
{
__amx_show_activity = get_cvar_pointer("amx_show_activity");
// if still not found, then register the cvar as a dummy
if (__amx_show_activity == 0)
{
__amx_show_activity = register_cvar("amx_show_activity", "2", FCVAR_PROTECTED);
}
}
new buffer[512];
new keyfmt[256];
new i;
switch( get_pcvar_num(__amx_show_activity) )
switch (get_pcvar_num(__amx_show_activity))
{
case 5: // hide name to admins, display nothing to normal players
while (i++ < MaxClients)
case 5: // hide name to admins, display nothing to normal players
{
if ( is_user_connected(i) )
while (i++ < MaxClients)
{
if ( is_user_admin(i) )
if (is_user_connected(i))
{
if (is_user_admin(i))
{
LookupLangKey(keyfmt, charsmax(keyfmt), KeyWithoutName, i);
// skip the "adminname" argument if not showing name
vformat(buffer, charsmax(buffer), keyfmt, 4);
client_print(i, print_chat, "%s", buffer);
}
}
}
}
case 4: // show name only to admins, display nothing to normal players
{
while (i++ < MaxClients)
{
if (is_user_connected(i))
{
if (is_user_admin(i))
{
LookupLangKey(keyfmt, charsmax(keyfmt), KeyWithName, i);
vformat(buffer, charsmax(buffer), keyfmt, 3);
client_print(i, print_chat, "%s", buffer);
}
}
}
}
case 3: // show name only to admins, hide name from normal users
{
while (i++ < MaxClients)
{
if (is_user_connected(i))
{
if (is_user_admin(i))
{
LookupLangKey(keyfmt, charsmax(keyfmt), KeyWithName, i);
vformat(buffer, charsmax(buffer), keyfmt, 3);
}
else
{
LookupLangKey(keyfmt, charsmax(keyfmt), KeyWithoutName, i);
// skip the "adminname" argument if not showing name
vformat(buffer, charsmax(buffer), keyfmt, 4);
}
client_print(i, print_chat, "%s", buffer);
}
}
}
case 2: // show name to all users
{
while (i++ < MaxClients)
{
if (is_user_connected(i))
{
LookupLangKey(keyfmt, charsmax(keyfmt), KeyWithName, i);
vformat(buffer, charsmax(buffer), keyfmt, 3);
client_print(i, print_chat, "%s", buffer);
}
}
}
case 1: // hide name from all users
{
while (i++ < MaxClients)
{
if (is_user_connected(i))
{
LookupLangKey(keyfmt, charsmax(keyfmt), KeyWithoutName, i);
@ -361,62 +434,6 @@ stock show_activity_key(const KeyWithoutName[], const KeyWithName[], const ___Ad
}
}
}
case 4: // show name only to admins, display nothing to normal players
while (i++ < MaxClients)
{
if ( is_user_connected(i) )
{
if ( is_user_admin(i) )
{
LookupLangKey(keyfmt, charsmax(keyfmt), KeyWithName, i);
vformat(buffer, charsmax(buffer), keyfmt, 3);
client_print(i, print_chat, "%s", buffer);
}
}
}
case 3: // show name only to admins, hide name from normal users
while (i++ < MaxClients)
{
if ( is_user_connected(i) )
{
if ( is_user_admin(i) )
{
LookupLangKey(keyfmt, charsmax(keyfmt), KeyWithName, i);
vformat(buffer, charsmax(buffer), keyfmt, 3);
}
else
{
LookupLangKey(keyfmt, charsmax(keyfmt), KeyWithoutName, i);
// skip the "adminname" argument if not showing name
vformat(buffer, charsmax(buffer), keyfmt, 4);
}
client_print(i, print_chat, "%s", buffer);
}
}
case 2: // show name to all users
while (i++ < MaxClients)
{
if ( is_user_connected(i) )
{
LookupLangKey(keyfmt, charsmax(keyfmt), KeyWithName, i);
vformat(buffer, charsmax(buffer), keyfmt, 3);
client_print(i, print_chat, "%s", buffer);
}
}
case 1: // hide name from all users
while (i++ < MaxClients)
{
if ( is_user_connected(i) )
{
LookupLangKey(keyfmt, charsmax(keyfmt), KeyWithoutName, i);
// skip the "adminname" argument if not showing name
vformat(buffer, charsmax(buffer), keyfmt, 4);
client_print(i, print_chat, "%s", buffer);
}
}
}
}
@ -448,86 +465,116 @@ stock colored_menus()
return ColoredMenus;
}
stock cstrike_running()
stock cstrike_running()
{
new mod_name[32];
get_modname(mod_name,31);
get_modname(mod_name, charsmax(mod_name));
return ( equal(mod_name,"cstrike") || equal(mod_name,"czero") || equal(mod_name,"csv15") || equal(mod_name,"cs13") );
return (equal(mod_name, "cstrike") || equal(mod_name, "czero") || equal(mod_name, "csv15") || equal(mod_name, "cs13"));
}
stock is_running(const mod[])
stock is_running(const mod[])
{
new mod_name[32];
get_modname(mod_name,31);
get_modname(mod_name, charsmax(mod_name));
return equal(mod_name,mod);
return equal(mod_name, mod);
}
stock get_basedir(name[],len)
stock get_basedir(name[], len)
{
return get_localinfo("amxx_basedir",name,len);
return get_localinfo("amxx_basedir", name, len);
}
stock get_configsdir(name[],len)
stock get_configsdir(name[], len)
{
return get_localinfo("amxx_configsdir",name,len);
return get_localinfo("amxx_configsdir", name, len);
}
stock get_datadir(name[],len)
stock get_datadir(name[], len)
{
return get_localinfo("amxx_datadir",name,len);
return get_localinfo("amxx_datadir", name, len);
}
stock register_menu(const title[],keys,const function[],outside=0)
stock register_menu(const title[], keys, const function[], outside = 0)
{
register_menucmd(register_menuid(title,outside),keys,function);
register_menucmd(register_menuid(title, outside), keys, function);
}
/* Backwards Compatibility
* don't use it! */
stock get_customdir(name[],len)
/**
* Backwards Compatibility
* don't use it!
*/
stock get_customdir(name[], len)
{
return get_localinfo("amxx_configsdir",name,len);
return get_localinfo("amxx_configsdir", name, len);
}
/* Add a menu item to Menus Front-End plugin ("amxmodmenu"):
* MENU_TEXT: Text that will be shown for this item in menu
* MENU_CMD: Command that should be executed to start menu
* MENU_ACCESS: Access required for menu
* MENU_PLUGIN: The exact case-insensitive name of plugin holding the menu command
*/
stock AddMenuItem(const MENU_TEXT[], const MENU_CMD[], const MENU_ACCESS, const MENU_PLUGIN[])
/**
* Add a menu item to Menus Front-End plugin ("amxmodmenu").
*
* @param MENU_TEXT Text that will be shown for this item in menu.
* @param MENU_CMD Command that should be executed to start menu.
* @param MENU_ACCESS Access required for menu.
* @param MENU_PLUGIN The exact case-insensitive name of plugin holding the menu command.
*
* @noreturn
*/
stock AddMenuItem(const MENU_TEXT[], const MENU_CMD[], const MENU_ACCESS, const MENU_PLUGIN[])
{
AddMenuItem_call(MENU_TEXT, MENU_CMD, MENU_ACCESS, MENU_PLUGIN, false);
}
/* Just like above, but add menu item to "amx_menu", that should also be accessible by non-admins.
*/
stock AddClientMenuItem(const MENU_TEXT[], const MENU_CMD[], const MENU_ACCESS, const MENU_PLUGIN[])
/**
* Add a menu item to "amx_menu", that should also be accessible by non-admins.
*
* @param MENU_TEXT Text that will be shown for this item in menu.
* @param MENU_CMD Command that should be executed to start menu.
* @param MENU_ACCESS Access required for menu.
* @param MENU_PLUGIN The exact case-insensitive name of plugin holding the menu command.
*
* @noreturn
*/
stock AddClientMenuItem(const MENU_TEXT[], const MENU_CMD[], const MENU_ACCESS, const MENU_PLUGIN[])
{
AddMenuItem_call(MENU_TEXT, MENU_CMD, MENU_ACCESS, MENU_PLUGIN, true);
}
// Internal function used by above stocks.
stock AddMenuItem_call(const MENU_TEXT[], const MENU_CMD[], const MENU_ACCESS, const MENU_PLUGIN[], const bool:ADD_TO_CLIENT_MENU)
/**
* Internal function used by above stocks.
*/
stock AddMenuItem_call(const MENU_TEXT[], const MENU_CMD[], const MENU_ACCESS, const MENU_PLUGIN[], const bool:ADD_TO_CLIENT_MENU)
{
new pluginid = is_plugin_loaded("Menus Front-End");
if (pluginid == -1) {
if (pluginid == -1)
{
log_amx("Can't add menu item ^"%s^" from plugin ^"%s^" to menu set because the Menus Front-End plugin itself is not loaded!", MENU_TEXT, MENU_PLUGIN);
return; // Menus Front-End doesn't exist, return.
}
new filename[64], b[1];
get_plugin(pluginid, filename, 63, b, 0, b, 0, b, 0, b, 0);
get_plugin(pluginid, filename, charsmax(filename), b, charsmax(b), b, charsmax(b), b, charsmax(b), b, charsmax(b));
new status = callfunc_begin(ADD_TO_CLIENT_MENU ? "AddClientMenu" : "AddMenu", filename);
new bool:failed = true;
switch (status)
{
case 1: failed = false;
case 0: log_amx("Run time error! (AddMenuItem_call failed)");
case -2: log_amx("Function not found! (AddMenuItem_call failed)");
case -1: log_amx("Plugin not found! (AddMenuItem_call failed)");
case 1:
{
failed = false;
}
case 0:
{
log_amx("Run time error! (AddMenuItem_call failed)");
}
case -2:
{
log_amx("Function not found! (AddMenuItem_call failed)");
}
case -1:
{
log_amx("Plugin not found! (AddMenuItem_call failed)");
}
}
if (failed)
{
@ -545,7 +592,6 @@ stock AddMenuItem_call(const MENU_TEXT[], const MENU_CMD[], const MENU_ACCESS, c
callfunc_end();
}
stock constraint_offset(low, high, seed, offset)
{
new numElements = high - low + 1;
@ -559,24 +605,35 @@ stock constraint_offset(low, high, seed, offset)
{
return high - (abs(offset) % numElements) + 1;
}
return 0; // Makes the compiler happy -_-
}
/* Returns true if the user has ANY of the provided flags
* false if they have none
/**
* Tells if the user has ANY of the provided flags.
*
* @param id Client index
* @param flags Flag string
*
* @return 1 if the user has ANY of the provided flags, 0 otherwise
*/
stock has_flag(id, const flags[])
stock has_flag(id, const flags[])
{
return (get_user_flags(id) & read_flags(flags));
}
/* Returns true if the user has ALL of the provided flags
* false otherwise
/**
* Tells if the user has ALL of the provided flags.
*
* @param id Client index
* @param flags Flag string
*
* @return 1 if the user has ALL of the provided flags, 0 otherwise
*/
stock has_all_flags(id, const flags[])
stock has_all_flags(id, const flags[])
{
new FlagsNumber=read_flags(flags);
return ((get_user_flags(id) & FlagsNumber)==FlagsNumber);
new FlagsNumber = read_flags(flags);
return ((get_user_flags(id) & FlagsNumber) == FlagsNumber);
}
/**
@ -585,6 +642,8 @@ stock has_all_flags(id, const flags[])
* @note This is just a wrapper around show_menu for the sake of readability.
*
* @param index Client to reset menu to, use 0 to reset to all clients
*
* @noreturn
*/
stock reset_menu(index)
{