Scumm::Player_Towns_v1 Class Reference

Inheritance diagram for Scumm::Player_Towns_v1:

Public Member Functions
	Player_Towns_v1 (ScummEngine *vm, Audio::Mixer *mixer)
bool	init () override
void	setMusicVolume (int vol) override
void	startSound (int sound) override
void	stopSound (int sound) override
void	stopAllSounds () override
int	getSoundStatus (int sound) const override
int	getCurrentCdaSound () override
int	getCurrentCdaVolume () override
int32	doCommand (int numargs, int args[]) override
void	setVolumeCD (int left, int right) override
void	setSoundVolume (int sound, int left, int right) override
void	setSoundNote (int sound, int note) override
void	saveLoadWithSerializer (Common::Serializer &ser) override
void	restoreAfterLoad () override
Public Member Functions inherited from Scumm::Player_Towns
	Player_Towns (ScummEngine *vm, bool isVersion2)
void	setSfxVolume (int vol) override
Public Member Functions inherited from Scumm::MusicEngine
virtual void	startSoundWithTrackID (int sound, int track)
virtual int	getMusicTimer ()
virtual void	setQuality (int qual)
virtual void	toggleMusic (bool enable)
virtual void	toggleSoundEffects (bool enable)

Additional Inherited Members
Protected Member Functions inherited from Scumm::Player_Towns
void	playPcmTrack (int sound, const uint8 *data, int velo=0, int pan=64, int note=0, int priority=0)
void	stopPcmTrack (int sound)
int	allocatePcmChannel (int sound, int sfxChanRelIndex, uint32 priority)
Protected Attributes inherited from Scumm::Player_Towns
struct Scumm::Player_Towns::PcmCurrentSound	_pcmCurrentSound [9]
uint8	_unkFlags = 0x33
TownsAudioInterface *	_intf = nullptr
ScummEngine *	_vm
const int	_numSoundMax
const bool	_v2

Member Function Documentation

setMusicVolume()

void Scumm::Player_Towns_v1::setMusicVolume ( int  vol )

overridevirtual

Set the output volume for music. Also used, if the inheriting class doesn't distinguish between music and sfx.

Parameters

vol	the new output volume

Implements Scumm::MusicEngine.

startSound()

void Scumm::Player_Towns_v1::startSound ( int  sound )

overridevirtual

Start playing the sound with the given id.

Parameters

sound

the sound to start

Implements Scumm::MusicEngine.

stopSound()

void Scumm::Player_Towns_v1::stopSound ( int  sound )

overridevirtual

Stop playing the sound with the given id.

Parameters

sound

the sound to stop

Implements Scumm::MusicEngine.

stopAllSounds()

void Scumm::Player_Towns_v1::stopAllSounds ( )

overridevirtual

Start playing all currently playing sounds.

Implements Scumm::MusicEngine.

getSoundStatus()

int Scumm::Player_Towns_v1::getSoundStatus ( int  sound ) const

overridevirtual

Query the status of the sound with the given id. Usually this is just a boolean telling us whether the sound is playing or not.

Parameters

sound

the sound to for which we want the status

Returns

the status of the specified sound

Reimplemented from Scumm::Player_Towns.

saveLoadWithSerializer()

void Scumm::Player_Towns_v1::saveLoadWithSerializer ( Common::Serializer &  ser )

overridevirtual

Save or load the music state.

Reimplemented from Scumm::Player_Towns.

restoreAfterLoad()

void Scumm::Player_Towns_v1::restoreAfterLoad ( )

overridevirtual

Performs necessary post-load operations on the sound engine, like restarting of music tracks or looping pcm sounds. Some targets get this done via scripts but others don't. Currently, this is used for FM-Towns and Mac.

Reimplemented from Scumm::Player_Towns.

---

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

• engines/scumm/players/player_towns.h