CommonLibSSE (Parapets fork)
RE::BSGameSound Class Referenceabstract

#include <BSGameSound.h>

Inheritance diagram for RE::BSGameSound:
RE::BSXAudio2GameSound

Public Types

enum class  Flags {
  HasBeenOpened = 1 << 0 , IsSoundFinished = 1 << 4 , IsPlaying = 1 << 5 , IsPaused = 1 << 6 ,
  IsValid = 1 << 8 , IsPlayable = 1 << 11 , IsOpening = 1 << 12 , IsValidBeam = 1 << 15 ,
  IsAsyncOpening = 1 << 18 , IsInDecay = 1 << 19 , PositionSet = 1 << 20
}
 
enum class  SoundType { Music = 1 << 5 }
 
using UnkCallbackFunc = void(void *, std::uint32_t)
 

Public Member Functions

virtual void OutputModelChangedImpl ()
 
virtual ~BSGameSound ()
 
virtual bool IsSoundFinished () const
 
virtual void SetSoundFinished (bool a_set)
 
virtual std::uint32_t GetCurrentPlaybackPosition () const =0
 
virtual bool PriorityTest (const BSGameSound *a_other) const
 
virtual bool SyncOpen ()=0
 
virtual bool StartAsyncOpen ()=0
 
virtual bool TestAsyncOpenReady ()=0
 
virtual bool FinishAsyncOpen ()=0
 
virtual bool HandleExternalOpen ()=0
 
virtual bool Prepare ()
 
virtual void Copy (BSGameSound *a_other, bool a_updateImpl)
 
virtual void UpdateEmitterPosition ()=0
 
virtual bool Update ()
 
virtual void SetEmitterPositionImpl (const NiPoint3 &a_position)=0
 
virtual void GetEmitterPositionImpl (NiPoint3 &a_position) const =0
 
virtual void Unk_11 (float a_arg1, float a_arg2)=0
 
virtual void SetAttenuationCurve (std::uint16_t a_val1, std::uint16_t a_val2, std::uint16_t a_val3, std::uint16_t a_val4, std::uint16_t a_val5)=0
 
virtual void DoApplyFrequency ()
 
virtual void Seek (std::uint32_t a_milliseconds)=0
 
virtual void PlayImpl ()=0
 
virtual void PauseImpl ()=0
 
virtual void StopImpl ()=0
 
virtual void SetVolumeImpl ()=0
 
 TES_HEAP_REDEFINE_NEW ()
 
void SetOutputModel (BSISoundOutputModel *a_outputModel)
 
void SetVolume (float a_volume)
 
constexpr float GetFrequency () const noexcept
 
constexpr bool HasBeenOpened () const noexcept
 
constexpr bool IsAsyncOpening () const noexcept
 
constexpr bool IsInDecay () const noexcept
 
constexpr bool IsOpening () const noexcept
 
constexpr bool IsMusic () const noexcept
 
constexpr bool IsPaused () const noexcept
 
constexpr bool IsPlayable () const noexcept
 
constexpr bool IsPlaying () const noexcept
 
constexpr bool IsValid () const noexcept
 
constexpr bool IsValidBeam () const noexcept
 
constexpr const BSISoundCategoryQCategory () const noexcept
 
constexpr bool QPositionSet () const noexcept
 

Public Attributes

BSTSmallArray< BSAudioMonitor::Request, 2 > requests
 
NiPoint3 beamEnd
 
std::byte pad2C [4]
 
SoundMessageList soundMessageList
 
BSResource::ID resourceID
 
std::uint32_t unk4C
 
stl::enumeration< SoundType, std::uint32_t > soundType
 
std::uint32_t unk54
 
std::uint32_t unk58
 
stl::enumeration< Flags, std::uint32_t > flags
 
std::uint32_t durationMilliseconds
 
std::uint16_t staticAttenuation
 
std::uint16_t unk66
 
std::uint16_t systemAttenuation
 
std::uint16_t unk6A
 
std::uint16_t unk6C
 
std::byte pad6E [2]
 
float volume
 
float unk74
 
float unk78
 
std::uint32_t unk7C
 
float listenerDistance
 
std::uint32_t unk84
 
std::uint64_t unk88
 
UnkCallbackFuncunk90
 
std::uint64_t unk98
 
std::uint64_t unkA0
 
std::uint32_t priority
 
std::uint32_t unkAC
 
BSISoundCategorycategory
 
BSISoundOutputModeloutputModel
 
std::uint8_t frequency
 
