stmm-games-doc  0.32.0
Public Member Functions | List of all members
stmg::ThemeSound Class Referenceabstract
Inheritance diagram for stmg::ThemeSound:
Inheritance graph
[legend]

Public Member Functions

virtual bool removeCapability (int32_t nCapabilityId) noexcept=0
 Signals playback capability removal. More...
 
virtual bool finishedSound (int32_t nCapabilityId, int32_t nSoundId) noexcept=0
 Signals playback sound finished. More...
 
virtual void stop () noexcept=0
 Stops the sound. More...
 
- Public Member Functions inherited from stmg::GameSound
virtual bool isFinished () noexcept=0
 Tells whether the sound has finished. More...
 
virtual void pause () noexcept=0
 Pause the sound. More...
 
virtual void resume () noexcept=0
 Resume the sound. More...
 
virtual void setPos (FPoint oXYPos, double fZ) noexcept=0
 Change sound position. More...
 
virtual void setVolume (double fVolume01) noexcept=0
 Set the volume. More...
 
virtual ~GameSound () noexcept=default
 

Member Function Documentation

◆ finishedSound()

virtual bool stmg::ThemeSound::finishedSound ( int32_t  nCapabilityId,
int32_t  nSoundId 
)
pure virtualnoexcept

Signals playback sound finished.

Parameters
nCapabilityIdThe id of the capability of the finished sound.
nSoundIdThe sound id of the finished (sub) sound.
Returns
Whether this theme sound is finished.

◆ removeCapability()

virtual bool stmg::ThemeSound::removeCapability ( int32_t  nCapabilityId)
pure virtualnoexcept

Signals playback capability removal.

Parameters
nCapabilityIdThe id of the capability being removed.
Returns
Whether this theme sound is finished.

◆ stop()

virtual void stmg::ThemeSound::stop ( )
pure virtualnoexcept

Stops the sound.

All sub-sounds are stopped. The reference to this instance can be reset after this call.