UNLOZE/sourcemod
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Correct spelling in API documentation.

Browse Source
This commit is contained in:
Asher Baker 2015-10-30 12:26:34 +00:00
parent 9bbcae1648
commit 4346e963e5
26 changed files with 59 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
plugins/include/admin.inc
View File

@ -662,7 +662,7 @@ native bool FindFlagByName(const char[] name, AdminFlag &flag);
native bool FindFlagByChar(int c, AdminFlag &flag);
/**
* Finds a flag char by a gived admin flag.
* Finds the flag char for a given admin flag.
*
* @param flag Flag to look up.
* @param c Variable to store flag char.

12
plugins/include/adt_array.inc
View File

@ -62,7 +62,7 @@ methodmap ArrayList < Handle {
// hold. For example, 32 cells is equivalent to:
// new Array[X][32]
// @param startsize Initial size of the array. Note that data will
// NOT be auto-intialized.
// NOT be auto-initialized.
// @return New Handle to the array object.
public native ArrayList(int blocksize=1, int startsize=0);
@ -191,14 +191,14 @@ methodmap ArrayList < Handle {
// @error Invalid index.
public native void SwapAt(int index1, int index2);
// Returns the index for the first occurance of the provided string. If
// Returns the index for the first occurrence of the provided string. If
// the string cannot be located, -1 will be returned.
//
// @param item String to search for
// @return Array index, or -1 on failure
public native int FindString(const char[] item);
// Returns the index for the first occurance of the provided value. If the
// Returns the index for the first occurrence of the provided value. If the
// value cannot be located, -1 will be returned.
//
// @param item Value to search for
@ -226,7 +226,7 @@ methodmap ArrayList < Handle {
* hold. For example, 32 cells is equivalent to:
* new Array[X][32]
* @param startsize Initial size of the array. Note that data will
* NOT be auto-intialized.
* NOT be auto-initialized.
* @return New Handle to the array object.
*/
native ArrayList CreateArray(int blocksize=1, int startsize=0);
@ -417,7 +417,7 @@ native void RemoveFromArray(Handle array, int index);
native void SwapArrayItems(Handle array, int index1, int index2);
/**
* Returns the index for the first occurance of the provided string. If the string
* Returns the index for the first occurrence of the provided string. If the string
* cannot be located, -1 will be returned.
*
* @param array Array Handle.
@ -428,7 +428,7 @@ native void SwapArrayItems(Handle array, int index1, int index2);
native int FindStringInArray(Handle array, const char[] item);
/**
* Returns the index for the first occurance of the provided value. If the value
* Returns the index for the first occurrence of the provided value. If the value
* cannot be located, -1 will be returned.
*
* @param array Array Handle.

6
plugins/include/clients.inc
View File

@ -197,7 +197,7 @@ forward void OnClientAuthorized(client, const String:auth[]);
* Note: If handled/blocked, PostAdminCheck must be signalled
* manually via NotifyPostAdminCheck().
*
* This callback is gauranteed to occur on all clients, and always
* This callback is guaranteed to occur on all clients, and always
* after each OnClientPutInServer() call.
*
* @param client Client index.
@ -226,7 +226,7 @@ forward void OnClientPostAdminFilter(client);
* Called once a client is authorized and fully in-game, and
* after all post-connection authorizations have been performed.
*
* This callback is gauranteed to occur on all clients, and always
* This callback is guaranteed to occur on all clients, and always
* after each OnClientPutInServer() call.
*
* @param client Client index.
@ -420,7 +420,7 @@ native bool:IsClientReplay(client);
* Returns if a certain player is an observer/spectator.
*
* @param client Player index.
* @return True if player is an obverser, false otherwise.
* @return True if player is an observer, false otherwise.
*/
native bool:IsClientObserver(client);

2
plugins/include/console.inc
View File