std::uint8_t freqVariance
 
std::byte padC2 [6]
 

Static Public Attributes

static constexpr auto RTTI = RTTI_BSGameSound
 

Member Typedef Documentation

◆ UnkCallbackFunc

using RE::BSGameSound::UnkCallbackFunc = void(void*, std::uint32_t)

Member Enumeration Documentation

◆ Flags

Enumerator
HasBeenOpened 
IsSoundFinished 
IsPlaying 
IsPaused 
IsValid 
IsPlayable 
IsOpening 
IsValidBeam 
IsAsyncOpening 
IsInDecay 
PositionSet 

◆ SoundType

Enumerator
Music 

Constructor & Destructor Documentation

◆ ~BSGameSound()

virtual RE::BSGameSound::~BSGameSound ( )
virtual

Member Function Documentation

◆ Copy()

virtual void RE::BSGameSound::Copy ( BSGameSound a_other,
bool  a_updateImpl 
)
virtual

Reimplemented in RE::BSXAudio2GameSound.

◆ DoApplyFrequency()

virtual void RE::BSGameSound::DoApplyFrequency ( )
virtual

Reimplemented in RE::BSXAudio2GameSound.

◆ FinishAsyncOpen()

virtual bool RE::BSGameSound::FinishAsyncOpen ( )
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ GetCurrentPlaybackPosition()

virtual std::uint32_t RE::BSGameSound::GetCurrentPlaybackPosition ( ) const
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ GetEmitterPositionImpl()

virtual void RE::BSGameSound::GetEmitterPositionImpl ( NiPoint3 a_position) const
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ GetFrequency()

constexpr float RE::BSGameSound::GetFrequency ( ) const
inlineconstexprnoexcept

◆ HandleExternalOpen()

virtual bool RE::BSGameSound::HandleExternalOpen ( )
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ HasBeenOpened()

constexpr bool RE::BSGameSound::HasBeenOpened ( ) const
inlineconstexprnoexcept

◆ IsAsyncOpening()

constexpr bool RE::BSGameSound::IsAsyncOpening ( ) const
inlineconstexprnoexcept

◆ IsInDecay()

constexpr bool RE::BSGameSound::IsInDecay ( ) const
inlineconstexprnoexcept

◆ IsMusic()

constexpr bool RE::BSGameSound::IsMusic ( ) const
inlineconstexprnoexcept

◆ IsOpening()

constexpr bool RE::BSGameSound::IsOpening ( ) const
inlineconstexprnoexcept

◆ IsPaused()

constexpr bool RE::BSGameSound::IsPaused ( ) const
inlineconstexprnoexcept

◆ IsPlayable()

constexpr bool RE::BSGameSound::IsPlayable ( ) const
inlineconstexprnoexcept

◆ IsPlaying()

constexpr bool RE::BSGameSound::IsPlaying ( ) const
inlineconstexprnoexcept

◆ IsSoundFinished()

virtual bool RE::BSGameSound::IsSoundFinished ( ) const
virtual

◆ IsValid()

constexpr bool RE::BSGameSound::IsValid ( ) const
inlineconstexprnoexcept

◆ IsValidBeam()

constexpr bool RE::BSGameSound::IsValidBeam ( ) const
inlineconstexprnoexcept

◆ OutputModelChangedImpl()

virtual void RE::BSGameSound::OutputModelChangedImpl ( )
virtual

Reimplemented in RE::BSXAudio2GameSound.

◆ PauseImpl()

virtual void RE::BSGameSound::PauseImpl ( )
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ PlayImpl()

virtual void RE::BSGameSound::PlayImpl ( )
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ Prepare()

virtual bool RE::BSGameSound::Prepare ( )
virtual

Reimplemented in RE::BSXAudio2GameSound.

◆ PriorityTest()

virtual bool RE::BSGameSound::PriorityTest ( const BSGameSound a_other) const
virtual

◆ QCategory()

constexpr const BSISoundCategory* RE::BSGameSound::QCategory ( ) const
inlineconstexprnoexcept

◆ QPositionSet()

constexpr bool RE::BSGameSound::QPositionSet ( ) const
inlineconstexprnoexcept

◆ Seek()

virtual void RE::BSGameSound::Seek ( std::uint32_t  a_milliseconds)
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ SetAttenuationCurve()

virtual void RE::BSGameSound::SetAttenuationCurve ( std::uint16_t  a_val1,
std::uint16_t  a_val2,
std::uint16_t  a_val3,
std::uint16_t  a_val4,
std::uint16_t  a_val5 
)
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ SetEmitterPositionImpl()

