Numerous code documentation fixups (bug 5720, r=psychonic).
1.1 --- a/plugins/include/admin.inc Wed Jul 31 22:57:50 2013 -0400
1.2 +++ b/plugins/include/admin.inc Thu Aug 01 09:26:34 2013 -0400
1.3 @@ -138,7 +138,7 @@
1.4 */
1.5 enum GroupId
1.6 {
1.7 - INVALID_GROUP_ID = -1, /**< An invalid/nonexistant group */
1.8 + INVALID_GROUP_ID = -1, /**< An invalid/non-existent group */
1.9 };
1.10
1.11 /**
1.12 @@ -146,7 +146,7 @@
1.13 */
1.14 enum AdminId
1.15 {
1.16 - INVALID_ADMIN_ID = -1, /**< An invalid/nonexistant admin */
1.17 + INVALID_ADMIN_ID = -1, /**< An invalid/non-existent admin */
1.18 };
1.19
1.20 /**
1.21 @@ -169,7 +169,7 @@
1.22 };
1.23
1.24 /**
1.25 - * Called when part of the cache which needs to be rebuilt.
1.26 + * Called when part of the cache needs to be rebuilt.
1.27 *
1.28 * @param part Part of the admin cache to rebuild.
1.29 */
1.30 @@ -324,7 +324,7 @@
1.31 * Registers an authentication identity type. You normally never need to call this except for
1.32 * very specific systems.
1.33 *
1.34 - * @param codename Codename to use for your authentication type.
1.35 + * @param name Codename to use for your authentication type.
1.36 * @noreturn
1.37 */
1.38 native RegisterAuthIdentType(const String:name[]);
1.39 @@ -425,7 +425,7 @@
1.40 * Sets a password on an admin.
1.41 *
1.42 * @param id AdminId index of the admin.
1.43 - * @param passwd String containing the password.
1.44 + * @param password String containing the password.
1.45 * @noreturn
1.46 */
1.47 native SetAdminPassword(AdminId:id, const String:password[]);
1.48 @@ -434,12 +434,12 @@
1.49 * Gets an admin's password.
1.50 *
1.51 * @param id AdminId index of the admin.
1.52 - * @param name Optional buffer to store the admin's password.
1.53 + * @param buffer Optional buffer to store the admin's password.
1.54 * @param maxlength Maximum size of the output name buffer.
1.55 * Note: This will safely chop UTF-8 strings.
1.56 * @return True if there was a password set, false otherwise.
1.57 */
1.58 -native bool:GetAdminPassword(AdminId:id, const String:buffer[]="", maxlength=0);
1.59 +native bool:GetAdminPassword(AdminId:id, String:buffer[]="", maxlength=0);
1.60
1.61 /**
1.62 * Attempts to find an admin by an auth method and an identity.
1.63 @@ -537,7 +537,7 @@
1.64 /**
1.65 * Tests whether one admin can target another.
1.66 *
1.67 - * The hueristics for this check are as follows:
1.68 + * The heuristics for this check are as follows:
1.69 * 0. If the targeting AdminId is INVALID_ADMIN_ID, targeting fails.
1.70 * 1. If the targeted AdminId is INVALID_ADMIN_ID, targeting succeeds.
1.71 * 2. If the targeted AdminId is the same as the targeting AdminId,
2.1 --- a/plugins/include/adt_array.inc Wed Jul 31 22:57:50 2013 -0400
2.2 +++ b/plugins/include/adt_array.inc Thu Aug 01 09:26:34 2013 -0400
2.3 @@ -210,14 +210,14 @@
2.4 * @return Number of characters copied.
2.5 * @error Invalid Handle or invalid index.
2.6 */
2.7 -native SetArrayString(Handle:array, index, const String:buffer[]);
2.8 +native SetArrayString(Handle:array, index, const String:value[]);
2.9
2.10 /**
2.11 * Sets an array of cells in an array.
2.12 *
2.13 * @param array Array Handle.
2.14 * @param index Index in the array.
2.15 - * @param buffer Array to copy.
2.16 + * @param values Array to copy.
2.17 * @param size If not set, assumes the buffer size is equal to the
2.18 * blocksize. Otherwise, the size passed is used.
2.19 * @return Number of cells copied.
3.1 --- a/plugins/include/adt_trie.inc Wed Jul 31 22:57:50 2013 -0400
3.2 +++ b/plugins/include/adt_trie.inc Thu Aug 01 09:26:34 2013 -0400
3.3 @@ -91,7 +91,7 @@
3.4 *
3.5 * @param trie Trie Handle.
3.6 * @param key Key string.
3.7 - * @param val Variable to store value.
3.8 + * @param value Variable to store value.
3.9 * @return True on success. False if the key is not set, or the key is set
3.10 * as an array or string (not a value).
3.11 * @error Invalid Handle.
4.1 --- a/plugins/include/clientprefs.inc Wed Jul 31 22:57:50 2013 -0400
4.2 +++ b/plugins/include/clientprefs.inc Thu Aug 01 09:26:34 2013 -0400
4.3 @@ -162,8 +162,8 @@
4.4 * Cookie Menu Callback prototype
4.5 *
4.6 * @param client Client index.
4.7 - * @param action CookeMenuAction being performed.
4.8 - * @param data Info data passed.
4.9 + * @param action CookieMenuAction being performed.
4.10 + * @param info Info data passed.
4.11 * @param buffer Outbut buffer.
4.12 * @param maxlen Max length of the output buffer.
4.13 */
4.14 @@ -221,7 +221,6 @@
4.15 * @param access Access level of the cookie.
4.16 * @param desc Cookie description buffer.
4.17 * @param descLen Cookie description buffer size.
4.18 - * @param
4.19 * @return True on success, false if there are no more commands.
4.20 */
4.21 native bool:ReadCookieIterator(Handle:iter,
5.1 --- a/plugins/include/clients.inc Wed Jul 31 22:57:50 2013 -0400
5.2 +++ b/plugins/include/clients.inc Thu Aug 01 09:26:34 2013 -0400
5.3 @@ -247,7 +247,7 @@
5.4 * Retrieves a client's IP address.
5.5 *
5.6 * @param client Player index.
5.7 - * @param name Buffer to store the client's ip address.
5.8 + * @param ip Buffer to store the client's ip address.
5.9 * @param maxlen Maximum length of string buffer (includes NULL terminator).
5.10 * @param remport Remove client's port from the ip string (true by default).
5.11 * @return True on success, false otherwise.
5.12 @@ -763,6 +763,7 @@
5.13 /**
5.14 * Returns the clients unique serial identifier.
5.15 *
5.16 + * @param client Client index.
5.17 * @return Serial number.
5.18 */
5.19 native GetClientSerial(client);
5.20 @@ -770,6 +771,7 @@
5.21 /**
5.22 * Returns the client index by its serial number.
5.23 *
5.24 + * @param serial Serial number.
5.25 * @return Client index, or 0 for invalid serial.
5.26 */
5.27 native GetClientFromSerial(serial);
6.1 --- a/plugins/include/console.inc Wed Jul 31 22:57:50 2013 -0400
6.2 +++ b/plugins/include/console.inc Thu Aug 01 09:26:34 2013 -0400
6.3 @@ -160,7 +160,7 @@
6.4 *
6.5 * @param client Index of the client.
6.6 * @param fmt Format of the client command.
6.7 - * @param ... Format parameters/
6.8 + * @param ... Format parameters
6.9 * @noreturn
6.10 * @error Invalid client index, or client not connected.
6.11 */
6.12 @@ -324,7 +324,7 @@
6.13 /**
6.14 * Called when a server-only command is invoked.
6.15 *
6.16 - * @params args Number of arguments that were in the argument string.
6.17 + * @param args Number of arguments that were in the argument string.
6.18 * @return An Action value. Not handling the command
6.19 * means that Source will report it as "not found."
6.20 */
6.21 @@ -358,7 +358,7 @@
6.22 * Creates a console command, or hooks an already existing one.
6.23 *
6.24 * Console commands are case sensitive. However, if the command already exists in the game,
6.25 - * the a client may enter the command in any case. SourceMod corrects for this automatically,
6.26 + * a client may enter the command in any case. SourceMod corrects for this automatically,
6.27 * and you should only hook the "real" version of the command.
6.28 *
6.29 * @param cmd Name of the command to hook or create.
6.30 @@ -703,7 +703,7 @@
6.31 * Starts a query to retrieve the value of a client's console variable.
6.32 *
6.33 * @param client Player index.
6.34 - * @param name Name of client convar to query.
6.35 + * @param cvarName Name of client convar to query.
6.36 * @param callback A function to use as a callback when the query has finished.
6.37 * @param value Optional value to pass to the callback function.
6.38 * @return A cookie that uniquely identifies the query.
7.1 --- a/plugins/include/cstrike.inc Wed Jul 31 22:57:50 2013 -0400
7.2 +++ b/plugins/include/cstrike.inc Thu Aug 01 09:26:34 2013 -0400
7.3 @@ -47,26 +47,26 @@
7.4
7.5 enum CSRoundEndReason
7.6 {
7.7 - CSRoundEnd_TargetBombed = 0, // Target Successfully Bombed!
7.8 - CSRoundEnd_VIPEscaped, // The VIP has escaped!
7.9 - CSRoundEnd_VIPKilled, // VIP has been assassinated!
7.10 - CSRoundEnd_TerroristsEscaped, // The terrorists have escaped!
7.11 - CSRoundEnd_CTStoppedEscape, // The CTs have prevented most of the terrorists from escaping!
7.12 - CSRoundEnd_TerroristsStopped, // Escaping terrorists have all been neutralized!
7.13 - CSRoundEnd_BombDefused, // The bomb has been defused!
7.14 - CSRoundEnd_CTWin, // Counter-Terrorists Win!
7.15 - CSRoundEnd_TerroristWin, // Terrorists Win!
7.16 - CSRoundEnd_Draw, // Round Draw!
7.17 - CSRoundEnd_HostagesRescued, // All Hostages have been rescued!
7.18 - CSRoundEnd_TargetSaved, // Target has been saved!
7.19 - CSRoundEnd_HostagesNotRescued, // Hostages have not been rescued!
7.20 - CSRoundEnd_TerroristsNotEscaped, // Terrorists have not escaped!
7.21 - CSRoundEnd_VIPNotEscaped, // VIP has not escaped!
7.22 - CSRoundEnd_GameStart, // Game Commencing!
7.23 + CSRoundEnd_TargetBombed = 0, /**< Target Successfully Bombed! */
7.24 + CSRoundEnd_VIPEscaped, /**< The VIP has escaped! */
7.25 + CSRoundEnd_VIPKilled, /**< VIP has been assassinated! */
7.26 + CSRoundEnd_TerroristsEscaped, /**< The terrorists have escaped! */
7.27 + CSRoundEnd_CTStoppedEscape, /**< The CTs have prevented most of the terrorists from escaping! */
7.28 + CSRoundEnd_TerroristsStopped, /**< Escaping terrorists have all been neutralized! */
7.29 + CSRoundEnd_BombDefused, /**< The bomb has been defused! */
7.30 + CSRoundEnd_CTWin, /**< Counter-Terrorists Win! */
7.31 + CSRoundEnd_TerroristWin, /**< Terrorists Win! */
7.32 + CSRoundEnd_Draw, /**< Round Draw! */
7.33 + CSRoundEnd_HostagesRescued, /**< All Hostages have been rescued! */
7.34 + CSRoundEnd_TargetSaved, /**< Target has been saved! */
7.35 + CSRoundEnd_HostagesNotRescued, /**< Hostages have not been rescued! */
7.36 + CSRoundEnd_TerroristsNotEscaped, /**< Terrorists have not escaped! */
7.37 + CSRoundEnd_VIPNotEscaped, /**< VIP has not escaped! */
7.38 + CSRoundEnd_GameStart, /**< Game Commencing! */
7.39
7.40 // The below only exist on CS:GO
7.41 - CSRoundEnd_TerroristsSurrender, // Terrorists Surrender
7.42 - CSRoundEnd_CTSurrender, // CTs Surrender
7.43 + CSRoundEnd_TerroristsSurrender, /**< Terrorists Surrender */
7.44 + CSRoundEnd_CTSurrender, /**< CTs Surrender */
7.45 };
7.46
7.47 enum CSWeaponID
7.48 @@ -144,7 +144,7 @@
7.49 * higher action to deny.
7.50 *
7.51 * @param client Client index
7.52 - * @param weapon Weapon index
7.53 + * @param weaponIndex Weapon index
7.54 */
7.55 forward Action:CS_OnCSWeaponDrop(client, weaponIndex);
7.56
8.1 --- a/plugins/include/dbi.inc Wed Jul 31 22:57:50 2013 -0400
8.2 +++ b/plugins/include/dbi.inc Thu Aug 01 09:26:34 2013 -0400
8.3 @@ -137,6 +137,8 @@
8.4 * @param keyvalues Key/value pairs from a KeyValues handle, describing the connection.
8.5 * @param error Error buffer.
8.6 * @param maxlength Maximum length of the error buffer.
8.7 + * @param persistent True to re-use a previous persistent connection if
8.8 + * possible, false otherwise.
8.9 * @return A database connection Handle, or INVALID_HANDLE on failure.
8.10 * On failure the error buffer will be filled with a message.
8.11 * @error Invalid KeyValues handle.
8.12 @@ -304,7 +306,7 @@
8.13 * encloses the string in ''. While drivers tend to allow " instead, the string
8.14 * may be not be escaped (for example, on SQLite)!
8.15 *
8.16 - * @param hndl A database Handle.
8.17 + * @param database A database Handle.
8.18 * @param string String to quote.
8.19 * @param buffer Buffer to store quoted string in.
8.20 * @param maxlength Maximum length of the buffer.
8.21 @@ -569,7 +571,7 @@
8.22 *
8.23 * @param statement A statement (prepared query) Handle.
8.24 * @param param The parameter index (starting from 0).
8.25 - * @param float The float number to bind.
8.26 + * @param value The float number to bind.
8.27 * @noreturn
8.28 * @error Invalid statement Handle or parameter index, or
8.29 * SQL error.
8.30 @@ -633,7 +635,7 @@
8.31 /**
8.32 * General callback for threaded SQL stuff.
8.33 *
8.34 - * @param db Parent object of the Handle (or INVALID_HANDLE if none).
8.35 + * @param owner Parent object of the Handle (or INVALID_HANDLE if none).
8.36 * @param hndl Handle to the child object (or INVALID_HANDLE if none).
8.37 * @param error Error string if there was an error. The error could be
8.38 * empty even if an error condition exists, so it is important
8.39 @@ -666,6 +668,7 @@
8.40 * @param callback Callback; new Handle will be in hndl, owner is the driver.
8.41 * If no driver was found, the owner is INVALID_HANDLE.
8.42 * @param name Database name.
8.43 + * @param data Extra data value to pass to the callback.
8.44 * @noreturn
8.45 */
8.46 native SQL_TConnect(SQLTCallback:callback, const String:name[]="default", any:data=0);
9.1 --- a/plugins/include/entity.inc Wed Jul 31 22:57:50 2013 -0400
9.2 +++ b/plugins/include/entity.inc Thu Aug 01 09:26:34 2013 -0400
9.3 @@ -226,6 +226,7 @@
9.4 *
9.5 * @param entity Edict index.
9.6 * @param offset Offset to use.
9.7 + * @param value Value to set.
9.8 * @param size Number of bytes to write (valid values are 1, 2, or 4).
9.9 * @param changeState If true, change will be sent over the network.
9.10 * @return Value at the given memory location.
9.11 @@ -251,6 +252,7 @@
9.12 *
9.13 * @param entity Edict index.
9.14 * @param offset Offset to use.
9.15 + * @param value Value to set.
9.16 * @param changeState If true, change will be sent over the network.
9.17 * @return Value at the given memory location.
9.18 * @error Invalid entity or offset out of reasonable bounds.
9.19 @@ -281,7 +283,7 @@
9.20 * reasons explained in the notes.
9.21 *
9.22 * Note: This function uses 0 as an indicator to unset data, but
9.23 - * 0 is also the world entity index. Thus, the a property cannot
9.24 + * 0 is also the world entity index. Thus, a property cannot
9.25 * be set to the world entity using this native.
9.26 *
9.27 * @param entity Edict index.
9.28 @@ -705,7 +707,7 @@
9.29 * This is like GetEdictClassname(), except it works for ALL
9.30 * entities, not just edicts.
9.31 *
9.32 - * @param edict Index of the entity.
9.33 + * @param entity Index of the entity.
9.34 * @param clsname Buffer to store the classname.
9.35 * @param maxlength Maximum length of the buffer.
9.36 * @return True on success, false if there is no classname set.
10.1 --- a/plugins/include/entity_prop_stocks.inc Wed Jul 31 22:57:50 2013 -0400
10.2 +++ b/plugins/include/entity_prop_stocks.inc Thu Aug 01 09:26:34 2013 -0400
10.3 @@ -113,56 +113,56 @@
10.4 #define IN_RELOAD (1 << 13)
10.5 #define IN_ALT1 (1 << 14)
10.6 #define IN_ALT2 (1 << 15)
10.7 -#define IN_SCORE (1 << 16) // Used by client.dll for when scoreboard is held down
10.8 -#define IN_SPEED (1 << 17) // Player is holding the speed key
10.9 -#define IN_WALK (1 << 18) // Player holding walk key
10.10 -#define IN_ZOOM (1 << 19) // Zoom key for HUD zoom
10.11 -#define IN_WEAPON1 (1 << 20) // weapon defines these bits
10.12 -#define IN_WEAPON2 (1 << 21) // weapon defines these bits
10.13 +#define IN_SCORE (1 << 16) /**< Used by client.dll for when scoreboard is held down */
10.14 +#define IN_SPEED (1 << 17) /**< Player is holding the speed key */
10.15 +#define IN_WALK (1 << 18) /**< Player holding walk key */
10.16 +#define IN_ZOOM (1 << 19) /**< Zoom key for HUD zoom */
10.17 +#define IN_WEAPON1 (1 << 20) /**< weapon defines these bits */
10.18 +#define IN_WEAPON2 (1 << 21) /**< weapon defines these bits */
10.19 #define IN_BULLRUSH (1 << 22)
10.20 -#define IN_GRENADE1 (1 << 23) // grenade 1
10.21 -#define IN_GRENADE2 (1 << 24) // grenade 2
10.22 +#define IN_GRENADE1 (1 << 23) /**< grenade 1 */
10.23 +#define IN_GRENADE2 (1 << 24) /**< grenade 2 */
10.24 #define IN_ATTACK3 (1 << 25)
10.25
10.26 // Note: these are only for use with GetEntityFlags and SetEntityFlags
10.27 // and may not match the game's actual, internal m_fFlags values.
10.28 // PLAYER SPECIFIC FLAGS FIRST BECAUSE WE USE ONLY A FEW BITS OF NETWORK PRECISION
10.29 -#define FL_ONGROUND (1 << 0) // At rest / on the ground
10.30 -#define FL_DUCKING (1 << 1) // Player flag -- Player is fully crouched
10.31 -#define FL_WATERJUMP (1 << 2) // player jumping out of water
10.32 -#define FL_ONTRAIN (1 << 3) // Player is _controlling_ a train, so movement commands should be ignored on client during prediction.
10.33 -#define FL_INRAIN (1 << 4) // Indicates the entity is standing in rain
10.34 -#define FL_FROZEN (1 << 5) // Player is frozen for 3rd person camera
10.35 -#define FL_ATCONTROLS (1 << 6) // Player can't move, but keeps key inputs for controlling another entity
10.36 -#define FL_CLIENT (1 << 7) // Is a player
10.37 -#define FL_FAKECLIENT (1 << 8) // Fake client, simulated server side; don't send network messages to them
10.38 +#define FL_ONGROUND (1 << 0) /**< At rest / on the ground */
10.39 +#define FL_DUCKING (1 << 1) /**< Player flag -- Player is fully crouched */
10.40 +#define FL_WATERJUMP (1 << 2) /**< player jumping out of water */
10.41 +#define FL_ONTRAIN (1 << 3) /**< Player is _controlling_ a train, so movement commands should be ignored on client during prediction. */
10.42 +#define FL_INRAIN (1 << 4) /**< Indicates the entity is standing in rain */
10.43 +#define FL_FROZEN (1 << 5) /**< Player is frozen for 3rd person camera */
10.44 +#define FL_ATCONTROLS (1 << 6) /**< Player can't move, but keeps key inputs for controlling another entity */
10.45 +#define FL_CLIENT (1 << 7) /**< Is a player */
10.46 +#define FL_FAKECLIENT (1 << 8) /**< Fake client, simulated server side; don't send network messages to them */
10.47 // NOTE if you move things up, make sure to change this value
10.48 #define PLAYER_FLAG_BITS 9
10.49 // NON-PLAYER SPECIFIC (i.e., not used by GameMovement or the client .dll ) -- Can still be applied to players, though
10.50 -#define FL_INWATER (1 << 9) // In water
10.51 -#define FL_FLY (1 << 10) // Changes the SV_Movestep() behavior to not need to be on ground
10.52 -#define FL_SWIM (1 << 11) // Changes the SV_Movestep() behavior to not need to be on ground (but stay in water)
10.53 +#define FL_INWATER (1 << 9) /**< In water */
10.54 +#define FL_FLY (1 << 10) /**< Changes the SV_Movestep() behavior to not need to be on ground */
10.55 +#define FL_SWIM (1 << 11) /**< Changes the SV_Movestep() behavior to not need to be on ground (but stay in water) */
10.56 #define FL_CONVEYOR (1 << 12)
10.57 #define FL_NPC (1 << 13)
10.58 #define FL_GODMODE (1 << 14)
10.59 #define FL_NOTARGET (1 << 15)
10.60 -#define FL_AIMTARGET (1 << 16) // set if the crosshair needs to aim onto the entity
10.61 -#define FL_PARTIALGROUND (1 << 17) // not all corners are valid
10.62 -#define FL_STATICPROP (1 << 18) // Eetsa static prop!
10.63 -#define FL_GRAPHED (1 << 19) // worldgraph has this ent listed as something that blocks a connection
10.64 +#define FL_AIMTARGET (1 << 16) /**< set if the crosshair needs to aim onto the entity */
10.65 +#define FL_PARTIALGROUND (1 << 17) /**< not all corners are valid */
10.66 +#define FL_STATICPROP (1 << 18) /**< Eetsa static prop! */
10.67 +#define FL_GRAPHED (1 << 19) /**< worldgraph has this ent listed as something that blocks a connection */
10.68 #define FL_GRENADE (1 << 20)
10.69 -#define FL_STEPMOVEMENT (1 << 21) // Changes the SV_Movestep() behavior to not do any processing
10.70 -#define FL_DONTTOUCH (1 << 22) // Doesn't generate touch functions, generates Untouch() for anything it was touching when this flag was set
10.71 -#define FL_BASEVELOCITY (1 << 23) // Base velocity has been applied this frame (used to convert base velocity into momentum)
10.72 -#define FL_WORLDBRUSH (1 << 24) // Not moveable/removeable brush entity (really part of the world, but represented as an entity for transparency or something)
10.73 -#define FL_OBJECT (1 << 25) // Terrible name. This is an object that NPCs should see. Missiles, for example.
10.74 -#define FL_KILLME (1 << 26) // This entity is marked for death -- will be freed by game DLL
10.75 -#define FL_ONFIRE (1 << 27) // You know...
10.76 -#define FL_DISSOLVING (1 << 28) // We're dissolving!
10.77 -#define FL_TRANSRAGDOLL (1 << 29) // In the process of turning into a client side ragdoll.
10.78 -#define FL_UNBLOCKABLE_BY_PLAYER (1 << 30) // pusher that can't be blocked by the player
10.79 -#define FL_FREEZING (1 << 31) // We're becoming frozen!
10.80 -#define FL_EP2V_UNKNOWN1 (1 << 31) // Unknown
10.81 +#define FL_STEPMOVEMENT (1 << 21) /**< Changes the SV_Movestep() behavior to not do any processing */
10.82 +#define FL_DONTTOUCH (1 << 22) /**< Doesn't generate touch functions, generates Untouch() for anything it was touching when this flag was set */
10.83 +#define FL_BASEVELOCITY (1 << 23) /**< Base velocity has been applied this frame (used to convert base velocity into momentum) */
10.84 +#define FL_WORLDBRUSH (1 << 24) /**< Not moveable/removeable brush entity (really part of the world, but represented as an entity for transparency or something) */
10.85 +#define FL_OBJECT (1 << 25) /**< Terrible name. This is an object that NPCs should see. Missiles, for example. */
10.86 +#define FL_KILLME (1 << 26) /**< This entity is marked for death -- will be freed by game DLL */
10.87 +#define FL_ONFIRE (1 << 27) /**< You know... */
10.88 +#define FL_DISSOLVING (1 << 28) /**< We're dissolving! */
10.89 +#define FL_TRANSRAGDOLL (1 << 29) /**< In the process of turning into a client side ragdoll. */
10.90 +#define FL_UNBLOCKABLE_BY_PLAYER (1 << 30) /**< pusher that can't be blocked by the player */
10.91 +#define FL_FREEZING (1 << 31) /**< We're becoming frozen! */
10.92 +#define FL_EP2V_UNKNOWN1 (1 << 31) /**< Unknown */
10.93 // END entity flag #defines
10.94
10.95 /**
11.1 --- a/plugins/include/events.inc Wed Jul 31 22:57:50 2013 -0400
11.2 +++ b/plugins/include/events.inc Thu Aug 01 09:26:34 2013 -0400
11.3 @@ -235,7 +235,7 @@
11.4 * Retrieves the name of a game event.
11.5 *
11.6 * @param event Handle to the event.
11.7 - * @param value Buffer to store the name of the event.
11.8 + * @param name Buffer to store the name of the event.
11.9 * @param maxlength Maximum length of string buffer.
11.10 * @noreturn
11.11 * @error Invalid or corrupt Handle.
12.1 --- a/plugins/include/geoip.inc Wed Jul 31 22:57:50 2013 -0400
12.2 +++ b/plugins/include/geoip.inc Thu Aug 01 09:26:34 2013 -0400
12.3 @@ -63,8 +63,8 @@
12.4 * Gets the full country name. (max length of output string is 45)
12.5 *
12.6 * @param ip Ip to determine the country code.
12.7 - * @param ccode Destination string buffer to store the country name.
12.8 - * @param len Maximum length of output string buffer.
12.9 + * @param name Destination string buffer to store the country name.
12.10 + * @param maxlength Maximum length of output string buffer.
12.11 * @return True on success, false if no country found.
12.12 */
12.13 native bool:GeoipCountry(const String:ip[], String:name[], maxlength);
13.1 --- a/plugins/include/halflife.inc Wed Jul 31 22:57:50 2013 -0400
13.2 +++ b/plugins/include/halflife.inc Thu Aug 01 09:26:34 2013 -0400
13.3 @@ -126,7 +126,7 @@
13.4 /**
13.5 * Returns whether a map is valid or not.
13.6 *
13.7 - * @param Map name, excluding .bsp extension.
13.8 + * @param map Map name, excluding .bsp extension.
13.9 * @return True if valid, false otherwise.
13.10 */
13.11 native bool:IsMapValid(const String:map[]);
13.12 @@ -244,7 +244,7 @@
13.13 /**
13.14 * Returns if a given generic file is precached.
13.15 *
13.16 - * @param decal Name of the generic file to check.
13.17 + * @param generic Name of the generic file to check.
13.18 * @return True if precached, false otherwise.
13.19 */
13.20 native bool:IsGenericPrecached(const String:generic[]);
14.1 --- a/plugins/include/keyvalues.inc Wed Jul 31 22:57:50 2013 -0400
14.2 +++ b/plugins/include/keyvalues.inc Thu Aug 01 09:26:34 2013 -0400
14.3 @@ -60,7 +60,7 @@
14.4 * @param firstValue If firstKey is non-empty, specifies the first key's value.
14.5 * @return A Handle to a new KeyValues structure.
14.6 */
14.7 -native Handle:CreateKeyValues(const String:name[], const String:firstkey[]="", const String:firstValue[]="");
14.8 +native Handle:CreateKeyValues(const String:name[], const String:firstKey[]="", const String:firstValue[]="");
14.9
14.10 /**
14.11 * Sets a string value of a KeyValues key.
15.1 --- a/plugins/include/lang.inc Wed Jul 31 22:57:50 2013 -0400
15.2 +++ b/plugins/include/lang.inc Thu Aug 01 09:26:34 2013 -0400
15.3 @@ -41,7 +41,7 @@
15.4 * Loads a translation file for the plugin calling this native.
15.5 * If no extension is specified, .txt is assumed.
15.6 *
15.7 - * @param path Translation file.
15.8 + * @param file Translation file.
15.9 * @noreturn
15.10 */
15.11 native LoadTranslations(const String:file[]);
16.1 --- a/plugins/include/menus.inc Wed Jul 31 22:57:50 2013 -0400
16.2 +++ b/plugins/include/menus.inc Thu Aug 01 09:26:34 2013 -0400
16.3 @@ -345,6 +345,7 @@
16.4 * Creates a raw MenuPanel based off the menu's style.
16.5 * The Handle must be freed with CloseHandle().
16.6 *
16.7 + * @param menu Menu Handle.
16.8 * @return A new MenuPanel Handle.
16.9 * @error Invalid Handle.
16.10 */
16.11 @@ -600,7 +601,7 @@
16.12 * Creates a Menu from a MenuStyle. The Handle must be closed with
16.13 * CloseHandle().
16.14 *
16.15 - * @parma hStyle MenuStyle Handle, or INVALID_HANDLE to use the default style.
16.16 + * @param hStyle MenuStyle Handle, or INVALID_HANDLE to use the default style.
16.17 * @param handler Function which will receive menu actions.
16.18 * @param actions Optionally set which actions to receive. Select,
16.19 * Cancel, and End will always be received regardless
16.20 @@ -624,7 +625,7 @@
16.21 /**
16.22 * Cancels a menu on a client. This will only affect non-external menus.
16.23 *
16.24 - * @param hstyle MenuStyle Handle, or INVALID_HANDLE to use the default style.
16.25 + * @param hStyle MenuStyle Handle, or INVALID_HANDLE to use the default style.
16.26 * @param client Client index.
16.27 * @param autoIgnore If true, no menus can be re-drawn on the client during
16.28 * the cancellation process.
16.29 @@ -654,7 +655,7 @@
16.30 * Sets the panel's title.
16.31 *
16.32 * @param panel A MenuPanel Handle.
16.33 - * @param title Text to set as the title.
16.34 + * @param text Text to set as the title.
16.35 * @param onlyIfEmpty If true, the title will only be set if no title is set.
16.36 * @noreturn
16.37 * @error Invalid Handle.
16.38 @@ -701,6 +702,7 @@
16.39 * Sets the selectable key map of a panel. This is not supported by
16.40 * all styles (only by Radio, as of this writing).
16.41 *
16.42 + * @param panel A MenuPanel Handle.
16.43 * @param keys An integer where each bit N allows key
16.44 * N+1 to be selected. If no keys are selectable,
16.45 * then key 0 (bit 9) is automatically set.
17.1 --- a/plugins/include/protobuf.inc Wed Jul 31 22:57:50 2013 -0400
17.2 +++ b/plugins/include/protobuf.inc Thu Aug 01 09:26:34 2013 -0400
17.3 @@ -44,7 +44,7 @@
17.4 * @param field Field name.
17.5 * @param index Index into repeated field.
17.6 * @return Integer value read.
17.7 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.8 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.9 */
17.10 native PbReadInt(Handle:pb, const String:field[], index=PB_FIELD_NOT_REPEATED);
17.11
17.12 @@ -55,7 +55,7 @@
17.13 * @param field Field name.
17.14 * @param index Index into repeated field.
17.15 * @return Float value read.
17.16 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.17 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.18 */
17.19 native Float:PbReadFloat(Handle:pb, const String:field[], index=PB_FIELD_NOT_REPEATED);
17.20
17.21 @@ -66,7 +66,7 @@
17.22 * @param field Field name.
17.23 * @param index Index into repeated field.
17.24 * @return Boolean value read.
17.25 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.26 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.27 */
17.28 native bool:PbReadBool(Handle:pb, const String:field[], index=PB_FIELD_NOT_REPEATED);
17.29
17.30 @@ -79,7 +79,7 @@
17.31 * @param maxlength Maximum length of output string buffer.
17.32 * @param index Index into repeated field.
17.33 * @noreturn
17.34 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.35 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.36 */
17.37 native PbReadString(Handle:pb, const String:field[], String:buffer[], maxlength, index=PB_FIELD_NOT_REPEATED);
17.38
17.39 @@ -91,7 +91,7 @@
17.40 * @param buffer Destination color buffer.
17.41 * @param index Index into repeated field.
17.42 * @noreturn
17.43 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.44 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.45 */
17.46 native PbReadColor(Handle:pb, const String:field[], buffer[4], index=PB_FIELD_NOT_REPEATED);
17.47
17.48 @@ -103,7 +103,7 @@
17.49 * @param buffer Destination angle buffer.
17.50 * @param index Index into repeated field.
17.51 * @noreturn
17.52 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.53 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.54 */
17.55 native PbReadAngle(Handle:pb, const String:field[], Float:buffer[3], index=PB_FIELD_NOT_REPEATED);
17.56
17.57 @@ -115,7 +115,7 @@
17.58 * @param buffer Destination vector buffer.
17.59 * @param index Index into repeated field.
17.60 * @noreturn
17.61 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.62 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.63 */
17.64 native PbReadVector(Handle:pb, const String:field[], Float:buffer[3], index=PB_FIELD_NOT_REPEATED);
17.65
17.66 @@ -127,7 +127,7 @@
17.67 * @param buffer Destination vector buffer.
17.68 * @param index Index into repeated field.
17.69 * @noreturn
17.70 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.71 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.72 */
17.73 native PbReadVector2D(Handle:pb, const String:field[], Float:buffer[2], index=PB_FIELD_NOT_REPEATED);
17.74
17.75 @@ -137,7 +137,7 @@
17.76 * @param pb protobuf handle.
17.77 * @param field Field name.
17.78 * @return Number of elements in the field.
17.79 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.80 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.81 */
17.82 native PbGetRepeatedFieldCount(Handle:pb, const String:field[]);
17.83
17.84 @@ -149,7 +149,7 @@
17.85 * @param value Integer value to set.
17.86 * @param index Index into repeated field.
17.87 * @noreturn
17.88 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.89 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.90 */
17.91 native PbSetInt(Handle:pb, const String:field[], value, index=PB_FIELD_NOT_REPEATED);
17.92
17.93 @@ -161,7 +161,7 @@
17.94 * @param value Float value to set.
17.95 * @param index Index into repeated field.
17.96 * @noreturn
17.97 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.98 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.99 */
17.100 native PbSetFloat(Handle:pb, const String:field[], Float:value, index=PB_FIELD_NOT_REPEATED);
17.101
17.102 @@ -173,7 +173,7 @@
17.103 * @param value Boolean value to set.
17.104 * @param index Index into repeated field.
17.105 * @noreturn
17.106 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.107 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.108 */
17.109 native PbSetBool(Handle:pb, const String:field[], bool:value, index=PB_FIELD_NOT_REPEATED);
17.110
17.111 @@ -185,7 +185,7 @@
17.112 * @param value String value to set.
17.113 * @param index Index into repeated field.
17.114 * @noreturn
17.115 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.116 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.117 */
17.118 native PbSetString(Handle:pb, const String:field[], const String:value[], index=PB_FIELD_NOT_REPEATED);
17.119
17.120 @@ -194,10 +194,10 @@
17.121 *
17.122 * @param pb protobuf handle.
17.123 * @param field Field name.
17.124 - * @param value Color value to set.
17.125 + * @param color Color value to set.
17.126 * @param index Index into repeated field.
17.127 * @noreturn
17.128 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.129 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.130 */
17.131 native PbSetColor(Handle:pb, const String:field[], const color[4], index=PB_FIELD_NOT_REPEATED);
17.132
17.133 @@ -206,10 +206,10 @@
17.134 *
17.135 * @param pb protobuf handle.
17.136 * @param field Field name.
17.137 - * @param value Angle value to set.
17.138 + * @param angle Angle value to set.
17.139 * @param index Index into repeated field.
17.140 * @noreturn
17.141 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.142 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.143 */
17.144 native PbSetAngle(Handle:pb, const String:field[], const Float:angle[3], index=PB_FIELD_NOT_REPEATED);
17.145
17.146 @@ -218,10 +218,10 @@
17.147 *
17.148 * @param pb protobuf handle.
17.149 * @param field Field name.
17.150 - * @param value Vector value to set.
17.151 + * @param vec Vector value to set.
17.152 * @param index Index into repeated field.
17.153 * @noreturn
17.154 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.155 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.156 */
17.157 native PbSetVector(Handle:pb, const String:field[], const Float:vec[3], index=PB_FIELD_NOT_REPEATED);
17.158
17.159 @@ -230,10 +230,10 @@
17.160 *
17.161 * @param pb protobuf handle.
17.162 * @param field Field name.
17.163 - * @param value Vector value to set.
17.164 + * @param vec Vector value to set.
17.165 * @param index Index into repeated field.
17.166 * @noreturn
17.167 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.168 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.169 */
17.170 native PbSetVector2D(Handle:pb, const String:field[], const Float:vec[2], index=PB_FIELD_NOT_REPEATED);
17.171
17.172 @@ -244,7 +244,7 @@
17.173 * @param field Field name.
17.174 * @param value Integer value to add.
17.175 * @noreturn
17.176 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.177 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.178 */
17.179 native PbAddInt(Handle:pb, const String:field[], value);
17.180
17.181 @@ -255,7 +255,7 @@
17.182 * @param field Field name.
17.183 * @param value Float value to add.
17.184 * @noreturn
17.185 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.186 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.187 */
17.188 native PbAddFloat(Handle:pb, const String:field[], Float:value);
17.189
17.190 @@ -266,7 +266,7 @@
17.191 * @param field Field name.
17.192 * @param value Boolean value to add.
17.193 * @noreturn
17.194 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.195 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.196 */
17.197 native PbAddBool(Handle:pb, const String:field[], bool:value);
17.198
17.199 @@ -277,7 +277,7 @@
17.200 * @param field Field name.
17.201 * @param value String value to add.
17.202 * @noreturn
17.203 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.204 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.205 */
17.206 native PbAddString(Handle:pb, const String:field[], const String:value[]);
17.207
17.208 @@ -286,9 +286,9 @@
17.209 *
17.210 * @param pb protobuf handle.
17.211 * @param field Field name.
17.212 - * @param value Color value to add.
17.213 + * @param color Color value to add.
17.214 * @noreturn
17.215 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.216 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.217 */
17.218 native PbAddColor(Handle:pb, const String:field[], const color[4]);
17.219
17.220 @@ -297,9 +297,9 @@
17.221 *
17.222 * @param pb protobuf handle.
17.223 * @param field Field name.
17.224 - * @param value Angle value to add.
17.225 + * @param angle Angle value to add.
17.226 * @noreturn
17.227 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.228 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.229 */
17.230 native PbAddAngle(Handle:pb, const String:field[], const Float:angle[3]);
17.231
17.232 @@ -308,9 +308,9 @@
17.233 *
17.234 * @param pb protobuf handle.
17.235 * @param field Field name.
17.236 - * @param value Vector value to add.
17.237 + * @param vec Vector value to add.
17.238 * @noreturn
17.239 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.240 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.241 */
17.242 native PbAddVector(Handle:pb, const String:field[], const Float:vec[3]);
17.243
17.244 @@ -319,9 +319,9 @@
17.245 *
17.246 * @param pb protobuf handle.
17.247 * @param field Field name.
17.248 - * @param value Vector value to add.
17.249 + * @param vec Vector value to add.
17.250 * @noreturn
17.251 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.252 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.253 */
17.254 native PbAddVector2D(Handle:pb, const String:field[], const Float:vec[2]);
17.255
17.256 @@ -331,7 +331,7 @@
17.257 * @param pb protobuf handle.
17.258 * @param field Field name.
17.259 * @return protobuf handle to embedded message.
17.260 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.261 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.262 */
17.263 native Handle:PbReadMessage(Handle:pb, const String:field[]);
17.264
17.265 @@ -342,7 +342,7 @@
17.266 * @param field Field name.
17.267 * @param index Index in the repeated field.
17.268 * @return protobuf handle to embedded message.
17.269 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.270 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.271 */
17.272 native Handle:PbReadRepeatedMessage(Handle:pb, const String:field[], index);
17.273
17.274 @@ -352,6 +352,6 @@
17.275 * @param pb protobuf handle.
17.276 * @param field Field name.
17.277 * @return protobuf handle to added, embedded message.
17.278 - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type.
17.279 + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type.
17.280 */
17.281 native Handle:PbAddMessage(Handle:pb, const String:field[]);
18.1 --- a/plugins/include/regex.inc Wed Jul 31 22:57:50 2013 -0400
18.2 +++ b/plugins/include/regex.inc Thu Aug 01 09:26:34 2013 -0400
18.3 @@ -127,7 +127,7 @@
18.4 * @param regex The regex handle to extract data from.
18.5 * @param str_id The index of the expression to get - starts at 0, and ends at substrings - 1.
18.6 * @param buffer The buffer to set to the matching substring.
18.7 - * @param maxLen The maximum string length of the buffer.
18.8 + * @param maxlen The maximum string length of the buffer.
18.9 * @return True if a substring was found, False on fail/error
18.10 */
18.11 native bool:GetRegexSubString(Handle:regex, str_id, String:buffer[], maxlen);
19.1 --- a/plugins/include/sdkhooks.inc Wed Jul 31 22:57:50 2013 -0400
19.2 +++ b/plugins/include/sdkhooks.inc Thu Aug 01 09:26:34 2013 -0400
19.3 @@ -35,40 +35,40 @@
19.4
19.5 // this is obviously _not_ a robust check, but it will solve most conflict and is clean
19.6 #if !defined DMG_GENERIC
19.7 -#define DMG_GENERIC 0 // generic damage was done
19.8 -#define DMG_CRUSH (1 << 0) // crushed by falling or moving object.
19.9 - // NOTE: It's assumed crush damage is occurring as a result of physics collision, so no extra physics force is generated by crush damage.
19.10 - // DON'T use DMG_CRUSH when damaging entities unless it's the result of a physics collision. You probably want DMG_CLUB instead.
19.11 -#define DMG_BULLET (1 << 1) // shot
19.12 -#define DMG_SLASH (1 << 2) // cut, clawed, stabbed
19.13 -#define DMG_BURN (1 << 3) // heat burned
19.14 -#define DMG_VEHICLE (1 << 4) // hit by a vehicle
19.15 -#define DMG_FALL (1 << 5) // fell too far
19.16 -#define DMG_BLAST (1 << 6) // explosive blast damage
19.17 -#define DMG_CLUB (1 << 7) // crowbar, punch, headbutt
19.18 -#define DMG_SHOCK (1 << 8) // electric shock
19.19 -#define DMG_SONIC (1 << 9) // sound pulse shockwave
19.20 -#define DMG_ENERGYBEAM (1 << 10) // laser or other high energy beam
19.21 -#define DMG_PREVENT_PHYSICS_FORCE (1 << 11) // Prevent a physics force
19.22 -#define DMG_NEVERGIB (1 << 12) // with this bit OR'd in, no damage type will be able to gib victims upon death
19.23 -#define DMG_ALWAYSGIB (1 << 13) // with this bit OR'd in, any damage type can be made to gib victims upon death.
19.24 -#define DMG_DROWN (1 << 14) // Drowning
19.25 -#define DMG_PARALYZE (1 << 15) // slows affected creature down
19.26 -#define DMG_NERVEGAS (1 << 16) // nerve toxins, very bad
19.27 -#define DMG_POISON (1 << 17) // blood poisoning - heals over time like drowning damage
19.28 -#define DMG_RADIATION (1 << 18) // radiation exposure
19.29 -#define DMG_DROWNRECOVER (1 << 19) // drowning recovery
19.30 -#define DMG_ACID (1 << 20) // toxic chemicals or acid burns
19.31 -#define DMG_SLOWBURN (1 << 21) // in an oven
19.32 -#define DMG_REMOVENORAGDOLL (1 << 22) // with this bit OR'd in, no ragdoll will be created, and the target will be quietly removed.
19.33 - // use this to kill an entity that you've already got a server-side ragdoll for
19.34 -#define DMG_PHYSGUN (1 << 23) // Hit by manipulator. Usually doesn't do any damage.
19.35 -#define DMG_PLASMA (1 << 24) // Shot by Cremator
19.36 -#define DMG_AIRBOAT (1 << 25) // Hit by the airboat's gun
19.37 -#define DMG_DISSOLVE (1 << 26) // Dissolving!
19.38 -#define DMG_BLAST_SURFACE (1 << 27) // A blast on the surface of water that cannot harm things underwater
19.39 +#define DMG_GENERIC 0 /**< generic damage was done */
19.40 +#define DMG_CRUSH (1 << 0) /**< crushed by falling or moving object.
19.41 + NOTE: It's assumed crush damage is occurring as a result of physics collision, so no extra physics force is generated by crush damage.
19.42 + DON'T use DMG_CRUSH when damaging entities unless it's the result of a physics collision. You probably want DMG_CLUB instead. */
19.43 +#define DMG_BULLET (1 << 1) /**< shot */
19.44 +#define DMG_SLASH (1 << 2) /**< cut, clawed, stabbed */
19.45 +#define DMG_BURN (1 << 3) /**< heat burned */
19.46 +#define DMG_VEHICLE (1 << 4) /**< hit by a vehicle */
19.47 +#define DMG_FALL (1 << 5) /**< fell too far */
19.48 +#define DMG_BLAST (1 << 6) /**< explosive blast damage */
19.49 +#define DMG_CLUB (1 << 7) /**< crowbar, punch, headbutt */
19.50 +#define DMG_SHOCK (1 << 8) /**< electric shock */
19.51 +#define DMG_SONIC (1 << 9) /**< sound pulse shockwave */
19.52 +#define DMG_ENERGYBEAM (1 << 10) /**< laser or other high energy beam */
19.53 +#define DMG_PREVENT_PHYSICS_FORCE (1 << 11) /**< Prevent a physics force */
19.54 +#define DMG_NEVERGIB (1 << 12) /**< with this bit OR'd in, no damage type will be able to gib victims upon death */
19.55 +#define DMG_ALWAYSGIB (1 << 13) /**< with this bit OR'd in, any damage type can be made to gib victims upon death. */
19.56 +#define DMG_DROWN (1 << 14) /**< Drowning */
19.57 +#define DMG_PARALYZE (1 << 15) /**< slows affected creature down */
19.58 +#define DMG_NERVEGAS (1 << 16) /**< nerve toxins, very bad */
19.59 +#define DMG_POISON (1 << 17) /**< blood poisoning - heals over time like drowning damage */
19.60 +#define DMG_RADIATION (1 << 18) /**< radiation exposure */
19.61 +#define DMG_DROWNRECOVER (1 << 19) /**< drowning recovery */
19.62 +#define DMG_ACID (1 << 20) /**< toxic chemicals or acid burns */
19.63 +#define DMG_SLOWBURN (1 << 21) /**< in an oven */
19.64 +#define DMG_REMOVENORAGDOLL (1 << 22) /**< with this bit OR'd in, no ragdoll will be created, and the target will be quietly removed.
19.65 + use this to kill an entity that you've already got a server-side ragdoll for */
19.66 +#define DMG_PHYSGUN (1 << 23) /**< Hit by manipulator. Usually doesn't do any damage. */
19.67 +#define DMG_PLASMA (1 << 24) /**< Shot by Cremator */
19.68 +#define DMG_AIRBOAT (1 << 25) /**< Hit by the airboat's gun */
19.69 +#define DMG_DISSOLVE (1 << 26) /**< Dissolving! */
19.70 +#define DMG_BLAST_SURFACE (1 << 27) /**< A blast on the surface of water that cannot harm things underwater */
19.71 #define DMG_DIRECT (1 << 28)
19.72 -#define DMG_BUCKSHOT (1 << 29) // not quite a bullet. Little, rounder, different.
19.73 +#define DMG_BUCKSHOT (1 << 29) /**< not quite a bullet. Little, rounder, different. */
19.74 #endif
19.75
19.76 #if !defined DMG_CRIT
19.77 @@ -116,7 +116,7 @@
19.78 SDKHook_UsePost,
19.79 SDKHook_Reload,
19.80 SDKHook_ReloadPost,
19.81 - SDKHook_GetMaxHealth, // ep2v and later
19.82 + SDKHook_GetMaxHealth, /**< ep2v and later */
19.83 };
19.84
19.85 /*
20.1 --- a/plugins/include/sdktools_entinput.inc Wed Jul 31 22:57:50 2013 -0400
20.2 +++ b/plugins/include/sdktools_entinput.inc Thu Aug 01 09:26:34 2013 -0400
20.3 @@ -109,7 +109,7 @@
20.4 /**
20.5 * Sets an entity in the global variant object.
20.6 *
20.7 - * @param Entity index.
20.8 + * @param entity Entity index.
20.9 * @noreturn
20.10 * @error Invalid entity index.
20.11 */
21.1 --- a/plugins/include/sdktools_functions.inc Wed Jul 31 22:57:50 2013 -0400
21.2 +++ b/plugins/include/sdktools_functions.inc Thu Aug 01 09:26:34 2013 -0400
21.3 @@ -81,13 +81,13 @@
21.4 native IgniteEntity(entity, Float:time, bool:npc=false, Float:size=0.0, bool:level=false);
21.5
21.6 /**
21.7 - * Extinguishes a player that is on fire.
21.8 + * Extinguishes an entity that is on fire.
21.9 *
21.10 * @param entity Entity index.
21.11 * @noreturn
21.12 * @error Invalid entity or client not in game, or lack of mod support.
21.13 */
21.14 -native ExtinguishEntity(client);
21.15 +native ExtinguishEntity(entity);
21.16
21.17 /**
21.18 * Teleports an entity.
21.19 @@ -194,7 +194,7 @@
21.20 * @return True on success, false otherwise.
21.21 * @error Invalid entity index, or no mod support.
21.22 */
21.23 -native bool:DispatchKeyValueVector(entity, const String:keyName[], const Float:vector[3]);
21.24 +native bool:DispatchKeyValueVector(entity, const String:keyName[], const Float:vec[3]);
21.25
21.26 /**
21.27 * Returns the entity a client is aiming at.
21.28 @@ -293,7 +293,7 @@
21.29 * Equip's a player's weapon.
21.30 *
21.31 * @param client Client index.
21.32 - * @param item CBaseCombatWeapon entity index.
21.33 + * @param weapon CBaseCombatWeapon entity index.
21.34 * @noreturn
21.35 * @error Invalid client or entity, lack of mod support, or client not in
21.36 * game.
22.1 --- a/plugins/include/sdktools_gamerules.inc Wed Jul 31 22:57:50 2013 -0400
22.2 +++ b/plugins/include/sdktools_gamerules.inc Thu Aug 01 09:26:34 2013 -0400
22.3 @@ -93,6 +93,7 @@
22.4 * This value is auto-detected, and the size parameter is
22.5 * only used as a fallback in case detection fails.
22.6 * @param element Element # (starting from 0) if property is an array.
22.7 + * @param changeState If true, change will be sent over the network.
22.8 * @error Not supported.
22.9 * @noreturn
22.10 */
22.11 @@ -114,6 +115,7 @@
22.12 * @param prop Property name.
22.13 * @param value Value to set.
22.14 * @param element Element # (starting from 0) if property is an array.
22.15 + * @param changeState If true, change will be sent over the network.
22.16 * @noreturn
22.17 * @error Not supported.
22.18 */
22.19 @@ -137,6 +139,7 @@
22.20 * @param prop Property name.
22.21 * @param other Entity index to set, or -1 to unset.
22.22 * @param element Element # (starting from 0) if property is an array.
22.23 + * @param changeState If true, change will be sent over the network.
22.24 * @noreturn
22.25 * @error Not supported.
22.26 */
22.27 @@ -159,6 +162,7 @@
22.28 * @param prop Property name.
22.29 * @param vec Vector to set.
22.30 * @param element Element # (starting from 0) if property is an array.
22.31 + * @param changeState If true, change will be sent over the network.
22.32 * @noreturn
22.33 * @error Not supported.
22.34 */
22.35 @@ -180,6 +184,7 @@
22.36 *
22.37 * @param prop Property to use.
22.38 * @param buffer String to set.
22.39 + * @param changeState If true, change will be sent over the network.
22.40 * @return Number of non-null bytes written.
22.41 * @error Not supported.
22.42 */
23.1 --- a/plugins/include/sdktools_sound.inc Wed Jul 31 22:57:50 2013 -0400
23.2 +++ b/plugins/include/sdktools_sound.inc Thu Aug 01 09:26:34 2013 -0400
23.3 @@ -127,7 +127,7 @@
23.4 * @param name Sound file name relative to the "sounds" folder.
23.5 * @noreturn
23.6 */
23.7 -native PrefetchSound(const String:nane[]);
23.8 +native PrefetchSound(const String:name[]);
23.9
23.10 /**
23.11 * This function is not known to work, and may crash. You should
24.1 --- a/plugins/include/sdktools_stringtables.inc Wed Jul 31 22:57:50 2013 -0400
24.2 +++ b/plugins/include/sdktools_stringtables.inc Thu Aug 01 09:26:34 2013 -0400
24.3 @@ -86,7 +86,7 @@
24.4 * Searches for the index of a given string in a string table.
24.5 *
24.6 * @param tableidx A string table index.
24.7 - * @param string String to find.
24.8 + * @param str String to find.
24.9 * @return String index if found, INVALID_STRING_INDEX otherwise.
24.10 * @error Invalid string table index.
24.11 */
24.12 @@ -97,12 +97,12 @@
24.13 *
24.14 * @param tableidx A string table index.
24.15 * @param stringidx A string index.
24.16 - * @param name Buffer to store the string value.
24.17 + * @param str Buffer to store the string value.
24.18 * @param maxlength Maximum length of string buffer.
24.19 * @return Number of bytes written to the buffer (UTF-8 safe).
24.20 * @error Invalid string table index or string index.
24.21 */
24.22 -native ReadStringTable(tableidx, stringIdx, String:str[], maxlength);
24.23 +native ReadStringTable(tableidx, stringidx, String:str[], maxlength);
24.24
24.25 /**
24.26 * Returns the length of the user data associated with a given string index.
24.27 @@ -124,7 +124,7 @@
24.28 * @return Number of bytes written to the buffer (UTF-8 safe).
24.29 * @error Invalid string table index or string index.
24.30 */
24.31 -native GetStringTableData(tableidx, stringIdx, String:userdata[], maxlength);
24.32 +native GetStringTableData(tableidx, stringidx, String:userdata[], maxlength);
24.33
24.34 /**
24.35 * Sets the user data associated with a given string index.
24.36 @@ -136,13 +136,13 @@
24.37 * @return Number of bytes written to the buffer (UTF-8 safe).
24.38 * @error Invalid string table index or string index.
24.39 */
24.40 -native SetStringTableData(tableidx, stringIdx, const String:userdata[], length);
24.41 +native SetStringTableData(tableidx, stringidx, const String:userdata[], length);
24.42
24.43 /**
24.44 * Adds a string to a given string table.
24.45 *
24.46 * @param tableidx A string table index.
24.47 - * @param string String to add.
24.48 + * @param str String to add.
24.49 * @param userdata An optional user data string.
24.50 * @param length Length of user data string. This should include the null terminator.
24.51 * If set to -1, then user data will be not be altered if the specified string
25.1 --- a/plugins/include/sdktools_tempents_stocks.inc Wed Jul 31 22:57:50 2013 -0400
25.2 +++ b/plugins/include/sdktools_tempents_stocks.inc Thu Aug 01 09:26:34 2013 -0400
25.3 @@ -100,7 +100,7 @@
25.4 * @param pos Position of the smoke.
25.5 * @param Model Precached model index.
25.6 * @param Scale Scale of the smoke.
25.7 - * @param Framerate Frame rate of the smoke.
25.8 + * @param FrameRate Frame rate of the smoke.
25.9 * @noreturn
25.10 */
25.11 stock TE_SetupSmoke(const Float:pos[3], Model, Float:Scale, FrameRate)
25.12 @@ -278,7 +278,7 @@
25.13 * @param Life Time duration of the ring.
25.14 * @param Width Beam width.
25.15 * @param Amplitude Beam amplitude.
25.16 - * @param color Color array (r, g, b, a).
25.17 + * @param Color Color array (r, g, b, a).
25.18 * @param Speed Speed of the beam.
25.19 * @param Flags Beam flags.
25.20 * @noreturn
25.21 @@ -321,7 +321,7 @@
25.22 * @param EndWidth Final beam width.
25.23 * @param FadeLength Beam fade time duration.
25.24 * @param Amplitude Beam amplitude.
25.25 - * @param color Color array (r, g, b, a).
25.26 + * @param Color Color array (r, g, b, a).
25.27 * @param Speed Speed of the beam.
25.28 * @noreturn
25.29 */
25.30 @@ -361,7 +361,7 @@
25.31 * @param EndWidth Final beam width.
25.32 * @param FadeLength Beam fade time duration.
25.33 * @param Amplitude Beam amplitude.
25.34 - * @param color Color array (r, g, b, a).
25.35 + * @param Color Color array (r, g, b, a).
25.36 * @param Speed Speed of the beam.
25.37 * @noreturn
25.38 */
25.39 @@ -399,7 +399,7 @@
25.40 * @param Life Time duration of the ring.
25.41 * @param Width Beam width.
25.42 * @param Amplitude Beam amplitude.
25.43 - * @param color Color array (r, g, b, a).
25.44 + * @param Color Color array (r, g, b, a).
25.45 * @param Speed Speed of the beam.
25.46 * @param Flags Beam flags.
25.47 * @noreturn
25.48 @@ -436,7 +436,7 @@
25.49 * @param Width Initial beam width.
25.50 * @param EndWidth Final beam width.
25.51 * @param FadeLength Beam fade time duration.
25.52 - * @param color Color array (r, g, b, a).
25.53 + * @param Color Color array (r, g, b, a).
25.54 * @noreturn
25.55 */
25.56 stock TE_SetupBeamFollow(EntIndex, ModelIndex, HaloIndex, Float:Life, Float:Width, Float:EndWidth, FadeLength, const Color[4])
26.1 --- a/plugins/include/sdktools_voice.inc Wed Jul 31 22:57:50 2013 -0400
26.2 +++ b/plugins/include/sdktools_voice.inc Thu Aug 01 09:26:34 2013 -0400
26.3 @@ -78,6 +78,7 @@
26.4 *
26.5 * @param iReceiver The listener index.
26.6 * @param iSender The sender index.
26.7 + * @param bListen True if the receiver can listen to the sender, false otherwise.
26.8 * @return True if successful otherwise false.
26.9 */
26.10 #pragma deprecated Use SetListenOverride() instead
26.11 @@ -98,7 +99,7 @@
26.12 *
26.13 * @param iReceiver The listener index.
26.14 * @param iSender The sender index.
26.15 - * @param override
26.16 + * @param override The override of the receiver's ability to listen to the sender.
26.17 * @return True if successful otherwise false.
26.18 */
26.19 native bool:SetListenOverride(iReceiver, iSender, ListenOverride:override);
27.1 --- a/plugins/include/sorting.inc Wed Jul 31 22:57:50 2013 -0400
27.2 +++ b/plugins/include/sorting.inc Thu Aug 01 09:26:34 2013 -0400
27.3 @@ -84,7 +84,7 @@
27.4 * @param order Sorting order to use.
27.5 * @noreturn
27.6 */
27.7 -native SortStrings(String:array[][], num_strings, SortOrder:order = Sort_Ascending);
27.8 +native SortStrings(String:array[][], array_size, SortOrder:order = Sort_Ascending);
27.9
27.10 /**
27.11 * Sort comparison function for 1D array elements.
28.1 --- a/plugins/include/sourcemod.inc Wed Jul 31 22:57:50 2013 -0400
28.2 +++ b/plugins/include/sourcemod.inc Thu Aug 01 09:26:34 2013 -0400
28.3 @@ -278,7 +278,7 @@
28.4 * @return True if being debugged, false otherwise.
28.5 * @error Invalid Handle.
28.6 */
28.7 -native bool:IsPluginDebugging(Handle:hndl);
28.8 +native bool:IsPluginDebugging(Handle:plugin);
28.9
28.10 /**
28.11 * Retrieves a plugin's public info.
28.12 @@ -328,7 +328,7 @@
28.13 * Aborts the current callback and throws an error. This function
28.14 * does not return in that no code is executed following it.
28.15 *
28.16 - * @param format String format.
28.17 + * @param fmt String format.
28.18 * @param ... Format arguments.
28.19 * @noreturn
28.20 * @error Always!
29.1 --- a/plugins/include/string.inc Wed Jul 31 22:57:50 2013 -0400
29.2 +++ b/plugins/include/string.inc Thu Aug 01 09:26:34 2013 -0400
29.3 @@ -119,7 +119,7 @@
29.4 * destination will be truncated.
29.5 *
29.6 * @param dest Destination string buffer to copy to.
29.7 - * @param destlen Destination buffer length (includes null terminator).
29.8 + * @param destLen Destination buffer length (includes null terminator).
29.9 * @param source Source string buffer to copy from.
29.10 * @return Number of cells written.
29.11 */
29.12 @@ -323,7 +323,7 @@
29.13 *
29.14 * @note Multi-byte characters will always return false.
29.15 *
29.16 - * @param char Character to test.
29.17 + * @param chr Character to test.
29.18 * @return True if character is alphabetical, otherwise false.
29.19 */
29.20 native bool:IsCharAlpha(chr);
29.21 @@ -333,7 +333,7 @@
29.22 *
29.23 * @note Multi-byte characters will always return false.
29.24 *
29.25 - * @param char Character to test.
29.26 + * @param chr Character to test.
29.27 * @return True if character is numeric, otherwise false.
29.28 */
29.29 native bool:IsCharNumeric(chr);
29.30 @@ -343,7 +343,7 @@
29.31 *
29.32 * @note Multi-byte characters will always return false.
29.33 *
29.34 - * @param char Character to test.
29.35 + * @param chr Character to test.
29.36 * @return True if character is whitespace, otherwise false.
29.37 */
29.38 native bool:IsCharSpace(chr);
29.39 @@ -351,7 +351,7 @@
29.40 /**
29.41 * Returns if a character is multi-byte or not.
29.42 *
29.43 - * @param char Character to test.
29.44 + * @param chr Character to test.
29.45 * @return 0 for a normal 7-bit ASCII character,
29.46 * otherwise number of bytes in multi-byte character.
29.47 */
29.48 @@ -362,7 +362,7 @@
29.49 *
29.50 * @note Multi-byte characters will always return false.
29.51 *
29.52 - * @param char Character to test.
29.53 + * @param chr Character to test.
29.54 * @return True if character is uppercase, otherwise false.
29.55 */
29.56 native bool:IsCharUpper(chr);
29.57 @@ -372,7 +372,7 @@
29.58 *
29.59 * @note Multi-byte characters will always return false.
29.60 *
29.61 - * @param char Character to test.
29.62 + * @param chr Character to test.
29.63 * @return True if character is lowercase, otherwise false.
29.64 */
29.65 native bool:IsCharLower(chr);
30.1 --- a/plugins/include/tf2.inc Wed Jul 31 22:57:50 2013 -0400
30.2 +++ b/plugins/include/tf2.inc Thu Aug 01 09:26:34 2013 -0400
30.3 @@ -35,13 +35,13 @@
30.4 #endif
30.5 #define _tf2_included
30.6
30.7 -#define TF_STUNFLAG_SLOWDOWN (1 << 0) // activates slowdown modifier
30.8 -#define TF_STUNFLAG_BONKSTUCK (1 << 1) // bonk sound, stuck
30.9 -#define TF_STUNFLAG_LIMITMOVEMENT (1 << 2) // disable forward/backward movement
30.10 -#define TF_STUNFLAG_CHEERSOUND (1 << 3) // cheering sound
30.11 -#define TF_STUNFLAG_NOSOUNDOREFFECT (1 << 5) // no sound or particle
30.12 -#define TF_STUNFLAG_THIRDPERSON (1 << 6) // panic animation
30.13 -#define TF_STUNFLAG_GHOSTEFFECT (1 << 7) // ghost particles
30.14 +#define TF_STUNFLAG_SLOWDOWN (1 << 0) /**< activates slowdown modifier */
30.15 +#define TF_STUNFLAG_BONKSTUCK (1 << 1) /**< bonk sound, stuck */
30.16 +#define TF_STUNFLAG_LIMITMOVEMENT (1 << 2) /**< disable forward/backward movement */
30.17 +#define TF_STUNFLAG_CHEERSOUND (1 << 3) /**< cheering sound */
30.18 +#define TF_STUNFLAG_NOSOUNDOREFFECT (1 << 5) /**< no sound or particle */
30.19 +#define TF_STUNFLAG_THIRDPERSON (1 << 6) /**< panic animation */
30.20 +#define TF_STUNFLAG_GHOSTEFFECT (1 << 7) /**< ghost particles */
30.21
30.22 #define TF_STUNFLAGS_LOSERSTATE TF_STUNFLAG_SLOWDOWN|TF_STUNFLAG_NOSOUNDOREFFECT|TF_STUNFLAG_THIRDPERSON
30.23 #define TF_STUNFLAGS_GHOSTSCARE TF_STUNFLAG_GHOSTEFFECT|TF_STUNFLAG_THIRDPERSON
30.24 @@ -173,10 +173,11 @@
30.25 * Sets a client on fire for 10 seconds.
30.26 *
30.27 * @param client Player's index.
30.28 + * @param attacker Attacker's index.
30.29 * @noreturn
30.30 * @error Invalid client index, client not in game, or no mod support.
30.31 */
30.32 -native TF2_IgnitePlayer(client, target);
30.33 +native TF2_IgnitePlayer(client, attacker);
30.34
30.35 /**
30.36 * Respawns a client
30.37 @@ -255,10 +256,10 @@
30.38 * Stuns a client
30.39 *
30.40 * @param client Player's index.
30.41 - * @param float Duration of stun.
30.42 - * @param float Slowdown percent (as decimal, 0.00-1.00)
30.43 - * (ignored if TF_STUNFLAG_SLOWDOWN is not set.
30.44 - * @param int Stun flags.
30.45 + * @param duration Duration of stun.
30.46 + * @param slowdown Slowdown percent (as decimal, 0.00-1.00)
30.47 + * Ignored if TF_STUNFLAG_SLOWDOWN is not set.
30.48 + * @param stunflags Stun flags.
30.49 * @param attacker Attacker's index (0 is allowed for world).
30.50 * @noreturn
30.51 */
30.52 @@ -269,7 +270,7 @@
30.53 *
30.54 * @param client Player's index.
30.55 * @param attacker Attacker's index.
30.56 - * @param float Duration of bleeding (in seconds).
30.57 + * @param duration Duration of bleeding (in seconds).
30.58 * @noreturn
30.59 */
30.60 native TF2_MakeBleed(client, attacker, Float:duration);
31.1 --- a/plugins/include/tf2_stocks.inc Wed Jul 31 22:57:50 2013 -0400
31.2 +++ b/plugins/include/tf2_stocks.inc Thu Aug 01 09:26:34 2013 -0400
31.3 @@ -461,6 +461,7 @@
31.4 * Check whether or not a condition is set on a player
31.5 *
31.6 * @param client Player's index.
31.7 + * @param cond TFCond constant
31.8 * @return True if set, false otherwise
31.9 */
31.10 stock bool:TF2_IsPlayerInCondition(client, TFCond:cond)
32.1 --- a/plugins/include/timers.inc Wed Jul 31 22:57:50 2013 -0400
32.2 +++ b/plugins/include/timers.inc Thu Aug 01 09:26:34 2013 -0400
32.3 @@ -92,6 +92,7 @@
32.4 /**
32.5 * Kills a timer. Use this instead of CloseHandle() if you need more options.
32.6 *
32.7 + * @param timer Timer Handle to kill.
32.8 * @param autoClose If autoClose is true, the data that was passed to CreateTimer() will
32.9 * be closed as a handle if TIMER_DATA_HNDL_CLOSE was not specified.
32.10 * @noreturn
33.1 --- a/plugins/include/topmenus.inc Wed Jul 31 22:57:50 2013 -0400
33.2 +++ b/plugins/include/topmenus.inc Thu Aug 01 09:26:34 2013 -0400
33.3 @@ -201,7 +201,7 @@
33.4 * Retrieves the info string of a top menu item.
33.5 *
33.6 * @param topmenu TopMenu Handle.
33.7 - * @param object TopMenuObject ID.
33.8 + * @param parent TopMenuObject ID.
33.9 * @param buffer Buffer to store info string.
33.10 * @param maxlength Maximum size of info string.
33.11 * @return Number of bytes written, not including the
34.1 --- a/plugins/include/usermessages.inc Wed Jul 31 22:57:50 2013 -0400
34.2 +++ b/plugins/include/usermessages.inc Thu Aug 01 09:26:34 2013 -0400
34.3 @@ -158,7 +158,7 @@
34.4 * @param intercept If intercept is true, message will be fully intercepted,
34.5 * allowing the user to block the message. Otherwise,
34.6 * the hook is normal and ignores the return value.
34.7 - * @param notify Notification function.
34.8 + * @param post Notification function.
34.9 * @noreturn
34.10 * @error Invalid message index.
34.11 */
