CommonLibVR
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
RE::TESForm Class Reference

#include <TESForm.h>

Inheritance diagram for RE::TESForm:
RE::BaseFormComponent RE::ActorValueInfo RE::BGSAssociationType RE::BGSBodyPartData RE::BGSCameraPath RE::BGSCameraShot RE::BGSCollisionLayer RE::BGSColorForm RE::BGSConstructibleObject RE::BGSDebris RE::BGSDefaultObjectManager RE::BGSDialogueBranch RE::BGSEncounterZone RE::BGSEquipSlot RE::BGSFootstep RE::BGSFootstepSet RE::BGSHeadPart RE::BGSImpactData RE::BGSImpactDataSet RE::BGSKeyword RE::BGSLensFlare RE::BGSLightingTemplate RE::BGSListForm RE::BGSLocation RE::BGSMaterialObject RE::BGSMaterialType RE::BGSMenuIcon RE::BGSMessage RE::BGSMovementType RE::BGSMusicTrackFormWrapper RE::BGSMusicType RE::BGSOutfit RE::BGSPerk RE::BGSRagdoll RE::BGSReferenceEffect RE::BGSRelationship RE::BGSReverbParameters RE::BGSScene RE::BGSShaderParticleGeometryData RE::BGSSoundCategory RE::BGSSoundDescriptorForm RE::BGSSoundOutput RE::BGSStoryManagerTreeForm RE::BGSVoiceType RE::BGSVolumetricLighting RE::EffectSetting RE::NavMesh RE::NavMeshInfoMap RE::Script RE::TESClass RE::TESClimate RE::TESCombatStyle RE::TESEffectShader RE::TESEyes RE::TESFaction RE::TESGlobal RE::TESIdleForm RE::TESImageSpace RE::TESImageSpaceModifier RE::TESLandTexture RE::TESLoadScreen RE::TESObject RE::TESObjectANIO RE::TESObjectCELL RE::TESObjectLAND RE::TESObjectREFR RE::TESPackage RE::TESRace RE::TESRegion RE::TESShout RE::TESTopic RE::TESTopicInfo RE::TESWaterForm RE::TESWeather RE::TESWordOfPower RE::TESWorldSpace

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 GetLocalFormID ()
 
const char * GetName () const
 
float GetWeight () const
 
bool HasKeywordInArray (const std::vector< BGSKeyword * > &a_keywords, bool a_matchAll) const
 
bool HasAnyKeywordByEditorID (const std::vector< std::string > &editorIDs) const
 
bool HasKeywordByEditorID (std::string_view a_editorID)
 
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>
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 IsInventoryObject () const
 
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 IsSkooma () const noexcept
 
bool IsSoulGem () const noexcept
 
bool IsWeapon () const noexcept
 
void SetPlayerKnows (bool a_known)
 
- Public Member Functions inherited from RE::BaseFormComponent
virtual ~BaseFormComponent ()
 
 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 VTABLE = VTABLE_TESForm
 
static constexpr auto FORMTYPE = FormType::None
 
- Static Public Attributes inherited from RE::BaseFormComponent
static constexpr auto RTTI = RTTI_BaseFormComponent
 
static constexpr auto VTABLE = VTABLE_BaseFormComponent
 

Member Enumeration Documentation

◆ InGameFormFlag

enum 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::TESWaterForm, RE::TESObjectTREE, RE::TESObjectLIGH, RE::TESObjectDOOR, RE::TESObjectCONT, RE::TESObjectBOOK, RE::TESObjectACTI, RE::TESNPC, RE::TESFurniture, RE::TESFlora, RE::TESBoundObject, RE::BGSProjectile, RE::BGSNote, and RE::BGSTalkingActivator.

◆ 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::TESTopicInfo, RE::TESObjectREFR, RE::TESObjectLAND, RE::TESObjectCELL, and RE::NavMesh.

◆ CheckSaveGame()

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

Reimplemented in RE::TESObjectREFR.

◆ ClearData()

virtual void RE::TESForm::ClearData ( )
virtual

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

◆ ClearDataComponent()

void RE::TESForm::ClearDataComponent ( )
overridevirtual

