CommonLibSSE (Parapets fork)
Loading...
Searching...
No Matches
RE::TESFurniture Class Reference

#include <TESFurniture.h>

Inheritance diagram for RE::TESFurniture:
RE::TESObjectACTI RE::TESBoundAnimObject RE::TESFullName RE::TESModelTextureSwap RE::TESMagicTargetForm RE::BGSDestructibleObjectForm RE::BGSOpenCloseForm RE::BGSKeywordForm RE::TESBoundObject RE::BaseFormComponent RE::TESModel RE::BaseFormComponent RE::BaseFormComponent RE::TESObject RE::BaseFormComponent RE::TESForm RE::BaseFormComponent

Classes

struct  EntryPointData
 
struct  RecordFlags
 
struct  WorkBenchData
 

Public Types

enum class  ActiveMarker {
  kNone = 0 , kSit0 = 1 << 0 , kSit1 = 1 << 1 , kSit2 = 1 << 2 ,
  kSit3 = 1 << 3 , kSit4 = 1 << 4 , kSit5 = 1 << 5 , kSit6 = 1 << 6 ,
  kSit7 = 1 << 7 , kSit8 = 1 << 8 , kSit9 = 1 << 9 , kSit10 = 1 << 10 ,
  kSit11 = 1 << 11 , kSit12 = 1 << 12 , kSit13 = 1 << 13 , kSit14 = 1 << 14 ,
  kSit15 = 1 << 15 , kSit16 = 1 << 16 , kSit17 = 1 << 17 , kSit18 = 1 << 18 ,
  kSit19 = 1 << 19 , kSit20 = 1 << 20 , kSit21 = 1 << 21 , kSit22 = 1 << 22 ,
  kSit23 = 1 << 23 , kDisablesActivation = 1 << 25 , kIsPerch = 1 << 26 , kMustExitToTalk = 1 << 27
}
 
- Public Types inherited from RE::TESObjectACTI
enum class  ActiFlags {
  kNone = 0 , kNoDisplacement = 1 << 0 , kIgnoredBySandbox = 1 << 1 , kIsProceduralWater = 1 << 2 ,
  kIsLODWater = 1 << 3
}
 
- 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::BGSOpenCloseForm
enum class  OPEN_STATE {
  kNone = 0 , kOpen = 1 , kOpening = 2 , kClosed = 3 ,
  kClosing = 4
}
 

Public Member Functions

 ~TESFurniture () override
 
void InitializeData () override
 
void ClearData () override
 
bool Load (TESFile *a_mod) override
 
void InitItemImpl () override
 
bool Activate (TESObjectREFR *a_targetRef, TESObjectREFR *a_activatorRef, std::uint8_t a_arg3, TESBoundObject *a_object, std::int32_t a_targetCount) override
 
NiAVObjectClone3D (TESObjectREFR *a_ref) override
 
bool GetActivateText (TESObjectREFR *a_activator, BSString &a_dst) override
 
bool CalculateDoFavor (Actor *a_activator, bool a_arg2, TESObjectREFR *a_toActivate, float a_arg3) override
 
- Public Member Functions inherited from RE::TESObjectACTI
 ~TESObjectACTI () override
 
void InitializeData () override
 
void ClearData () override
 
bool Load (TESFile *a_mod) override
 
void SaveGame (BGSSaveFormBuffer *a_buf) override
 
void LoadGame (BGSLoadFormBuffer *a_buf) override
 
void InitItemImpl () override
 
bool GetIgnoredBySandbox () const override
 
bool IsWater () const override
 
bool Activate (TESObjectREFR *a_targetRef, TESObjectREFR *a_activatorRef, std::uint8_t a_arg3, TESBoundObject *a_object, std::int32_t a_targetCount) override
 
TESWaterFormGetWaterType () const override
 
bool GetActivateText (TESObjectREFR *a_activator, BSString &a_dst) override
 
bool CalculateDoFavor (Actor *a_activator, bool a_arg2, TESObjectREFR *a_toActivate, float a_arg3) override
 
- Public Member Functions inherited from RE::TESBoundAnimObject
 ~TESBoundAnimObject () override
 
bool IsBoundAnimObject () override
 
bool ReplaceModel (const char *a_str) override
 
- Public Member Functions inherited from RE::TESBoundObject
 ~TESBoundObject () override
 
void LoadObjectBound (TESFile *a_mod) override
 
bool IsBoundObject () const override
 
bool Activate (TESObjectREFR *a_targetRef, TESObjectREFR *a_activatorRef, std::uint8_t a_arg3, TESBoundObject *a_object, std::int32_t a_targetCount) override
 
