SourceMod SDK  1.7
Public Member Functions | List of all members
SourceMod::IUserMessageListener Class Referenceabstract

Listens to user messages sent from the server. More...

#include <public/IUserMessages.h>

Inheritance diagram for SourceMod::IUserMessageListener:
SourceMod::IBitBufUserMessageListener SourceMod::IProtobufUserMessageListener

Public Member Functions

virtual void OnUserMessageSent (int msg_id)
 Called when a hooked user message is sent, regardless of the hook type. More...
 
virtual unsigned int GetUserMessageAPIVersion ()
 Returns the user message API version.
 
virtual void OnPostUserMessage (int msg_id, bool sent)
 Called when a hooked user message hook is finished, regardless of the hook type. More...
 
virtual UserMessageType GetUserMessageType () const =0
 

Detailed Description

Listens to user messages sent from the server.

Member Function Documentation

virtual void SourceMod::IUserMessageListener::OnPostUserMessage ( int  msg_id,
bool  sent 
)
inlinevirtual

Called when a hooked user message hook is finished, regardless of the hook type.

Note: this is only called if hooked using the new API (version 2 or greater).

Parameters
msg_idMessage Id.
sentTrue if message was sent, false if blocked.
virtual void SourceMod::IUserMessageListener::OnUserMessageSent ( int  msg_id)
inlinevirtual

Called when a hooked user message is sent, regardless of the hook type.

Note: This is called regardless of the API version, though it only happens if the message is successfully sent.

Parameters
msg_idMessage Id.
The documentation for this class was generated from the following file: