clients

Enumerations2

Symbol	Description
AuthIdType	Auth string types. Note that for the Steam2 and Steam3 types, the following ids are also valid values: "STEAM_ID_PENDING" - Authentication is pending. "STEAM_ID_LAN" - Authentication is disabled because of being on a LAN server. "BOT" - The client is a bot.
NetFlow	Network flow directions.

Defines3

Symbol	Description
MAX_AUTHID_LENGTH	Maximum buffer required to store any AuthID type
MAX_NAME_LENGTH	Maximum buffer required to store a client name
MAXPLAYERS	Maximum number of players SourceMod supports

Forwards16

Symbol	Description
OnClientAuthorized	Called after a client's auth ID has been validated. The state of a client's authorization as an admin is not guaranteed here. Use OnClientPostAdminCheck() if you need a client's admin status. There may be a delay in receiving this callback if the Steam netowrk is experience downtime or other issues. This is called by bots, but the ID will be "BOT".
OnClientCommand	Called when a client is sending a command. As of SourceMod 1.3, the client is guaranteed to be in-game. Use command listeners (console.inc) for more advanced hooks.
OnClientCommandKeyValues	Called when a client is sending a KeyValues command.
OnClientCommandKeyValues_Post	Called after a client has sent a KeyValues command.
OnClientConnect	Called on client connection. If you return true, the client will be allowed in the server. If you return false (or return nothing), the client will be rejected. If the client is rejected by this forward or any other, OnClientDisconnect will not be called. Note: Do not write to rejectmsg if you plan on returning true. If multiple plugins write to the string buffer, it is not defined which plugin's string will be shown to the client, but it is guaranteed one of them will.
OnClientConnected	Called once a client successfully connects. This callback is paired with OnClientDisconnect.
OnClientDisconnect	Called when a client is disconnecting from the server.
OnClientDisconnect_Post	Called when a client is disconnected from the server.
OnClientLanguageChanged	Called when the language was received from the player.
OnClientPostAdminCheck	Called once a client is authorized and fully in-game, and after all post-connection authorizations have been performed. This callback is guaranteed to occur on all clients, and always after each OnClientPutInServer() call.
OnClientPostAdminFilter	Called directly before OnClientPostAdminCheck() as a method to alter administrative permissions before plugins perform final post-connect operations. In general, do not use this function unless you are specifically attempting to change access permissions. Use OnClientPostAdminCheck() instead if you simply want to perform post-connect authorization routines. See OnClientPostAdminCheck() for more information.
OnClientPreAdminCheck	Called once a client is authorized and fully in-game, but before admin checks are done. This can be used to override the default admin checks for a client. You should only use this for overriding; use OnClientPostAdminCheck() instead if you want notification. Note: If handled/blocked, PostAdminCheck must be signalled manually via NotifyPostAdminCheck(). This callback is guaranteed to occur on all clients, and always after each OnClientPutInServer() call.
OnClientPutInServer	Called when a client is entering the game. Whether a client has a steamid is undefined until OnClientAuthorized is called, which may occur either before or after OnClientPutInServer. Similarly, use OnClientPostAdminCheck() if you need to verify whether connecting players are admins. GetClientCount() will include clients as they are passed through this function, as clients are already in game at this point.
OnClientSettingsChanged	Called whenever the client's settings are changed.
OnServerEnterHibernation	Called directly before the server enters hibernation. This is your last chance to do anything in the plugin before hibernation occurs, as SV_Frame will no longer be called.
OnServerExitHibernation	Called directly before the server leaves hibernation.

Functions57