NiAVObjectClone3D (TESObjectREFR *a_ref, bool a_arg3) override
 
bool ReplaceModel () override
 
virtual void SetObjectVoiceType (BGSVoiceType *a_voiceType)
 
virtual BGSVoiceTypeGetObjectVoiceType () const
 
virtual NiAVObjectClone3D (TESObjectREFR *a_ref)
 
virtual bool ReplaceModel (const char *a_str)
 
virtual bool GetActivateText (TESObjectREFR *a_activator, BSString &a_dst)
 
virtual bool CalculateDoFavor (Actor *a_activator, bool a_arg2, TESObjectREFR *a_toActivate, float a_arg3)
 
virtual void HandleRemoveItemFromContainer (TESObjectREFR *a_container)
 
virtual void OnRemove3D (NiAVObject *a_obj3D)
 
virtual void OnCheckModels ()
 
virtual void OnCopyReference ()
 
virtual void OnFinishScale ()
 
- Public Member Functions inherited from RE::TESObject
 ~TESObject () override
 
bool IsObject () const override
 
std::uint32_t GetRefCount () const override
 
virtual void Unk_3B (void)
 
virtual bool IsBoundAnimObject ()
 
virtual TESWaterFormGetWaterType () const
 
virtual bool IsAutoCalc () const
 
virtual void SetAutoCalc (bool a_autoCalc)
 
virtual NiAVObjectClone3D (TESObjectREFR *a_ref, bool a_arg3)
 
virtual void UnClone3D (TESObjectREFR *a_ref)
 
virtual bool IsMarker ()
 
virtual bool IsOcclusionMarker ()
 
virtual bool ReplaceModel ()
 
virtual std::uint32_t IncRef ()
 
virtual std::uint32_t DecRef ()
 
virtual NiAVObjectLoadGraphics (TESObjectREFR *a_ref)
 
- 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 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 void InitItemImpl ()
 
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 , 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
 
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>
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::TESModelTextureSwap
 ~TESModelTextureSwap () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
TESModelTextureSwapGetAsModelTextureSwap () override
 
- Public Member Functions inherited from RE::TESModel
 ~TESModel () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
virtual const char * GetModel () const
 
virtual void SetModel (const char *a_model)
 
virtual TESModelTextureSwapGetAsModelTextureSwap ()
 
- Public Member Functions inherited from RE::BGSDestructibleObjectForm
 ~BGSDestructibleObjectForm () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
- Public Member Functions inherited from RE::BGSOpenCloseForm
virtual ~BGSOpenCloseForm ()
 
virtual void HandleOpen (TESObjectREFR *a_target, TESObjectREFR *a_activator)
 
virtual void HandleClose (TESObjectREFR *a_target, TESObjectREFR *a_activator)
 
virtual void Unk_03 (void)
 
- Public Member Functions inherited from RE::BGSKeywordForm
 ~BGSKeywordForm () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
virtual bool HasKeyword (const BGSKeyword *a_keyword) const
 
virtual BGSKeywordGetDefaultKeyword () const
 
bool HasKeyword (FormID a_formID) const
 
std::optional< BGSKeyword * > GetKeywordAt (std::uint32_t a_idx) const
 
std::uint32_t GetNumKeywords () const
 

Public Attributes

BSTArray< EntryPointDataentryPointDataArray
 
WorkBenchData workBenchData
 
std::uint16_t padE2
 
stl::enumeration< ActiveMarker, std::uint32_t > furnFlags
 
SpellItemassociatedForm
 
- Public Attributes inherited from RE::TESObjectACTI
BGSSoundDescriptorFormsoundLoop
 
BGSSoundDescriptorFormsoundActivate
 
TESWaterFormwaterForm
 
stl::enumeration< ActiFlags, std::uint16_t > flags
 
std::uint16_t padC2
 
std::uint32_t padC4
 
- Public Attributes inherited from RE::TESBoundObject
BOUND_DATA boundData
 
std::uint32_t pad2C
 
- 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
 
- Public Attributes inherited from RE::TESModelTextureSwap
AlternateTexturealternateTextures
 
std::uint32_t numAlternateTextures
 
std::uint32_t pad34
 
- Public Attributes inherited from RE::TESModel
BSFixedString model
 
BSResource::IDtextures
 
std::uint32_t * addons
 
std::uint16_t numTextures
 
std::uint16_t numAddons
 
std::uint32_t pad24
 
- Public Attributes inherited from RE::BGSDestructibleObjectForm
DestructibleObjectDatadata
 
- Public Attributes inherited from RE::BGSKeywordForm
BGSKeyword ** keywords
 
