RE::TESForm Class Reference

#include <TESForm.h>

Inheritance diagram for RE::TESForm:

Classes
struct	ChangeFlags
struct	RecordFlags

Public Types
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
	~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 ()

Static Public Member Functions
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)

Public Attributes
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_TESForm
static constexpr auto	FORMTYPE = FormType::None
Static Public Attributes inherited from RE::BaseFormComponent
static constexpr auto	RTTI = RTTI_BaseFormComponent

Member Enumeration Documentation

InGameFormFlag

enum class RE::TESForm::InGameFormFlag

strong

Enumerator
kNone
kWantsDelete
kForcedPersistent
kNoFavorAllowed
kIsSkyObject
kRefOriginalPersistent
kRefPermanentlyDeleted

Constructor & Destructor Documentation

~TESForm()

RE::TESForm::~TESForm ( )

override

Member Function Documentation

Activate()

virtual bool RE::TESForm::Activate ( TESObjectREFR *  a_targetRef, TESObjectREFR *  a_activatorRef, std::uint8_t  a_arg3, TESBoundObject *  a_object, std::int32_t  a_targetCount  )

virtual

Reimplemented in RE::BGSTalkingActivator, RE::BGSNote, RE::BGSProjectile, RE::TESBoundObject, RE::TESFlora, RE::TESFurniture, RE::TESNPC, RE::TESObjectACTI, RE::TESObjectBOOK, RE::TESObjectCONT, RE::TESObjectDOOR, RE::TESObjectLIGH, RE::TESObjectTREE, and RE::TESWaterForm.

AddChange()

virtual bool RE::TESForm::AddChange ( std::uint32_t  a_changeFlags )

virtual

Reimplemented in RE::TESActorBase.

AddCompileIndex()

static void RE::TESForm::AddCompileIndex ( FormID &  a_id, TESFile *  a_file  )

inlinestatic

As() [1/2]

template<class T , class >

const T * RE::TESForm::As

noexcept

As() [2/2]

template<class T , class >

T * RE::TESForm::As

noexcept

AsReference() [1/2]

TESObjectREFR * RE::TESForm::AsReference ( )

inline

AsReference() [2/2]

const TESObjectREFR * RE::TESForm::AsReference ( ) const

inline

AsReference1()

virtual TESObjectREFR * RE::TESForm::AsReference1 ( )

virtual

Reimplemented in RE::TESObjectREFR.

AsReference2()

virtual const TESObjectREFR * RE::TESForm::AsReference2 ( ) const

virtual

Reimplemented in RE::TESObjectREFR.

BelongsInGroup()

virtual bool RE::TESForm::BelongsInGroup ( FORM *  a_form, bool  a_allowParentGroups, bool  a_currentOnly  )

virtual

Reimplemented in RE::NavMesh, RE::TESObjectCELL, RE::TESObjectLAND, RE::TESObjectREFR, and RE::TESTopicInfo.

CheckSaveGame()

virtual bool RE::TESForm::CheckSaveGame ( BGSSaveFormBuffer *  a_buf )

virtual

Reimplemented in RE::TESObjectREFR.

ClearData()

virtual void RE::TESForm::ClearData ( )

virtual

Reimplemented in RE::ActorValueInfo, RE::AlchemyItem, RE::BGSBodyPartData, RE::BGSCameraPath, RE::BGSCollisionLayer, RE::BGSColorForm, RE::BGSConstructibleObject, RE::BGSDebris, RE::BGSDialogueBranch, RE::BGSEquipSlot, RE::BGSHeadPart, RE::BGSImpactDataSet, RE::BGSLensFlare, RE::BGSListForm, RE::BGSMaterialObject, RE::BGSMaterialType, RE::BGSMessage, RE::BGSMusicTrackFormWrapper, RE::BGSMusicType, RE::BGSNote, RE::BGSOutfit, RE::BGSPerk, RE::BGSProjectile, RE::BGSRagdoll, RE::BGSReferenceEffect, RE::BGSShaderParticleGeometryData, RE::BGSSoundDescriptorForm, RE::BGSSoundOutput, RE::BGSStaticCollection, RE::BGSStoryManagerBranchNode, RE::BGSStoryManagerEventNode, RE::BGSStoryManagerNodeBase, RE::BGSStoryManagerQuestNode, RE::BGSTextureSet, RE::BGSVolumetricLighting, RE::EffectSetting, RE::EnchantmentItem, RE::IngredientItem, RE::Script, RE::SpellItem, RE::TESFaction, RE::TESFurniture, RE::TESIdleForm, RE::TESImageSpaceModifier, RE::TESLandTexture, RE::TESLoadScreen, RE::TESNPC, RE::TESObjectACTI, RE::TESObjectARMA, RE::TESObjectBOOK, RE::TESObjectCELL, RE::TESObjectDOOR, RE::TESObjectREFR, RE::TESObjectSTAT, RE::TESObjectWEAP, RE::TESPackage, RE::TESQuest, RE::TESRace, RE::TESTopicInfo, RE::TESWeather, RE::TESWorldSpace, and RE::TESRegion.

ClearDataComponent()

void RE::TESForm::ClearDataComponent ( )

overridevirtual

Implements RE::BaseFormComponent.

Copy()

virtual void RE::TESForm::Copy ( TESForm *  a_srcForm )

virtual

Reimplemented in RE::DialoguePackage, RE::EffectSetting, RE::MagicItem, RE::TESNPC, and RE::TESObjectARMO.

CopyComponent()

void RE::TESForm::CopyComponent ( BaseFormComponent *  a_rhs )

overridevirtual

Reimplemented from RE::BaseFormComponent.

CreateDuplicateForm()

virtual TESForm * RE::TESForm::CreateDuplicateForm ( bool  a_createEditorID, void *  a_arg2  )

virtual

Reimplemented in RE::BGSCameraPath, RE::TESIdleForm, RE::TESObjectCELL, RE::TESObjectLAND, RE::TESObjectREFR, and RE::TESWorldSpace.

CreateGroupData()

virtual void RE::TESForm::CreateGroupData ( FORM *  a_form, FORM_GROUP *  a_group  )

virtual

Reimplemented in RE::NavMesh, RE::TESObjectCELL, RE::TESObjectLAND, RE::TESObjectREFR, and RE::TESTopicInfo.

FindInFileFast()

virtual bool RE::TESForm::FindInFileFast ( TESFile *  a_mod )

virtual

Reimplemented in RE::BGSLocation, RE::TESNPC, RE::TESObjectCELL, and RE::TESWorldSpace.

FinishLoadGame()

virtual void RE::TESForm::FinishLoadGame ( BGSLoadFormBuffer *  a_buf )

virtual

Reimplemented in RE::Actor, RE::BarrierProjectile, RE::BeamProjectile, RE::Character, RE::ConeProjectile, RE::FlameProjectile, RE::GrenadeProjectile, RE::Hazard, RE::MissileProjectile, RE::NavMesh, RE::Projectile, RE::TESObjectREFR, and RE::TESQuest.

GetAllForms()

static auto RE::TESForm::GetAllForms ( ) -> std::pair< BSTHashMap<FormID, TESForm*>*, std::reference_wrapper<BSReadWriteLock>>

inlinestatic

GetAllFormsByEditorID()

static auto RE::TESForm::GetAllFormsByEditorID ( ) -> std::pair< BSTHashMap<BSFixedString, TESForm*>*, std::reference_wrapper<BSReadWriteLock>>

inlinestatic

GetDangerous()

virtual bool RE::TESForm::GetDangerous ( ) const

virtual

Reimplemented in RE::BGSTalkingActivator, RE::TESObjectREFR, and RE::TESWaterForm.

GetDescriptionOwnerFile()

virtual TESFile * RE::TESForm::GetDescriptionOwnerFile ( ) const

virtual

Reimplemented in RE::TESObjectARMO, and RE::TESObjectWEAP.

GetFile()