Implements RE::BaseFormComponent.

◆ Copy()

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

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

◆ 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::TESWorldSpace, RE::TESObjectREFR, RE::TESObjectLAND, RE::TESObjectCELL, RE::TESIdleForm, and RE::BGSCameraPath.

◆ CreateGroupData()

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

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

◆ FindInFileFast()

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

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

◆ FinishLoadGame()

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

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

◆ 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::TESWaterForm, RE::TESObjectREFR, and RE::BGSTalkingActivator.

◆ GetDescriptionOwnerFile()

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

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

◆ 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::TESTopicInfo, RE::TESObjectREFR, RE::TESObjectCELL, and RE::NavMesh.

◆ GetFormEditorID()

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

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

◆ 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::TESObjectREFR, RE::TESObjectACTI, and RE::BGSIdleMarker.

◆ GetKnown()

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

Reimplemented in RE::TESShout.

◆ GetLocalFormID()

FormID RE::TESForm::GetLocalFormID ( )
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::TESPackage, RE::TESObjectWEAP, and RE::EffectSetting.

◆ 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::TESRace, RE::TESObjectWEAP, RE::TESObjectSTAT, and RE::TESAmmo.

◆ GetRandomAnim()

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

Reimplemented in RE::TESObjectREFR.

◆ GetRefCount()

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

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

◆ 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

◆ HasAnyKeywordByEditorID()

bool RE::TESForm::HasAnyKeywordByEditorID ( const std::vector< std::string > &  editorIDs) const

◆ HasKeywordByEditorID()

bool RE::TESForm::HasKeywordByEditorID ( std::string_view  a_editorID)

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

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

◆ InitLoadGame()

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

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

◆ Is() [1/2]

template<class... Args>
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::TESWorldSpace, RE::TESTopic, and RE::TESObjectCELL.

◆ IsGold()

bool RE::TESForm::IsGold ( ) const
inlinenoexcept

◆ IsHeadingMarker()

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

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

◆ 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>
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::TESWorldSpace, RE::TESTopic, and RE::TESObjectCELL.

◆ IsParentFormTree()

virtual bool RE::TESForm::IsParentFormTree ( )
virtual

◆ IsPlayer()

bool RE::TESForm::IsPlayer ( ) const
inlinenoexcept

◆ IsPlayerRef()

bool RE::TESForm::IsPlayerRef ( ) const
inlinenoexcept

◆ IsSkooma()

bool RE::TESForm::IsSkooma ( ) const
inlinenoexcept

◆ IsSoulGem()

bool RE::TESForm::IsSoulGem ( ) const
inlinenoexcept

◆ IsWater()

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

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

◆ IsWeapon()

bool RE::TESForm::IsWeapon ( ) const
inlinenoexcept

◆ Load()

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

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

◆ LoadEdit()

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

◆ LoadGame()

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

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

◆ 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::TESTopicInfo, RE::TESQuest, RE::TESPackage, RE::TESObjectREFR, RE::TESObjectCELL, RE::TESNPC, RE::TESLevSpell, RE::TESLevItem, RE::TESLevCharacter, RE::TESFaction, RE::Projectile, RE::MissileProjectile, RE::IngredientItem, RE::Hazard, RE::GrenadeProjectile, RE::FlameProjectile, RE::Explosion, RE::ConeProjectile, RE::Character, RE::BGSTalkingActivator, RE::BGSStoryManagerQuestNode, RE::BGSScene, RE::BGSNote, RE::BGSLocation, RE::BGSListForm, RE::BGSEncounterZone, RE::BeamProjectile, RE::BarrierProjectile, and RE::Actor.

◆ SaveGame()

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

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

◆ SaveObjectBound()

virtual void RE::TESForm::SaveObjectBound ( )
virtual

◆ SetAltered()

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

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

◆ SetDelete()

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

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

◆ SetFormEditorID()

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

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

◆ 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.

◆ SetPlayerKnows()

void RE::TESForm::SetPlayerKnows ( bool  a_known)

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

◆ VTABLE

constexpr auto RE::TESForm::VTABLE = VTABLE_TESForm
inlinestaticconstexpr
The documentation for this class was generated from the following files: