IPlayerHelpers.h

Go to the documentation of this file.

#ifndef _INCLUDE_SOURCEMOD_INTERFACE_IPLAYERHELPERS_H_
#define _INCLUDE_SOURCEMOD_INTERFACE_IPLAYERHELPERS_H_

#include <IShareSys.h>
#include <IAdminSystem.h>

#define SMINTERFACE_PLAYERMANAGER_NAME          "IPlayerManager"
#define SMINTERFACE_PLAYERMANAGER_VERSION       21

struct edict_t;
class IPlayerInfo;

#define SM_REPLY_CONSOLE        0                       
#define SM_REPLY_CHAT           1                       
#define SM_MAXPLAYERS                           65              
namespace SourceMod
{
        class IGamePlayer
        {
        public:
                virtual const char *GetName() =0;

                virtual const char *GetIPAddress() =0;

                virtual const char *GetAuthString(bool validated = true) =0;

                virtual edict_t *GetEdict() =0;

                virtual bool IsInGame() =0;

                virtual bool IsConnected() =0;

                virtual bool IsFakeClient() =0;

                virtual AdminId GetAdminId() =0;

                virtual void SetAdminId(AdminId id, bool temp) =0;

                virtual int GetUserId() =0;

                virtual unsigned int GetLanguageId() =0;

                virtual IPlayerInfo *GetPlayerInfo() =0;

                virtual bool RunAdminCacheChecks() =0;

                virtual void NotifyPostAdminChecks() =0;

                virtual unsigned int GetSerial() =0;

                virtual bool IsAuthorized() =0;
                
                virtual void Kick(const char *message) =0;
                
                virtual bool IsInKickQueue() =0;
                
                virtual void MarkAsBeingKicked() =0;

                virtual void SetLanguageId(unsigned int id) =0;

                virtual bool IsSourceTV() const =0;
                
                virtual bool IsReplay() const =0;
                
                virtual unsigned int GetSteamAccountID(bool validated = true) =0;

                virtual int GetIndex() const =0;
                
                virtual void PrintToConsole(const char *pMsg) =0;

                virtual void ClearAdmin() =0;
                
                virtual uint64_t GetSteamId64(bool validated = true) =0;
                
                virtual const char *GetSteam2Id(bool validated = true) =0;
                
                virtual const char *GetSteam3Id(bool validated = true) =0;
        };

        class IClientListener
        {
        public:
                virtual unsigned int GetClientListenerVersion()
                {
                        return SMINTERFACE_PLAYERMANAGER_VERSION;
                }
        public:
                virtual bool InterceptClientConnect(int client, char *error, size_t maxlength)
                {
                        return true;
                }

                virtual void OnClientConnected(int client)
                {
                }

                virtual void OnClientPutInServer(int client)
                {
                }

                virtual void OnClientDisconnecting(int client)
                {
                }

                virtual void OnClientDisconnected(int client)
                {
                }

                virtual void OnClientAuthorized(int client, const char *authstring)
                {
                }

                virtual void OnServerActivated(int max_clients)
                {
                }

                virtual bool OnClientPreAdminCheck(int client)
                {
                        return true;
                }

                virtual void OnClientPostAdminCheck(int client)
                {
                }

                virtual void OnMaxPlayersChanged(int newvalue)
                {
                }

                virtual void OnClientSettingsChanged(int client)
                {
                }
        };

        #define COMMAND_FILTER_ALIVE            (1<<0)          
        #define COMMAND_FILTER_DEAD                     (1<<1)          
        #define COMMAND_FILTER_CONNECTED        (1<<2)          
        #define COMMAND_FILTER_NO_IMMUNITY      (1<<3)          
        #define COMMAND_FILTER_NO_MULTI         (1<<4)          
        #define COMMAND_FILTER_NO_BOTS          (1<<5)          
        #define COMMAND_TARGET_VALID            1                       
        #define COMMAND_TARGET_NONE                     0                       
        #define COMMAND_TARGET_NOT_ALIVE        -1                      
        #define COMMAND_TARGET_NOT_DEAD         -2                      
        #define COMMAND_TARGET_NOT_IN_GAME      -3                      
        #define COMMAND_TARGET_IMMUNE           -4                      
        #define COMMAND_TARGET_EMPTY_FILTER     -5                      
        #define COMMAND_TARGET_NOT_HUMAN        -6                      
        #define COMMAND_TARGET_AMBIGUOUS        -7                      
        #define COMMAND_TARGETNAME_RAW          0                       
        #define COMMAND_TARGETNAME_ML           1                       
        struct cmd_target_info_t
        {
                const char *pattern;                    
                int admin;                                              
                cell_t *targets;                                
                cell_t max_targets;                             
                int flags;                                              
                char *target_name;                              
                size_t target_name_maxlength;   
                int target_name_style;                  
                int reason;                                             
                unsigned int num_targets;               
        };

        class ICommandTargetProcessor
        {
        public:
                virtual bool ProcessCommandTarget(cmd_target_info_t *info) =0;
        };

        class IPlayerManager : public SMInterface
        {
        public:
                const char *GetInterfaceName()
                {
                        return SMINTERFACE_PLAYERMANAGER_NAME;
                }
                unsigned int GetInterfaceVersion()
                {
                        return SMINTERFACE_PLAYERMANAGER_VERSION;
                }
        public:
                virtual void AddClientListener(IClientListener *listener) =0;

                virtual void RemoveClientListener(IClientListener *listener) =0;

                virtual IGamePlayer *GetGamePlayer(int client) =0;

                virtual IGamePlayer *GetGamePlayer(edict_t *pEdict) =0;

                virtual int GetMaxClients() =0;

                virtual int GetNumPlayers() =0;

                virtual int GetClientOfUserId(int userid) =0;

                virtual bool IsServerActivated() =0;

                virtual unsigned int GetReplyTo() =0;

                virtual unsigned int SetReplyTo(unsigned int reply) =0;

                virtual int FilterCommandTarget(IGamePlayer *pAdmin, IGamePlayer *pTarget, int flags) =0;

                virtual void RegisterCommandTargetProcessor(ICommandTargetProcessor *pHandler) =0;

                virtual void UnregisterCommandTargetProcessor(ICommandTargetProcessor *pHandler) =0;

                virtual int GetClientFromSerial(unsigned int serial) =0;

                virtual void ProcessCommandTarget(cmd_target_info_t *info) =0;

                virtual void ClearAdminId(AdminId id) =0;

                virtual void RecheckAnyAdmins() =0;
        };
}

#endif //_INCLUDE_SOURCEMOD_INTERFACE_IPLAYERHELPERS_H_