CommonLibSSE (Parapets fork)
RE::BGSSoundOutput Class Reference

#include <BGSSoundOutput.h>

Inheritance diagram for RE::BGSSoundOutput:
RE::TESForm RE::BSISoundOutputModel RE::BaseFormComponent

Classes

struct  Data
 
struct  DynamicAttenuationCharacteristics
 
struct  RecordFlags
 
struct  SpeakerArrays
 

Public Types

enum class  Type { kUsesHRTF = 0 , kDefinedSpeakerOutput = 1 }
 
- Public Types inherited from RE::TESForm
enum class  InGameFormFlag {
  kNone = 0 , kWantsDelete = 1 << 0 , kForcedPersistent = 1 << 1 , kNoFavorAllowed = 1 << 4 ,
  kIsSkyObject = 1 << 5 , kRefOriginalPersistent = 1 << 6 , kRefPermanentlyDeleted = 1 << 7
}
 

Public Member Functions

 ~BGSSoundOutput () override
 
void ClearData () override
 
bool Load (TESFile *a_mod) override
 
void InitItemImpl () override
 
bool DoGetUsesHRTF () const override
 
bool DoGetHasSpeakerBias () const override
 
bool DoGetSpeakerBias (std::uint32_t a_arg1, std::uint32_t a_arg2, float(&a_arg3)[8]) const override
 
bool DoGetAttenuatesWithDistance () const override
 
bool DoGetAudibility (float a_distance) const override
 
std::uint32_t DoGetSupportedInputChannels () const override
 
const BSIAttenuationCharacteristicsDoGetAttenuation () const override
 
float DoGetReverbSendLevel () const override
 
bool DoGetSupportsMonitor (std::uint32_t a_arg1) const override
 
- Public Member Functions inherited from RE::TESForm
 ~TESForm () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
virtual void InitializeData ()
 
virtual bool LoadPartial (TESFile *a_mod)
 
virtual bool LoadEdit (TESFile *a_mod)
 
virtual TESFormCreateDuplicateForm (bool a_createEditorID, void *a_arg2)
 
virtual bool AddChange (std::uint32_t a_changeFlags)
 
virtual void RemoveChange (std::uint32_t a_changeFlags)
 
virtual bool FindInFileFast (TESFile *a_mod)
 
virtual bool CheckSaveGame (BGSSaveFormBuffer *a_buf)
 
virtual void SaveGame (BGSSaveFormBuffer *a_buf)
 
virtual void LoadGame (BGSLoadFormBuffer *a_buf)
 
virtual void InitLoadGame (BGSLoadFormBuffer *a_buf)
 
virtual void FinishLoadGame (BGSLoadFormBuffer *a_buf)
 
virtual void Revert (BGSLoadFormBuffer *a_buf)
 
virtual TESFileGetDescriptionOwnerFile () const
 
virtual FormType GetSavedFormType () const
 
virtual void GetFormDetailedString (char *a_buf, std::uint32_t a_bufLen)
 
virtual bool GetKnown () const
 
virtual bool GetRandomAnim () const
 
virtual bool GetPlayable () const
 
virtual bool IsHeadingMarker () const
 
virtual bool GetDangerous () const
 
virtual bool QHasCurrents () const
 
virtual bool GetObstacle () const
 
virtual bool QIsLODLandObject () const
 
virtual bool GetOnLocalMap () const
 
virtual bool GetMustUpdate () const
 
virtual void SetOnLocalMap (bool a_set)
 
virtual bool GetIgnoredBySandbox () const
 
virtual void SetDelete (bool a_set)
 
virtual void SetAltered (bool a_set)
 
virtual void SaveObjectBound ()
 
virtual void LoadObjectBound (TESFile *a_mod)
 
virtual bool IsBoundObject () const
 
virtual bool IsObject () const
 
virtual bool IsMagicItem () const
 
virtual bool IsWater () const
 
virtual TESObjectREFRAsReference1 ()
 
virtual const TESObjectREFRAsReference2 () const
 
virtual std::uint32_t GetRefCount () const
 
virtual const char * GetTextForParsedSubTag (const BSFixedString &a_tag) const
 
virtual void Copy (TESForm *a_srcForm)
 
virtual bool BelongsInGroup (FORM *a_form, bool a_allowParentGroups, bool a_currentOnly)
 
virtual void CreateGroupData (FORM *a_form, FORM_GROUP *a_group)
 
virtual const char * GetFormEditorID () const
 
virtual bool SetFormEditorID (const char *a_str)
 
virtual bool IsParentForm ()
 
virtual bool IsParentFormTree ()
 
virtual bool IsFormTypeChild (FormType a_type)
 
virtual bool Activate (TESObjectREFR *a_targetRef, TESObjectREFR *a_activatorRef, std::uint8_t a_arg3, TESBoundObject *a_object, std::int32_t a_targetCount)
 
virtual void SetFormID (FormID a_id, bool a_updateFile)
 
virtual const char * GetObjectTypeName () const
 
virtual bool QAvailableInGame () const
 
template<class T >
 requires (std::is_class_v< T >) T *As() noexcept
 
template<class T >
 requires (requires { T::FORMTYPE;}) const T *As() const noexcept
 
template<class T >
 requires (!requires { T::FORMTYPE;}) const T *As() const noexcept
 
TESObjectREFRAsReference ()
 
const TESObjectREFRAsReference () const
 
TESFileGetFile (std::int32_t a_idx=-1) const
 
std::uint32_t GetFormFlags () const noexcept
 
FormID GetFormID () const noexcept
 
FormType GetFormType () const noexcept
 
std::int32_t GetGoldValue () const
 
const char * GetName () const
 
float GetWeight () const
 
bool HasVMAD () const
 
bool HasWorldModel () const noexcept
 
void InitItem ()
 
bool Is (FormType a_type) const noexcept
 
