From 6cff249b5cca2ca22760df7fb662d69859ab985a Mon Sep 17 00:00:00 2001 From: Scott Ehlert Date: Mon, 12 Feb 2007 09:00:55 +0000 Subject: [PATCH] Fixed tabs, hopefully... --HG-- extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%40481 --- plugins/include/admin.inc | 101 +++++++++--------- plugins/include/console.inc | 189 +++++++++++++++++----------------- plugins/include/core.inc | 2 +- plugins/include/datapack.inc | 11 +- plugins/include/files.inc | 51 ++++----- plugins/include/float.inc | 3 +- plugins/include/geoip.inc | 2 +- plugins/include/handles.inc | 10 +- plugins/include/helpers.inc | 1 + plugins/include/lang.inc | 3 +- plugins/include/sourcemod.inc | 27 ++--- plugins/include/string.inc | 19 ++-- plugins/include/textparse.inc | 71 ++++++------- 13 files changed, 250 insertions(+), 240 deletions(-) diff --git a/plugins/include/admin.inc b/plugins/include/admin.inc index 3bfad62a..d803edf3 100644 --- a/plugins/include/admin.inc +++ b/plugins/include/admin.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -127,7 +128,7 @@ enum AdminCachePart /** * Called when part of the cache which needs to be rebuilt. * - * @param part Part of the admin cache to rebuild. + * @param part Part of the admin cache to rebuild. */ forward OnRebuildAdminCache(AdminCachePart:part); @@ -326,9 +327,9 @@ native bool:BindAdminIdentity(AdminId:id, const String:auth[], const String:iden /** * Sets whether or not a flag is enabled on an admin. * - * @param id AdminId index of the admin. - * @param flag Admin flag to use. - * @param enabled True to enable, false to disable. + * @param id AdminId index of the admin. + * @param flag Admin flag to use. + * @param enabled True to enable, false to disable. * @noreturn */ native SetAdminFlag(AdminId:id, AdminFlag:flag, bool:enabled); @@ -336,19 +337,19 @@ native SetAdminFlag(AdminId:id, AdminFlag:flag, bool:enabled); /** * Returns whether or not a flag is enabled on an admin. * - * @param id AdminId index of the admin. - * @param flag Admin flag to use. - * @param mode Access mode to check. - * @return True if enabled, false otherwise. + * @param id AdminId index of the admin. + * @param flag Admin flag to use. + * @param mode Access mode to check. + * @return True if enabled, false otherwise. */ native bool:GetAdminFlag(AdminId:id, AdminFlag:flag, AdmAccessMode:mode); /** * Returns the bitstring of access flags on an admin. * - * @param id AdminId index of the admin. - * @param mode Access mode to use. - * @return A bitstring containing which flags are enabled. + * @param id AdminId index of the admin. + * @param mode Access mode to use. + * @return A bitstring containing which flags are enabled. */ native GetAdminFlags(AdminId:id, AdmAccessMode:mode); @@ -356,39 +357,39 @@ native GetAdminFlags(AdminId:id, AdmAccessMode:mode); * Adds a group to an admin's inherited group list. Any flags the group has * will be added to the admin's effective flags. * - * @param id AdminId index of the admin. - * @param gid GroupId index of the group. - * @return True on success, false on invalid input or duplicate membership. + * @param id AdminId index of the admin. + * @param gid GroupId index of the group. + * @return True on success, false on invalid input or duplicate membership. */ native bool:AdminInheritGroup(AdminId:id, GroupId:gid); /** * Returns the number of groups this admin is a member of. * - * @param id AdminId index of the admin. - * @return Number of groups this admin is a member of. + * @param id AdminId index of the admin. + * @return Number of groups this admin is a member of. */ native GetAdminGroupCount(AdminId:id); /** * Returns group information from an admin. * - * @param id AdminId index of the admin. - * @param index Group number to retrieve, from 0 to N-1, where N - * is the value of GetAdminGroupCount(id). - * @param name Buffer to store the group's name. - * Note: This will safely chop UTF-8 strings. - * @param maxlength Maximum size of the output name buffer. - * @return A GroupId index and a name pointer, or - * INVALID_GROUP_ID and NULL if an error occurred. + * @param id AdminId index of the admin. + * @param index Group number to retrieve, from 0 to N-1, where N + * is the value of GetAdminGroupCount(id). + * @param name Buffer to store the group's name. + * Note: This will safely chop UTF-8 strings. + * @param maxlength Maximum size of the output name buffer. + * @return A GroupId index and a name pointer, or + * INVALID_GROUP_ID and NULL if an error occurred. */ native GroupId:GetAdminGroup(AdminId:id, index, const String:name[], maxlength) =0; /** * Sets a password on an admin. * - * @param id AdminId index of the admin. - * @param passwd String containing the password. + * @param id AdminId index of the admin. + * @param passwd String containing the password. * @noreturn */ native SetAdminPassword(AdminId:id, const String:password[]); @@ -396,20 +397,20 @@ native SetAdminPassword(AdminId:id, const String:password[]); /** * Gets an admin's password. * - * @param id AdminId index of the admin. - * @param name Optional buffer to store the admin's password. - * @param maxlength Maximum size of the output name buffer. - * Note: This will safely chop UTF-8 strings. - * @return True if there was a password set, false otherwise. + * @param id AdminId index of the admin. + * @param name Optional buffer to store the admin's password. + * @param maxlength Maximum size of the output name buffer. + * Note: This will safely chop UTF-8 strings. + * @return True if there was a password set, false otherwise. */ native bool:GetAdminPassword(AdminId:id, const String:buffer[]="", maxlength=0); /** * Attempts to find an admin by an auth method and an identity. * - * @param auth Auth method to try. - * @param identity Identity string to look up. - * @return An AdminId index if found, INVALID_ADMIN_ID otherwise. + * @param auth Auth method to try. + * @param identity Identity string to look up. + * @return An AdminId index if found, INVALID_ADMIN_ID otherwise. */ native AdminId:FindAdminByIdentity(const String:auth[], const String:identity[]); @@ -418,46 +419,46 @@ native AdminId:FindAdminByIdentity(const String:auth[], const String:identity[]) * * Note: This will remove any bindings to a specific user. * - * @param id AdminId index to remove/invalidate. - * @return True on success, false otherwise. + * @param id AdminId index to remove/invalidate. + * @return True on success, false otherwise. */ native bool:RemoveAdmin(AdminId:id); /** * Converts a flag bit string to a bit array. * - * @param bits Bit string containing the flags. - * @param array Array to write the flags to. Enabled flags will be 'true'. - * @param maxSize Maximum number of flags the array can store. - * @return Number of flags written. + * @param bits Bit string containing the flags. + * @param array Array to write the flags to. Enabled flags will be 'true'. + * @param maxSize Maximum number of flags the array can store. + * @return Number of flags written. */ native FlagBitsToBitArray(bits, bool:array[], maxSize); /** * Converts a flag array to a bit string. * - * @param array Array containing true or false for each AdminFlag. - * @param maxSize Maximum size of the flag array. - * @return A bit string composed of the array bits. + * @param array Array containing true or false for each AdminFlag. + * @param maxSize Maximum size of the flag array. + * @return A bit string composed of the array bits. */ native FlagBitArrayToBits(const bool:array[], maxSize); /** * Converts an array of flags to bits. * - * @param array Array containing flags that are enabled. - * @param numFlags Number of flags in the array. - * @return A bit string composed of the array flags. + * @param array Array containing flags that are enabled. + * @param numFlags Number of flags in the array. + * @return A bit string composed of the array flags. */ native FlagArrayToBits(const AdminFlag:array[], numFlags) =0; /** * Converts a bit string to an array of flags. * - * @param bits Bit string containing the flags. - * @param array Output array to write flags. - * @param maxSize Maximum size of the flag array. - * @return Number of flags written. + * @param bits Bit string containing the flags. + * @param array Output array to write flags. + * @param maxSize Maximum size of the flag array. + * @return Number of flags written. */ native FlagBitsToArray(bits, AdminFlag:array[], maxSize) =0; diff --git a/plugins/include/console.inc b/plugins/include/console.inc index 58b04506..445b9972 100644 --- a/plugins/include/console.inc +++ b/plugins/include/console.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -21,66 +22,66 @@ * Flags for console commands and console variables * @note The descriptions for each constant come directly from the Source SDK. */ -#define FCVAR_NONE 0 /**< The default, no flags at all */ -#define FCVAR_UNREGISTERED (1<<0) /**< If this is set, don't add to linked list, etc. */ -#define FCVAR_LAUNCHER (1<<1) /**< Defined by launcher. */ -#define FCVAR_GAMEDLL (1<<2) /**< Defined by the game DLL. */ -#define FCVAR_CLIENTDLL (1<<3) /**< Defined by the client DLL. */ -#define FCVAR_MATERIAL_SYSTEM (1<<4) /**< Defined by the material system. */ -#define FCVAR_PROTECTED (1<<5) /**< It's a server cvar, but we don't send the data since it's a password, etc. Sends 1 if it's not bland/zero, 0 otherwise as value. */ -#define FCVAR_SPONLY (1<<6) /**< This cvar cannot be changed by clients connected to a multiplayer server. */ -#define FCVAR_ARCHIVE (1<<7) /**< Set to cause it to be saved to vars.rc */ -#define FCVAR_NOTIFY (1<<8) /**< Notifies players when changed. */ -#define FCVAR_USERINFO (1<<9) /**< Changes the client's info string. */ -#define FCVAR_PRINTABLEONLY (1<<10) /**< This cvar's string cannot contain unprintable characters (e.g., used for player name, etc.) */ -#define FCVAR_UNLOGGED (1<<11) /**< If this is a FCVAR_SERVER, don't log changes to the log file / console if we are creating a log */ -#define FCVAR_NEVER_AS_STRING (1<<12) /**< Never try to print that cvar. */ -#define FCVAR_REPLICATED (1<<13) /**< Server setting enforced on clients. */ -#define FCVAR_CHEAT (1<<14) /**< Only useable in singleplayer / debug / multiplayer & sv_cheats */ -#define FCVAR_STUDIORENDER (1<<15) /**< Defined by the studiorender system. */ -#define FCVAR_DEMO (1<<16) /**< Record this cvar when starting a demo file. */ -#define FCVAR_DONTRECORD (1<<17) /**< Don't record these command in demo files. */ -#define FCVAR_PLUGIN (1<<18) /**< Defined by a 3rd party plugin. */ -#define FCVAR_DATACACHE (1<<19) /**< Defined by the datacache system. */ -#define FCVAR_TOOLSYSTEM (1<<20) /**< Defined by an IToolSystem library */ -#define FCVAR_FILESYSTEM (1<<21) /**< Defined by the file system. */ -#define FCVAR_NOT_CONNECTED (1<<22) /**< Cvar cannot be changed by a client that is connected to a server. */ -#define FCVAR_SOUNDSYSTEM (1<<23) /**< Defined by the soundsystem library. */ -#define FCVAR_ARCHIVE_XBOX (1<<24) /**< Cvar written to config.cfg on the Xbox. */ -#define FCVAR_INPUTSYSTEM (1<<25) /**< Defined by the inputsystem DLL. */ -#define FCVAR_NETWORKSYSTEM (1<<26) /**< Defined by the network system. */ -#define FCVAR_VPHYSICS (1<<27) /**< Defined by vphysics. */ +#define FCVAR_NONE 0 /**< The default, no flags at all */ +#define FCVAR_UNREGISTERED (1<<0) /**< If this is set, don't add to linked list, etc. */ +#define FCVAR_LAUNCHER (1<<1) /**< Defined by launcher. */ +#define FCVAR_GAMEDLL (1<<2) /**< Defined by the game DLL. */ +#define FCVAR_CLIENTDLL (1<<3) /**< Defined by the client DLL. */ +#define FCVAR_MATERIAL_SYSTEM (1<<4) /**< Defined by the material system. */ +#define FCVAR_PROTECTED (1<<5) /**< It's a server cvar, but we don't send the data since it's a password, etc. Sends 1 if it's not bland/zero, 0 otherwise as value. */ +#define FCVAR_SPONLY (1<<6) /**< This cvar cannot be changed by clients connected to a multiplayer server. */ +#define FCVAR_ARCHIVE (1<<7) /**< Set to cause it to be saved to vars.rc */ +#define FCVAR_NOTIFY (1<<8) /**< Notifies players when changed. */ +#define FCVAR_USERINFO (1<<9) /**< Changes the client's info string. */ +#define FCVAR_PRINTABLEONLY (1<<10) /**< This cvar's string cannot contain unprintable characters (e.g., used for player name, etc.) */ +#define FCVAR_UNLOGGED (1<<11) /**< If this is a FCVAR_SERVER, don't log changes to the log file / console if we are creating a log */ +#define FCVAR_NEVER_AS_STRING (1<<12) /**< Never try to print that cvar. */ +#define FCVAR_REPLICATED (1<<13) /**< Server setting enforced on clients. */ +#define FCVAR_CHEAT (1<<14) /**< Only useable in singleplayer / debug / multiplayer & sv_cheats */ +#define FCVAR_STUDIORENDER (1<<15) /**< Defined by the studiorender system. */ +#define FCVAR_DEMO (1<<16) /**< Record this cvar when starting a demo file. */ +#define FCVAR_DONTRECORD (1<<17) /**< Don't record these command in demo files. */ +#define FCVAR_PLUGIN (1<<18) /**< Defined by a 3rd party plugin. */ +#define FCVAR_DATACACHE (1<<19) /**< Defined by the datacache system. */ +#define FCVAR_TOOLSYSTEM (1<<20) /**< Defined by an IToolSystem library */ +#define FCVAR_FILESYSTEM (1<<21) /**< Defined by the file system. */ +#define FCVAR_NOT_CONNECTED (1<<22) /**< Cvar cannot be changed by a client that is connected to a server. */ +#define FCVAR_SOUNDSYSTEM (1<<23) /**< Defined by the soundsystem library. */ +#define FCVAR_ARCHIVE_XBOX (1<<24) /**< Cvar written to config.cfg on the Xbox. */ +#define FCVAR_INPUTSYSTEM (1<<25) /**< Defined by the inputsystem DLL. */ +#define FCVAR_NETWORKSYSTEM (1<<26) /**< Defined by the network system. */ +#define FCVAR_VPHYSICS (1<<27)/**< Defined by vphysics. */ /** * Creates a new console variable. * - * @param name Name of new convar. - * @param defaultValue String containing the default value of new convar. - * @param helpText Optional description of the convar. - * @param flags Optional bitstream of flags determining how the convar should be handled. (See FCVAR_* constants for more details) - * @param hasMin Optional boolean that determines if the convar has a minimum value. - * @param min Minimum floating point value that the convar can have if hasMin is true. - * @param hasMax Optional boolean that determines if the convar has a maximum value. - * @param max Maximum floating point value that the convar can have if hasMax is true. + * @param name Name of new convar. + * @param defaultValue String containing the default value of new convar. + * @param helpText Optional description of the convar. + * @param flags Optional bitstream of flags determining how the convar should be handled. (See FCVAR_* constants for more details) + * @param hasMin Optional boolean that determines if the convar has a minimum value. + * @param min Minimum floating point value that the convar can have if hasMin is true. + * @param hasMax Optional boolean that determines if the convar has a maximum value. + * @param max Maximum floating point value that the convar can have if hasMax is true. * @return A handle to the newly created convar. If the convar already exists, INVALID_HANDLE is returned. - * @error Convar name is blank or is the same as a console command. + * @error Convar name is blank or is the same as a console command. */ native Handle:CreateConVar(const String:name[], const String:defaultValue[], const String:helpText[]="", flags=0, bool:hasMin=false, Float:min=0.0, bool:hasMax=false, Float:max=0.0); /** * Searches for a console variable. * - * @param name Name of convar to find. - * @return A handle to the convar if it is found. INVALID_HANDLE otherwise. + * @param name Name of convar to find. + * @return A handle to the convar if it is found. INVALID_HANDLE otherwise. */ native Handle:FindConVar(const String:name[]); /** * Called when a console variable's value is changed. * - * @param convar Handle to the convar that was changed. - * @param oldValue String containing the value of the convar before it was changed. - * @param newValue String containing the new value of the convar. + * @param convar Handle to the convar that was changed. + * @param oldValue String containing the value of the convar before it was changed. + * @param newValue String containing the new value of the convar. * @noreturn */ functag OnConVarChanged public(Handle:convar, const String:oldValue[], const String:newValue[]); @@ -88,156 +89,156 @@ functag OnConVarChanged public(Handle:convar, const String:oldValue[], const Str /** * Creates a hook for when a console variable's value is changed. * - * @param convar Handle to the convar. - * @param callback An OnConVarChanged function pointer. + * @param convar Handle to the convar. + * @param callback An OnConVarChanged function pointer. * @noreturn - * @error Invalid or corrupt Handle or invalid callback function. + * @error Invalid or corrupt Handle or invalid callback function. */ native HookConVarChange(Handle:convar, OnConVarChanged:callback); /** * Removes a hook for when a console variable's value is changed. * - * @param convar Handle to the convar. - * @param callback An OnConVarChanged function pointer. + * @param convar Handle to the convar. + * @param callback An OnConVarChanged function pointer. * @noreturn - * @error Invalid or corrupt Handle, invalid callback function, or no active hook on convar. + * @error Invalid or corrupt Handle, invalid callback function, or no active hook on convar. */ native UnhookConVarChange(Handle:convar, OnConVarChanged:callback); /** * Returns the boolean value of a console variable. * - * @param convar Handle to the convar. - * @return The boolean value of the convar. - * @error Invalid or corrupt Handle. + * @param convar Handle to the convar. + * @return The boolean value of the convar. + * @error Invalid or corrupt Handle. */ native bool:GetConVarBool(Handle:convar); /** * Sets the boolean value of a console variable. * - * @param convar Handle to the convar. - * @param value New boolean value. + * @param convar Handle to the convar. + * @param value New boolean value. * @noreturn - * @error Invalid or corrupt Handle. + * @error Invalid or corrupt Handle. */ native SetConVarBool(Handle:convar, bool:value); /** * Returns the integer value of a console variable. * - * @param convar Handle to the convar. - * @return The integer value of the convar. - * @error Invalid or corrupt Handle. + * @param convar Handle to the convar. + * @return The integer value of the convar. + * @error Invalid or corrupt Handle. */ native GetConVarInt(Handle:convar); /** * Sets the integer value of a console variable. * - * @param convar Handle to the convar. - * @param value New integer value. + * @param convar Handle to the convar. + * @param value New integer value. * @noreturn - * @error Invalid or corrupt Handle. + * @error Invalid or corrupt Handle. */ native SetConVarInt(Handle:convar, value); /** * Returns the floating point value of a console variable. * - * @param convar Handle to the convar. - * @return The floating point value of the convar. - * @error Invalid or corrupt Handle. + * @param convar Handle to the convar. + * @return The floating point value of the convar. + * @error Invalid or corrupt Handle. */ native Float:GetConVarFloat(Handle:convar); /** * Sets the floating point value of a console variable. * - * @param convar Handle to the convar. - * @param value New floating point value. + * @param convar Handle to the convar. + * @param value New floating point value. * @noreturn - * @error Invalid or corrupt Handle. + * @error Invalid or corrupt Handle. */ native SetConVarFloat(Handle:convar, Float:value); /** * Retrieves the string value of a console variable. * - * @param convar Handle to the convar. - * @param value Buffer to store the value of the convar. - * @param maxlength Maximum length of string buffer. + * @param convar Handle to the convar. + * @param value Buffer to store the value of the convar. + * @param maxlength Maximum length of string buffer. * @noreturn - * @error Invalid or corrupt Handle. + * @error Invalid or corrupt Handle. */ native GetConVarString(Handle:convar, String:value[], maxlength); /** * Sets the string value of a console variable. * - * @param convar Handle to the convar. - * @param value New string value. + * @param convar Handle to the convar. + * @param value New string value. * @noreturn - * @error Invalid or corrupt Handle. + * @error Invalid or corrupt Handle. */ native SetConVarString(Handle:convar, const String:value[]); /** * Returns the bitstring of flags on a console variable. * - * @param convar Handle to the convar. - * @return A bitstring containing the FCVAR_* flags that are enabled. - * @error Invalid or corrupt Handle. + * @param convar Handle to the convar. + * @return A bitstring containing the FCVAR_* flags that are enabled. + * @error Invalid or corrupt Handle. */ native GetConVarFlags(Handle:convar); /** * Sets the bitstring of flags on a console variable. * - * @param convar Handle to the convar. - * @param flags A bitstring containing the FCVAR_* flags to enable. + * @param convar Handle to the convar. + * @param flags A bitstring containing the FCVAR_* flags to enable. * @noreturn - * @error Invalid or corrupt Handle. + * @error Invalid or corrupt Handle. */ native SetConVarFlags(Handle:convar, flags); /** * Retrieves the name of a console variable. * - * @param convar Handle to the convar. - * @param value Buffer to store the name of the convar. - * @param maxlength Maximum length of string buffer. + * @param convar Handle to the convar. + * @param value Buffer to store the name of the convar. + * @param maxlength Maximum length of string buffer. * @noreturn - * @error Invalid or corrupt Handle. + * @error Invalid or corrupt Handle. */ native GetConVarName(Handle:convar, const String:name[], maxlength); /** * Retrieves the minimum floating point value that a console variable can contain. * - * @param convar Handle to the convar. - * @param min By-reference cell to store the minimum floating point value. - * @return True if the convar has a minimum value set, false otherwise. - * @error Invalid or corrupt Handle. + * @param convar Handle to the convar. + * @param min By-reference cell to store the minimum floating point value. + * @return True if the convar has a minimum value set, false otherwise. + * @error Invalid or corrupt Handle. */ native bool:GetConVarMin(Handle:convar, &Float:min); /** * Retrieves the maximum floating point value that a console variable can contain. * - * @param convar Handle to the convar. - * @param min By-reference cell to store the maximum floating point value. - * @return True if the convar has a maximum value set, false otherwise. - * @error Invalid or corrupt Handle. + * @param convar Handle to the convar. + * @param min By-reference cell to store the maximum floating point value. + * @return True if the convar has a maximum value set, false otherwise. + * @error Invalid or corrupt Handle. */ native bool:GetConVarMax(Handle:convar, &Float:max); /** * Resets the console variable to its default value. * - * @param convar Handle to the convar. + * @param convar Handle to the convar. * @noreturn - * @error Invalid or corrupt Handle. + * @error Invalid or corrupt Handle. */ native ResetConVar(Handle:convar); diff --git a/plugins/include/core.inc b/plugins/include/core.inc index c520295d..0e345757 100644 --- a/plugins/include/core.inc +++ b/plugins/include/core.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -38,4 +39,3 @@ struct Extension #define AUTOLOAD_EXTENSIONS #define REQUIRE_EXTENSIONS - diff --git a/plugins/include/datapack.inc b/plugins/include/datapack.inc index 5e491d6d..0e493eda 100644 --- a/plugins/include/datapack.inc +++ b/plugins/include/datapack.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -21,7 +22,7 @@ /** * Creates a new data pack. * - * @return A Handle to the data pack. Must be closed with CloseHandle(). + * @return A Handle to the data pack. Must be closed with CloseHandle(). */ native Handle:CreateDataPack(); @@ -90,7 +91,7 @@ native ReadPackString(Handle:pack, String:buffer[], maxlen); * @param pack Handle to the data pack. * @param clear If true, clears the contained data. * @noreturn - * @error Invalid handle. + * @error Invalid handle. */ native ResetPack(Handle:pack, bool:clear=false); @@ -99,7 +100,7 @@ native ResetPack(Handle:pack, bool:clear=false); * * @param pack Handle to the data pack. * @return Numerical position in the data pack. - * @error Invalid handle. + * @error Invalid handle. */ native GetPackPosition(Handle:pack); @@ -119,7 +120,7 @@ native SetPackPosition(Handle:pack, position); * * @param pack Handle to the data pack. * @param bytes Number of bytes to simulate reading. - * @return True if can be read, false otherwise. - * @error Invalid handle. + * @return True if can be read, false otherwise. + * @error Invalid handle. */ native bool:IsPackReadable(Handle:pack, bytes); diff --git a/plugins/include/files.inc b/plugins/include/files.inc index 677a0681..4df1f731 100644 --- a/plugins/include/files.inc +++ b/plugins/include/files.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -78,17 +79,17 @@ native bool:ReadDirEntry(Handle:dir, String:buffer[], maxlength, &FileType:type= * @note Files are closed with CloseHandle(). * @note File Handles can be cloned. * - * @param file File to open. - * @param mode Open mode. - * @return A Handle to the file, INVALID_HANDLE on open error. + * @param file File to open. + * @param mode Open mode. + * @return A Handle to the file, INVALID_HANDLE on open error. */ native Handle:OpenFile(const String:file[], const String:mode[]); /** * @brief Deletes a file. * - * @param path Path of the file to delete. - * @return True on success, false otherwise. + * @param path Path of the file to delete. + * @return True on success, false otherwise. */ native bool:DeleteFile(const String:path[]); @@ -105,34 +106,34 @@ native bool:ReadFileLine(Handle:hndl, String:buffer[], maxlength); /** * @brief Tests if the end of file has been reached. * - * @param file Handle to the file. - * @return True if end of file has been reached, false otherwise. + * @param file Handle to the file. + * @return True if end of file has been reached, false otherwise. */ native bool:IsEndOfFile(Handle:file); /** * @brief Sets the file position indicator. * - * @param file Handle to the file. - * @param position Position relative to what is specified in whence. - * @param whence Look at the SEEK_* definitions. - * @return True on success, false otherwise. + * @param file Handle to the file. + * @param position Position relative to what is specified in whence. + * @param whence Look at the SEEK_* definitions. + * @return True on success, false otherwise. */ native bool:FileSeek(Handle:file, position, whence); /** * @brief Get current position in the file. * - * @param file Handle to the file. - * @return Value for the file position indicator. + * @param file Handle to the file. + * @return Value for the file position indicator. */ native FilePosition(Handle:file); /** * @brief Checks if a file exists. * - * @param path Path to the file. - * @return True if the file exists, false otherwise. + * @param path Path to the file. + * @return True if the file exists, false otherwise. */ native bool:FileExists(const String:path[]); @@ -148,16 +149,16 @@ native bool:RenameFile(const String:newpath[], const String:oldpath[]); /** * @brief Checks if a directory exists. * - * @param path Path to the directory. - * @return True if the directory exists, false otherwise. + * @param path Path to the directory. + * @return True if the directory exists, false otherwise. */ native bool:DirExists(const String:path[]); /** * @brief Get the file size in bytes. * - * @param path Path to the file. - * @return File size in bytes, -1 if file not found. + * @param path Path to the file. + * @return File size in bytes, -1 if file not found. */ native FileSize(const String:path[]); @@ -165,8 +166,8 @@ native FileSize(const String:path[]); * @brief Removes a directory. * @note On most Operating Systems you cannot remove a directory which has files inside it. * - * @param path Path to the directory. - * @return True on success, false otherwise. + * @param path Path to the directory. + * @return True on success, false otherwise. */ native bool:RemoveDir(const String:path[]); @@ -174,9 +175,9 @@ native bool:RemoveDir(const String:path[]); * @brief Writes a line of text in a file. * @note This native will append the newline character. * - * @param hndl Handle to the file. - * @param format Formatting rules. - * @param ... Variable number of format parameters. - * @return True on success, false otherwise. + * @param hndl Handle to the file. + * @param format Formatting rules. + * @param ... Variable number of format parameters. + * @return True on success, false otherwise. */ native bool:WriteFileLine(Handle:hndl, const String:format[], {Handle,Float,String,_}:...); diff --git a/plugins/include/float.inc b/plugins/include/float.inc index a1bf2034..0d9f8139 100644 --- a/plugins/include/float.inc +++ b/plugins/include/float.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -319,4 +320,4 @@ stock Float:DegToRad(Float:angle) stock Float:RadToDeg(Float:angle) { return (angle*180)/FLOAT_PI; -} \ No newline at end of file +} diff --git a/plugins/include/geoip.inc b/plugins/include/geoip.inc index 66271799..161e9210 100644 --- a/plugins/include/geoip.inc +++ b/plugins/include/geoip.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -70,4 +71,3 @@ public Extension:__ext_geoip = required = 0, #endif }; - diff --git a/plugins/include/handles.inc b/plugins/include/handles.inc index 554dd632..8655c5c4 100644 --- a/plugins/include/handles.inc +++ b/plugins/include/handles.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -29,7 +30,7 @@ enum Handle * This is provided for situations only where testing for handle validity is needed. * * @param hndl Handle to test for validity. - * @return True if handle is valid, false otherwise. + * @return True if handle is valid, false otherwise. */ native bool:IsValidHandle(Handle:hndl); @@ -41,7 +42,7 @@ native bool:IsValidHandle(Handle:hndl); * sure you read the documentation on whatever provided the Handle. * * @param hndl Handle to close. - * @return True if successful, false if not closeable. + * @return True if successful, false if not closeable. * @error Invalid handles will cause a run time error. */ native bool:CloseHandle(Handle:hndl); @@ -59,9 +60,8 @@ native bool:CloseHandle(Handle:hndl); * * @param hndl Handle to clone/duplicate. * @param plugin Optional Handle to another plugin to mark as the new owner. - * If no owner is passed, the owner becomes the calling plugin. - * @return Handle on success, INVALID_HANDLE if not cloneable. + * If no owner is passed, the owner becomes the calling plugin. + * @return Handle on success, INVALID_HANDLE if not cloneable. * @error Invalid handles will cause a run time error. */ native Handle:CloneHandle(Handle:hndl, Handle:plugin=INVALID_HANDLE); - diff --git a/plugins/include/helpers.inc b/plugins/include/helpers.inc index 2b0427f7..61fd8f82 100644 --- a/plugins/include/helpers.inc +++ b/plugins/include/helpers.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== diff --git a/plugins/include/lang.inc b/plugins/include/lang.inc index 66fff159..ea6ef4a5 100644 --- a/plugins/include/lang.inc +++ b/plugins/include/lang.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -23,4 +24,4 @@ * @param path Translation file. * @noreturn */ -native LoadTranslations(const String:file[]); \ No newline at end of file +native LoadTranslations(const String:file[]); diff --git a/plugins/include/sourcemod.inc b/plugins/include/sourcemod.inc index 4ee73244..279584a4 100644 --- a/plugins/include/sourcemod.inc +++ b/plugins/include/sourcemod.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -20,7 +21,7 @@ struct Plugin { const String:name[], /* Plugin Name */ - const String:description[], /* Plugin Description */ + const String:description[], /* Plugin Description */ const String:author[], /* Plugin Author */ const String:version[], /* Plugin Version */ const String:url[], /* Plugin URL */ @@ -82,7 +83,7 @@ forward OnPluginEnd(); /** * Called when the plugin's pause status is changing. * - * @param pause True if the plugin is being paused, false otherwise. + * @param pause True if the plugin is being paused, false otherwise. * @noreturn */ forward OnPluginPauseChange(bool:pause); @@ -164,11 +165,11 @@ native GetClientCount(bool:inGameOnly=true); /** * Returns the client's name. * - * @param client Player index. - * @param name Buffer to store the client's name. - * @param maxlen Maximum length of string buffer (includes NULL terminator). - * @return True on success, false otherwise. - * @error If the client is not connected an error will be thrown. + * @param client Player index. + * @param name Buffer to store the client's name. + * @param maxlen Maximum length of string buffer (includes NULL terminator). + * @return True on success, false otherwise. + * @error If the client is not connected an error will be thrown. */ native bool:GetClientName(client, String:name[], maxlen); @@ -334,8 +335,8 @@ native PrintToConsole(client, const String:format[], {Handle,Float,String,_}:... /** * Logs a generic message to the HL2 logs. * - * @param format String format. - * @param ... Format arguments. + * @param format String format. + * @param ... Format arguments. * @noreturn */ native LogToGame(const String:format[], {Handle,Float,String,_}:...); @@ -343,8 +344,8 @@ native LogToGame(const String:format[], {Handle,Float,String,_}:...); /** * Logs a plugin message to the SourceMod logs. * - * @param format String format. - * @param ... Format arguments. + * @param format String format. + * @param ... Format arguments. * @noreturn */ native LogMessage(const String:format[], {Handle,Float,String,_}:...); @@ -352,8 +353,8 @@ native LogMessage(const String:format[], {Handle,Float,String,_}:...); /** * Logs a plugin error message to the SourceMod logs. * - * @param format String format. - * @param ... Format arguments. + * @param format String format. + * @param ... Format arguments. * @noreturn */ native LogError(const String:format[], {Handle,Float,String,_}:...); diff --git a/plugins/include/string.inc b/plugins/include/string.inc index b8dd34d4..6d61f7de 100644 --- a/plugins/include/string.inc +++ b/plugins/include/string.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -27,8 +28,8 @@ /** * Calculates the length of a string. * - * @param str String to check. - * @return Length of string, in cells (NOT characters). + * @param str String to check. + * @return Length of string, in cells (NOT characters). */ native strlen(const String:str[]); @@ -38,9 +39,9 @@ native strlen(const String:str[]); * @param str String to search in. * @param substr Substring to find inside the original string. * @param caseSensitive If true (default), search is case sensitive. - * If false, search is case insensitive. - * @return -1 on failure (no match found). Any other value - * indicates a position in the string where the match starts. + * If false, search is case insensitive. + * @return -1 on failure (no match found). Any other value + * indicates a position in the string where the match starts. */ native StrContains(const String:str[], const String:substr[], bool:caseSensitive=true); @@ -50,10 +51,10 @@ native StrContains(const String:str[], const String:substr[], bool:caseSensitive * @param str1 First string (left). * @param str2 Second string (right). * @param caseSensitive If true (default), comparison is case sensitive. - * If false, comparison is case insensitive. - * @return -1 if str1 < str2 - * 0 if str1 == str2 - * 1 if str1 > str2 + * If false, comparison is case insensitive. + * @return -1 if str1 < str2 + * 0 if str1 == str2 + * 1 if str1 > str2 */ native StrCompare(const String:str1[], const String:str2[], bool:caseSensitive=true); diff --git a/plugins/include/textparse.inc b/plugins/include/textparse.inc index c39dc6f7..e03cd4d6 100644 --- a/plugins/include/textparse.inc +++ b/plugins/include/textparse.inc @@ -1,4 +1,5 @@ /** + * vim: set ts=4 : * =============================================================== * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. * =============================================================== @@ -26,25 +27,25 @@ enum SMCResult { - SMCParse_Continue, //continue parsing - SMCParse_Halt, //stop parsing here - SMCParse_HaltFail //stop parsing and return failure + SMCParse_Continue, /**< Continue parsing */ + SMCParse_Halt, /**< Stop parsing here */ + SMCParse_HaltFail /**< Stop parsing and return failure */ }; enum SMCError { - SMCError_Okay = 0, //no error - SMCError_StreamOpen, //stream failed to open - SMCError_StreamError, //the stream died... somehow - SMCError_Custom, //a custom handler threw an error - SMCError_InvalidSection1, //a section was declared without quotes, and had extra tokens - SMCError_InvalidSection2, //a section was declared without any header - SMCError_InvalidSection3, //a section ending was declared with too many unknown tokens - SMCError_InvalidSection4, //a section ending has no matching beginning - SMCError_InvalidSection5, //a section beginning has no matching ending - SMCError_InvalidTokens, //there were too many unidentifiable strings on one line - SMCError_TokenOverflow, //the token buffer overflowed - SMCError_InvalidProperty1, //a property was declared outside of any section + SMCError_Okay = 0, /**< No error */ + SMCError_StreamOpen, /**< Stream failed to open */ + SMCError_StreamError, /**< The stream died... somehow */ + SMCError_Custom, /**< A custom handler threw an error */ + SMCError_InvalidSection1, /**< A section was declared without quotes, and had extra tokens */ + SMCError_InvalidSection2, /**< A section was declared without any header */ + SMCError_InvalidSection3, /**< A section ending was declared with too many unknown tokens */ + SMCError_InvalidSection4, /**< A section ending has no matching beginning */ + SMCError_InvalidSection5, /**< A section beginning has no matching ending */ + SMCError_InvalidTokens, /**< There were too many unidentifiable strings on one line */ + SMCError_TokenOverflow, /**< The token buffer overflowed */ + SMCError_InvalidProperty1, /**< A property was declared outside of any section */ }; /** @@ -57,12 +58,12 @@ native Handle:SMC_CreateParser(); /** * Parses an SMC file. * - * @param smc A Handle to an SMC Parse structure. - * @param file A string containing the file path. - * @param line An optional by reference cell to store the last line number read. - * @param col An optional by reference cell to store the last column number read. - * @return An SMCParseError result. - * @error Invalid or corrupt Handle. + * @param smc A Handle to an SMC Parse structure. + * @param file A string containing the file path. + * @param line An optional by reference cell to store the last line number read. + * @param col An optional by reference cell to store the last column number read. + * @return An SMCParseError result. + * @error Invalid or corrupt Handle. */ native SMCError:SMC_ParseFile(Handle:smc, const String:file[], &line=0, &col=0); @@ -71,10 +72,10 @@ native SMCError:SMC_ParseFile(Handle:smc, const String:file[], &line=0, &col=0); * @note SMCError_Okay returns false. * @note SMCError_Custom (which is thrown on SMCParse_HaltFail) returns false. * - * @param error The SMCParseError code. - * @param buffer A string buffer for the error (contents undefined on failure). - * @param buf_max The maximum size of the buffer. - * @return True on success, false otherwise. + * @param error The SMCParseError code. + * @param buffer A string buffer for the error (contents undefined on failure). + * @param buf_max The maximum size of the buffer. + * @return True on success, false otherwise. */ native bool:SMC_GetErrorString(SMCError:error, String:buffer[], buf_max); @@ -89,10 +90,10 @@ functag SMC_ParseStart public(Handle:smc); /** * Sets the SMC_ParseStart function of a parse Handle. * - * @param smc Handle to an SMC Parse. - * @param func SMC_ParseStart function. + * @param smc Handle to an SMC Parse. + * @param func SMC_ParseStart function. * @noreturn - * @error Invalid or corrupt Handle. + * @error Invalid or corrupt Handle. */ native SMC_SetParseStart(Handle:smc, SMC_ParseStart:func); @@ -100,8 +101,8 @@ native SMC_SetParseStart(Handle:smc, SMC_ParseStart:func); * Called when parsing is halted. * * @param smc The SMC Parse Handle. - * @param halted True if abnormally halted, false otherwise. - * @param failed True if parsing failed, false otherwise. + * @param halted True if abnormally halted, false otherwise. + * @param failed True if parsing failed, false otherwise. * @noreturn */ functag SMC_ParseEnd public(Handle:smc, bool:halted, bool:failed); @@ -109,10 +110,10 @@ functag SMC_ParseEnd public(Handle:smc, bool:halted, bool:failed); /** * Sets the SMC_ParseEnd of a parse handle. * - * @param smc Handle to an SMC Parse. - * @param func SMC_ParseEnd function. + * @param smc Handle to an SMC Parse. + * @param func SMC_ParseEnd function. * @noreturn - * @error Invalid or corrupt Handle. + * @error Invalid or corrupt Handle. */ native SMC_SetParseEnd(Handle:smc, SMC_ParseEnd:func); @@ -172,8 +173,8 @@ functag SMC_RawLine SMCResult:public(Handle:smc, const String:line[], lineno); /** * Sets a raw line reader on an SMC parser Handle. * - * @param smc Handle to an SMC Parse. - * @param func SMC_RawLine function. + * @param smc Handle to an SMC Parse. + * @param func SMC_RawLine function. * @noreturn */ native SMC_SetRawLine(Handle:smc, SMC_RawLine:func);