ScummVM API documentation
Xeen::Sound Class Reference

Public Member Functions

 Sound (Audio::Mixer *mixer)
 
void playFX (uint effectId)
 
void stopFX ()
 
int songCommand (uint commandId, byte musicVolume=0, byte sfxVolume=0)
 
void stopSong ()
 
void setMusicPercent (byte percent)
 
void playSong (Common::SeekableReadStream &stream)
 
void playSong (const Common::String &name, int param=0)
 
bool isMusicPlaying () const
 
void setMusicOn (bool isOn)
 
void setFxOn (bool isOn)
 
void updateSoundSettings ()
 
void stopAllAudio ()
 
void playSound (Common::SeekableReadStream &s, int unused=0)
 
void playSound (const Common::String &name, int unused=0)
 
void playSound (const Common::String &name, int ccNum, int unused)
 
void stopSound ()
 
bool isSoundPlaying () const
 
void playVoice (const Common::String &name, int ccMode=-1)
 

Public Attributes

bool _fxOn
 
bool _musicOn
 
Common::String _currentMusic
 
int _musicSide
 
bool _subtitles
 

Member Function Documentation

◆ playFX()

void Xeen::Sound::playFX ( uint  effectId)

Starts an effect playing

◆ stopFX()

void Xeen::Sound::stopFX ( )

Stops any currently playing FX

◆ songCommand()

int Xeen::Sound::songCommand ( uint  commandId,
byte  musicVolume = 0,
byte  sfxVolume = 0 
)

Executes special music command

◆ stopSong()

void Xeen::Sound::stopSong ( )
inline

Stops any currently playing music

◆ setMusicPercent()

void Xeen::Sound::setMusicPercent ( byte  percent)

Sets the in-game music volume percent. This is separate from the ScummVM volume

◆ playSong() [1/2]

void Xeen::Sound::playSong ( Common::SeekableReadStream stream)

Plays a song

◆ playSong() [2/2]

void Xeen::Sound::playSong ( const Common::String name,
int  param = 0 
)

Plays a song

◆ isMusicPlaying()

bool Xeen::Sound::isMusicPlaying ( ) const

Returns true if music is playing

◆ setMusicOn()

void Xeen::Sound::setMusicOn ( bool  isOn)

Sets whether music is on

◆ setFxOn()

void Xeen::Sound::setFxOn ( bool  isOn)

Sets whether sound effects is on

◆ updateSoundSettings()

void Xeen::Sound::updateSoundSettings ( )

Called to reload sound settings

◆ stopAllAudio()

void Xeen::Sound::stopAllAudio ( )

Stops all playing music, FX, and sound samples

◆ playSound() [1/3]

void Xeen::Sound::playSound ( Common::SeekableReadStream s,
int  unused = 0 
)

Play a given sound

◆ playSound() [2/3]

void Xeen::Sound::playSound ( const Common::String name,
int  unused = 0 
)

Play a given sound

◆ playSound() [3/3]

void Xeen::Sound::playSound ( const Common::String name,
int  ccNum,
int  unused 
)

Play a given sound

◆ stopSound()

void Xeen::Sound::stopSound ( )

Stop playing a sound loaded from a .m file

Remarks
In the original, passing 1 to playSound stopped the sound

◆ isSoundPlaying()

bool Xeen::Sound::isSoundPlaying ( ) const

Returns true if a sound file is currently playing

Remarks
In the original, passing 0 to playSound returned play status

◆ playVoice()

void Xeen::Sound::playVoice ( const Common::String name,
int  ccMode = -1 
)

Play a given voice file


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