#include <BGSMusicType.h>

Inheritance diagram for RE::BGSMusicType:

Classes
struct	RecordFlags

Public Member Functions
	~BGSMusicType () override

void	ClearData () override

bool	Load (TESFile *a_mod) override

void	InitItemImpl () override

const char *	GetFormEditorID () const override

bool	SetFormEditorID (const char *a_str) override

void	DoUpdate () override

void	DoPlay () override

void	DoPause () override

void	DoFinish (bool a_arg1) override

void	DoApplyDuckingAttenuation (std::uint16_t a_arg1) override

void	DoClearDucking () override

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

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>
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::BSIMusicType
virtual	~BSIMusicType ()

Public Attributes
BSFixedString	formEditorID

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::BSIMusicType
stl::enumeration< MST, std::uint32_t >	flags

std::uint8_t	priority

std::uint8_t	padding

std::uint16_t	ducksOtherMusicBy

float	fadeTime

std::uint32_t	currentTrackIndex

BSTArray< std::uint32_t >	trackHistory

BSTArray< BSIMusicTrack * >	tracks

stl::enumeration< MUSIC_STATUS, std::uint32_t >	typeStatus

std::uint32_t	pad4C

Static Public Attributes
static constexpr auto	RTTI = RTTI_BGSMusicType

static constexpr auto	FORMTYPE = FormType::MusicType

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::BSIMusicType
static constexpr auto	RTTI = RTTI_BSIMusicType

Additional Inherited Members
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 Types inherited from RE::BSIMusicType
enum class	MST { kNone = 0 , kPlaysOnce = 1 << 0 , kAbruptTransition = 1 << 1 , kCycleTracks = 1 << 2 , kUseTrackOrder = 1 << 3 , kRemovalQueued = 1 << 4 , kPlaysOver = 1 << 5 , kDoesntQueue = 1 << 6 }

enum class	MUSIC_STATUS { kInactive = 0 , kPlaying = 1 , kPaused = 2 , kFinishing = 3 , kFinished = 4 }

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)

Constructor & Destructor Documentation

◆ ~BGSMusicType()

RE::BGSMusicType::~BGSMusicType ( )

override

Member Function Documentation

◆ ClearData()

void RE::BGSMusicType::ClearData ( )

overridevirtual

Reimplemented from RE::TESForm.

◆ DoApplyDuckingAttenuation()

void RE::BGSMusicType::DoApplyDuckingAttenuation ( std::uint16_t a_arg1 )

overridevirtual

Reimplemented from RE::BSIMusicType.

◆ DoClearDucking()

void RE::BGSMusicType::DoClearDucking ( )

overridevirtual

Reimplemented from RE::BSIMusicType.

◆ DoFinish()

void RE::BGSMusicType::DoFinish ( bool a_arg1 )

overridevirtual

Implements RE::BSIMusicType.

◆ DoPause()

void RE::BGSMusicType::DoPause ( )

overridevirtual

Implements RE::BSIMusicType.

◆ DoPlay()

void RE::BGSMusicType::DoPlay ( )

overridevirtual

Implements RE::BSIMusicType.

◆ DoPrepare()

void RE::BGSMusicType::DoPrepare ( )

overridevirtual

Reimplemented from RE::BSIMusicType.

◆ DoUpdate()

void RE::BGSMusicType::DoUpdate ( )

overridevirtual

Implements RE::BSIMusicType.

◆ GetFormEditorID()

const char* RE::BGSMusicType::GetFormEditorID ( ) const

overridevirtual

Reimplemented from RE::TESForm.

◆ InitItemImpl()

void RE::BGSMusicType::InitItemImpl ( )

overridevirtual

Reimplemented from RE::TESForm.

◆ Load()

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

overridevirtual

Reimplemented from RE::TESForm.

◆ SetFormEditorID()

bool RE::BGSMusicType::SetFormEditorID ( const char * a_str )

overridevirtual

Reimplemented from RE::TESForm.

Member Data Documentation

◆ formEditorID

BSFixedString RE::BGSMusicType::formEditorID

◆ FORMTYPE

constexpr auto RE::BGSMusicType::FORMTYPE = FormType::MusicType

inlinestaticconstexpr

◆ RTTI

constexpr auto RE::BGSMusicType::RTTI = RTTI_BGSMusicType

inlinestaticconstexpr

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

CommonLibSSE/include/RE/B/BGSMusicType.h

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~BGSMusicType()

Member Function Documentation

◆ ClearData()

◆ DoApplyDuckingAttenuation()

◆ DoClearDucking()

◆ DoFinish()

◆ DoPause()

◆ DoPlay()

◆ DoPrepare()

◆ DoUpdate()

◆ GetFormEditorID()

◆ InitItemImpl()

◆ Load()

◆ SetFormEditorID()

Member Data Documentation

◆ formEditorID

◆ FORMTYPE

◆ RTTI