CommonLibSSE (Parapets fork)
RE::TESPackage Class Reference

#include <TESPackage.h>

Inheritance diagram for RE::TESPackage:
RE::TESForm RE::BaseFormComponent RE::DialoguePackage

Classes

struct  ChangeFlags
 
struct  RecordFlags
 

Public Member Functions

 ~TESPackage () override
 
void InitializeData () override
 
void ClearData () override
 
bool Load (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
 
std::uint32_t GetRefCount () const override
 
const char * GetObjectTypeName () const override
 
virtual bool IsActorAtLocation (Actor *a_actor, bool a_arg2, float a_arg3, bool a_arg4)
 
virtual bool IsActorAtSecondLocation (Actor *a_arg1, Actor *a_arg2, bool a_arg3, float a_arg4, bool a_arg5)
 
virtual bool IsActorAtRefTarget (Actor *a_actor, std::int32_t a_arg2)
 
virtual bool IsTargetAtLocation (Actor *a_actor, std::int32_t a_arg2)
 
virtual bool IsPackageOwner (Actor *a_actor)
 
- Public Member Functions inherited from RE::TESForm
 ~TESForm () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
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 InitLoadGame (BGSLoadFormBuffer *a_buf)
 
virtual void FinishLoadGame (BGSLoadFormBuffer *a_buf)
 
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 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 bool QAvailableInGame () const
 
template<class T >
 requires (std::is_class_v< T >) T *As() noexcept
 
template<class T >
 requires (requires { T::FORMTYPE;}) const T *As() const noexcept
 
template<class T >
 requires (!requires { T::FORMTYPE;}) 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
 
const char * GetName () const
 
float GetWeight () 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 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 IsSoulGem () const noexcept
 
bool IsWeapon () const noexcept
 
- Public Member Functions inherited from RE::BaseFormComponent
virtual ~BaseFormComponent ()
 
 TES_HEAP_REDEFINE_NEW ()
 

Public Attributes

PACKAGE_DATA packData
 
std::uint32_t pad2C
 
TESPackageDatadata
 
PackageLocationpackLoc
 
PackageTargetpackTarg
 
BGSIdleCollectionidleCollection
 
PackageSchedule packSched
 
std::uint32_t pad5C
 
TESCondition packConditions
 
TESCombatStylecombatStyle
 
TESQuestownerQuest
 
PackageEventAction onBegin
 
PackageEventAction onEnd
 
PackageEventAction onChange
 
stl::enumeration< PACKAGE_PROCEDURE_TYPE, std::uint32_t > procedureType
 
volatile std::uint32_t refCount
 
- 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
 

Static Public Attributes

static constexpr auto RTTI = RTTI_TESPackage
 
static constexpr auto FORMTYPE = FormType::Package
 
- 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
 

Additional Inherited Members

- 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
}
 
- 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)
 

Constructor & Destructor Documentation

◆ ~TESPackage()

RE::TESPackage::~TESPackage ( )
override

Member Function Documentation

◆ ClearData()

void RE::TESPackage::ClearData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ GetObjectTypeName()

const char* RE::TESPackage::GetObjectTypeName ( ) const
overridevirtual

Reimplemented from RE::TESForm.

◆ GetRefCount()

std::uint32_t RE::TESPackage::GetRefCount ( ) const
overridevirtual

Reimplemented from RE::TESForm.

◆ InitializeData()

void RE::TESPackage::InitializeData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ InitItemImpl()

void RE::TESPackage::InitItemImpl ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ IsActorAtLocation()

virtual bool RE::TESPackage::IsActorAtLocation ( Actor a_actor,
bool  a_arg2,
float  a_arg3,
bool  a_arg4 
)
virtual

◆ IsActorAtRefTarget()

virtual bool RE::TESPackage::IsActorAtRefTarget ( Actor a_actor,
std::int32_t  a_arg2 
)
virtual

◆ IsActorAtSecondLocation()

virtual bool RE::TESPackage::IsActorAtSecondLocation ( Actor a_arg1,
Actor a_arg2,
bool  a_arg3,
float  a_arg4,
bool  a_arg5 
)
virtual

◆ IsPackageOwner()

virtual bool RE::TESPackage::IsPackageOwner ( Actor a_actor)
virtual

Reimplemented in RE::DialoguePackage.

◆ IsTargetAtLocation()

virtual bool RE::TESPackage::IsTargetAtLocation ( Actor a_actor,
std::int32_t  a_arg2 
)
virtual

◆ Load()

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

Reimplemented from RE::TESForm.

◆ LoadGame()

void RE::TESPackage::LoadGame ( BGSLoadFormBuffer *  a_buf)
overridevirtual

Reimplemented from RE::TESForm.

◆ Revert()

void RE::TESPackage::Revert ( BGSLoadFormBuffer *  a_buf)
overridevirtual

Reimplemented from RE::TESForm.

◆ SaveGame()

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

Reimplemented from RE::TESForm.

Member Data Documentation

◆ combatStyle

TESCombatStyle* RE::TESPackage::combatStyle

◆ data

TESPackageData* RE::TESPackage::data

◆ FORMTYPE

constexpr auto RE::TESPackage::FORMTYPE = FormType::Package
inlinestaticconstexpr

◆ idleCollection

BGSIdleCollection* RE::TESPackage::idleCollection

◆ onBegin

PackageEventAction RE::TESPackage::onBegin

◆ onChange

PackageEventAction RE::TESPackage::onChange

◆ onEnd

PackageEventAction RE::TESPackage::onEnd

◆ ownerQuest

TESQuest* RE::TESPackage::ownerQuest

◆ packConditions

TESCondition RE::TESPackage::packConditions

◆ packData

PACKAGE_DATA RE::TESPackage::packData

◆ packLoc

PackageLocation* RE::TESPackage::packLoc

◆ packSched

PackageSchedule RE::TESPackage::packSched

◆ packTarg

PackageTarget* RE::TESPackage::packTarg

◆ pad2C

std::uint32_t RE::TESPackage::pad2C

◆ pad5C

std::uint32_t RE::TESPackage::pad5C

◆ procedureType

stl::enumeration<PACKAGE_PROCEDURE_TYPE, std::uint32_t> RE::TESPackage::procedureType

◆ refCount

volatile std::uint32_t RE::TESPackage::refCount

◆ RTTI

constexpr auto RE::TESPackage::RTTI = RTTI_TESPackage
inlinestaticconstexpr

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