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

#include <TESObjectCELL.h>

Inheritance diagram for RE::TESObjectCELL:
RE::TESForm RE::TESFullName RE::BaseFormComponent RE::BaseFormComponent

Classes

union  CellData
 
struct  ChangeFlags
 
struct  RecordFlags
 
struct  RUNTIME_DATA
 

Public Types

enum class  Flag {
  kNone = 0 , kIsInteriorCell = 1 << 0 , kHasWater = 1 << 1 , kCanTravelFromHere = 1 << 2 ,
  kNoLODWater = 1 << 3 , kHasTempData = 1 << 4 , kPublicArea = 1 << 5 , kHandChanged = 1 << 6 ,
  kShowSky = 1 << 7 , kUseSkyLighting = 1 << 8 , kWarnToLeave = 1 << 9
}
 
enum class  CellState { kAttached = 7 }
 
- 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

 ~TESObjectCELL () override
 
void ClearData () override
 
bool Load (TESFile *a_mod) override
 
TESFormCreateDuplicateForm (bool a_createEditorID, void *a_arg2) override
 
bool FindInFileFast (TESFile *a_mod) override
 
void SaveGame (BGSSaveFormBuffer *a_buf) override
 
void LoadGame (BGSLoadFormBuffer *a_buf) override
 
void Revert (BGSLoadFormBuffer *a_buf) override
 
void InitItemImpl () override
 
void GetFormDetailedString (char *a_buf, std::uint32_t a_bufLen) override
 
void SetAltered (bool a_set) override
 
bool BelongsInGroup (FORM *a_form, bool a_allowParentGroups, bool a_currentOnly) override
 
void CreateGroupData (FORM *a_form, FORM_GROUP *a_group) override
 
const char * GetFormEditorID () const override
 
bool SetFormEditorID (const char *a_str) override
 
bool IsParentForm () override
 
bool IsFormTypeChild (FormType a_type) override
 
TESNPCGetActorOwner ()
 
bhkWorldGetbhkWorld () const
 
void ForEachReference (std::function< BSContainer::ForEachResult(TESObjectREFR &)> a_callback) const
 
void ForEachReferenceInRange (const NiPoint3 &a_origin, float a_radius, std::function< BSContainer::ForEachResult(TESObjectREFR &)> a_callback) const
 
EXTERIOR_DATAGetCoordinates ()
 
TESFactionGetFactionOwner ()
 
INTERIOR_DATAGetLighting ()
 
BGSLocationGetLocation () const
 
float GetNorthRotation ()
 
TESFormGetOwner ()
 
float GetExteriorWaterHeight () const
 
TESRegionListGetRegionList (bool a_createIfMissing)
 
bool GetWaterHeight (const NiPoint3 &a_pos, float &a_waterHeight)
 
bool IsAttached () const
 
bool IsExteriorCell () const
 
bool IsInteriorCell () const
 
void SetActorOwner (TESNPC *a_owner)
 
void SetFactionOwner (TESFaction *a_owner)
 
void SetFogColor (Color a_near, Color a_far)
 
void SetFogPlanes (float a_near, float a_far)
 
void SetFogPower (float a_power)
 
void SetHandChanged (bool a_changed)
 
void SetOwner (TESForm *a_owner)
 
void SetPublic (bool a_public)
 
bool UsesSkyLighting () const
 
RUNTIME_DATAGetRuntimeData () noexcept
 
const RUNTIME_DATAGetRuntimeData () const noexcept
 
- 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 Attributes

BSSpinLock grassCreateLock
 
BSSpinLock grassTaskLock
 
stl::enumeration< Flag, std::uint16_t > cellFlags
 
std::uint16_t cellGameFlags
 
stl::enumeration< CellState, std::uint8_t > cellState
 
bool autoWaterLoaded
 
bool cellDetached
 
std::uint8_t pad047
 
ExtraDataList extraList
 
