Flummi/amxmodx
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #194 from Freeman-AM/amxmisc-smallupdate

Browse Source 
amxmisc.inc: Missing charsmax, more readability, more compliance to amxmodx style.
This commit is contained in:
Vincent Herbet 2015-02-06 21:51:26 +01:00
commit 041113dbc4
1 changed files with 248 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

127
plugins/include/amxmisc.inc
View File

@ -56,7 +56,7 @@ stock cmd_access(id, level, cid, num, bool:accesssilent = false)
if (read_argc() < num) if (read_argc() < num)
{ {
new hcmd[32], hinfo[128], hflag; new hcmd[32], hinfo[128], hflag;
get_concmd(cid,hcmd,31,hflag,hinfo,127,level); get_concmd(cid, hcmd, charsmax(hcmd), hflag, hinfo, charsmax(hinfo), level);
console_print(id, "%L: %s %s", id, "USAGE", hcmd, hinfo); console_print(id, "%L: %s %s", id, "USAGE", hcmd, hinfo);
return 0; return 0;
} }
@ -78,15 +78,18 @@ stock access(id,level)
return (get_user_flags(id) & level); return (get_user_flags(id) & level);
} }
/* Flags: /**
* Flags related to cmd_target:
* 1 - obey immunity * 1 - obey immunity
* 2 - allow yourself * 2 - allow yourself
* 4 - must be alive * 4 - must be alive
* 8 - can't be bot */ * 8 - can't be bot
*/
#define CMDTARGET_OBEY_IMMUNITY (1<<0) #define CMDTARGET_OBEY_IMMUNITY (1<<0)
#define CMDTARGET_ALLOW_SELF (1<<1) #define CMDTARGET_ALLOW_SELF (1<<1)
#define CMDTARGET_ONLY_ALIVE (1<<2) #define CMDTARGET_ONLY_ALIVE (1<<2)
#define CMDTARGET_NO_BOTS (1<<3) #define CMDTARGET_NO_BOTS (1<<3)
stock cmd_target(id, const arg[], flags = CMDTARGET_OBEY_IMMUNITY) stock cmd_target(id, const arg[], flags = CMDTARGET_OBEY_IMMUNITY)
{ {
new player = find_player("bl", arg); new player = find_player("bl", arg);
@ -109,11 +112,10 @@ stock cmd_target(id,const arg[],flags = CMDTARGET_OBEY_IMMUNITY)
} }
if (flags & CMDTARGET_OBEY_IMMUNITY) if (flags & CMDTARGET_OBEY_IMMUNITY)
{ {
if ((get_user_flags(player) & ADMIN_IMMUNITY) && if ((get_user_flags(player) & ADMIN_IMMUNITY) && ((flags & CMDTARGET_ALLOW_SELF) ? (id != player) : true))
((flags & CMDTARGET_ALLOW_SELF) ? (id != player) : true) )
{ {
new imname[MAX_NAME_LENGTH]; new imname[MAX_NAME_LENGTH];
get_user_name(player,imname,31); get_user_name(player, imname, charsmax(imname));
console_print(id, "%L", id, "CLIENT_IMM", imname); console_print(id, "%L", id, "CLIENT_IMM", imname);
return 0; return 0;
} }
@ -123,7 +125,7 @@ stock cmd_target(id,const arg[],flags = CMDTARGET_OBEY_IMMUNITY)
if (!is_user_alive(player)) if (!is_user_alive(player))
{ {
new imname[MAX_NAME_LENGTH]; new imname[MAX_NAME_LENGTH];
get_user_name(player,imname,31); get_user_name(player, imname, charsmax(imname));
console_print(id, "%L", id, "CANT_PERF_DEAD", imname); console_print(id, "%L", id, "CANT_PERF_DEAD", imname);
return 0; return 0;
} }
@ -133,11 +135,12 @@ stock cmd_target(id,const arg[],flags = CMDTARGET_OBEY_IMMUNITY)
if (is_user_bot(player)) if (is_user_bot(player))
{ {
new imname[MAX_NAME_LENGTH]; new imname[MAX_NAME_LENGTH];
get_user_name(player,imname,31); get_user_name(player, imname, charsmax(imname));
console_print(id, "%L", id, "CANT_PERF_BOT", imname); console_print(id, "%L", id, "CANT_PERF_BOT", imname);
return 0; return 0;
} }
} }
return player; return player;
} }
@ -148,6 +151,8 @@ stock cmd_target(id,const arg[],flags = CMDTARGET_OBEY_IMMUNITY)
* @param id The user id of the person doing the action. * @param id The user id of the person doing the action.
* @param name The name 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 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:...)
{ {
@ -240,11 +245,12 @@ stock show_activity( id, const name[], const fmt[], any:... )
* @param idadmin The user id of the person doing the action. * @param idadmin The user id of the person doing the action.
* @param name The name 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 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:...) stock show_activity_id(idtarget, idadmin, const name[], const fmt[], any:...)
{ {
if (idtarget == 0 || if (idtarget == 0 || !is_user_connected(idtarget))
!is_user_connected(idtarget) )
{ {
return; return;
} }
@ -274,7 +280,6 @@ stock show_activity_id(idtarget, idadmin, const name[], const fmt[], any:...)
static buffer[512]; static buffer[512];
vformat(buffer, charsmax(buffer), fmt, 5); 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 case 5: // hide name only to admins, show nothing to normal users
@ -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. * 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: * These keys need to be in the format of standard AMXX keys:
@ -323,6 +329,8 @@ stock show_activity_id(idtarget, idadmin, const name[], const fmt[], any:...)
* @param KeyWithName The language key that does 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. * @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. * @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:...) stock show_activity_key(const KeyWithoutName[], const KeyWithName[], const ___AdminName[], any:...)
{ {
@ -347,6 +355,7 @@ stock show_activity_key(const KeyWithoutName[], const KeyWithName[], const ___Ad
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 case 5: // hide name to admins, display nothing to normal players
{
while (i++ < MaxClients) while (i++ < MaxClients)
{ {
if (is_user_connected(i)) if (is_user_connected(i))
@ -361,7 +370,9 @@ stock show_activity_key(const KeyWithoutName[], const KeyWithName[], const ___Ad
} }
} }
} }
}
case 4: // show name only to admins, display nothing to normal players case 4: // show name only to admins, display nothing to normal players
{
while (i++ < MaxClients) while (i++ < MaxClients)
{ {
if (is_user_connected(i)) if (is_user_connected(i))
@ -374,7 +385,9 @@ stock show_activity_key(const KeyWithoutName[], const KeyWithName[], const ___Ad
} }
} }
} }
}
case 3: // show name only to admins, hide name from normal users case 3: // show name only to admins, hide name from normal users
{
while (i++ < MaxClients) while (i++ < MaxClients)
{ {
if (is_user_connected(i)) if (is_user_connected(i))
@ -394,7 +407,9 @@ stock show_activity_key(const KeyWithoutName[], const KeyWithName[], const ___Ad
client_print(i, print_chat, "%s", buffer); client_print(i, print_chat, "%s", buffer);
} }
} }
}
case 2: // show name to all users case 2: // show name to all users
{
while (i++ < MaxClients) while (i++ < MaxClients)
{ {
if (is_user_connected(i)) if (is_user_connected(i))
@ -404,7 +419,9 @@ stock show_activity_key(const KeyWithoutName[], const KeyWithName[], const ___Ad
client_print(i, print_chat, "%s", buffer); client_print(i, print_chat, "%s", buffer);
} }
} }
}
case 1: // hide name from all users case 1: // hide name from all users
{
while (i++ < MaxClients) while (i++ < MaxClients)
{ {
if (is_user_connected(i)) if (is_user_connected(i))
@ -416,7 +433,7 @@ stock show_activity_key(const KeyWithoutName[], const KeyWithName[], const ___Ad
client_print(i, print_chat, "%s", buffer); client_print(i, print_chat, "%s", buffer);
} }
} }
}
} }
} }
@ -451,7 +468,7 @@ stock colored_menus()
stock cstrike_running() stock cstrike_running()
{ {
new mod_name[32]; 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"));
} }
@ -459,7 +476,7 @@ stock cstrike_running()
stock is_running(const mod[]) stock is_running(const mod[])
{ {
new mod_name[32]; 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);
} }
@ -484,50 +501,80 @@ 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! */ * Backwards Compatibility
* don't use it!
*/
stock get_customdir(name[], len) 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 * Add a menu item to Menus Front-End plugin ("amxmodmenu").
* MENU_CMD: Command that should be executed to start menu *
* MENU_ACCESS: Access required for menu * @param MENU_TEXT Text that will be shown for this item in menu.
* MENU_PLUGIN: The exact case-insensitive name of plugin holding the menu command * @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[]) 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); 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.
/**
* 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[]) 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); AddMenuItem_call(MENU_TEXT, MENU_CMD, MENU_ACCESS, MENU_PLUGIN, true);
} }
// Internal function used by above stocks. /**
* 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) 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"); 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); 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. return; // Menus Front-End doesn't exist, return.
} }
new filename[64], b[1]; 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 status = callfunc_begin(ADD_TO_CLIENT_MENU ? "AddClientMenu" : "AddMenu", filename);
new bool:failed = true; new bool:failed = true;
switch (status) switch (status)
{ {
case 1: failed = false; case 1:
case 0: log_amx("Run time error! (AddMenuItem_call failed)"); {
case -2: log_amx("Function not found! (AddMenuItem_call failed)"); failed = false;
case -1: log_amx("Plugin not found! (AddMenuItem_call failed)"); }
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) if (failed)
{ {
@ -545,7 +592,6 @@ stock AddMenuItem_call(const MENU_TEXT[], const MENU_CMD[], const MENU_ACCESS, c
callfunc_end(); callfunc_end();
} }
stock constraint_offset(low, high, seed, offset) stock constraint_offset(low, high, seed, offset)
{ {
new numElements = high - low + 1; new numElements = high - low + 1;
@ -563,15 +609,26 @@ stock constraint_offset(low, high, seed, offset)
return 0; // Makes the compiler happy -_- 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)); 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[])
{ {
@ -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. * @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 * @param index Client to reset menu to, use 0 to reset to all clients
*
* @noreturn
*/ */
stock reset_menu(index) stock reset_menu(index)
{ {