@ -87,7 +87,7 @@ enum ReplySource
#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_SS_ADDED (1<<18) // This is one of the "added" FCVAR_SS variables for the splitscreen players (L4D+)
#define FCVAR_RELEASE (1<<19) // Cvars tagged with this are the only cvars avaliable to customers (L4D+)
#define FCVAR_RELEASE (1<<19) // Cvars tagged with this are the only cvars available to customers (L4D+)
#define FCVAR_RELOAD_MATERIALS (1<<20) // If this cvar changes, it forces a material reload (OB+)
#define FCVAR_RELOAD_TEXTURES (1<<21) // If this cvar changes, if forces a texture reload (OB+)
#define FCVAR_NOT_CONNECTED (1<<22) // Cvar cannot be changed by a client that is connected to a server.

2
plugins/include/core.inc
View File

@ -114,7 +114,7 @@ enum PluginInfo
PlInfo_Name, /**< Plugin name */
PlInfo_Author, /**< Plugin author */
PlInfo_Description, /**< Plugin description */
PlInfo_Version, /**< Plugin verison */
PlInfo_Version, /**< Plugin version */
PlInfo_URL, /**< Plugin URL */
};

6
plugins/include/dbi.inc
View File

@ -388,7 +388,7 @@ methodmap Database < Handle
//
// The database handle returned through the callback is always a new Handle,
// and if necessary, IsSameConnection() should be used to test against other
// conenctions.
// connections.
//
// The result handle returned through the callback is temporary and destroyed
// at the end of the callback.
@ -448,7 +448,7 @@ stock Database SQL_DefConnect(char[] error, int maxlength, bool persistent=true)
* Connects to a database using key value pairs containing the database info.
* The key/value pairs should match what would be in databases.cfg.
*
* I.e. "driver" should be "default" or a driver name (or ommitted for
* I.e. "driver" should be "default" or a driver name (or omitted for
* the default). For SQLite, only the "database" parameter is needed in addition.
* For drivers which require external connections, more of the parameters may be
* needed.
@ -989,7 +989,7 @@ native void SQL_TConnect(SQLTCallback callback, const char[] name="default", any
*
* The database Handle returned through the callback is always a new Handle,
* and if necessary, SQL_IsSameConnection() should be used to test against
* other conenctions.
* other connections.
*
* The query Handle returned through the callback is temporary and destroyed
* at the end of the callback. If you need to hold onto it, use CloneHandle().

4
plugins/include/entity.inc
View File

@ -168,7 +168,7 @@ native bool:GetEdictClassname(edict, String:clsname[], maxlength);
*
* @param edict Index of the entity.
* @param clsname Buffer to store the serverclass name.
* @param maxlength Maximum lnegth of the buffer.
* @param maxlength Maximum length of the buffer.
* @return True on success, false if the edict is not networkable.
* @error Invalid edict index.
*/
@ -192,7 +192,7 @@ native bool:GetEntityNetClass(edict, String:clsname[], maxlength);
* below 32768. Offsets out of these bounds will throw an error. However,
* this does not represent any real range, it is simply a sanity check for
* illegal values. Any range outside of the CBaseEntity structure's private
* size will cause undefined behaviour or even crash.
* size will cause undefined behavior or even crash.
*/
/**

12
plugins/include/events.inc
View File

@ -88,7 +88,7 @@ methodmap Event < Handle
//
// @param key Name of event key.
// @param defValue Optional default value to use if the key is not found.
// @return The boolean value of the specfied event key.
// @return The boolean value of the specified event key.
public native bool GetBool(const char[] key, bool defValue=false);
// Sets the boolean value of a game event's key.
@ -101,7 +101,7 @@ methodmap Event < Handle
//
// @param key Name of event key.
// @param defValue Optional default value to use if the key is not found.
// @return The integer value of the specfied event key.
// @return The integer value of the specified event key.
public native int GetInt(const char[] key, int defValue=0);
// Sets the integer value of a game event's key.
@ -119,7 +119,7 @@ methodmap Event < Handle
//
// @param key Name of event key.
// @param defValue Optional default value to use if the key is not found.
// @return The floating point value of the specfied event key.
// @return The floating point value of the specified event key.
public native float GetFloat(const char[] key, float defValue=0.0);
// Sets the floating point value of a game event's key.
@ -231,7 +231,7 @@ native void CancelCreatedEvent(Handle event);
* @param event Handle to the event.
* @param key Name of event key.
* @param defValue Optional default value to use if the key is not found.
* @return The boolean value of the specfied event key.
* @return The boolean value of the specified event key.
* @error Invalid or corrupt Handle.
*/
native bool GetEventBool(Handle event, const char[] key, bool defValue=false);
@ -253,7 +253,7 @@ native void SetEventBool(Handle event, const char[] key, bool value);
* @param event Handle to the event.
* @param key Name of event key.
* @param defValue Optional default value to use if the key is not found.
* @return The integer value of the specfied event key.
* @return The integer value of the specified event key.
* @error Invalid or corrupt Handle.
*/
native int GetEventInt(Handle event, const char[] key, int defValue=0);
@ -280,7 +280,7 @@ native void SetEventInt(Handle event, const char[] key, int value);
* @param event Handle to the event.
* @param key Name of event key.
* @param defValue Optional default value to use if the key is not found.
* @return The floating point value of the specfied event key.
* @return The floating point value of the specified event key.
* @error Invalid or corrupt Handle.
*/
native float GetEventFloat(Handle event, const char[] key, float defValue=0.0);

2
plugins/include/files.inc
View File

@ -392,7 +392,7 @@ native bool WriteFile(Handle hndl, const int[] items, int num_items, int size);
/**
* Writes a binary string to a file.
*
* @param hndl Handle to th efile.
* @param hndl Handle to the file.
* @param buffer String to write.
* @param term True to append NUL terminator, false otherwise.
* @return True on success, false on error.

10
plugins/include/functions.inc
View File

@ -88,7 +88,7 @@ enum ExecType
#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 */
@ -164,7 +164,7 @@ native GetForwardFunctionCount(Handle:fwd);
/**
* Adds a function to a private forward's call list.
*
* @note Cannot be used during an incompleted call.
* @note Cannot be used during an incomplete call.
*
* @param fwd Handle to private forward.
* @param plugin Handle of the plugin that contains the function.
@ -206,7 +206,7 @@ native RemoveAllFromForward(Handle:fwd, Handle:plugin);
/**
* Starts a call to functions in a forward's call list.
*
* @note Cannot be used during an incompleted call.
* @note Cannot be used during an incomplete call.
*
* @param fwd Handle to global or private forward.
* @noreturn
@ -217,7 +217,7 @@ native Call_StartForward(Handle:fwd);
/**
* Starts a call to a function.
*
* @note Cannot be used during an incompleted call.
* @note Cannot be used during an incomplete call.
*
* @param plugin Handle of the plugin that contains the function.
* Pass INVALID_HANDLE to specify the calling plugin.
@ -363,7 +363,7 @@ typedef NativeCall = function int (Handle plugin, int numParams);
* Creates a dynamic native. This should only be called in AskPluginLoad(), or
* else you risk not having your native shared with other plugins.
*
* @param name Name of the dynamic native; must be unique amongst
* @param name Name of the dynamic native; must be unique among
* all other registered dynamic natives.
* @param func Function to use as the dynamic native.
* @noreturn

2
plugins/include/halflife.inc
View File

@ -53,7 +53,7 @@
#define MOTDPANEL_TYPE_TEXT 0 /**< Treat msg as plain text */
#define MOTDPANEL_TYPE_INDEX 1 /**< Msg is auto determined by the engine */
#define MOTDPANEL_TYPE_URL 2 /**< Treat msg as an URL link */
#define MOTDPANEL_TYPE_FILE 3 /**< Treat msg as a filename to be openned */
#define MOTDPANEL_TYPE_FILE 3 /**< Treat msg as a filename to be opened */
enum DialogType
{

2
plugins/include/keyvalues.inc
View File

@ -169,7 +169,7 @@ methodmap KeyValues < Handle
// @param a Alpha value, set by reference.
public native void GetColor(const char[] key, &r, &g, &b, &a);
// Retrives a set of color values from a KeyValues key.
// Retrieves a set of color values from a KeyValues key.
//
// @param key Name of the key, or NULL_STRING.
// @param color Red, green, blue, and alpha channels.

2
plugins/include/logging.inc
View File

@ -99,7 +99,7 @@ native LogError(const String:format[], any:...);
* @param client Client the action is from; 0 for server, -1 if not applicable.
* @param target Client the action is targetting, or -1 if not applicable.
* @param message Message that is being logged.
* @return Plugin_Continue will cause Core to defaulty log the message.
* @return Plugin_Continue will perform the default logging behavior.
* Plugin_Handled will stop Core from logging the message.
* Plugin_Stop is the same as Handled, but prevents any other
* plugins from handling the message.

6
plugins/include/mapchooser.inc
View File

@ -39,7 +39,7 @@ enum NominateResult
Nominate_Added, /** The map was added to the nominate list */
Nominate_Replaced, /** A clients existing nomination was replaced */
Nominate_AlreadyInVote, /** Specified map was already in the vote */
Nominate_InvalidMap, /** Mapname specifed wasn't a valid map */
Nominate_InvalidMap, /** Mapname specified wasn't a valid map */
Nominate_VoteFull, /** This will only occur if force was set to false */
};
@ -55,7 +55,7 @@ enum MapChange
*
* @param map Map to add.
* @param force Should we force the map in even if it requires overwriting an existing nomination?
* @param owner Client index of the nominater. If the client disconnects the nomination will be removed. Use 0 for constant nominations
* @param owner Client index of the nominator. If the client disconnects the nomination will be removed. Use 0 for constant nominations
* @return Nominate Result of the outcome
*/
native NominateResult NominateMap(const char[] map, bool force, int owner);
@ -71,7 +71,7 @@ native bool RemoveNominationByMap(const char[] map);
/**
* Attempt to remove a map from the mapchooser map list.
*
* @param owner Client index of the nominater.
* @param owner Client index of the nominator.
* @return True if the nomination was found and removed, or false if the nomination was not found.
*/
native bool RemoveNominationByOwner(int owner);

2
plugins/include/menus.inc
View File

@ -379,7 +379,7 @@ methodmap Menu < Handle
// Get or set the menu's pagination.
//
// If pgination is MENU_NO_PAGINATION, and the exit button flag is set,
// If pagination is MENU_NO_PAGINATION, and the exit button flag is set,
// then the exit button flag is removed. It can be re-applied if desired.
property int Pagination {
public native get();

2
plugins/include/sdktools_entinput.inc
View File

@ -38,7 +38,7 @@
/**
* Invokes a named input method on an entity.
*
* After completion (successful or not), the current global variant is re-initalized.
* After completion (successful or not), the current global variant is re-initialized.
*
* @param dest Destination entity index.
* @param input Input action.

2
plugins/include/sdktools_functions.inc
View File

@ -331,7 +331,7 @@ native ActivateEntity(entity);
/**
* Sets values to client info buffer keys and notifies the engine of the change.
* The change does not get propogated to mods until the next frame.
* The change does not get propagated to mods until the next frame.
*
* @param client Player's index.
* @param key Key string.

2
plugins/include/sdktools_hooks.inc
View File

@ -53,7 +53,7 @@
* @param mouse Mouse direction (x, y).
* @return Plugin_Handled to block the commands from being processed, Plugin_Continue otherwise.
*
* @note To see if all 11 params are avaliable, use FeatureType_Capability and
* @note To see if all 11 params are available, use FeatureType_Capability and
* FEATURECAP_PLAYERRUNCMD_11PARAMS.
*/
forward Action:OnPlayerRunCmd(client, &buttons, &impulse, Float:vel[3], Float:angles[3], &weapon, &subtype, &cmdnum, &tickcount, &seed, mouse[2]);

6
plugins/include/sdktools_sound.inc
View File

@ -92,7 +92,7 @@ enum
SNDLEVEL_RUSTLE = 20, /**< Rustling leaves */
SNDLEVEL_WHISPER = 25, /**< Whispering */
SNDLEVEL_LIBRARY = 30, /**< In a library */
SNDLEVEL_FRIDGE = 45, /**< Refridgerator */
SNDLEVEL_FRIDGE = 45, /**< Refrigerator */
SNDLEVEL_HOME = 50, /**< Average home (3.9 attn) */
SNDLEVEL_CONVO = 60, /**< Normal conversation (2.0 attn) */
SNDLEVEL_DRYER = 60, /**< Clothes dryer */
@ -268,7 +268,7 @@ native EmitSoundEntry(const clients[],
*
* @param clients Array of client indexes.
* @param numClients Number of clients in the array.
* @param sentence Sentence index (from PrecacheSenteFile).
* @param sentence Sentence index (from PrecacheSentenceFile).
* @param entity Entity to emit from.
* @param channel Channel to emit with.
* @param level Sound level.
@ -338,7 +338,7 @@ typedef AmbientSHook = function Action (
/**
* Called when a sound is going to be emitted to one or more clients.
* NOTICE: all params can be overwritten to modify the default behaviour.
* NOTICE: all params can be overwritten to modify the default behavior.
*
* @param clients Array of client indexes.
* @param numClients Number of clients in the array (modify this value if you add/remove elements from the client array).

10
plugins/include/sdktools_tempents_stocks.inc
View File

@ -182,7 +182,7 @@ stock TE_SetupEnergySplash(const Float:pos[3], const Float:dir[3], bool:Explosiv
* Sets up an armor ricochet effect.
*
* @param pos Position of the armor ricochet.
* @param dir Directon of the armor ricochet.
* @param dir Direction of the armor ricochet.
* @noreturn
*/
stock TE_SetupArmorRicochet(const Float:pos[3], const Float:dir[3])
@ -273,7 +273,7 @@ stock TE_SetupBloodSprite(const Float:pos[3], const Float:dir[3], const color[4]
* @param End_Radius Final ring radius.
* @param ModelIndex Precached model index.
* @param HaloIndex Precached model index.
* @param StartFrame Initital frame to render.
* @param StartFrame Initial frame to render.
* @param FrameRate Ring frame rate.
* @param Life Time duration of the ring.
* @param Width Beam width.
@ -314,7 +314,7 @@ stock TE_SetupBeamRingPoint(const Float:center[3], Float:Start_Radius, Float:End
* @param end End position of the beam.
* @param ModelIndex Precached model index.
* @param HaloIndex Precached model index.
* @param StartFrame Initital frame to render.
* @param StartFrame Initial frame to render.
* @param FrameRate Beam frame rate.
* @param Life Time duration of the beam.
* @param Width Initial beam width.
@ -354,7 +354,7 @@ stock TE_SetupBeamPoints(const Float:start[3], const Float:end[3], ModelIndex, H
* @param EndEntity Entity index from where the beam ends.
* @param ModelIndex Precached model index.
* @param HaloIndex Precached model index.
* @param StartFrame Initital frame to render.
* @param StartFrame Initial frame to render.
* @param FrameRate Beam frame rate.
* @param Life Time duration of the beam.
* @param Width Initial beam width.
@ -394,7 +394,7 @@ stock TE_SetupBeamLaser(StartEntity, EndEntity, ModelIndex, HaloIndex, StartFram
* @param EndEntity Entity index from where the ring ends.
* @param ModelIndex Precached model index.
* @param HaloIndex Precached model index.
* @param StartFrame Initital frame to render.
* @param StartFrame Initial frame to render.
* @param FrameRate Ring frame rate.
* @param Life Time duration of the ring.
* @param Width Beam width.

4
plugins/include/sdktools_trace.inc
View File

@ -71,7 +71,7 @@
* @endsection
*/
#define CONTENTS_ORIGIN 0x1000000 /**< removed before bsping an entity. */
#define CONTENTS_ORIGIN 0x1000000 /**< removed before bsp-ing an entity. */
#define CONTENTS_MONSTER 0x2000000 /**< should never be on a brush, only in game. */
#define CONTENTS_DEBRIS 0x4000000
#define CONTENTS_DETAIL 0x8000000 /**< brushes to be added after vis leafs. */
@ -356,7 +356,7 @@ native bool:TR_DidHit(Handle:hndl=INVALID_HANDLE);
native TR_GetHitGroup(Handle:hndl=INVALID_HANDLE);
/**
* Find the normal vector to the collison plane of a trace.
* Find the normal vector to the collision plane of a trace.
*
* @param hndl A trace Handle, or INVALID_HANDLE to use a global trace result.
* @param normal Vector buffer to store the vector normal to the collision plane

2
plugins/include/sorting.inc
View File

@ -169,7 +169,7 @@ typedef SortFuncADTArray = function int (int index1, int index2, Handle array, H
* Custom sorts an ADT Array. You must pass in a comparison function.
*
* @param array Array Handle to sort
* @param sortfunc Sort comparision function to use
* @param sortfunc Sort comparison function to use
* @param hndl Optional Handle to pass through the comparison calls.
* @noreturn
*/

5
plugins/include/sourcemod.inc
View File

@ -146,8 +146,7 @@ forward void OnPluginPauseChange(bool:pause);
/**
* Called before every server frame. Note that you should avoid
* doing expensive computations here, and you should declare large
* local arrays using 'decl' instead of 'new'.
* doing expensive computations or declaring large local arrays.
*/
forward void OnGameFrame();
@ -477,7 +476,7 @@ forward void OnLibraryRemoved(const String:name[]);
*
* Serial change numbers are used to identify if a map list has changed. Thus, if
* you pass a serial change number and it's equal to what SourceMod currently knows
* about the map list, then SourceMod won't reparse the file.
* about the map list, then SourceMod won't re-parse the file.
*
* If the maps end up being read from the maps folder (MAPLIST_FLAG_MAPSFOLDER), they
* are automatically sorted in alphabetical, ascending order.

8
plugins/include/string.inc
View File

@ -207,7 +207,7 @@ native IntToString(num, String:str[], maxlength);
/**
* Converts a string to a floating point number.
*
* @param str String to convert to a foat.
* @param str String to convert to a float.
* @return Floating point result, or 0.0 on error.
*/
native Float:StringToFloat(const String:str[]);
@ -215,7 +215,7 @@ native Float:StringToFloat(const String:str[]);
/**
* Converts a string to a floating point number with some more options.
*
* @param str String to convert to a foat.
* @param str String to convert to a float.
* @param result Variable to store result in.
* @return Number of characters consumed.
*/
@ -394,7 +394,7 @@ native bool:StripQuotes(String:text[]);
/**
* Returns an uppercase character to a lowercase character.
*
* @param chr Characer to convert.
* @param chr Character to convert.
* @return Lowercase character on success,
* no change on failure.
*/
@ -410,7 +410,7 @@ stock CharToUpper(chr)
/**
* Returns a lowercase character to an uppercase character.
*
* @param chr Characer to convert.
* @param chr Character to convert.
* @return Uppercase character on success,
* no change on failure.
*/

2
plugins/include/tf2.inc
View File

@ -410,7 +410,7 @@ native TF2_RemoveWearable(client, wearable);
/**
* Called after a condition is added to a player
*
* @param client Index of the client to which the conditon is being added.
* @param client Index of the client to which the condition is being added.
* @param condition Condition that is being added.
*/
forward void TF2_OnConditionAdded(client, TFCond:condition);

4
plugins/include/topmenus.inc
View File

@ -246,7 +246,7 @@ methodmap TopMenu < Handle
// INVALID_TOPMENUOBJECT on failure.
public native TopMenuObject FindCategory(const char[] name);
// Set the menu title caching behaviour of the TopMenu. By default titles
// Set the menu title caching behavior of the TopMenu. By default titles
// are cached to reduce overhead. If you need dynamic menu titles which
// change each time the menu is displayed to a user, set this to false.
property bool CacheTitles {
@ -390,7 +390,7 @@ native bool DisplayTopMenuCategory(Handle topmenu, TopMenuObject category, int c
native TopMenuObject FindTopMenuCategory(Handle topmenu, const char[] name);
/**
* Change the menu title caching behaviour of the TopMenu. By default the
* Change the menu title caching behavior of the TopMenu. By default the
* titles are cached to reduce overhead. If you need dynamic menu titles, which
* can change everytime the menu is displayed to a user, set this to false.
*