IUserMessages.h

Go to the documentation of this file.

#ifndef _INCLUDE_SOURCEMOD_INTERFACE_USERMESSAGES_H_
#define _INCLUDE_SOURCEMOD_INTERFACE_USERMESSAGES_H_

#include <IShareSys.h>
#include <sp_vm_api.h>
#include <IForwardSys.h>
#include <irecipientfilter.h>

namespace google { namespace protobuf {
        class Message;
} };

class bf_write;

#define SMINTERFACE_USERMSGS_NAME               "IUserMessages"
#define SMINTERFACE_USERMSGS_VERSION    4

namespace SourceMod
{
        enum UserMessageType
        {
                UM_BitBuf,
                UM_Protobuf,
        };
        
        class IUserMessageListener
        {
        public:
                virtual void OnUserMessageSent(int msg_id)
                {
                }

                virtual unsigned int GetUserMessageAPIVersion()
                {
                        return SMINTERFACE_USERMSGS_VERSION;
                }

                virtual void OnPostUserMessage(int msg_id, bool sent)
                {
                }
                
                virtual UserMessageType GetUserMessageType() const =0;
        };
        
        class IBitBufUserMessageListener : public IUserMessageListener
        {
        public:
                virtual void OnUserMessage(int msg_id, bf_write *bf, IRecipientFilter *pFilter)
                {
                }

                virtual ResultType InterceptUserMessage(int msg_id, bf_write *bf, IRecipientFilter *pFilter)
                {
                        return Pl_Continue;
                }
                
                virtual UserMessageType GetUserMessageType() const
                {
                        return UM_BitBuf;
                }
        };
        
        class IProtobufUserMessageListener : public IUserMessageListener
        {
        public:
                virtual void OnUserMessage(int msg_id, google::protobuf::Message *msg, IRecipientFilter *pFilter)
                {
                }

                virtual ResultType InterceptUserMessage(int msg_id, google::protobuf::Message *msg, IRecipientFilter *pFilter)
                {
                        return Pl_Continue;
                }
                
                virtual UserMessageType GetUserMessageType() const
                {
                        return UM_Protobuf;
                }
        };

        #define USERMSG_RELIABLE                        (1<<2)          
        #define USERMSG_INITMSG                         (1<<3)          
        #define USERMSG_BLOCKHOOKS                      (1<<7)          
        class IUserMessages : public SMInterface
        {
        public:
                virtual unsigned int GetInterfaceVersion()
                {
                        return SMINTERFACE_USERMSGS_VERSION;
                }
                virtual const char *GetInterfaceName()
                {
                        return SMINTERFACE_USERMSGS_NAME;
                }
        public:
                virtual int GetMessageIndex(const char *msg) =0;

                virtual bool HookUserMessage(int msg_id,
                        IUserMessageListener *pListener,
                        bool intercept=false) =0;

                virtual bool UnhookUserMessage(int msg_id,
                        IUserMessageListener *pListener,
                        bool intercept=false) =0;

                virtual bf_write *StartBitBufMessage(int msg_id,
                        const cell_t players[],
                        unsigned int playersNum,
                        int flags) =0;

                virtual google::protobuf::Message *StartProtobufMessage(int msg_id,
                        const cell_t players[],
                        unsigned int playersNum,
                        int flags) =0;

                virtual bool EndMessage() =0;

                virtual bool HookUserMessage2(int msg_id,
                        IUserMessageListener *pListener,
                        bool intercept=false) =0;

                virtual bool UnhookUserMessage2(int msg_id,
                        IUserMessageListener *pListener,
                        bool intercept=false) =0;

                virtual bool GetMessageName(int msgid, char *buffer, size_t maxlength) const =0;
                
                virtual UserMessageType GetUserMessageType() const =0;
        };
}

#endif //_INCLUDE_SOURCEMOD_INTERFACE_USERMESSAGES_H_