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 (MsgEntry *me)
	Constructor from a MsgEntry.
	psPlaySongMessage (uint32_t client, uint32_t songID, bool toPlayer, const char instrName, uint32_t scoreSize, const char musicalScore)
	Constructor.
virtual csString	ToString (NetBase::AccessPointers *)
	Converts the message into human readable string.
Public Attributes
csString	instrName
csString	musicalScore
uint32_t	songID
bool	toPlayer

Detailed Description

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

Definition at line 5508 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 ) [inline, virtual]

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.