std::uint32_t numKeywords
 
std::uint32_t pad14
 

Static Public Attributes

static constexpr auto RTTI = RTTI_TESFurniture
 
static constexpr auto FORMTYPE = FormType::Furniture
 
- Static Public Attributes inherited from RE::TESObjectACTI
static constexpr auto RTTI = RTTI_TESObjectACTI
 
static constexpr auto FORMTYPE = FormType::Activator
 
- Static Public Attributes inherited from RE::TESBoundAnimObject
static constexpr auto RTTI = RTTI_TESBoundAnimObject
 
- Static Public Attributes inherited from RE::TESBoundObject
static constexpr auto RTTI = RTTI_TESBoundObject
 
- Static Public Attributes inherited from RE::TESObject
static constexpr auto RTTI = RTTI_TESObject
 
- 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::TESModelTextureSwap
static constexpr auto RTTI = RTTI_TESModelTextureSwap
 
- Static Public Attributes inherited from RE::TESModel
static constexpr auto RTTI = RTTI_TESModel
 
- Static Public Attributes inherited from RE::TESMagicTargetForm
static constexpr auto RTTI = RTTI_TESMagicTargetForm
 
- Static Public Attributes inherited from RE::BGSDestructibleObjectForm
static constexpr auto RTTI = RTTI_BGSDestructibleObjectForm
 
- Static Public Attributes inherited from RE::BGSOpenCloseForm
static constexpr auto RTTI = RTTI_BGSOpenCloseForm
 
- Static Public Attributes inherited from RE::BGSKeywordForm
static constexpr auto RTTI = RTTI_BGSKeywordForm
 

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)
 
- Static Public Member Functions inherited from RE::BGSOpenCloseForm
static OPEN_STATE GetOpenState (const TESObjectREFR *a_ref)
 
static void SetOpenState (TESObjectREFR *a_ref, bool a_open, bool a_snap)
 

Member Enumeration Documentation

◆ ActiveMarker

enum class RE::TESFurniture::ActiveMarker
strong
Enumerator
kNone 
kSit0 
kSit1 
kSit2 
kSit3 
kSit4 
kSit5 
kSit6 
kSit7 
kSit8 
kSit9 
kSit10 
kSit11 
kSit12 
kSit13 
kSit14 
kSit15 
kSit16 
kSit17 
kSit18 
kSit19 
kSit20 
kSit21 
kSit22 
kSit23 
kDisablesActivation 
kIsPerch 
kMustExitToTalk 

Constructor & Destructor Documentation

◆ ~TESFurniture()

RE::TESFurniture::~TESFurniture ( )
override

Member Function Documentation

◆ Activate()

bool RE::TESFurniture::Activate ( TESObjectREFR a_targetRef,
TESObjectREFR a_activatorRef,
std::uint8_t  a_arg3,
TESBoundObject a_object,
std::int32_t  a_targetCount 
)
overridevirtual

Reimplemented from RE::TESBoundObject.

◆ CalculateDoFavor()

bool RE::TESFurniture::CalculateDoFavor ( Actor a_activator,
bool  a_arg2,
TESObjectREFR a_toActivate,
float  a_arg3 
)
overridevirtual

Reimplemented from RE::TESBoundObject.

◆ ClearData()

void RE::TESFurniture::ClearData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ Clone3D()

NiAVObject * RE::TESFurniture::Clone3D ( TESObjectREFR a_ref)
overridevirtual

Reimplemented from RE::TESBoundObject.

◆ GetActivateText()

bool RE::TESFurniture::GetActivateText ( TESObjectREFR a_activator,
BSString a_dst 
)
overridevirtual

Reimplemented from RE::TESBoundObject.

◆ InitializeData()

void RE::TESFurniture::InitializeData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ InitItemImpl()

void RE::TESFurniture::InitItemImpl ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ Load()

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

Reimplemented from RE::TESForm.

Member Data Documentation

◆ associatedForm

SpellItem* RE::TESFurniture::associatedForm

◆ entryPointDataArray

BSTArray<EntryPointData> RE::TESFurniture::entryPointDataArray

◆ FORMTYPE

constexpr auto RE::TESFurniture::FORMTYPE = FormType::Furniture
inlinestaticconstexpr

◆ furnFlags

stl::enumeration<ActiveMarker, std::uint32_t> RE::TESFurniture::furnFlags

◆ padE2

std::uint16_t RE::TESFurniture::padE2

◆ RTTI

constexpr auto RE::TESFurniture::RTTI = RTTI_TESFurniture
inlinestaticconstexpr

◆ workBenchData

WorkBenchData RE::TESFurniture::workBenchData

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