Symbol	Description
AddUserFlags	Sets access flags on a client. If the client is not an admin, a temporary, anonymous AdminId is given.
CanUserTarget	Returns whether a user can target another user. This is a helper function for CanAdminTarget.
ChangeClientTeam	Changes a client's team through the mod's generic team changing function. On CS:S, this will kill the player.
CreateFakeClient	Creates a fake client.
GetClientAbsAngles	Returns the client's position angle.
GetClientAbsOrigin	Returns the client's origin vector.
GetClientArmor	Returns the client's armor.
GetClientAuthId	Retrieves a client's authentication string (SteamID).
GetClientAuthString
GetClientAvgChoke	Returns the client's average packet choke, values go from 0 to 1 (for percentages).
GetClientAvgData	Returns the client's data flow in bytes/sec.
GetClientAvgLatency	Returns the client's average packet latency in seconds.
GetClientAvgLoss	Returns the client's average packet loss, values go from 0 to 1 (for percentages).
GetClientAvgPackets	Returns the client's average packet frequency in packets/sec.
GetClientCount	Returns the client count put in the server.
GetClientDataRate	Returns the client's send data rate in bytes/sec.
GetClientDeaths	Returns the client's death count.
GetClientFrags	Returns the client's frag count.
GetClientFromSerial	Returns the client index by its serial number.
GetClientHealth	Returns the client's health.
GetClientInfo	Retrieves values from client replicated keys.
GetClientIP	Retrieves a client's IP address.
GetClientLatency	Returns the client's current latency (RTT), more accurate than GetAvgLatency but jittering.
GetClientMaxs	Returns the client's max size vector.
GetClientMins	Returns the client's min size vector.
GetClientModel	Returns the client's model name.
GetClientName	Returns the client's name.
GetClientOfUserId	Translates an userid index to the real player index.
GetClientSerial	Returns the clients unique serial identifier.
GetClientTeam	Retrieves a client's team index.
GetClientTime	Returns the client's connection time in seconds.
GetClientUserId	Retrieves a client's user id, which is an index incremented for every client that joins the server.
GetClientWeapon	Returns the client's weapon name.
GetMaxClients
GetMaxHumanPlayers	Returns the maximum number of human players allowed on the server. This is a game-specific function used on newer games to limit the number of humans that can join a game and can be lower than MaxClients. It is the number often reflected in the server browser or when viewing the output of the status command. On unsupported games or modes without overrides, it will return the same value as MaxClients. You should not globally cache the value to GetMaxHumanPlayers() because it can change across game modes. You may still cache it locally.
GetSteamAccountID	Returns the client's Steam account ID, a number uniquely identifying a given Steam account. This number is the basis for the various display SteamID forms, see the AuthIdType enum for examples.
GetUserAdmin	Retrieves a client's AdminId.
GetUserFlagBits	Returns client access flags. If the client is not an admin, the result is always 0.
IsClientAuthorized	Returns if a certain player has been authenticated.
IsClientConnected	Returns if a certain player is connected.
IsClientInGame	Returns if a certain player has entered the game.
IsClientInKickQueue	Returns if a client is in the "kick queue" (i.e. the client will be kicked shortly and thus they should not appear as valid).
IsClientObserver	Returns if a certain player is an observer/spectator.
IsClientReplay	Returns if a certain player is the Replay bot.
IsClientSourceTV	Returns if a certain player is the SourceTV bot.
IsClientTimingOut	Returns if a client is timing out
IsFakeClient	Returns if a certain player is a fake client.
IsPlayerAlive	Returns if the client is alive or dead. Note: This function was originally in SDKTools and was moved to core.
IsPlayerInGame
KickClient	Disconnects a client from the server as soon as the next frame starts. Note: Originally, KickClient() was immediate. The delay was introduced because despite warnings, plugins were using it in ways that would crash. The new safe version can break cases that rely on immediate disconnects, but ensures that plugins do not accidentally cause crashes. If you need immediate disconnects, use KickClientEx(). Note: IsClientInKickQueue() will return true before the kick occurs.
KickClientEx	Immediately disconnects a client from the server. Kicking clients from certain events or callbacks may cause crashes. If in doubt, create a short (0.1 second) timer to kick the client in the next available frame.
NotifyPostAdminCheck	Signals that a player has completed post-connection admin checks. Has no effect if the player has already had this event signalled. Note: This must be sent even if no admin id was assigned.
RemoveUserFlags	Removes flags from a client. If the client is not an admin, this has no effect.
RunAdminCacheChecks	Runs through the Core-defined admin authorization checks on a player. Has no effect if the player is already an admin. Note: This function is based on the internal cache only.
SetFakeClientConVar	Sets a convar value on a fake client.
SetUserAdmin	Sets a client's AdminId.
SetUserFlagBits	Sets access flags on a client using bits instead of flags. If the client is not an admin, and flags not 0, a temporary, anonymous AdminId is given.