TESFile * RE::TESForm::GetFile ( std::int32_t  a_idx = -1 ) const

inline

GetFormDetailedString()

virtual void RE::TESForm::GetFormDetailedString ( char *  a_buf, std::uint32_t  a_bufLen  )

virtual

Reimplemented in RE::NavMesh, RE::TESObjectCELL, RE::TESObjectREFR, and RE::TESTopicInfo.

GetFormEditorID()

virtual const char * RE::TESForm::GetFormEditorID ( ) const

virtual

Reimplemented in RE::BGSHeadPart, RE::BGSKeyword, RE::BGSMusicType, RE::BGSStoryManagerEventNode, RE::BGSVoiceType, RE::TESGlobal, RE::TESIdleForm, RE::TESImageSpaceModifier, RE::TESObjectANIO, RE::TESObjectCELL, RE::TESObjectREFR, RE::TESQuest, RE::TESRace, RE::TESTopic, and RE::TESWorldSpace.

GetFormFlags()

std::uint32_t RE::TESForm::GetFormFlags ( ) const

inlinenoexcept

GetFormID()

FormID RE::TESForm::GetFormID ( ) const

inlinenoexcept

GetFormType()

FormType RE::TESForm::GetFormType ( ) const

inlinenoexcept

GetGoldValue()

std::int32_t RE::TESForm::GetGoldValue

(

)

const

GetIgnoredBySandbox()

virtual bool RE::TESForm::GetIgnoredBySandbox ( ) const

virtual

Reimplemented in RE::BGSIdleMarker, RE::TESObjectACTI, and RE::TESObjectREFR.

GetKnown()

virtual bool RE::TESForm::GetKnown ( ) const

virtual

Reimplemented in RE::TESShout.

GetLocalFormID()

FormID RE::TESForm::GetLocalFormID ( ) const

inline

GetMustUpdate()

virtual bool RE::TESForm::GetMustUpdate ( ) const

virtual

Reimplemented in RE::TESObjectREFR.

GetName()

const char * RE::TESForm::GetName

(

)

const

GetObjectTypeName()

virtual const char * RE::TESForm::GetObjectTypeName ( ) const

virtual

Reimplemented in RE::EffectSetting, RE::TESObjectWEAP, and RE::TESPackage.

GetObstacle()

virtual bool RE::TESForm::GetObstacle ( ) const

virtual

Reimplemented in RE::TESObjectREFR.

GetOnLocalMap()

virtual bool RE::TESForm::GetOnLocalMap ( ) const

virtual

Reimplemented in RE::TESObjectREFR.

GetPlayable()

virtual bool RE::TESForm::GetPlayable ( ) const

virtual

Reimplemented in RE::TESAmmo, RE::TESObjectSTAT, RE::TESObjectWEAP, and RE::TESRace.

GetRandomAnim()

virtual bool RE::TESForm::GetRandomAnim ( ) const

virtual

Reimplemented in RE::TESObjectREFR.

GetRawFormID()

FormID RE::TESForm::GetRawFormID

(

)

const

GetRefCount()

virtual std::uint32_t RE::TESForm::GetRefCount ( ) const

virtual

Reimplemented in RE::TESObject, and RE::TESPackage.

GetSavedFormType()

virtual FormType RE::TESForm::GetSavedFormType ( ) const

virtual

Reimplemented in RE::TESObjectREFR.

GetTextForParsedSubTag()

virtual const char * RE::TESForm::GetTextForParsedSubTag ( const BSFixedString &  a_tag ) const

virtual

Reimplemented in RE::TESNPC.

GetWeight()

float RE::TESForm::GetWeight

(

)

const

HasKeywordInArray()

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

HasKeywordInList()

bool RE::TESForm::HasKeywordInList	(	BGSListForm *	a_keywordList,
		bool	a_matchAll
	)		const

HasVMAD()

bool RE::TESForm::HasVMAD

(

)

const

HasWorldModel()

bool RE::TESForm::HasWorldModel ( ) const

noexcept

InitializeData()

virtual void RE::TESForm::InitializeData ( )

