ScummVM API documentation
Titanic::CMusicRoomHandler Class Reference

Public Member Functions

 CMusicRoomHandler (CProjectItem *project, CSoundManager *soundManager)
 
CMusicRoomInstrumentcreateInstrument (MusicInstrument instrument, int count)
 
void setup (int volume)
 
void setActive (bool flag)
 
void stop ()
 
bool checkInstrument (MusicInstrument instrument) const
 
void setSpeedControl2 (MusicInstrument instrument, int value)
 
void setPitchControl2 (MusicInstrument instrument, int value)
 
void setInversionControl2 (MusicInstrument instrument, bool value)
 
void setDirectionControl2 (MusicInstrument instrument, bool value)
 
void setPitchControl (MusicInstrument instrument, int value)
 
void setSpeedControl (MusicInstrument instrument, int value)
 
void setDirectionControl (MusicInstrument instrument, bool value)
 
void setInversionControl (MusicInstrument instrument, bool value)
 
void setMuteControl (MusicInstrument instrument, bool value)
 
bool update ()
 

Member Function Documentation

◆ createInstrument()

CMusicRoomInstrument* Titanic::CMusicRoomHandler::createInstrument ( MusicInstrument  instrument,
int  count 
)

Creates a new music room instrument class to handle the operation of one of the instruments in the music room.

Parameters
instrumentWhich instrument to create for
countNumber of Wave files the new instance will contain

◆ setup()

void Titanic::CMusicRoomHandler::setup ( int  volume)

Main setup for the music room handler

◆ setActive()

void Titanic::CMusicRoomHandler::setActive ( bool  flag)
inline

Flags whether the music handler is active

◆ stop()

void Titanic::CMusicRoomHandler::stop ( )

Stop playing the music

◆ checkInstrument()

bool Titanic::CMusicRoomHandler::checkInstrument ( MusicInstrument  instrument) const

Checks the specified instrument to see if it's settings are "correct"

◆ setSpeedControl2()

void Titanic::CMusicRoomHandler::setSpeedControl2 ( MusicInstrument  instrument,
int  value 
)

Sets the speed control value

◆ setPitchControl2()

void Titanic::CMusicRoomHandler::setPitchControl2 ( MusicInstrument  instrument,
int  value 
)

Sets the pitch control value

◆ setInversionControl2()

void Titanic::CMusicRoomHandler::setInversionControl2 ( MusicInstrument  instrument,
bool  value 
)

Sets the inversion control value

◆ setDirectionControl2()

void Titanic::CMusicRoomHandler::setDirectionControl2 ( MusicInstrument  instrument,
bool  value 
)

Sets the direction control value

◆ setPitchControl()

void Titanic::CMusicRoomHandler::setPitchControl ( MusicInstrument  instrument,
int  value 
)

Sets the pitch control value

◆ setSpeedControl()

void Titanic::CMusicRoomHandler::setSpeedControl ( MusicInstrument  instrument,
int  value 
)

Sets the speed control value

◆ setDirectionControl()

void Titanic::CMusicRoomHandler::setDirectionControl ( MusicInstrument  instrument,
bool  value 
)

Sets the direction control value

◆ setInversionControl()

void Titanic::CMusicRoomHandler::setInversionControl ( MusicInstrument  instrument,
bool  value 
)

Sets the inversion control value

◆ setMuteControl()

void Titanic::CMusicRoomHandler::setMuteControl ( MusicInstrument  instrument,
bool  value 
)

Sets the mute control value

◆ update()

bool Titanic::CMusicRoomHandler::update ( )

Handles regular updates

Returns
True if the music is still playing

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