Various pointless things of no importance:
- Renamed ISourceMod::GetModPath() to GetGamePath() - Renamed ISourceMod::GetModFolderName() to GetGameFolderName() - Various spelling corrections (why did I do this?) --HG-- extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%40735
This commit is contained in:
@@ -148,12 +148,12 @@ namespace SourceMod
|
||||
typedef int AdminId;
|
||||
|
||||
/**
|
||||
* @brief Represents an invalid/nonexistant group or an erroneous operation.
|
||||
* @brief Represents an invalid/nonexistent group or an erroneous operation.
|
||||
*/
|
||||
#define INVALID_GROUP_ID -1
|
||||
|
||||
/**
|
||||
* @brief Represents an invalid/nonexistant user or an erroneous operation.
|
||||
* @brief Represents an invalid/nonexistent user or an erroneous operation.
|
||||
*/
|
||||
#define INVALID_ADMIN_ID -1
|
||||
|
||||
@@ -571,12 +571,12 @@ namespace SourceMod
|
||||
* @brief Checks whether an AdminId can target another AdminId.
|
||||
*
|
||||
* Zeroth, if the targeting AdminId is INVALID_ADMIN_ID, targeting fails.
|
||||
* First, if the targetted AdminId is INVALID_ADMIN_ID, targeting succeeds.
|
||||
* Second, if the targeting admin is root, targeting suceeds.
|
||||
* Third, if the targetted admin has global immunity, targeting fails.
|
||||
* Fourth, if the targetted admin has default immunity,
|
||||
* First, if the targeted AdminId is INVALID_ADMIN_ID, targeting succeeds.
|
||||
* Second, if the targeting admin is root, targeting succeeds.
|
||||
* Third, if the targeted admin has global immunity, targeting fails.
|
||||
* Fourth, if the targeted admin has default immunity,
|
||||
* and the admin belongs to no groups, targeting fails.
|
||||
* Fifth, if the targetted admin has specific immunity from the
|
||||
* Fifth, if the targeted admin has specific immunity from the
|
||||
* targeting admin via group immunities, targeting fails.
|
||||
* Sixth, targeting succeeds if it passes these tests.
|
||||
*
|
||||
|
||||
@@ -175,7 +175,7 @@ namespace SourceMod
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Return false to tell Core that your extension should be considered unsable.
|
||||
* @brief Return false to tell Core that your extension should be considered usable.
|
||||
*
|
||||
* @param error Error buffer.
|
||||
* @param maxlength Size of error buffer.
|
||||
|
||||
@@ -208,9 +208,9 @@ namespace SourceMod
|
||||
|
||||
/**
|
||||
* @brief Adds a function to the call list.
|
||||
* NOTE: Cannot be used during an incompleted call.
|
||||
* NOTE: Cannot be used during an incomplete call.
|
||||
* NOTE: If used during a call, function is temporarily queued until calls are over.
|
||||
* NOTE: Adding mulitple copies of the same function is illegal.
|
||||
* NOTE: Adding multiple copies of the same function is illegal.
|
||||
*
|
||||
* @param func Function to add.
|
||||
* @return True on success, otherwise false.
|
||||
@@ -219,7 +219,7 @@ namespace SourceMod
|
||||
|
||||
/**
|
||||
* @brief Adds a function to the call list.
|
||||
* NOTE: Cannot be used during an incompleted call.
|
||||
* NOTE: Cannot be used during an incomplete call.
|
||||
* NOTE: If used during a call, function is temporarily queued until calls are over.
|
||||
*
|
||||
* @param ctx Context to use as a look-up.
|
||||
|
||||
@@ -176,7 +176,7 @@ namespace SourceMod
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Called when a client has recieved authorization.
|
||||
* @brief Called when a client has received authorization.
|
||||
*
|
||||
* @param client Index of the client.
|
||||
* @param authstring Authorization string.
|
||||
|
||||
+11
-11
@@ -20,7 +20,7 @@
|
||||
|
||||
/**
|
||||
* @file ISourceMod.h
|
||||
* @brief Defines miscellanious helper functions useful to extensions.
|
||||
* @brief Defines miscellaneous helper functions useful to extensions.
|
||||
*/
|
||||
|
||||
#include <IHandleSys.h>
|
||||
@@ -64,11 +64,11 @@ namespace SourceMod
|
||||
}
|
||||
public:
|
||||
/**
|
||||
* @brief Returns the full path to the mod directory.
|
||||
* @brief Returns the full path to the game directory.
|
||||
*
|
||||
* @return A string containing the full mod path.
|
||||
* @return A string containing the full game path.
|
||||
*/
|
||||
virtual const char *GetModPath() const =0;
|
||||
virtual const char *GetGamePath() const =0;
|
||||
|
||||
/**
|
||||
* @brief Returns the full path to the SourceMod directory.
|
||||
@@ -111,7 +111,7 @@ namespace SourceMod
|
||||
* @brief Formats a string from a native.
|
||||
*
|
||||
* @param buffer Buffer to store message.
|
||||
* @param maxlength Maximum length of buffer (inculding null terminator).
|
||||
* @param maxlength Maximum length of buffer (including null terminator).
|
||||
* @param pContext Pointer to the plugin's context.
|
||||
* @param params Parameter array that was passed to the native.
|
||||
* @param param Parameter index where format string and variable arguments begin.
|
||||
@@ -141,12 +141,12 @@ namespace SourceMod
|
||||
/**
|
||||
* @brief Returns the automated data pack handle type.
|
||||
*
|
||||
* The readonly data type is the parent of the writable type.
|
||||
* The read-only data type is the parent of the writable type.
|
||||
* Note that calling CloseHandle() on either type will release the data pack.
|
||||
* The readonly type is inheritable, but due to limitations of the Handle System,
|
||||
* The read-only type is inheritable, but due to limitations of the Handle System,
|
||||
* the writable type is not.
|
||||
*
|
||||
* @param readonly If true, the readonly type will be returned.
|
||||
* @param readonly If true, the read-only type will be returned.
|
||||
* @return The Handle type for storing generic data packs.
|
||||
*/
|
||||
virtual HandleType_t GetDataPackHandleType(bool readonly=false) =0;
|
||||
@@ -163,11 +163,11 @@ namespace SourceMod
|
||||
virtual KeyValues *ReadKeyValuesHandle(Handle_t hndl, HandleError *err=NULL, bool root=false) =0;
|
||||
|
||||
/**
|
||||
* @brief Returns the name of the directory in which the mod or game's gameinfo.txt resides.
|
||||
* @brief Returns the name of the game directory.
|
||||
*
|
||||
* @return A string containing the name of the mod directory.
|
||||
* @return A string containing the name of the game directory.
|
||||
*/
|
||||
virtual const char *GetModFolderName() const =0;
|
||||
virtual const char *GetGameFolderName() const =0;
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ namespace SourceMod
|
||||
* Where KEY is an IDENTIFIER and VALUE is a STRING.
|
||||
*
|
||||
* WHITESPACE should always be omitted.
|
||||
* COMMENTS should be stripped, and are defined as text occuring in:
|
||||
* COMMENTS should be stripped, and are defined as text occurring in:
|
||||
* ;<TEXT>
|
||||
*
|
||||
* Example file below. Note that
|
||||
@@ -161,7 +161,7 @@ namespace SourceMod
|
||||
* For an example, see configs/permissions.cfg
|
||||
*
|
||||
* WHITESPACE should be ignored.
|
||||
* Comments are text occuring inside the following tokens, and should be stripped
|
||||
* Comments are text occurring inside the following tokens, and should be stripped
|
||||
* unless they are inside literal strings:
|
||||
* ;<TEXT>
|
||||
* //<TEXT>
|
||||
@@ -308,7 +308,7 @@ namespace SourceMod
|
||||
* @param ini_listener Event handler for reading file.
|
||||
* @param line If non-NULL, will contain last line parsed (0 if file could not be opened).
|
||||
* @param col If non-NULL, will contain last column parsed (undefined if file could not be opened).
|
||||
* @return True if parsing succeded, false if file couldn't be opened or there was a syntax error.
|
||||
* @return True if parsing succeeded, false if file couldn't be opened or there was a syntax error.
|
||||
*/
|
||||
virtual bool ParseFile_INI(const char *file,
|
||||
ITextListener_INI *ini_listener,
|
||||
@@ -333,7 +333,7 @@ namespace SourceMod
|
||||
unsigned int *col) =0;
|
||||
|
||||
/**
|
||||
* @brief Converts an SMCParseError to a stirng.
|
||||
* @brief Converts an SMCParseError to a string.
|
||||
*
|
||||
* @param err SMCParseError.
|
||||
* @return String error message, or NULL if none.
|
||||
|
||||
@@ -45,7 +45,7 @@ typedef uint32_t funcid_t; /**< Function index code */
|
||||
#define SP_ERROR_INVALID_ADDRESS 5 /**< A memory address was not valid */
|
||||
#define SP_ERROR_NOT_FOUND 6 /**< The object in question was not found */
|
||||
#define SP_ERROR_INDEX 7 /**< Invalid index parameter */
|
||||
#define SP_ERROR_STACKLOW 8 /**< Nnot enough space left on the stack */
|
||||
#define SP_ERROR_STACKLOW 8 /**< Not enough space left on the stack */
|
||||
#define SP_ERROR_NOTDEBUGGING 9 /**< Debug mode was not on or debug section not found */
|
||||
#define SP_ERROR_INVALID_INSTRUCTION 10 /**< Invalid instruction was encountered */
|
||||
#define SP_ERROR_MEMACCESS 11 /**< Invalid memory access */
|
||||
@@ -220,7 +220,7 @@ typedef sp_fdbg_arraydim_t sp_debug_arraydim_t;
|
||||
typedef struct sp_debug_symbol_s
|
||||
{
|
||||
uint32_t codestart; /**< Relocated code address */
|
||||
uint32_t codeend; /**< relocated code end address */
|
||||
uint32_t codeend; /**< Relocated code end address */
|
||||
const char * name; /**< Relocated name */
|
||||
sp_debug_arraydim_t *dims; /**< Relocated dimension struct, if any */
|
||||
sp_fdbg_symbol_t *sym; /**< Pointer to original symbol */
|
||||
|
||||
Reference in New Issue
Block a user