psPlaySoundMessage Class Reference

Sound Message. More...

#include <messages.h>

List of all members.

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psPlaySoundMessage (MsgEntry *message)
	Crack incoming psMessageBytes struct for inbound use.
	psPlaySoundMessage (uint32_t clientnum, csString snd)
	Create psMessageBytes struct for outbound use.
virtual csString	ToString (NetBase::AccessPointers *accessPointers)
	Converts the message into human readable string.
Public Attributes
csString	sound

---

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 5900 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 5903 of file messages.h.

---

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

• common/net/messages.h