diff --git a/plugins/include/amxmodx.inc b/plugins/include/amxmodx.inc index 7ebebdcb..4166c6e4 100755 --- a/plugins/include/amxmodx.inc +++ b/plugins/include/amxmodx.inc @@ -420,7 +420,7 @@ native console_print(id, const message[], any:...); * @param cmd Formatting rules * @param ... Variable number of formatting parameters * - * @return The length of the formatted command. + * @return Length of the formatted command */ native console_cmd(id, const cmd[], any:...); @@ -615,7 +615,7 @@ native show_dhudmessage(index, const message[], any:...); * @param time Menu timeout in seconds, -1 to disable * @param title Name of the menu for internal tracking purposes */ -native show_menu(index, keys, const menu[], time = -1, const title[] = ""); +native show_menu(index, keys, const menu[], time=-1, const title[]=""); /** * Retrieves values from a client message. @@ -723,7 +723,7 @@ native read_logargv(id, output[], len); * @error If the provided string is not valid client log data, an * error will be thrown. */ -native parse_loguser(const text[], name[], nlen, &userid = -2, authid[] = "", alen = 0, team[]="", tlen=0); +native parse_loguser(const text[], name[], nlen, &userid=-2, authid[]="", alen=0, team[]="", tlen=0); /** * Sends a message to the console of the server. @@ -930,7 +930,7 @@ native get_user_deaths(index); native get_user_health(index); /** - * Retrieve a client's index by name. + * Retrieves a client's index by name. * * @param name Name to search for * @@ -948,7 +948,7 @@ native get_user_index(const name[]); * * @return Number of cells written to the buffer */ -native get_user_ip(index, ip[], len, without_port = 0); +native get_user_ip(index, ip[], len, without_port=0); /** * Returns if the client has the specified weapon in their inventory. @@ -1021,7 +1021,7 @@ native num_to_word(num, output[], len); * @return Team index on success, -1 if client index is invalid or * the client is not connected. */ -native get_user_team(index, team[]="", len = 0); +native get_user_team(index, team[]="", len=0); /** * Returns client's playing time in seconds. @@ -1033,7 +1033,7 @@ native get_user_team(index, team[]="", len = 0); * @return Connection time in seconds, 0 if client index is invalid or * client is not connected */ -native get_user_time(index, flag = 0); +native get_user_time(index, flag=0); /** * Retrieves the ping and loss of a client. @@ -1063,7 +1063,7 @@ native get_user_ping(index, &ping, &loss); * @error If the client index is not within the range of 1 to * MaxClients an error will be thrown. */ -native get_user_origin(index, origin[3], mode = 0); +native get_user_origin(index, origin[3], mode=0); /** * Retrieves all weapons in the client inventory, stores them in an array and @@ -1374,7 +1374,7 @@ native engclient_cmd(index, const command[], const arg1[]="", const arg2[]=""); * command hooks. For an alternative that doesn't, see engclient_cmd(). * * @param index Client index, use 0 to execute from all clients. - * @param command The client command to execute on + * @param command Client command to execute on * @param arg1 Optional command arguments * @param arg2 Optional command arguments * @@ -1382,7 +1382,7 @@ native engclient_cmd(index, const command[], const arg1[]="", const arg2[]=""); * @error If a single client is specified and the index is not * within the range of 1 to MaxClients an error will be thrown */ -native amxclient_cmd(index, const command[], const arg1[] = "", const arg2[] = ""); +native amxclient_cmd(index, const command[], const arg1[]="", const arg2[]=""); /** * Queues a command to be executed from the server console. @@ -1442,7 +1442,7 @@ native cvar_exists(const cvar[]); * * @return 1 on success, 0 if cvar does not exist or is not permitted */ -native remove_cvar_flags(const cvar[], flags = -1); +native remove_cvar_flags(const cvar[], flags=-1); /** * Sets specified flags to a cvar. The cvar is accessed by name. @@ -1635,7 +1635,7 @@ native get_time(const format[], output[], len); * @return Number of cells written to buffer * @error If the conversion process fails, an error will be thrown */ -native format_time(output[], len, const format[], time = -1); +native format_time(output[], len, const format[], time=-1); /** * Returns the system time as a unix timestamp (number of seconds since unix @@ -1646,7 +1646,7 @@ native format_time(output[], len, const format[], time = -1); * @return Unix time stamp * @error */ -native get_systime(offset = 0); +native get_systime(offset=0); /** * Converts time string to unix time stamp. @@ -1666,7 +1666,7 @@ native get_systime(offset = 0); * @return Unix time stamp * @error If the conversion process fails, an error will be thrown */ -native parse_time(const input[], const format[], time = -1); +native parse_time(const input[], const format[], time=-1); /** * Calls a function after a specified time has elapsed. @@ -1686,7 +1686,7 @@ native parse_time(const input[], const format[], time = -1); * @param repeat If the "a" flag is set the task will be repeated this * many times */ -native set_task(Float:time, const function[], id = 0, const parameter[]="", len = 0, const flags[]="", repeat = 0); +native set_task(Float:time, const function[], id=0, const parameter[]="", len=0, const flags[]="", repeat=0); /** * Removes all tasks with the specified id. @@ -1696,7 +1696,7 @@ native set_task(Float:time, const function[], id = 0, const parameter[]="", len * * @return Number of removed tasks */ -native remove_task(id = 0, outside = 0); +native remove_task(id=0, outside=0); /** * Modifies the time interval of all tasks with the specified id. @@ -1707,7 +1707,7 @@ native remove_task(id = 0, outside = 0); * * @return Number of affected tasks */ -native change_task(id = 0, Float:newTime=1.0, outside = 0); +native change_task(id=0, Float:newTime=1.0, outside=0); /** * Returns if a task with the specified id exists. @@ -1717,7 +1717,7 @@ native change_task(id = 0, Float:newTime=1.0, outside = 0); * * @return 1 if a task was found, 0 otherwise */ -native task_exists(id = 0, outside = 0); +native task_exists(id=0, outside=0); /** * Sets the specified admin flags to a client. @@ -1958,7 +1958,7 @@ native get_concmd_plid(cid, flag_mask, id_type); * * @return Number of registered console commants */ -native get_concmdsnum(flag, id = -1); +native get_concmdsnum(flag, id=-1); /** * Returns the number of plugin-registered cvars. @@ -2069,7 +2069,7 @@ native emit_sound(index, channel, const sample[], Float:vol, Float:att, flags, p * * @return Unique cvar pointer */ -native register_cvar(const name[], const string[], flags = 0, Float:fvalue = 0.0); +native register_cvar(const name[], const string[], flags=0, Float:fvalue=0.0); /** * Returns a random floating point value generated by the engine. @@ -2180,7 +2180,7 @@ native Float:get_xvar_float(id); * @noreturn * @error If an invalid xvar id is specified an error will be thrown. */ -native set_xvar_num(id, value = 0); +native set_xvar_num(id, value=0); /** * Sets the float value of a public variable. @@ -2196,7 +2196,7 @@ native set_xvar_num(id, value = 0); * @noreturn * @error If an invalid xvar id is specified an error will be thrown. */ -native set_xvar_float(id, Float:value = 0.0); +native set_xvar_float(id, Float:value=0.0); /** * Returns if a module is loaded. @@ -2275,7 +2275,7 @@ native get_plugin(index, filename[]="", len1=0, name[]="", len2=0, version[]="", /** * Returns the number of loaded AMXX plugins. * - * @return The number of loaded plugins + * @return Number of loaded plugins */ native get_pluginsnum(); @@ -2358,10 +2358,10 @@ native callfunc_begin(const func[], const plugin[]=""); * @error If called while another callfunc has not yet been finished, * or the specified function is invalid, an error is thrown. */ -native callfunc_begin_i(func, plugin = -1); +native callfunc_begin_i(func, plugin=-1); /** - * Retrieve a functions id for use with callfunc_begin_i() + * Retrieves a functions id for use with callfunc_begin_i() * * @param funcName Function name * @param pluginId Plugin id. If -1 the calling plugin is targeted. The plugin @@ -2370,7 +2370,7 @@ native callfunc_begin_i(func, plugin = -1); * @return >0 Function id on success * -1 if plugin or function was not found */ -native get_func_id(const funcName[], pluginId = -1); +native get_func_id(const funcName[], pluginId=-1); /** * Pushes an int value onto the current call. @@ -2826,7 +2826,7 @@ native set_array_f(param, const Float:source[], size); * unavailable or the querying process runs out of memory, * an error will be thrown. */ -native query_client_cvar(id, const cvar[], const resultFunc[], paramlen=0, const params[] = ""); +native query_client_cvar(id, const cvar[], const resultFunc[], paramlen=0, const params[]=""); /** * Allows to trap error messages that occur in a plugin. diff --git a/plugins/include/cellarray.inc b/plugins/include/cellarray.inc index 1ea1b3ef..3c52a233 100644 --- a/plugins/include/cellarray.inc +++ b/plugins/include/cellarray.inc @@ -52,7 +52,7 @@ stock ByteCountToCells(size) * Creates a handle to a dynamically sized array. * * @note It is very important that the provided cellsize matches up with the - * buffer sizes that you pass with subsequent Array[Get|Set|Push] calls. + * buffer sizes that are passed with subsequent Array[Get|Set|Push] calls. * @note Initially the "reserved" parameter was intended to create blank entries * that would immediately be usable with Array[Get|Set] functions. This * functionality was never working as intended, and can now be achieved @@ -73,7 +73,8 @@ native Array:ArrayCreate(cellsize = 1, reserved = 32); * @param which Array handle * * @return Handle to the cloned array on success, 0 otherwise - * @error If an invalid handle is provided an error will be thrown + * @error If an invalid handle is provided an error will be + * thrown. */ native Array:ArrayClone(Array:which); @@ -93,7 +94,8 @@ native ArrayClear(Array:which); * @param which Array handle * * @return Number of elements in the array - * @error If an invalid handle is provided an error will be thrown + * @error If an invalid handle is provided an error will be + * thrown. */ native ArraySize(Array:which); @@ -108,7 +110,7 @@ native ArraySize(Array:which); * * @noreturn * @error If an invalid handle is provided or the resizing - * operation runs out of memory, an error will be thrown + * operation runs out of memory, an error will be thrown. */ native bool:ArrayResize(Array:which, newsize); @@ -141,7 +143,7 @@ native ArrayGetArray(Array:which, item, any:output[], size = -1); * * @return Integer value * @error If an invalid handle, index or block is provided an - * error will be thrown + * error will be thrown. */ native any:ArrayGetCell(Array:which, item, block = 0, bool:asChar = false); @@ -155,7 +157,7 @@ native any:ArrayGetCell(Array:which, item, block = 0, bool:asChar = false); * * @return Number of characters copied * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native ArrayGetString(Array:which, item, output[], size); @@ -175,7 +177,7 @@ native ArrayGetString(Array:which, item, output[], size); * * @return Number of cells copied * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native ArraySetArray(Array:which, item, const any:input[], size =-1); @@ -194,7 +196,7 @@ native ArraySetArray(Array:which, item, const any:input[], size =-1); * * @noreturn * @error If an invalid handle, index or block is provided an - * error will be thrown + * error will be thrown. */ native ArraySetCell(Array:which, item, any:input, block = 0, bool:asChar = false); @@ -212,7 +214,7 @@ native ArraySetCell(Array:which, item, any:input, block = 0, bool:asChar = false * * @return Number of characters copied * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native ArraySetString(Array:which, item, const input[]); @@ -230,7 +232,7 @@ native ArraySetString(Array:which, item, const input[]); * * @return Index of the new entry * @error If an invalid handle is provided or the resizing - * operation runs out of memory, an error will be thrown + * operation runs out of memory, an error will be thrown. */ native ArrayPushArray(Array:which, const any:input[], size = -1); @@ -243,7 +245,7 @@ native ArrayPushArray(Array:which, const any:input[], size = -1); * * @return Index of the new entry * @error If an invalid handle is provided or the resizing - * operation runs out of memory, an error will be thrown + * operation runs out of memory, an error will be thrown. */ native ArrayPushCell(Array:which, any:input); @@ -259,7 +261,7 @@ native ArrayPushCell(Array:which, any:input); * * @return Index of the new entry * @error If an invalid handle is provided or the resizing - * operation runs out of memory, an error will be thrown + * operation runs out of memory, an error will be thrown. */ native ArrayPushString(Array:which, const input[]); @@ -273,7 +275,7 @@ native ArrayPushString(Array:which, const input[]); * * @noreturn * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native ArrayInsertArrayAfter(Array:which, item, const any:input[]); @@ -283,11 +285,11 @@ native ArrayInsertArrayAfter(Array:which, item, const any:input[]); * * @param which Array handle * @param item Item index in the array - * @param input The value to set. + * @param input Value to set * * @noreturn * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native ArrayInsertCellAfter(Array:which, item, any:input); @@ -304,7 +306,7 @@ native ArrayInsertCellAfter(Array:which, item, any:input); * * @noreturn * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native ArrayInsertStringAfter(Array:which, item, const input[]); @@ -318,7 +320,7 @@ native ArrayInsertStringAfter(Array:which, item, const input[]); * * @noreturn * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native ArrayInsertArrayBefore(Array:which, item, const any:input[]); @@ -332,7 +334,7 @@ native ArrayInsertArrayBefore(Array:which, item, const any:input[]); * * @noreturn * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native ArrayInsertCellBefore(Array:which, item, const any:input); @@ -349,7 +351,7 @@ native ArrayInsertCellBefore(Array:which, item, const any:input); * * @noreturn * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native ArrayInsertStringBefore(Array:which, item, const input[]); @@ -361,24 +363,24 @@ native ArrayInsertStringBefore(Array:which, item, const input[]); * * @noreturn * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native ArraySwap(Array:which, item1, item2); /** * Deletes an item from the array. All items beyond it get shifted down by one. * - * @param which The array that contains the item to delete. - * @param item The item to delete. + * @param which Array handle + * @param item Item to delete * * @noreturn * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native ArrayDeleteItem(Array:which, item); /** - * Searches through the array and returns the index of the first occurance of + * Searches through the array and returns the index of the first occurence of * the specified string. * * @param which Array handle @@ -390,14 +392,15 @@ native ArrayDeleteItem(Array:which, item); native ArrayFindString(Array:which, const item[]); /** - * Searches through the array and returns the index of the first occurance of + * Searches through the array and returns the index of the first occurence of * the specified value. * - * @param which Array handle. + * @param which Array handle * @param item Value to search for * * @return Array index on success, -1 if the value can't be found - * @error Invalid handle. + * @error If an invalid handle is provided an error will be + * thrown. */ native ArrayFindValue(Array:which, any:item); @@ -416,7 +419,7 @@ native ArrayFindValue(Array:which, any:item); * * @return Handle to the item * @error If an invalid handle or an invalid index is provided an - * error will be thrown + * error will be thrown. */ native DoNotUse:ArrayGetStringHandle(Array:which, item); @@ -426,16 +429,15 @@ native DoNotUse:ArrayGetStringHandle(Array:which, item); * @note The function automatically sets the variable passed to it to 0 to aid * in preventing accidental usage after destroy. * - * @param which The array to destroy. + * @param which Array to destroy * * @return 1 if the array was destroyed, 0 if nothing had to be * destroyed (invalid handle) */ native ArrayDestroy(&Array:which); - /** - * Similar to sorting.inc's CustomSort, the sorting algorithm then uses your + * Similar to sorting.inc's CustomSort, the sorting algorithm then uses the * custom comparison function to sort the data. * * @note The function is called in the following manner: @@ -452,8 +454,8 @@ native ArrayDestroy(&Array:which); * 0 if item1 and item2 are equal * 1 if item1 should go after item2 * - * @note All parameters after item2 are optional and you do not need to specify - * and use them. + * @note All parameters after item2 are optional and do not need to be specified + * and used. * @note Unlike the sorting.inc version, the array passed to the callback is not * in mid-sorted state. * @@ -463,16 +465,17 @@ native ArrayDestroy(&Array:which); * @param data_size Size of extra data * * @noreturn - * @error Invalid handle or invalid callback. + * @error If an invalid handle or an invalid callback is provided + * an error will be thrown. */ native ArraySort(Array:array, const comparefunc[], data[]="", data_size=0); /** - * A faster version of ArraySort, the sorting algorithm then uses your custom + * A faster version of ArraySort, the sorting algorithm then uses the custom * comparison function to sort the data. * * @note The advantage of this function is that the data of the elements being - * compared is directly passed to your function, instead of the item + * compared is directly passed to the function, instead of the item * indexes that are passed by ArraySort. This removes the need for calling * ArrayGet[Cell|String|Array] every time before being able to compare the * elements. @@ -492,7 +495,7 @@ native ArraySort(Array:array, const comparefunc[], data[]="", data_size=0); * * public MySortFunc(Array:array, elem1[], elem2[], const data[], data_size) * - * array - Array handle in its current un-sorted state. + * array - Array handle in its current un-sorted state * elem1[], elem2[] - Current element pair being compared * data[] - Extra data array passed to the sort func * data_size - Size of extra data @@ -503,8 +506,8 @@ native ArraySort(Array:array, const comparefunc[], data[]="", data_size=0); * 0 if elem1 and elem2 are equal * 1 if elem1 should go after elem2 * - * @note All parameters after item2 are optional and you do not need to specify - * and use them. + * @note All parameters after item2 are optional and do not need to be specified + * and used. * @note Unlike the sorting.inc version, the array passed to the callback is not * in mid-sorted state. * @@ -514,6 +517,7 @@ native ArraySort(Array:array, const comparefunc[], data[]="", data_size=0); * @param data_size Size of extra data * * @noreturn - * @error Invalid handle, invalid callback or out of memory. + * @error If an invalid handle or an invalid callback is provided + * an error will be thrown. */ native ArraySortEx(Array:array, const comparefunc[], data[]="", data_size=0);