virtual

Reimplemented in RE::AlchemyItem, RE::BGSAcousticSpace, RE::BGSAddonNode, RE::BGSAssociationType, RE::BGSBodyPartData, RE::BGSCameraPath, RE::BGSCameraShot, RE::BGSColorForm, RE::BGSConstructibleObject, RE::BGSDebris, RE::BGSDialogueBranch, RE::BGSEncounterZone, RE::BGSEquipSlot, RE::BGSExplosion, RE::BGSFootstep, RE::BGSFootstepSet, RE::BGSHazard, RE::BGSHeadPart, RE::BGSImpactData, RE::BGSLightingTemplate, RE::BGSLocation, RE::BGSMessage, RE::BGSMovableStatic, RE::BGSMovementType, RE::BGSNote, RE::BGSPerk, RE::BGSProjectile, RE::BGSRagdoll, RE::BGSReferenceEffect, RE::BGSRelationship, RE::BGSReverbParameters, RE::BGSScene, RE::BGSShaderParticleGeometryData, RE::BGSSoundCategory, RE::BGSStoryManagerEventNode, RE::BGSStoryManagerNodeBase, RE::BGSTalkingActivator, RE::BGSTextureSet, RE::EnchantmentItem, RE::IngredientItem, RE::MagicItem, RE::Script, RE::SpellItem, RE::TESAmmo, RE::TESClass, RE::TESClimate, RE::TESCombatStyle, RE::TESEffectShader, RE::TESEyes, RE::TESFaction, RE::TESFurniture, RE::TESGrass, RE::TESIdleForm, RE::TESImageSpace, RE::TESImageSpaceModifier, RE::TESLandTexture, RE::TESLoadScreen, RE::TESNPC, RE::TESObjectACTI, RE::TESObjectARMA, RE::TESObjectARMO, RE::TESObjectBOOK, RE::TESObjectCONT, RE::TESObjectDOOR, RE::TESObjectLIGH, RE::TESObjectREFR, RE::TESObjectTREE, RE::TESObjectWEAP, RE::TESPackage, RE::TESQuest, RE::TESRace, RE::TESSoulGem, RE::TESSound, RE::TESTopicInfo, RE::TESWaterForm, RE::TESWeather, and RE::TESWorldSpace.

InitializeDataComponent()

void RE::TESForm::InitializeDataComponent ( )

overridevirtual

Implements RE::BaseFormComponent.

InitItem()

void RE::TESForm::InitItem ( )

inline

InitItemImpl()

virtual void RE::TESForm::InitItemImpl ( )

virtual

