CommonLibSSE (Parapets fork)
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
RE::BSIMusicTrack Class Referenceabstract

#include <BSIMusicTrack.h>

Inheritance diagram for RE::BSIMusicTrack:
RE::BGSMusicTrack RE::BGSMusicTrackFormWrapper RE::BGSMusicPaletteTrack RE::BGSMusicSilenceTrack RE::BGSMusicSingleTrack

Public Types

enum class  TrackType : std::uint32_t { kSilentTrack = 0xA1A9C4D5 , kSingleTrack = 0x6ED7E048 , kPalette = 0x23F678C3 }
 
enum class  MUSIC_STATUS {
  kInactive = 0 , kPlaying = 1 , kPaused = 2 , kFinishing = 3 ,
  kFinished = 4
}
 

Public Member Functions

virtual ~BSIMusicTrack ()
 
virtual void DoUpdate ()=0
 
virtual void DoPlay ()=0
 
virtual void DoPause ()=0
 
virtual void DoFinish (bool a_immediate, float a_fadeTime)=0
 
virtual float GetDurationImpl () const =0
 
virtual TrackType GetType () const =0
 
virtual bool TestCanPlay () const
 
virtual MUSIC_STATUS GetMusicStatus () const
 
virtual void DoSetDuckingAttenuation (std::uint16_t a_ducking)
 
virtual void DoClearDucking ()
 

Public Attributes

stl::enumeration< MUSIC_STATUS, std::uint32_t > trackStatus
 
std::uint32_t pad0C
 

Static Public Attributes

static constexpr auto RTTI = RTTI_BSIMusicTrack
 

Member Enumeration Documentation

◆ MUSIC_STATUS

enum RE::BSIMusicTrack::MUSIC_STATUS
strong
Enumerator
kInactive 
kPlaying 
kPaused 
kFinishing 
kFinished 

◆ TrackType

enum RE::BSIMusicTrack::TrackType : std::uint32_t
strong
Enumerator
kSilentTrack 
kSingleTrack 
kPalette 

Constructor & Destructor Documentation

◆ ~BSIMusicTrack()

virtual RE::BSIMusicTrack::~BSIMusicTrack ( )
virtual

Member Function Documentation

◆ DoClearDucking()

virtual void RE::BSIMusicTrack::DoClearDucking ( )
virtual

Reimplemented in RE::BGSMusicTrackFormWrapper, and RE::BGSMusicSingleTrack.

◆ DoFinish()

virtual void RE::BSIMusicTrack::DoFinish ( bool  a_immediate,
float  a_fadeTime 
)
pure virtual

Implemented in RE::BGSMusicTrackFormWrapper, RE::BGSMusicSingleTrack, RE::BGSMusicSilenceTrack, and RE::BGSMusicPaletteTrack.

◆ DoPause()

virtual void RE::BSIMusicTrack::DoPause ( )
pure virtual

Implemented in RE::BGSMusicTrackFormWrapper, RE::BGSMusicSingleTrack, RE::BGSMusicSilenceTrack, and RE::BGSMusicPaletteTrack.

◆ DoPlay()

virtual void RE::BSIMusicTrack::DoPlay ( )
pure virtual

Implemented in RE::BGSMusicTrackFormWrapper, RE::BGSMusicSingleTrack, RE::BGSMusicSilenceTrack, and RE::BGSMusicPaletteTrack.

◆ DoSetDuckingAttenuation()

virtual void RE::BSIMusicTrack::DoSetDuckingAttenuation ( std::uint16_t  a_ducking)
virtual

Reimplemented in RE::BGSMusicTrackFormWrapper, and RE::BGSMusicSingleTrack.

◆ DoUpdate()

virtual void RE::BSIMusicTrack::DoUpdate ( )
pure virtual

Implemented in RE::BGSMusicSilenceTrack, RE::BGSMusicTrackFormWrapper, RE::BGSMusicSingleTrack, and RE::BGSMusicPaletteTrack.

◆ GetDurationImpl()

virtual float RE::BSIMusicTrack::GetDurationImpl ( ) const
pure virtual

Implemented in RE::BGSMusicTrackFormWrapper, RE::BGSMusicSingleTrack, RE::BGSMusicSilenceTrack, and RE::BGSMusicPaletteTrack.

◆ GetMusicStatus()

virtual MUSIC_STATUS RE::BSIMusicTrack::GetMusicStatus ( ) const
virtual

Reimplemented in RE::BGSMusicTrackFormWrapper.

◆ GetType()

virtual TrackType RE::BSIMusicTrack::GetType ( ) const
pure virtual

Implemented in RE::BGSMusicTrackFormWrapper, RE::BGSMusicSingleTrack, RE::BGSMusicSilenceTrack, and RE::BGSMusicPaletteTrack.

◆ TestCanPlay()

virtual bool RE::BSIMusicTrack::TestCanPlay ( ) const
virtual

Reimplemented in RE::BGSMusicTrackFormWrapper, and RE::BGSMusicTrack.

Member Data Documentation

◆ pad0C

std::uint32_t RE::BSIMusicTrack::pad0C

◆ RTTI

constexpr auto RE::BSIMusicTrack::RTTI = RTTI_BSIMusicTrack
inlinestaticconstexpr

◆ trackStatus

stl::enumeration<MUSIC_STATUS, std::uint32_t> RE::BSIMusicTrack::trackStatus
The documentation for this class was generated from the following file: