#include <BGSSoundCategory.h>

Inheritance diagram for RE::BGSSoundCategory:

Classes
struct	RecordFlags

Public Types
enum class	Flag { kNone = 0 , kMuteWhenSubmerged = 1 << 0 , kShouldAppearOnMenu = 1 << 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
	~BGSSoundCategory () override

void	InitializeData () override

bool	Load (TESFile *a_mod) override

void	InitItemImpl () override

bool	Matches (const BSISoundCategory *a_category) const override

float	GetCategoryVolume () const override

void	SetCategoryVolume (float a_value) override

float	GetCategoryFrequency () const override

void	SetCategoryFrequency (float a_value) override

std::uint16_t	GetCategoryAttenuation () const override

void	SetCategoryAttenuation (std::uint16_t a_value) override

float	GetDefaultMenuValue () const

float	GetStaticVolumeMultiplier () const

bool	IsMenuCategory () const

void	SetDefaultMenuValue (float a_val)

void	SetStaticVolumeMultiplier (float a_val)

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 void	ClearData ()

virtual bool	Load (TESFile *a_mod)

virtual bool	LoadPartial (TESFile *a_mod)

virtual bool	LoadEdit (TESFile *a_mod)

virtual TESForm *	CreateDuplicateForm (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 void	InitItemImpl ()

virtual TESFile *	GetDescriptionOwnerFile () 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 TESObjectREFR *	AsReference1 ()

virtual const TESObjectREFR *	AsReference2 () 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 , class = std::enable_if_t< std::negation_v< std::disjunction< std::is_pointer<T>, std::is_reference<T>, std::is_const<T>, std::is_volatile<T>>>>>
T *	As () noexcept

template<class T , class = std::enable_if_t< std::negation_v< std::disjunction< std::is_pointer<T>, std::is_reference<T>, std::is_const<T>, std::is_volatile<T>>>>>
const T *	As () const noexcept

TESObjectREFR *	AsReference ()

const TESObjectREFR *	AsReference () const

TESFile *	GetFile (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> requires (std::same_as<Args, FormType>&&...)
bool	Is (Args... a_args) const noexcept

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> requires (std::same_as<Args, FormType>&&...)
bool	IsNot (Args... a_args) const noexcept

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 ()

virtual void	InitializeDataComponent ()=0

virtual void	ClearDataComponent ()=0

virtual void	CopyComponent (BaseFormComponent *a_rhs)

	TES_HEAP_REDEFINE_NEW ()

Public Member Functions inherited from RE::TESFullName
	~TESFullName () override

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

virtual std::uint32_t	GetFullNameLength () const

virtual const char *	GetFullName () const

Public Member Functions inherited from RE::BSISoundCategory
virtual	~BSISoundCategory ()

virtual bool	Matches (const BSISoundCategory *a_category) const =0

virtual float	GetCategoryVolume () const =0

virtual void	SetCategoryVolume (float a_value)=0

virtual float	GetCategoryFrequency () const =0

virtual void	SetCategoryFrequency (float a_value)=0

virtual std::uint16_t	GetCategoryAttenuation () const =0

virtual void	SetCategoryAttenuation (std::uint16_t a_value)=0

virtual void	Unk_08 (void)=0

virtual void	Unk_09 (void)=0

virtual void	Unk_0A (void)=0

virtual void	Unk_0B (void)=0

Public Attributes
stl::enumeration< Flag, std::uint32_t >	flags

std::uint32_t	unk3C

BGSSoundCategory *	parentCategory

std::uint16_t	unk48

std::uint16_t	attenuation

std::uint16_t	staticMult

std::uint16_t	defaultMenuValue

float	volumeMult

float	frequencyMult

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

Public Attributes inherited from RE::TESFullName
BSFixedString	fullName

Static Public Attributes
static constexpr auto	RTTI = RTTI_BGSSoundCategory

static constexpr auto	FORMTYPE = FormType::SoundCategory

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::TESFullName
static constexpr auto	RTTI = RTTI_TESFullName

Static Public Attributes inherited from RE::BSISoundCategory
static constexpr auto	RTTI = RTTI_BSISoundCategory

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 TESForm *	LookupByID (FormID a_formID)

template<class T >
static T *	LookupByID (FormID a_formID)

static TESForm *	LookupByEditorID (const std::string_view &a_editorID)

template<class T >
static T *	LookupByEditorID (const std::string_view &a_editorID)

Member Enumeration Documentation

◆ Flag

enum class RE::BGSSoundCategory::Flag

strong

Enumerator
kNone
kMuteWhenSubmerged
kShouldAppearOnMenu

Constructor & Destructor Documentation

◆ ~BGSSoundCategory()

RE::BGSSoundCategory::~BGSSoundCategory ( )

override

Member Function Documentation

◆ GetCategoryAttenuation()

std::uint16_t RE::BGSSoundCategory::GetCategoryAttenuation ( ) const

overridevirtual

Implements RE::BSISoundCategory.

◆ GetCategoryFrequency()

float RE::BGSSoundCategory::GetCategoryFrequency ( ) const

overridevirtual

Implements RE::BSISoundCategory.

◆ GetCategoryVolume()

float RE::BGSSoundCategory::GetCategoryVolume ( ) const

overridevirtual

Implements RE::BSISoundCategory.

◆ GetDefaultMenuValue()

float RE::BGSSoundCategory::GetDefaultMenuValue ( ) const

◆ GetStaticVolumeMultiplier()

float RE::BGSSoundCategory::GetStaticVolumeMultiplier ( ) const

◆ InitializeData()

void RE::BGSSoundCategory::InitializeData ( )

overridevirtual

Reimplemented from RE::TESForm.

◆ InitItemImpl()

void RE::BGSSoundCategory::InitItemImpl ( )

overridevirtual

Reimplemented from RE::TESForm.

◆ IsMenuCategory()

bool RE::BGSSoundCategory::IsMenuCategory ( ) const

◆ Load()

bool RE::BGSSoundCategory::Load ( TESFile * a_mod )

overridevirtual

Reimplemented from RE::TESForm.

◆ Matches()

bool RE::BGSSoundCategory::Matches ( const BSISoundCategory * a_category ) const

overridevirtual

Implements RE::BSISoundCategory.

◆ SetCategoryAttenuation()

void RE::BGSSoundCategory::SetCategoryAttenuation ( std::uint16_t a_value )

overridevirtual

Implements RE::BSISoundCategory.

◆ SetCategoryFrequency()

void RE::BGSSoundCategory::SetCategoryFrequency ( float a_value )

overridevirtual

Implements RE::BSISoundCategory.

◆ SetCategoryVolume()

void RE::BGSSoundCategory::SetCategoryVolume ( float a_value )

overridevirtual

Implements RE::BSISoundCategory.

◆ SetDefaultMenuValue()

void RE::BGSSoundCategory::SetDefaultMenuValue ( float a_val )

◆ SetStaticVolumeMultiplier()

void RE::BGSSoundCategory::SetStaticVolumeMultiplier ( float a_val )

Member Data Documentation

◆ attenuation

std::uint16_t RE::BGSSoundCategory::attenuation

◆ defaultMenuValue

std::uint16_t RE::BGSSoundCategory::defaultMenuValue

◆ flags

stl::enumeration<Flag, std::uint32_t> RE::BGSSoundCategory::flags

◆ FORMTYPE

constexpr auto RE::BGSSoundCategory::FORMTYPE = FormType::SoundCategory

inlinestaticconstexpr

◆ frequencyMult

float RE::BGSSoundCategory::frequencyMult

◆ parentCategory

BGSSoundCategory* RE::BGSSoundCategory::parentCategory

◆ RTTI

constexpr auto RE::BGSSoundCategory::RTTI = RTTI_BGSSoundCategory

inlinestaticconstexpr

◆ staticMult

std::uint16_t RE::BGSSoundCategory::staticMult

◆ unk3C

std::uint32_t RE::BGSSoundCategory::unk3C

◆ unk48

std::uint16_t RE::BGSSoundCategory::unk48

◆ volumeMult

float RE::BGSSoundCategory::volumeMult

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

CommonLibSSE/include/RE/B/BGSSoundCategory.h

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ Flag

Constructor & Destructor Documentation

◆ ~BGSSoundCategory()

Member Function Documentation

◆ GetCategoryAttenuation()

◆ GetCategoryFrequency()

◆ GetCategoryVolume()

◆ GetDefaultMenuValue()

◆ GetStaticVolumeMultiplier()

◆ InitializeData()

◆ InitItemImpl()

◆ IsMenuCategory()

◆ Load()

◆ Matches()

◆ SetCategoryAttenuation()

◆ SetCategoryFrequency()

◆ SetCategoryVolume()

◆ SetDefaultMenuValue()

◆ SetStaticVolumeMultiplier()

Member Data Documentation

◆ attenuation

◆ defaultMenuValue

◆ flags

◆ FORMTYPE

◆ frequencyMult

◆ parentCategory

◆ RTTI

◆ staticMult

◆ unk3C

◆ unk48

◆ volumeMult