psPlaySongMessage Class Reference

This message is used by the server to make clients play a song. More...

#include <messages.h>

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psPlaySongMessage (uint32_t client, uint32_t songID, bool toPlayer, const char *instrName, uint32_t scoreSize, const char *musicalScore)
	Constructor. More...
	psPlaySongMessage (MsgEntry *me)
	Constructor from a MsgEntry. More...
virtual 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
csString	instrName
csString	musicalScore
uint32_t	songID
bool	toPlayer
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

This message is used by the server to make clients play a song.

Definition at line 5515 of file messages.h.

Constructor & Destructor Documentation

psPlaySongMessage::psPlaySongMessage	(	uint32_t	client,
		uint32_t	songID,
		bool	toPlayer,
		const char *	instrName,
		uint32_t	scoreSize,
		const char *	musicalScore
	)

Constructor.

Parameters

client	the client's ID.
songID	the song's ID.
toPlayer	true if this message is directed to the player that plays the song.
instrName	the name of the used instrument.
scoreSize	the length of the musical score
musicalScore	the musical sheet to play.

psPlaySongMessage::psPlaySongMessage

(

MsgEntry *

me

)

Constructor from a MsgEntry.

Parameters

me	the message entry.

Member Function Documentation

psPlaySongMessage::PSF_DECLARE_MSG_FACTORY

(

)

virtual csString psPlaySongMessage::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 5541 of file messages.h.

Member Data Documentation

csString psPlaySongMessage::instrName

Definition at line 5548 of file messages.h.

csString psPlaySongMessage::musicalScore

Definition at line 5549 of file messages.h.

uint32_t psPlaySongMessage::songID

Definition at line 5546 of file messages.h.

bool psPlaySongMessage::toPlayer

Definition at line 5547 of file messages.h.

---

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

• common/net/messages.h