- 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
 

Static Public Attributes

static constexpr auto RTTI = RTTI_TESObjectCELL
 
static constexpr auto VTABLE = VTABLE_TESObjectCELL
 
static constexpr auto FORMTYPE = FormType::Cell
 
- 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
 

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 Enumeration Documentation

◆ CellState

enum class RE::TESObjectCELL::CellState
strong
Enumerator
kAttached 

◆ Flag

enum class RE::TESObjectCELL::Flag
strong
Enumerator
kNone 
kIsInteriorCell 
kHasWater 
kCanTravelFromHere 
kNoLODWater 
kHasTempData 
kPublicArea 
kHandChanged 
kShowSky 
kUseSkyLighting 
kWarnToLeave 

Constructor & Destructor Documentation

◆ ~TESObjectCELL()

RE::TESObjectCELL::~TESObjectCELL ( )
override

Member Function Documentation

◆ BelongsInGroup()

bool RE::TESObjectCELL::BelongsInGroup ( FORM a_form,
bool  a_allowParentGroups,
bool  a_currentOnly 
)
overridevirtual

Reimplemented from RE::TESForm.

◆ ClearData()

void RE::TESObjectCELL::ClearData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ CreateDuplicateForm()

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

Reimplemented from RE::TESForm.

◆ CreateGroupData()

void RE::TESObjectCELL::CreateGroupData ( FORM a_form,
FORM_GROUP a_group 
)
overridevirtual

Reimplemented from RE::TESForm.

◆ FindInFileFast()

bool RE::TESObjectCELL::FindInFileFast ( TESFile a_mod)
overridevirtual

Reimplemented from RE::TESForm.

◆ ForEachReference()

void RE::TESObjectCELL::ForEachReference ( std::function< BSContainer::ForEachResult(TESObjectREFR &)>  a_callback) const

◆ ForEachReferenceInRange()

void RE::TESObjectCELL::ForEachReferenceInRange ( const NiPoint3 a_origin,
float  a_radius,
std::function< BSContainer::ForEachResult(TESObjectREFR &)>  a_callback 
) const

◆ GetActorOwner()

TESNPC * RE::TESObjectCELL::GetActorOwner ( )

◆ GetbhkWorld()

bhkWorld * RE::TESObjectCELL::GetbhkWorld ( ) const
inline

◆ GetCoordinates()

EXTERIOR_DATA * RE::TESObjectCELL::GetCoordinates ( )

◆ GetExteriorWaterHeight()

float RE::TESObjectCELL::GetExteriorWaterHeight ( ) const

◆ GetFactionOwner()

TESFaction * RE::TESObjectCELL::GetFactionOwner ( )

◆ GetFormDetailedString()

void RE::TESObjectCELL::GetFormDetailedString ( char *  a_buf,
std::uint32_t  a_bufLen 
)
overridevirtual

Reimplemented from RE::TESForm.

◆ GetFormEditorID()

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

Reimplemented from RE::TESForm.

◆ GetLighting()

INTERIOR_DATA * RE::TESObjectCELL::GetLighting ( )

◆ GetLocation()

BGSLocation * RE::TESObjectCELL::GetLocation ( ) const
inline

◆ GetNorthRotation()

float RE::TESObjectCELL::GetNorthRotation ( )

◆ GetOwner()

TESForm * RE::TESObjectCELL::GetOwner ( )

◆ GetRegionList()

TESRegionList * RE::TESObjectCELL::GetRegionList ( bool  a_createIfMissing)

◆ GetRuntimeData() [1/2]

const RUNTIME_DATA & RE::TESObjectCELL::GetRuntimeData ( ) const
inlinenoexcept

◆ GetRuntimeData() [2/2]

RUNTIME_DATA & RE::TESObjectCELL::GetRuntimeData ( )
inlinenoexcept

◆ GetWaterHeight()

