psStopEffectMessage Class Reference

#include <messages.h>

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psStopEffectMessage (uint32_t clientNum, uint32_t uid)
	psStopEffectMessage (uint32_t uid)
	psStopEffectMessage (MsgEntry *message)
csString	ToString (NetBase::AccessPointers *)
	Converts the message into human readable string. More...
Public Member Functions inherited from psMessageCracker
void	FireEvent ()
	Publishes the message to the local program. More...
virtual csString	GetMessageTypeName () const =0
	Gets the name of the message type. More...
void	Multicast (csArray< PublishDestination > &multi, uint32_t except, float range)
	Multicasts the message to all current connections. More...
	psMessageCracker ()
void	SendMessage ()
	Sends the message to the client/server. More...
virtual	~psMessageCracker ()

Public Attributes
uint32_t	uid
Public Attributes inherited from psMessageCracker
int	filterNumber
csRef< MsgEntry >	msg
bool	valid

Additional Inherited Members
Static Public Attributes inherited from psMessageCracker
static MsgHandler *	msghandler

Detailed Description

Definition at line 2439 of file messages.h.

Constructor & Destructor Documentation

psStopEffectMessage::psStopEffectMessage ( uint32_t  clientNum, uint32_t  uid  )

inline

Definition at line 2442 of file messages.h.

psStopEffectMessage::psStopEffectMessage ( uint32_t  uid )

inline

Definition at line 2452 of file messages.h.

psStopEffectMessage::psStopEffectMessage ( MsgEntry *  message )

inline

Definition at line 2462 of file messages.h.

Member Function Documentation

psStopEffectMessage::PSF_DECLARE_MSG_FACTORY

(

)

csString psStopEffectMessage::ToString ( NetBase::AccessPointers *  accessPointers )

inlinevirtual

Converts the message into human readable string.

Used when a message is Logged. Every message should implement a version of this function that print all data that was decoded when the message was initiated from a NetEntry. See psDRMessage::ToString for an example.

Parameters

accessPointers

A struct to a number of access pointers.

Returns

Return a human readable string for the message.

Implements psMessageCracker.

Definition at line 2471 of file messages.h.

Member Data Documentation

uint32_t psStopEffectMessage::uid

Definition at line 2478 of file messages.h.

---

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

• common/net/messages.h