Reimplemented in RE::Actor, RE::ActorValueInfo, RE::AlchemyItem, RE::BGSAcousticSpace, RE::BGSAddonNode, RE::BGSArtObject, RE::BGSBodyPartData, RE::BGSCameraPath, RE::BGSCameraShot, RE::BGSCollisionLayer, RE::BGSConstructibleObject, RE::BGSDefaultObjectManager, RE::BGSDialogueBranch, RE::BGSDualCastData, RE::BGSEncounterZone, RE::BGSEquipSlot, RE::BGSExplosion, RE::BGSFootstep, RE::BGSFootstepSet, RE::BGSHazard, RE::BGSHeadPart, RE::BGSIdleMarker, RE::BGSImpactData, RE::BGSImpactDataSet, RE::BGSLensFlare, RE::BGSLightingTemplate, RE::BGSListForm, RE::BGSLocation, RE::BGSLocationRefType, RE::BGSMaterialType, RE::BGSMessage, RE::BGSMovableStatic, RE::BGSMovementType, RE::BGSMusicTrackFormWrapper, RE::BGSMusicType, RE::BGSNote, RE::BGSOutfit, RE::BGSPerk, RE::BGSProjectile, RE::BGSRagdoll, RE::BGSReferenceEffect, RE::BGSRelationship, RE::BGSScene, RE::BGSShaderParticleGeometryData, RE::BGSSoundCategory, RE::BGSSoundDescriptorForm, RE::BGSSoundOutput, RE::BGSStaticCollection, RE::BGSStoryManagerBranchNode, RE::BGSStoryManagerEventNode, RE::BGSStoryManagerNodeBase, RE::BGSStoryManagerQuestNode, RE::BGSTalkingActivator, RE::BGSVolumetricLighting, RE::EffectSetting, RE::EnchantmentItem, RE::Hazard, RE::IngredientItem, RE::MagicItem, RE::NavMesh, RE::NavMeshInfoMap, RE::Script, RE::ScrollItem, RE::SpellItem, RE::TESAmmo, RE::TESCombatStyle, RE::TESEffectShader, RE::TESFaction, RE::TESFlora, RE::TESFurniture, RE::TESGrass, RE::TESIdleForm, RE::TESLandTexture, RE::TESLevCharacter, RE::TESLevItem, RE::TESLevSpell, RE::TESLoadScreen, RE::TESNPC, RE::TESObjectACTI, RE::TESObjectANIO, RE::TESObjectARMA, RE::TESObjectARMO, RE::TESObjectBOOK, RE::TESObjectCELL, RE::TESObjectCONT, RE::TESObjectDOOR, RE::TESObjectLIGH, RE::TESObjectMISC, RE::TESObjectREFR, RE::TESObjectSTAT, RE::TESObjectTREE, RE::TESObjectWEAP, RE::TESPackage, RE::TESQuest, RE::TESRace, RE::TESRegion, RE::TESShout, RE::TESSound, RE::TESTopic, RE::TESTopicInfo, RE::TESWaterForm, RE::TESWeather, and RE::TESWorldSpace.

InitLoadGame()

virtual void RE::TESForm::InitLoadGame ( BGSLoadFormBuffer *  a_buf )

virtual

Reimplemented in RE::Actor, RE::BarrierProjectile, RE::BeamProjectile, RE::BGSRelationship, RE::BGSScene, RE::Character, RE::ConeProjectile, RE::DialoguePackage, RE::FlameProjectile, RE::GrenadeProjectile, RE::MissileProjectile, RE::Projectile, and RE::TESObjectREFR.

Is() [1/2]

template<class... Args>
requires (std::same_as<Args, FormType>&&...)

bool RE::TESForm::Is ( Args...  a_args ) const

inlinenoexcept

Is() [2/2]

bool RE::TESForm::Is ( FormType  a_type ) const

inlinenoexcept

IsAmmo()

bool RE::TESForm::IsAmmo ( ) const

inlinenoexcept

IsArmor()

bool RE::TESForm::IsArmor ( ) const

inlinenoexcept

IsBook()

bool RE::TESForm::IsBook ( ) const

inlinenoexcept

IsBoundObject()

virtual bool RE::TESForm::IsBoundObject ( ) const

virtual

Reimplemented in RE::TESBoundObject.

IsDeleted()

bool RE::TESForm::IsDeleted ( ) const

inlinenoexcept

IsDynamicForm()

bool RE::TESForm::IsDynamicForm ( ) const

inlinenoexcept

IsFormTypeChild()

virtual bool RE::TESForm::IsFormTypeChild ( FormType  a_type )

virtual

Reimplemented in RE::TESObjectCELL, RE::TESTopic, and RE::TESWorldSpace.

IsGold()

bool RE::TESForm::IsGold ( ) const

inlinenoexcept

IsHeadingMarker()

virtual bool RE::TESForm::IsHeadingMarker ( ) const

virtual

Reimplemented in RE::TESObjectREFR, and RE::TESObjectSTAT.

IsIgnored()

bool RE::TESForm::IsIgnored ( ) const

inlinenoexcept

IsInitialized()

bool RE::TESForm::IsInitialized ( ) const

inlinenoexcept

IsInventoryObject()

bool RE::TESForm::IsInventoryObject

(

)

const

IsKey()

bool RE::TESForm::IsKey ( ) const

inlinenoexcept

IsLockpick()

bool RE::TESForm::IsLockpick ( ) const

