SourceMod::IUserMessageListener Class Reference

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

#include <public/IUserMessages.h>

List of all members.

Public Member Functions
virtual void	OnUserMessage (int msg_id, bf_write *bf, IRecipientFilter *pFilter)
	Called when a hooked user message is being sent and all interceptions have finished.
virtual ResultType	InterceptUserMessage (int msg_id, bf_write *bf, IRecipientFilter *pFilter)
	Called when a hooked user message is intercepted.
virtual void	OnUserMessageSent (int msg_id)
	Called when a hooked user message is sent, regardless of the hook type.

---

Detailed Description

Listens to user messages sent from the server.

Definition at line 54 of file IUserMessages.h.

---

Member Function Documentation

virtual void SourceMod::IUserMessageListener::OnUserMessage	(	int	msg_id,
		bf_write *	bf,
		IRecipientFilter *	pFilter
	)			[inline, virtual]

Called when a hooked user message is being sent and all interceptions have finished.

Parameters:

	msg_id	Message Id.
	bf	bf_write structure containing written bytes.
	pFilter	Recipient filter.

Definition at line 65 of file IUserMessages.h.

virtual ResultType SourceMod::IUserMessageListener::InterceptUserMessage	(	int	msg_id,
		bf_write *	bf,
		IRecipientFilter *	pFilter
	)			[inline, virtual]

Called when a hooked user message is intercepted.

Parameters:

	msg_id	Message Id.
	bf	bf_write structure containing written bytes.
	pFilter	Recipient filter.

Returns:

Pl_Continue to allow message, Pl_Stop or Pl_Handled to scrap it.

Definition at line 77 of file IUserMessages.h.

virtual void SourceMod::IUserMessageListener::OnUserMessageSent

(

int

msg_id

)

[inline, virtual]

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

Parameters:

msg_id

Message Id.

Definition at line 86 of file IUserMessages.h.

---

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

• public/IUserMessages.h

---