CommonLibSSE NG
Loading...
Searching...
No Matches
RE::BGSBaseAlias Class Referenceabstract

#include <BGSBaseAlias.h>

Inheritance diagram for RE::BGSBaseAlias:
RE::BGSLocAlias RE::BGSRefAlias

Public Types

enum class  FLAGS {
  kNone = 0 , kReserves = 1 << 0 , kOptional = 1 << 1 , kQuestObject = 1 << 2 ,
  kAllowReuse = 1 << 3 , kAllowDead = 1 << 4 , kLoadedOnly = 1 << 5 , kEssential = 1 << 6 ,
  kAllowDisabled = 1 << 7 , kStoreName = 1 << 8 , kAllowReserved = 1 << 9 , kProtected = 1 << 10 ,
  kForcedFromAlias = 1 << 11 , kAllowDestroyed = 1 << 12 , kFindPlayerClosest = 1 << 13 , kUsesNames = 1 << 14 ,
  kInitiallyDisabled = 1 << 15 , kAllowCleared = 1 << 16 , kClearNameOnRemove = 1 << 17 , kActorsOnly = 1 << 18 ,
  kTransient = 1 << 19 , kExternalLink = 1 << 20 , kNoPickpocket = 1 << 21 , kDataAlias = 1 << 22 ,
  kSceneOptional = 1 << 24 , kCreateIn = 1 << 31
}
 
enum class  FILL_TYPE {
  kConditions = 0 , kForced = 1 , kFromAlias = 2 , kFromEvent = 3 ,
  kCreated = 4 , kFromExternal = 5 , kUniqueActor = 6 , kNearAlias = 7
}
 

Public Member Functions

virtual ~BGSBaseAlias ()
 
virtual bool Load (TESFile *a_mod)=0
 
virtual void InitItem (TESForm *a_form)=0
 
virtual const BSFixedStringQType () const =0
 
const BSFixedStringGetTypeString () const
 
VMTypeID GetVMTypeID () const
 
bool IsEssential () const
 
bool IsProtected () const
 
bool IsQuestObject () const
 
void SetEssential (bool a_set)
 
void SetProtected (bool a_set)
 

Public Attributes

BSFixedString aliasName
 
TESQuestowningQuest
 
std::uint32_t aliasID
 
stl::enumeration< FLAGS, std::uint32_t > flags
 
stl::enumeration< FILL_TYPE, std::uint16_t > fillType
 
std::uint16_t pad22
 
std::uint32_t pad24
 

Static Public Attributes

static constexpr auto RTTI = RTTI_BGSBaseAlias
 
static auto VMTYPEID = static_cast<VMTypeID>(139)
 

Member Enumeration Documentation

◆ FILL_TYPE

enum class RE::BGSBaseAlias::FILL_TYPE
strong
Enumerator
kConditions 
kForced 
kFromAlias 
kFromEvent 
kCreated 
kFromExternal 
kUniqueActor 
kNearAlias 

◆ FLAGS

enum class RE::BGSBaseAlias::FLAGS
strong
Enumerator
kNone 
kReserves 
kOptional 
kQuestObject 
kAllowReuse 
kAllowDead 
kLoadedOnly 
kEssential 
kAllowDisabled 
kStoreName 
kAllowReserved 
kProtected 
kForcedFromAlias 
kAllowDestroyed 
kFindPlayerClosest 
kUsesNames 
kInitiallyDisabled 
kAllowCleared 
kClearNameOnRemove 
kActorsOnly 
kTransient 
kExternalLink 
kNoPickpocket 
kDataAlias 
kSceneOptional 
kCreateIn 

Constructor & Destructor Documentation

◆ ~BGSBaseAlias()

virtual RE::BGSBaseAlias::~BGSBaseAlias ( )
virtual

Member Function Documentation

◆ GetTypeString()

const BSFixedString & RE::BGSBaseAlias::GetTypeString ( ) const

◆ GetVMTypeID()

VMTypeID RE::BGSBaseAlias::GetVMTypeID ( ) const

◆ InitItem()

virtual void RE::BGSBaseAlias::InitItem ( TESForm a_form)
pure virtual

Implemented in RE::BGSRefAlias.

◆ IsEssential()

bool RE::BGSBaseAlias::IsEssential ( ) const

◆ IsProtected()

bool RE::BGSBaseAlias::IsProtected ( ) const

◆ IsQuestObject()

bool RE::BGSBaseAlias::IsQuestObject ( ) const

◆ Load()

virtual bool RE::BGSBaseAlias::Load ( TESFile a_mod)
pure virtual

Implemented in RE::BGSRefAlias.

◆ QType()

virtual const BSFixedString & RE::BGSBaseAlias::QType ( ) const
pure virtual

Implemented in RE::BGSRefAlias.

◆ SetEssential()

void RE::BGSBaseAlias::SetEssential ( bool  a_set)

◆ SetProtected()

void RE::BGSBaseAlias::SetProtected ( bool  a_set)

Member Data Documentation

◆ aliasID

std::uint32_t RE::BGSBaseAlias::aliasID

◆ aliasName

BSFixedString RE::BGSBaseAlias::aliasName

◆ fillType

stl::enumeration<FILL_TYPE, std::uint16_t> RE::BGSBaseAlias::fillType

◆ flags

stl::enumeration<FLAGS, std::uint32_t> RE::BGSBaseAlias::flags

◆ owningQuest

TESQuest* RE::BGSBaseAlias::owningQuest

◆ pad22

std::uint16_t RE::BGSBaseAlias::pad22

◆ pad24

std::uint32_t RE::BGSBaseAlias::pad24

◆ RTTI

constexpr auto RE::BGSBaseAlias::RTTI = RTTI_BGSBaseAlias
inlinestaticconstexpr

◆ VMTYPEID

auto RE::BGSBaseAlias::VMTYPEID = static_cast<VMTypeID>(139)
inlinestatic

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