inlinenoexcept

IsMagicItem()

virtual bool RE::TESForm::IsMagicItem ( ) const

virtual

Reimplemented in RE::MagicItem.

IsNot() [1/2]

template<class... Args>
requires (std::same_as<Args, FormType>&&...)

bool RE::TESForm::IsNot ( Args...  a_args ) const

inlinenoexcept

IsNot() [2/2]

bool RE::TESForm::IsNot ( FormType  a_type ) const

inlinenoexcept

IsNote()

bool RE::TESForm::IsNote ( ) const

inlinenoexcept

IsObject()

virtual bool RE::TESForm::IsObject ( ) const

virtual

Reimplemented in RE::TESObject.

IsParentForm()

virtual bool RE::TESForm::IsParentForm ( )

virtual

Reimplemented in RE::TESObjectCELL, RE::TESTopic, and RE::TESWorldSpace.

IsParentFormTree()

virtual bool RE::TESForm::IsParentFormTree ( )

virtual

IsPlayer()

bool RE::TESForm::IsPlayer ( ) const

inlinenoexcept

IsPlayerRef()

bool RE::TESForm::IsPlayerRef ( ) const

inlinenoexcept

IsSoulGem()

bool RE::TESForm::IsSoulGem ( ) const

inlinenoexcept

IsWater()

virtual bool RE::TESForm::IsWater ( ) const

virtual

Reimplemented in RE::TESObjectACTI, and RE::TESObjectREFR.

IsWeapon()

bool RE::TESForm::IsWeapon ( ) const

inlinenoexcept

Load()

virtual bool RE::TESForm::Load ( TESFile *  a_mod )

virtual

Reimplemented in RE::ActorValueInfo, RE::BGSAcousticSpace, RE::BGSAddonNode, RE::BGSApparatus, RE::BGSArtObject, RE::BGSAssociationType, RE::BGSBodyPartData, RE::BGSCameraPath, RE::BGSCameraShot, RE::BGSCollisionLayer, RE::BGSColorForm, RE::BGSConstructibleObject, RE::BGSDebris, RE::BGSDefaultObjectManager, RE::BGSDialogueBranch, RE::BGSDualCastData, RE::BGSEncounterZone, RE::BGSEquipSlot, RE::BGSExplosion, RE::BGSFootstep, RE::BGSFootstepSet, RE::BGSHazard, RE::BGSHeadPart, RE::BGSIdleMarker, RE::BGSImpactData, RE::BGSImpactDataSet, RE::BGSKeyword, RE::BGSLensFlare, RE::BGSLightingTemplate, RE::BGSListForm, RE::BGSLocation, RE::BGSMaterialObject, RE::BGSMaterialType, RE::BGSMenuIcon, RE::BGSMessage, RE::BGSMovableStatic, RE::BGSMovementType, RE::BGSMusicTrackFormWrapper, RE::BGSMusicType, RE::BGSNote, RE::BGSOutfit, RE::BGSPerk, RE::BGSProjectile, RE::BGSRagdoll, RE::BGSReferenceEffect, RE::BGSRelationship, RE::BGSReverbParameters, RE::BGSScene, RE::BGSShaderParticleGeometryData, RE::BGSSoundCategory, RE::BGSSoundDescriptorForm, RE::BGSSoundOutput, RE::BGSStaticCollection, RE::BGSStoryManagerEventNode, RE::BGSStoryManagerNodeBase, RE::BGSStoryManagerQuestNode, RE::BGSTalkingActivator, RE::BGSTextureSet, RE::BGSVoiceType, RE::BGSVolumetricLighting, RE::EffectSetting, RE::MagicItem, RE::NavMesh, RE::NavMeshInfoMap, RE::Projectile, RE::Script, RE::TESAmmo, RE::TESClass, RE::TESClimate, RE::TESCombatStyle, RE::TESEffectShader, RE::TESEyes, RE::TESFaction, RE::TESFlora, RE::TESFurniture, RE::TESGlobal, RE::TESGrass, RE::TESIdleForm, RE::TESImageSpace, RE::TESImageSpaceModifier, RE::TESLandTexture, RE::TESLevCharacter, RE::TESLevItem, RE::TESLevSpell, RE::TESLoadScreen, RE::TESNPC, RE::TESObjectACTI, RE::TESObjectANIO, RE::TESObjectARMA, RE::TESObjectARMO, RE::TESObjectBOOK, RE::TESObjectCELL, RE::TESObjectCONT, RE::TESObjectDOOR, RE::TESObjectLAND, RE::TESObjectLIGH, RE::TESObjectMISC, RE::TESObjectREFR, RE::TESObjectSTAT, RE::TESObjectTREE, RE::TESObjectWEAP, RE::TESPackage, RE::TESQuest, RE::TESRace, RE::TESRegion, RE::TESShout, RE::TESSound, RE::TESTopic, RE::TESTopicInfo, RE::TESWaterForm, RE::TESWeather, RE::TESWordOfPower, and RE::TESWorldSpace.

