SourceMod::IPlayerManager Class Reference

Inherits SourceMod::SMInterface.

Inheritance diagram for SourceMod::IPlayerManager:

[legend]Collaboration diagram for SourceMod::IPlayerManager:[legend]List of all members.

Public Member Functions
const char *	GetInterfaceName ()
	Must return a string defining the interface's unique name.
unsigned int	GetInterfaceVersion ()
	Must return an integer defining the interface's version.
virtual void	AddClientListener (IClientListener *listener)=0
	Adds a client listener.
virtual void	RemoveClientListener (IClientListener *listener)=0
	Removes a client listener.
virtual IGamePlayer *	GetGamePlayer (int client)=0
	Retrieves an IGamePlayer object by its client index.
virtual IGamePlayer *	GetGamePlayer (edict_t *pEdict)=0
	Retrieves an IGamePlayer object by its edict_t pointer.
virtual int	GetMaxClients ()=0
	Returns the maximum number of clients.
virtual int	GetNumPlayers ()=0
	Returns the number of players currently connected.
virtual int	GetClientOfUserId (int userid)=0
	Returns the client index by its userid.
virtual bool	IsServerActivated ()=0
	Returns whether or not the server is activated.
virtual unsigned int	GetReplyTo ()=0
	Gets SourceMod's reply source.
virtual unsigned int	SetReplyTo (unsigned int reply)=0
	Sets SourceMod's reply source.
virtual int	FilterCommandTarget (IGamePlayer *pAdmin, IGamePlayer *pTarget, int flags)=0
	Tests if a player meets command filtering rules.
virtual void	RegisterCommandTargetProcessor (ICommandTargetProcessor *pHandler)=0
	Registers a command target processor.
virtual void	UnregisterCommandTargetProcessor (ICommandTargetProcessor *pHandler)=0
	Removes a command target processor.

---

Detailed Description

Definition at line 360 of file IPlayerHelpers.h.

---

Member Function Documentation

virtual void SourceMod::IPlayerManager::AddClientListener

(

IClientListener *

listener

)

[pure virtual]

Adds a client listener.

Parameters:

listener

Pointer to an IClientListener.

virtual void SourceMod::IPlayerManager::RemoveClientListener

(

IClientListener *

listener

)

[pure virtual]

Removes a client listener.

Parameters:

listener

Pointer to an IClientListener.

virtual IGamePlayer* SourceMod::IPlayerManager::GetGamePlayer

(

int

client

)

[pure virtual]

Retrieves an IGamePlayer object by its client index.

Note: This will return a valid object for any player, connected or not. Note: Client indexes start at 1, not 0.

Parameters:

client

Index of the client.

Returns:

An IGamePlayer pointer, or NULL if out of range.

virtual IGamePlayer* SourceMod::IPlayerManager::GetGamePlayer

(

edict_t *

pEdict

)

[pure virtual]

Retrieves an IGamePlayer object by its edict_t pointer.

Parameters:

pEdict

Index of the client

Returns:

An IGamePlayer pointer, or NULL if out of range.

virtual int SourceMod::IPlayerManager::GetMaxClients

(

)

[pure virtual]

Returns the maximum number of clients.

Note: this will not work until the server is activated.

Returns:

Maximum number of clients.

virtual int SourceMod::IPlayerManager::GetNumPlayers

(

)

[pure virtual]

Returns the number of players currently connected.

Returns:

Current number of connected clients.

virtual int SourceMod::IPlayerManager::GetClientOfUserId

(

int

userid

)

[pure virtual]

Returns the client index by its userid.

Parameters:

userid

Userid of the client.

Returns:

Client index, or 0 if invalid userid passed.

virtual bool SourceMod::IPlayerManager::IsServerActivated

(

)

[pure virtual]

Returns whether or not the server is activated.

Returns:

True if ServerActivate() has been called at least once, false otherwise.

virtual unsigned int SourceMod::IPlayerManager::GetReplyTo

(

)

[pure virtual]

Gets SourceMod's reply source.

Returns:

ReplyTo source.

virtual unsigned int SourceMod::IPlayerManager::SetReplyTo

(

unsigned int

reply

)

[pure virtual]

Sets SourceMod's reply source.

Parameters:

reply

Reply source.

Returns:

Old reply source.

virtual int SourceMod::IPlayerManager::FilterCommandTarget	(	IGamePlayer *	pAdmin,
		IGamePlayer *	pTarget,
		int	flags
	)			[pure virtual]

Tests if a player meets command filtering rules.

Parameters:

	pAdmin	IGamePlayer of the admin, or NULL if the server.
	pTarget	IGamePlayer of the player being targeted.
	flags	COMMAND_FILTER flags.

Returns:

COMMAND_TARGET value.

virtual void SourceMod::IPlayerManager::RegisterCommandTargetProcessor

(

ICommandTargetProcessor *

pHandler

)

[pure virtual]

Registers a command target processor.

Parameters:

pHandler

Pointer to an ICommandTargetProcessor instance.

virtual void SourceMod::IPlayerManager::UnregisterCommandTargetProcessor

(

ICommandTargetProcessor *

pHandler

)

[pure virtual]

Removes a command target processor.

Parameters:

pHandler

Pointer to an ICommandTargetProcessor instance.

---

The documentation for this class was generated from the following file:

• public/IPlayerHelpers.h

---