#include <TESObjectBOOK.h>

Inheritance diagram for RE::TESObjectBOOK:

Classes
struct	ChangeFlags

struct	RecordFlags

Public Member Functions
	~TESObjectBOOK () 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	Activate (TESObjectREFR a_targetRef, TESObjectREFR a_activatorRef, std::uint8_t a_arg3, TESBoundObject *a_object, std::int32_t a_targetCount) override

bool	GetActivateText (TESObjectREFR *a_activator, BSString &a_dst) override

BGSKeyword *	GetDefaultKeyword () const override

bool	TeachesSkill () const

bool	TeachesSpell () const

bool	IsRead () const

bool	CanBeTaken () const

bool	IsBookTome () const

bool	IsNoteScroll () const

ActorValue	GetSkill () const

SpellItem *	GetSpell ()

bool	Read (TESObjectREFR *a_reader)

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

NiAVObject *	Clone3D (TESObjectREFR *a_ref, bool a_arg3) override

bool	ReplaceModel () override

virtual void	SetObjectVoiceType (BGSVoiceType *a_voiceType)

virtual BGSVoiceType *	GetObjectVoiceType () const

virtual NiAVObject *	Clone3D (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 TESWaterForm *	GetWaterType () const

virtual bool	IsAutoCalc () const

virtual void	SetAutoCalc (bool a_autoCalc)

virtual NiAVObject *	Clone3D (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 NiAVObject *	LoadGraphics (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 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

FormID	GetRawFormID () const

FormID	GetLocalFormID () const

const char *	GetName () const

float	GetWeight () const

bool	HasKeywordInArray (const std::vector< BGSKeyword * > &a_keywords, bool a_matchAll) const

bool	HasKeywordInList (BGSListForm *a_keywordList, bool a_matchAll) 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	IsInventoryObject () const

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

TESModelTextureSwap *	GetAsModelTextureSwap () 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 TESModelTextureSwap *	GetAsModelTextureSwap ()

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

const char *	GetDefaultPath () const override

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

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

virtual std::uint32_t	GetMaxAllowedSize ()

virtual const char *	GetAsNormalFile (BSString &a_out) const

virtual const char *	GetDefaultPath () const

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

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

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

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

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

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

void	GetDescription (BSString &a_out, TESForm *a_parent, std::uint32_t a_fieldType='CSED')

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::BGSMessageIcon
	~BGSMessageIcon () override

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

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

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

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 BGSKeyword *	GetDefaultKeyword () const

bool	AddKeyword (BGSKeyword *a_keyword)

bool	AddKeywords (const std::vector< BGSKeyword * > &a_keywords)

bool	ContainsKeywordString (std::string_view a_editorID) const

void	ForEachKeyword (std::function< BSContainer::ForEachResult(BGSKeyword &)> a_callback) const

std::optional< BGSKeyword * >	GetKeywordAt (std::uint32_t a_idx) const

std::optional< std::uint32_t >	GetKeywordIndex (BGSKeyword *a_keyword) const

std::uint32_t	GetNumKeywords () const

bool	HasKeywordID (FormID a_formID) const

bool	HasKeywordString (std::string_view a_editorID) const

bool	RemoveKeyword (std::uint32_t a_index)

bool	RemoveKeyword (BGSKeyword *a_keyword)

bool	RemoveKeywords (const std::vector< RE::BGSKeyword * > &a_keywords)

std::span< BGSKeyword * >	GetKeywords ()

std::span< BGSKeyword *const >	GetKeywords () const

Public Attributes
OBJ_BOOK	data

TESObjectSTAT *	inventoryModel

TESDescription	itemCardDescription

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
AlternateTexture *	alternateTextures

std::uint32_t	numAlternateTextures

std::uint32_t	pad34

Public Attributes inherited from RE::TESModel
BSFixedString	model

BSResource::ID *	textures

std::uint32_t *	addons

std::uint16_t	numTextures

std::uint16_t	numAddons

std::uint32_t	pad24

Public Attributes inherited from RE::TESTexture
BSFixedString	textureName

Public Attributes inherited from RE::TESValueForm
std::int32_t	value

std::uint32_t	pad0C

Public Attributes inherited from RE::TESWeightForm
float	weight

std::uint32_t	pad0C

Public Attributes inherited from RE::TESDescription
std::uint32_t	fileOffset

BGSLocalizedStringDL	descriptionText

Public Attributes inherited from RE::BGSDestructibleObjectForm
DestructibleObjectData *	data

Public Attributes inherited from RE::BGSMessageIcon
TESIcon	icon

Public Attributes inherited from RE::BGSPickupPutdownSounds
BGSSoundDescriptorForm *	pickupSound

BGSSoundDescriptorForm *	putdownSound

Public Attributes inherited from RE::BGSKeywordForm
BGSKeyword **	keywords

std::uint32_t	numKeywords

std::uint32_t	pad14

Static Public Attributes
static constexpr auto	RTTI = RTTI_TESObjectBOOK

static constexpr auto	VTABLE = VTABLE_TESObjectBOOK

static constexpr auto	FORMTYPE = FormType::Book

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 constexpr auto	VTABLE = VTABLE_TESModel

Static Public Attributes inherited from RE::TESIcon
static constexpr auto	RTTI = RTTI_TESTexture

Static Public Attributes inherited from RE::TESTexture
static constexpr auto	RTTI = RTTI_TESTexture

Static Public Attributes inherited from RE::TESValueForm
static constexpr auto	RTTI = RTTI_TESValueForm

Static Public Attributes inherited from RE::TESWeightForm
static constexpr auto	RTTI = RTTI_TESWeightForm

Static Public Attributes inherited from RE::TESDescription
static constexpr auto	RTTI = RTTI_TESDescription

Static Public Attributes inherited from RE::BGSDestructibleObjectForm
static constexpr auto	RTTI = RTTI_BGSDestructibleObjectForm

Static Public Attributes inherited from RE::BGSMessageIcon
static constexpr auto	RTTI = RTTI_BGSMessageIcon

Static Public Attributes inherited from RE::BGSPickupPutdownSounds
static constexpr auto	RTTI = RTTI_BGSPickupPutdownSounds

Static Public Attributes inherited from RE::BGSKeywordForm
static constexpr auto	RTTI = RTTI_BGSKeywordForm

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 }

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

◆ ~TESObjectBOOK()

RE::TESObjectBOOK::~TESObjectBOOK ( )

override

Member Function Documentation

◆ Activate()

bool RE::TESObjectBOOK::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.

◆ CanBeTaken()

bool RE::TESObjectBOOK::CanBeTaken ( ) const

◆ ClearData()

void RE::TESObjectBOOK::ClearData ( )

overridevirtual

Reimplemented from RE::TESForm.

◆ GetActivateText()

bool RE::TESObjectBOOK::GetActivateText	(	TESObjectREFR *	a_activator,
		BSString &	a_dst
	)

overridevirtual

Reimplemented from RE::TESBoundObject.

◆ GetDefaultKeyword()

BGSKeyword * RE::TESObjectBOOK::GetDefaultKeyword ( ) const

overridevirtual

Reimplemented from RE::BGSKeywordForm.

◆ GetSkill()

ActorValue RE::TESObjectBOOK::GetSkill ( ) const

◆ GetSpell()

SpellItem * RE::TESObjectBOOK::GetSpell ( )

◆ InitializeData()

void RE::TESObjectBOOK::InitializeData ( )

overridevirtual

Reimplemented from RE::TESForm.

◆ InitItemImpl()

void RE::TESObjectBOOK::InitItemImpl ( )

overridevirtual

Reimplemented from RE::TESForm.

◆ IsBookTome()

bool RE::TESObjectBOOK::IsBookTome ( ) const

◆ IsNoteScroll()

bool RE::TESObjectBOOK::IsNoteScroll ( ) const

◆ IsRead()

bool RE::TESObjectBOOK::IsRead ( ) const

◆ Load()

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

overridevirtual

Reimplemented from RE::TESForm.

◆ LoadGame()

void RE::TESObjectBOOK::LoadGame ( BGSLoadFormBuffer * a_buf )

overridevirtual

Reimplemented from RE::TESForm.

◆ Read()

bool RE::TESObjectBOOK::Read ( TESObjectREFR * a_reader )

◆ SaveGame()

void RE::TESObjectBOOK::SaveGame ( BGSSaveFormBuffer * a_buf )

overridevirtual

Reimplemented from RE::TESForm.

◆ TeachesSkill()

bool RE::TESObjectBOOK::TeachesSkill ( ) const

◆ TeachesSpell()

bool RE::TESObjectBOOK::TeachesSpell ( ) const

Member Data Documentation

◆ data

OBJ_BOOK RE::TESObjectBOOK::data

◆ FORMTYPE

constexpr auto RE::TESObjectBOOK::FORMTYPE = FormType::Book

inlinestaticconstexpr

◆ inventoryModel

TESObjectSTAT* RE::TESObjectBOOK::inventoryModel

◆ itemCardDescription

TESDescription RE::TESObjectBOOK::itemCardDescription

◆ RTTI

constexpr auto RE::TESObjectBOOK::RTTI = RTTI_TESObjectBOOK

inlinestaticconstexpr

◆ VTABLE

constexpr auto RE::TESObjectBOOK::VTABLE = VTABLE_TESObjectBOOK

inlinestaticconstexpr

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

CommonLibSSE-NG/include/RE/T/TESObjectBOOK.h

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~TESObjectBOOK()

Member Function Documentation

◆ Activate()

◆ CanBeTaken()

◆ ClearData()

◆ GetActivateText()

◆ GetDefaultKeyword()

◆ GetSkill()

◆ GetSpell()

◆ InitializeData()

◆ InitItemImpl()

◆ IsBookTome()

◆ IsNoteScroll()

◆ IsRead()

◆ Load()

◆ LoadGame()

◆ Read()

◆ SaveGame()

◆ TeachesSkill()

◆ TeachesSpell()

Member Data Documentation

◆ data

◆ FORMTYPE

◆ inventoryModel

◆ itemCardDescription

◆ RTTI

◆ VTABLE