ScummVM API documentation
Ultima::Ultima8::CruMusicProcess Class Reference
Inheritance diagram for Ultima::Ultima8::CruMusicProcess:
Ultima::Ultima8::MusicProcess Ultima::Ultima8::Process

Public Member Functions

void playMusic (int track) override
 Play some background music. Does not change the current track if combat music is active. If another track is currently queued, just queues this track for play.
 
void playCombatMusic (int track) override
 Play some combat music - the last played track will be remembered.
 
void queueMusic (int track) override
 Queue a track to start once the current one finishes.
 
void unqueueMusic () override
 Clear any queued track (does not affect currently playing track)
 
void restoreMusic () override
 Restore the last requested non-combat track (eg, at the end of combat)
 
void fadeMusic (uint16 length) override
 Fading is not used, so this does nothing.
 
bool isFading () override
 Fading is not used, so this returns false.
 
void saveTrackState () override
 Save the current track state - used when the menu is opened.
 
void restoreTrackState () override
 Bring back the track state from before it was put on hold.
 
bool isPlaying () override
 Is a track currently playing?
 
void pauseMusic () override
 Pause the currently playing track.
 
void unpauseMusic () override
 Resume the current track after pausing.
 
void run () override
 
bool loadData (Common::ReadStream *rs, uint32 version)
 
void saveData (Common::WriteStream *ws) override
 save Process data
 
- Public Member Functions inherited from Ultima::Ultima8::MusicProcess
 INTRINSIC (I_playMusic)
 
 INTRINSIC (I_stopMusic)
 
 INTRINSIC (I_pauseMusic)
 
 INTRINSIC (I_unpauseMusic)
 
- Public Member Functions inherited from Ultima::Ultima8::Process
 Process (ObjId _itemNum=0, uint16 type=0)
 
uint32 getProcessFlags () const
 
bool is_active () const
 
bool is_terminated () const
 
bool is_suspended () const
 
void fail ()
 terminate the process and recursively fail all processes waiting for it
 
virtual void terminate ()
 terminate the process. This wakes up all processes waiting for it.
 
void terminateDeferred ()
 terminate next frame
 
void setRunPaused ()
 run even when paused
 
void waitFor (ProcId pid)
 suspend until process 'pid' returns. If pid is 0, suspend indefinitely
 
void waitFor (Process *proc)
 suspend until process returns. If proc is 0, suspend indefinitely
 
void suspend ()
 suspend process
 
void wakeUp (uint32 result)
 Wake up when the process we were waiting for has finished.
 
virtual void onWakeUp ()
 A hook to add aditional behavior on wakeup, before anything else happens.
 
void setItemNum (ObjId it)
 
void setType (uint16 ty)
 
void setTicksPerRun (uint32 val)
 
ProcId getPid () const
 
ObjId getItemNum () const
 
uint16 getType () const
 
uint32 getTicksPerRun () const
 
virtual Common::String dumpInfo () const
 dump some info about this process to a string
 
bool loadData (Common::ReadStream *rs, uint32 version)
 load Process data
 
bool validateWaiters () const
 

Protected Member Functions

void playMusic_internal (int track) override
 

Additional Inherited Members

- Public Types inherited from Ultima::Ultima8::Process
enum  processflags {
  PROC_ACTIVE = 0x0001, PROC_SUSPENDED = 0x0002, PROC_TERMINATED = 0x0004, PROC_TERM_DEFERRED = 0x0008,
  PROC_FAILED = 0x0010, PROC_RUNPAUSED = 0x0020, PROC_TERM_DISPOSE = 0x0040, PROC_PREVENT_SAVE = 0x0080
}
 
- Static Public Member Functions inherited from Ultima::Ultima8::MusicProcess
static MusicProcessget_instance ()
 Get the current instance of the Music Processes.
 
- Protected Attributes inherited from Ultima::Ultima8::Process
ProcId _pid
 process id
 
uint32 _flags
 
uint32 _ticksPerRun
 
ObjId _itemNum
 item we are assigned to
 
uint16 _type
 
uint32 _result
 process result
 
Std::vector< ProcId > _waiting
 
- Static Protected Attributes inherited from Ultima::Ultima8::MusicProcess
static MusicProcess_theMusicProcess
 

Member Function Documentation

◆ playMusic_internal()

void Ultima::Ultima8::CruMusicProcess::playMusic_internal ( int  track)
overrideprotectedvirtual

Play a music track

Parameters
trackThe track number to play. Pass 0 to stop music

Implements Ultima::Ultima8::MusicProcess.


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