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

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.
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.

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.

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.

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

Parameters:

msg_id

Message Id.

Definition at line 90 of file IUserMessages.h.

virtual void SourceMod::IUserMessageListener::OnPostUserMessage	(	int	msg_id,
		bool	sent
	)			`[inline, virtual]`

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_id	Message Id.
	sent	True if message was sent, false if blocked.

Definition at line 110 of file IUserMessages.h.

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