CommonLibSSE NG
Loading...
Searching...
No Matches
RE::BGSHeadPart Class Reference

#include <BGSHeadPart.h>

Inheritance diagram for RE::BGSHeadPart:
RE::TESForm RE::TESFullName RE::TESModelTextureSwap RE::BaseFormComponent RE::BaseFormComponent RE::TESModel RE::BaseFormComponent

Classes

struct  MorphIndices
 
struct  RecordFlags
 

Public Types

enum class  Flag {
  kNone = 0 , kPlayable = 1 << 0 , kMale = 1 << 1 , kFemale = 1 << 2 ,
  kIsExtraPart = 1 << 3 , kUseSolidTint = 1 << 4
}
 
enum class  HeadPartType {
  kMisc = 0x0 , kFace = 0x1 , kEyes = 0x2 , kHair = 0x3 ,
  kFacialHair = 0x4 , kScar = 0x5 , kEyebrows = 0x6 , kTotal
}
 
using MorphIndex = MorphIndices::MorphIndex
 
- 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 Member Functions

 ~BGSHeadPart () override
 
void InitializeData () override
 
void ClearData () override
 
bool Load (TESFile *a_mod) override
 
void InitItemImpl () override
 
const char * GetFormEditorID () const override
 
bool SetFormEditorID (const char *a_str) override
 
bool IsExtraPart ()
 
- 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
 
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
 
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 Attributes

stl::enumeration< Flag, std::uint8_t > flags
 
std::uint8_t pad069
 
std::uint16_t pad06A
 
stl::enumeration< HeadPartType, std::uint32_t > type
 
BSTArray< BGSHeadPart * > extraParts
 
BGSTextureSettextureSet
 
TESModelTri morphs [MorphIndices::kTotal]
 
BGSColorFormcolor
 
BGSListFormvalidRaces
 
BSFixedString formEditorID
 
- Public Attributes inherited from RE::TESForm
TESFileContainer sourceFiles
 
std::uint32_t formFlags
 
FormID formID
 
stl::enumeration< InGameFormFlag, std::uint16_t > inGameFormFlags
 
stl::enumeration< FormType, std::uint8_t > formType
 
std::uint8_t pad1B
 
std::uint32_t pad1C
 
- Public Attributes inherited from RE::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
 

Static Public Attributes

static constexpr auto RTTI = RTTI_BGSHeadPart
 
static constexpr auto VTABLE = VTABLE_BGSHeadPart
 
static constexpr auto FORMTYPE = FormType::HeadPart
 
- 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
 

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)
 

Member Typedef Documentation

◆ MorphIndex

Member Enumeration Documentation

◆ Flag

enum class RE::BGSHeadPart::Flag
strong
Enumerator
kNone 
kPlayable 
kMale 
kFemale 
kIsExtraPart 
kUseSolidTint 

◆ HeadPartType

enum class RE::BGSHeadPart::HeadPartType
strong
Enumerator
kMisc 
kFace 
kEyes 
kHair 
kFacialHair 
kScar 
kEyebrows 
kTotal 

Constructor & Destructor Documentation

◆ ~BGSHeadPart()

RE::BGSHeadPart::~BGSHeadPart ( )
override

Member Function Documentation

◆ ClearData()

void RE::BGSHeadPart::ClearData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ GetFormEditorID()

const char * RE::BGSHeadPart::GetFormEditorID ( ) const
overridevirtual

Reimplemented from RE::TESForm.

◆ InitializeData()

void RE::BGSHeadPart::InitializeData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ InitItemImpl()

void RE::BGSHeadPart::InitItemImpl ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ IsExtraPart()

bool RE::BGSHeadPart::IsExtraPart ( )

◆ Load()

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

Reimplemented from RE::TESForm.

◆ SetFormEditorID()

bool RE::BGSHeadPart::SetFormEditorID ( const char *  a_str)
overridevirtual

Reimplemented from RE::TESForm.

Member Data Documentation

◆ color

BGSColorForm* RE::BGSHeadPart::color

◆ extraParts

BSTArray<BGSHeadPart*> RE::BGSHeadPart::extraParts

◆ flags

stl::enumeration<Flag, std::uint8_t> RE::BGSHeadPart::flags

◆ formEditorID

BSFixedString RE::BGSHeadPart::formEditorID

◆ FORMTYPE

constexpr auto RE::BGSHeadPart::FORMTYPE = FormType::HeadPart
inlinestaticconstexpr

◆ morphs

TESModelTri RE::BGSHeadPart::morphs[MorphIndices::kTotal]

◆ pad069

std::uint8_t RE::BGSHeadPart::pad069

◆ pad06A

std::uint16_t RE::BGSHeadPart::pad06A

◆ RTTI

constexpr auto RE::BGSHeadPart::RTTI = RTTI_BGSHeadPart
inlinestaticconstexpr

◆ textureSet

BGSTextureSet* RE::BGSHeadPart::textureSet

◆ type

stl::enumeration<HeadPartType, std::uint32_t> RE::BGSHeadPart::type

◆ validRaces

BGSListForm* RE::BGSHeadPart::validRaces

◆ VTABLE

constexpr auto RE::BGSHeadPart::VTABLE = VTABLE_BGSHeadPart
inlinestaticconstexpr

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