LoadEdit()

virtual bool RE::TESForm::LoadEdit ( TESFile *  a_mod )

virtual

LoadGame()

virtual void RE::TESForm::LoadGame ( BGSLoadFormBuffer *  a_buf )

virtual

Reimplemented in RE::Actor, RE::ArrowProjectile, RE::BarrierProjectile, RE::BeamProjectile, RE::BGSEncounterZone, RE::BGSListForm, RE::BGSLocation, RE::BGSNote, RE::BGSRelationship, RE::BGSScene, RE::BGSStoryManagerQuestNode, RE::BGSTalkingActivator, RE::Character, RE::ConeProjectile, RE::DialoguePackage, RE::FlameProjectile, RE::GrenadeProjectile, RE::Hazard, RE::IngredientItem, RE::MissileProjectile, RE::Projectile, RE::TESActorBase, RE::TESAmmo, RE::TESFaction, RE::TESLevCharacter, RE::TESLevItem, RE::TESLevSpell, RE::TESNPC, RE::TESObjectACTI, RE::TESObjectARMO, RE::TESObjectBOOK, RE::TESObjectCELL, RE::TESObjectLIGH, RE::TESObjectMISC, RE::TESObjectREFR, RE::TESObjectWEAP, RE::TESPackage, RE::TESQuest, and RE::TESTopicInfo.

LoadObjectBound()

virtual void RE::TESForm::LoadObjectBound ( TESFile *  a_mod )

virtual

Reimplemented in RE::TESBoundObject.

LoadPartial()

virtual bool RE::TESForm::LoadPartial ( TESFile *  a_mod )

virtual

Reimplemented in RE::TESWorldSpace.

LookupByEditorID() [1/2]

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

inlinestatic

LookupByEditorID() [2/2]

template<class T >

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

inlinestatic

LookupByID() [1/2]

static TESForm * RE::TESForm::LookupByID ( FormID  a_formID )

inlinestatic

LookupByID() [2/2]

template<class T >

static T * RE::TESForm::LookupByID ( FormID  a_formID )

inlinestatic

QAvailableInGame()

virtual bool RE::TESForm::QAvailableInGame ( ) const

virtual

QHasCurrents()

virtual bool RE::TESForm::QHasCurrents ( ) const

virtual

QIsLODLandObject()

virtual bool RE::TESForm::QIsLODLandObject ( ) const

virtual

RemoveChange()

virtual void RE::TESForm::RemoveChange ( std::uint32_t  a_changeFlags )

virtual

Reimplemented in RE::TESActorBase.

Revert()

virtual void RE::TESForm::Revert ( BGSLoadFormBuffer *  a_buf )

virtual

Reimplemented in RE::Actor, RE::BarrierProjectile, RE::BeamProjectile, RE::BGSEncounterZone, RE::BGSListForm, RE::BGSLocation, RE::BGSNote, RE::BGSScene, RE::BGSStoryManagerQuestNode, RE::BGSTalkingActivator, RE::Character, RE::ConeProjectile, RE::Explosion, RE::FlameProjectile, RE::GrenadeProjectile, RE::Hazard, RE::IngredientItem, RE::MissileProjectile, RE::Projectile, RE::TESFaction, RE::TESLevCharacter, RE::TESLevItem, RE::TESLevSpell, RE::TESNPC, RE::TESObjectCELL, RE::TESObjectREFR, RE::TESPackage, RE::TESQuest, and RE::TESTopicInfo.

SaveGame()

virtual void RE::TESForm::SaveGame ( BGSSaveFormBuffer *  a_buf )

virtual

Reimplemented in RE::Actor, RE::ArrowProjectile, RE::BarrierProjectile, RE::BeamProjectile, RE::BGSEncounterZone, RE::BGSListForm, RE::BGSLocation, RE::BGSRelationship, RE::BGSScene, RE::BGSStoryManagerQuestNode, RE::BGSTalkingActivator, RE::Character, RE::ConeProjectile, RE::DialoguePackage, RE::Explosion, RE::FlameProjectile, RE::GrenadeProjectile, RE::Hazard, RE::IngredientItem, RE::MissileProjectile, RE::Projectile, RE::TESActorBase, RE::TESAmmo, RE::TESFaction, RE::TESLevCharacter, RE::TESLevItem, RE::TESLevSpell, RE::TESNPC, RE::TESObjectACTI, RE::TESObjectARMO, RE::TESObjectBOOK, RE::TESObjectCELL, RE::TESObjectLIGH, RE::TESObjectMISC, RE::TESObjectREFR, RE::TESObjectWEAP, RE::TESPackage, and RE::TESQuest.

SaveObjectBound()

virtual void RE::TESForm::SaveObjectBound ( )

virtual

SetAltered()

virtual void RE::TESForm::SetAltered ( bool  a_set )

virtual

Reimplemented in RE::NavMesh, RE::NavMeshInfoMap, RE::TESObjectCELL, RE::TESObjectLAND, RE::TESObjectREFR, and RE::TESTopicInfo.

SetDelete()

virtual void RE::TESForm::SetDelete ( bool  a_set )

virtual

Reimplemented in RE::Actor, RE::BGSCollisionLayer, RE::NavMesh, and RE::TESObjectREFR.

SetFormEditorID()

virtual bool RE::TESForm::SetFormEditorID ( const char *  a_str )

virtual

Reimplemented in RE::BGSHeadPart, RE::BGSKeyword, RE::BGSMusicType, RE::BGSSoundDescriptorForm, RE::BGSVoiceType, RE::TESGlobal, RE::TESIdleForm, RE::TESImageSpaceModifier, RE::TESObjectANIO, RE::TESObjectCELL, RE::TESQuest, RE::TESRace, RE::TESSound, RE::TESTopic, and RE::TESWorldSpace.

SetFormID()

virtual void RE::TESForm::SetFormID ( FormID  a_id, bool  a_updateFile  )

virtual

SetOnLocalMap()

virtual void RE::TESForm::SetOnLocalMap ( bool  a_set )

virtual

Reimplemented in RE::TESObjectREFR.

Member Data Documentation

formFlags

std::uint32_t RE::TESForm::formFlags

formID

FormID RE::TESForm::formID

FORMTYPE

constexpr auto RE::TESForm::FORMTYPE = FormType::None

inlinestaticconstexpr

formType

stl::enumeration<FormType, std::uint8_t> RE::TESForm::formType

inGameFormFlags

stl::enumeration<InGameFormFlag, std::uint16_t> RE::TESForm::inGameFormFlags

pad1B

std::uint8_t RE::TESForm::pad1B

pad1C

std::uint32_t RE::TESForm::pad1C

RTTI

constexpr auto RE::TESForm::RTTI = RTTI_TESForm

inlinestaticconstexpr

sourceFiles

TESFileContainer RE::TESForm::sourceFiles

---

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

• CommonLibSSE-NG/include/RE/T/TESForm.h
• CommonLibSSE-NG/include/RE/F/FormTraits.h