bool RE::TESObjectCELL::GetWaterHeight ( const NiPoint3 a_pos,
float &  a_waterHeight 
)

◆ InitItemImpl()

void RE::TESObjectCELL::InitItemImpl ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ IsAttached()

bool RE::TESObjectCELL::IsAttached ( ) const

◆ IsExteriorCell()

bool RE::TESObjectCELL::IsExteriorCell ( ) const

◆ IsFormTypeChild()

bool RE::TESObjectCELL::IsFormTypeChild ( FormType  a_type)
overridevirtual

Reimplemented from RE::TESForm.

◆ IsInteriorCell()

bool RE::TESObjectCELL::IsInteriorCell ( ) const

◆ IsParentForm()

bool RE::TESObjectCELL::IsParentForm ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ Load()

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

Reimplemented from RE::TESForm.

◆ LoadGame()

void RE::TESObjectCELL::LoadGame ( BGSLoadFormBuffer a_buf)
overridevirtual

Reimplemented from RE::TESForm.

◆ Revert()

void RE::TESObjectCELL::Revert ( BGSLoadFormBuffer a_buf)
overridevirtual

Reimplemented from RE::TESForm.

◆ SaveGame()

void RE::TESObjectCELL::SaveGame ( BGSSaveFormBuffer *  a_buf)
overridevirtual

Reimplemented from RE::TESForm.

◆ SetActorOwner()

void RE::TESObjectCELL::SetActorOwner ( TESNPC a_owner)

◆ SetAltered()

void RE::TESObjectCELL::SetAltered ( bool  a_set)
overridevirtual

Reimplemented from RE::TESForm.

◆ SetFactionOwner()

void RE::TESObjectCELL::SetFactionOwner ( TESFaction a_owner)

◆ SetFogColor()

void RE::TESObjectCELL::SetFogColor ( Color  a_near,
Color  a_far 
)

◆ SetFogPlanes()

void RE::TESObjectCELL::SetFogPlanes ( float  a_near,
float  a_far 
)

◆ SetFogPower()

void RE::TESObjectCELL::SetFogPower ( float  a_power)

◆ SetFormEditorID()

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

Reimplemented from RE::TESForm.

◆ SetHandChanged()

void RE::TESObjectCELL::SetHandChanged ( bool  a_changed)

◆ SetOwner()

void RE::TESObjectCELL::SetOwner ( TESForm a_owner)

◆ SetPublic()

void RE::TESObjectCELL::SetPublic ( bool  a_public)

◆ UsesSkyLighting()

bool RE::TESObjectCELL::UsesSkyLighting ( ) const

Member Data Documentation

◆ autoWaterLoaded

bool RE::TESObjectCELL::autoWaterLoaded

◆ cellDetached

bool RE::TESObjectCELL::cellDetached

◆ cellFlags

stl::enumeration<Flag, std::uint16_t> RE::TESObjectCELL::cellFlags

◆ cellGameFlags

std::uint16_t RE::TESObjectCELL::cellGameFlags

◆ cellState

stl::enumeration<CellState, std::uint8_t> RE::TESObjectCELL::cellState

◆ extraList

ExtraDataList RE::TESObjectCELL::extraList

◆ FORMTYPE

constexpr auto RE::TESObjectCELL::FORMTYPE = FormType::Cell
inlinestaticconstexpr

◆ grassCreateLock

BSSpinLock RE::TESObjectCELL::grassCreateLock
mutable

◆ grassTaskLock

BSSpinLock RE::TESObjectCELL::grassTaskLock
mutable

◆ pad047

std::uint8_t RE::TESObjectCELL::pad047

◆ RTTI

constexpr auto RE::TESObjectCELL::RTTI = RTTI_TESObjectCELL
inlinestaticconstexpr

◆ VTABLE

constexpr auto RE::TESObjectCELL::VTABLE = VTABLE_TESObjectCELL
inlinestaticconstexpr

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