psPlaySoundMessage Class Reference

Sound Message. More...

#include <messages.h>

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psPlaySoundMessage (uint32_t clientnum, csString snd)
	Create psMessageBytes struct for outbound use. More...
	psPlaySoundMessage (MsgEntry *message)
	Crack incoming psMessageBytes struct for inbound use. More...
virtual csString	ToString (NetBase::AccessPointers *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
csString	sound
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

Sound Message.

This message is used to tell the client to play a sound. The client psSoundManager and various server managers will deal with this messages. Specific sound events with additional data should inherit from this message.

Definition at line 5907 of file messages.h.

Constructor & Destructor Documentation

psPlaySoundMessage::psPlaySoundMessage	(	uint32_t	clientnum,
		csString	snd
	)

Create psMessageBytes struct for outbound use.

psPlaySoundMessage::psPlaySoundMessage

(

MsgEntry *

message

)

Crack incoming psMessageBytes struct for inbound use.

Member Function Documentation

psPlaySoundMessage::PSF_DECLARE_MSG_FACTORY

(

)

virtual csString psPlaySoundMessage::ToString ( NetBase::AccessPointers *  accessPointers )

virtual

Converts the message into human readable string.

Parameters

accessPointers

A struct to a number of access pointers.

Returns

Return a human readable string for the message.

Implements psMessageCracker.

Member Data Documentation

csString psPlaySoundMessage::sound

Definition at line 5910 of file messages.h.

---

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

• common/net/messages.h