template<class... Args>
bool Is (Args... a_args) const noexcept requires(std
 
bool IsAmmo () const noexcept
 
bool IsArmor () const noexcept
 
bool IsBook () const noexcept
 
bool IsDeleted () const noexcept
 
bool IsDynamicForm () const noexcept
 
bool IsGold () const noexcept
 
bool IsIgnored () const noexcept
 
bool IsInitialized () const noexcept
 
bool IsKey () const noexcept
 
bool IsLockpick () const noexcept
 
bool IsNot (FormType a_type) const noexcept
 
template<class... Args>
bool IsNot (Args... a_args) const noexcept requires(std
 
bool IsNote () const noexcept
 
bool IsPlayer () const noexcept
 
bool IsPlayerRef () const noexcept
 
bool IsSoulGem () const noexcept
 
bool IsWeapon () const noexcept
 
- Public Member Functions inherited from RE::BaseFormComponent
virtual ~BaseFormComponent ()
 
 TES_HEAP_REDEFINE_NEW ()
 
- Public Member Functions inherited from RE::BSISoundOutputModel
virtual ~BSISoundOutputModel ()
 

Public Attributes

Data data
 
stl::enumeration< Type, std::uint32_t > type
 
DynamicAttenuationCharacteristicsattenuation
 
SpeakerArraysspeakerOutputs
 
- Public Attributes inherited from RE::TESForm
TESFileContainer sourceFiles
 
std::uint32_t formFlags
 
FormID formID
 
stl::enumeration< InGameFormFlag, std::uint16_t > inGameFormFlags
 
stl::enumeration< FormType, std::uint8_t > formType
 
std::uint8_t pad1B
 
std::uint32_t pad1C
 

Static Public Attributes

static constexpr auto RTTI = RTTI_BGSSoundOutput
 
static constexpr auto FORMTYPE = FormType::SoundOutputModel
 
- Static Public Attributes inherited from RE::TESForm
static constexpr auto RTTI = RTTI_TESForm
 
static constexpr auto FORMTYPE = FormType::None
 
- Static Public Attributes inherited from RE::BaseFormComponent
static constexpr auto RTTI = RTTI_BaseFormComponent
 
- Static Public Attributes inherited from RE::BSISoundOutputModel
static constexpr auto RTTI = RTTI_BSISoundOutputModel
 

Additional Inherited Members

- Static Public Member Functions inherited from RE::TESForm
static void AddCompileIndex (FormID &a_id, TESFile *a_file)
 
static auto GetAllForms () -> std::pair< BSTHashMap< FormID, TESForm * > *, std::reference_wrapper< BSReadWriteLock >>
 
static auto GetAllFormsByEditorID () -> std::pair< BSTHashMap< BSFixedString, TESForm * > *, std::reference_wrapper< BSReadWriteLock >>
 
static TESFormLookupByID (FormID a_formID)
 
template<class T >
static T * LookupByID (FormID a_formID)
 
static TESFormLookupByEditorID (const std::string_view &a_editorID)
 
template<class T >
static T * LookupByEditorID (const std::string_view &a_editorID)
 

Member Enumeration Documentation

◆ Type

Enumerator
kUsesHRTF 
kDefinedSpeakerOutput 

Constructor & Destructor Documentation

◆ ~BGSSoundOutput()

RE::BGSSoundOutput::~BGSSoundOutput ( )
override

Member Function Documentation

◆ ClearData()

void RE::BGSSoundOutput::ClearData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ DoGetAttenuatesWithDistance()

bool RE::BGSSoundOutput::DoGetAttenuatesWithDistance ( ) const
overridevirtual

◆ DoGetAttenuation()

const BSIAttenuationCharacteristics* RE::BGSSoundOutput::DoGetAttenuation ( ) const
overridevirtual

◆ DoGetAudibility()

bool RE::BGSSoundOutput::DoGetAudibility ( float  a_distance) const
overridevirtual

◆ DoGetHasSpeakerBias()

bool RE::BGSSoundOutput::DoGetHasSpeakerBias ( ) const
overridevirtual

◆ DoGetReverbSendLevel()

float RE::BGSSoundOutput::DoGetReverbSendLevel ( ) const
overridevirtual

◆ DoGetSpeakerBias()

bool RE::BGSSoundOutput::DoGetSpeakerBias ( std::uint32_t  a_arg1,
std::uint32_t  a_arg2,
float(&)  a_arg3[8] 
) const
overridevirtual

◆ DoGetSupportedInputChannels()

std::uint32_t RE::BGSSoundOutput::DoGetSupportedInputChannels ( ) const
overridevirtual

◆ DoGetSupportsMonitor()

bool RE::BGSSoundOutput::DoGetSupportsMonitor ( std::uint32_t  a_arg1) const
overridevirtual

◆ DoGetUsesHRTF()

bool RE::BGSSoundOutput::DoGetUsesHRTF ( ) const
overridevirtual

◆ InitItemImpl()

void RE::BGSSoundOutput::InitItemImpl ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ Load()

bool RE::BGSSoundOutput::Load ( TESFile a_mod)
overridevirtual

Reimplemented from RE::TESForm.

Member Data Documentation

◆ attenuation

DynamicAttenuationCharacteristics* RE::BGSSoundOutput::attenuation

◆ data

Data RE::BGSSoundOutput::data

◆ FORMTYPE

constexpr auto RE::BGSSoundOutput::FORMTYPE = FormType::SoundOutputModel
inlinestaticconstexpr

◆ RTTI

constexpr auto RE::BGSSoundOutput::RTTI = RTTI_BGSSoundOutput
inlinestaticconstexpr

◆ speakerOutputs

SpeakerArrays* RE::BGSSoundOutput::speakerOutputs

◆ type

stl::enumeration<Type, std::uint32_t> RE::BGSSoundOutput::type

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