virtual void RE::BSGameSound::SetEmitterPositionImpl ( const NiPoint3 a_position)
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ SetOutputModel()

void RE::BSGameSound::SetOutputModel ( BSISoundOutputModel a_outputModel)

◆ SetSoundFinished()

virtual void RE::BSGameSound::SetSoundFinished ( bool  a_set)
virtual

◆ SetVolume()

void RE::BSGameSound::SetVolume ( float  a_volume)

◆ SetVolumeImpl()

virtual void RE::BSGameSound::SetVolumeImpl ( )
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ StartAsyncOpen()

virtual bool RE::BSGameSound::StartAsyncOpen ( )
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ StopImpl()

virtual void RE::BSGameSound::StopImpl ( )
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ SyncOpen()

virtual bool RE::BSGameSound::SyncOpen ( )
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ TES_HEAP_REDEFINE_NEW()

RE::BSGameSound::TES_HEAP_REDEFINE_NEW ( )

◆ TestAsyncOpenReady()

virtual bool RE::BSGameSound::TestAsyncOpenReady ( )
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ Unk_11()

virtual void RE::BSGameSound::Unk_11 ( float  a_arg1,
float  a_arg2 
)
pure virtual

Implemented in RE::BSXAudio2GameSound.

◆ Update()

virtual bool RE::BSGameSound::Update ( )
virtual

Reimplemented in RE::BSXAudio2GameSound.

◆ UpdateEmitterPosition()

virtual void RE::BSGameSound::UpdateEmitterPosition ( )
pure virtual

Implemented in RE::BSXAudio2GameSound.

Member Data Documentation

◆ beamEnd

NiPoint3 RE::BSGameSound::beamEnd

◆ category

BSISoundCategory* RE::BSGameSound::category

◆ durationMilliseconds

std::uint32_t RE::BSGameSound::durationMilliseconds

◆ flags

stl::enumeration<Flags, std::uint32_t> RE::BSGameSound::flags

◆ frequency

std::uint8_t RE::BSGameSound::frequency

◆ freqVariance

std::uint8_t RE::BSGameSound::freqVariance

◆ listenerDistance

float RE::BSGameSound::listenerDistance

◆ outputModel

BSISoundOutputModel* RE::BSGameSound::outputModel

◆ pad2C

std::byte RE::BSGameSound::pad2C[4]

◆ pad6E

std::byte RE::BSGameSound::pad6E[2]

◆ padC2

std::byte RE::BSGameSound::padC2[6]

◆ priority

std::uint32_t RE::BSGameSound::priority

◆ requests

BSTSmallArray<BSAudioMonitor::Request, 2> RE::BSGameSound::requests

◆ resourceID

BSResource::ID RE::BSGameSound::resourceID

◆ RTTI

constexpr auto RE::BSGameSound::RTTI = RTTI_BSGameSound
inlinestaticconstexpr

◆ soundMessageList

SoundMessageList RE::BSGameSound::soundMessageList

◆ soundType

stl::enumeration<SoundType, std::uint32_t> RE::BSGameSound::soundType

◆ staticAttenuation

std::uint16_t RE::BSGameSound::staticAttenuation

◆ systemAttenuation

std::uint16_t RE::BSGameSound::systemAttenuation

◆ unk4C

std::uint32_t RE::BSGameSound::unk4C

◆ unk54

std::uint32_t RE::BSGameSound::unk54

◆ unk58

std::uint32_t RE::BSGameSound::unk58

◆ unk66

std::uint16_t RE::BSGameSound::unk66

◆ unk6A

std::uint16_t RE::BSGameSound::unk6A

◆ unk6C

std::uint16_t RE::BSGameSound::unk6C

◆ unk74

float RE::BSGameSound::unk74

◆ unk78

float RE::BSGameSound::unk78

◆ unk7C

std::uint32_t RE::BSGameSound::unk7C

◆ unk84

std::uint32_t RE::BSGameSound::unk84

◆ unk88

std::uint64_t RE::BSGameSound::unk88

◆ unk90

UnkCallbackFunc* RE::BSGameSound::unk90

◆ unk98

std::uint64_t RE::BSGameSound::unk98

◆ unkA0

std::uint64_t RE::BSGameSound::unkA0

◆ unkAC

std::uint32_t RE::BSGameSound::unkAC

◆ volume

float RE::BSGameSound::volume

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