SourceMod::IClientListener Class Reference

Provides callbacks for important client events. More...

#include <public/IPlayerHelpers.h>

List of all members.

Public Member Functions

virtual unsigned int GetClientListenerVersion ()
 Returns the current client listener version.
virtual bool InterceptClientConnect (int client, char *error, size_t maxlength)
 Called when a client requests connection.
virtual void OnClientConnected (int client)
 Called when a client has connected.
virtual void OnClientPutInServer (int client)
 Called when a client is put in server.
virtual void OnClientDisconnecting (int client)
 Called when a client is disconnecting (not fully disconnected yet).
virtual void OnClientDisconnected (int client)
 Called when a client has fully disconnected.
virtual void OnClientAuthorized (int client, const char *authstring)
 Called when a client has received authorization.
virtual void OnServerActivated (int max_clients)
 Called when the server is activated.
virtual bool OnClientPreAdminCheck (int client)
 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.
virtual void OnClientPostAdminCheck (int client)
 Called once a client is authorized and fully in-game, and after all post-connection authorizations have been passed. If the client does not have an AdminId by this stage, it means that no admin entry was in the cache that matched, and the user could not be authenticated as an admin.
virtual void OnMaxPlayersChanged (int newvalue)
 Notifies the extension that the maxplayers value has changed.


Detailed Description

Provides callbacks for important client events.

Definition at line 198 of file IPlayerHelpers.h.


Member Function Documentation

virtual unsigned int SourceMod::IClientListener::GetClientListenerVersion (  )  [inline, virtual]

Returns the current client listener version.

Returns:
Client listener version.

Definition at line 206 of file IPlayerHelpers.h.

virtual bool SourceMod::IClientListener::InterceptClientConnect ( int  client,
char *  error,
size_t  maxlength 
) [inline, virtual]

Called when a client requests connection.

Parameters:
client Index of the client.
error Error buffer for a disconnect reason.
maxlength Maximum length of error buffer.
Returns:
True to allow client, false to reject.

Definition at line 219 of file IPlayerHelpers.h.

virtual void SourceMod::IClientListener::OnClientConnected ( int  client  )  [inline, virtual]

Called when a client has connected.

Parameters:
client Index of the client.

Definition at line 229 of file IPlayerHelpers.h.

virtual void SourceMod::IClientListener::OnClientPutInServer ( int  client  )  [inline, virtual]

Called when a client is put in server.

Parameters:
client Index of the client.

Definition at line 238 of file IPlayerHelpers.h.

virtual void SourceMod::IClientListener::OnClientDisconnecting ( int  client  )  [inline, virtual]

Called when a client is disconnecting (not fully disconnected yet).

Parameters:
client Index of the client.

Definition at line 247 of file IPlayerHelpers.h.

virtual void SourceMod::IClientListener::OnClientDisconnected ( int  client  )  [inline, virtual]

Called when a client has fully disconnected.

Parameters:
client Index of the client.

Definition at line 256 of file IPlayerHelpers.h.

virtual void SourceMod::IClientListener::OnClientAuthorized ( int  client,
const char *  authstring 
) [inline, virtual]

Called when a client has received authorization.

Parameters:
client Index of the client.
authstring Authorization string.

Definition at line 266 of file IPlayerHelpers.h.

virtual bool SourceMod::IClientListener::OnClientPreAdminCheck ( int  client  )  [inline, virtual]

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.

By default, this function allows the authentication process to continue as normal. If you need to delay the cache searching process in order to get asynchronous data, then return false here.

If you return false, you must call IPlayerManager::NotifyPostAdminCheck for the same client, or else the OnClientPostAdminCheck callback will never be called.

Parameters:
client Client index.
Returns:
True to continue normally, false to override the authentication process.

Definition at line 294 of file IPlayerHelpers.h.

virtual void SourceMod::IClientListener::OnClientPostAdminCheck ( int  client  )  [inline, virtual]

Called once a client is authorized and fully in-game, and after all post-connection authorizations have been passed. If the client does not have an AdminId by this stage, it means that no admin entry was in the cache that matched, and the user could not be authenticated as an admin.

Parameters:
client Client index.

Definition at line 308 of file IPlayerHelpers.h.

virtual void SourceMod::IClientListener::OnMaxPlayersChanged ( int  newvalue  )  [inline, virtual]

Notifies the extension that the maxplayers value has changed.

Parameters:
newvalue New maxplayers value.

Definition at line 317 of file IPlayerHelpers.h.


The documentation for this class was generated from the following file:
Generated on Thu Mar 5 14:05:27 2009 for SourceMod SDK by  doxygen 1.5.1