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

#include <EffectSetting.h>

Inheritance diagram for RE::EffectSetting:
RE::TESForm RE::TESFullName RE::BGSMenuDisplayObject RE::BGSKeywordForm RE::BaseFormComponent RE::BaseFormComponent RE::BaseFormComponent RE::BaseFormComponent

Classes

struct  EffectSettingData
 
struct  RecordFlags
 
struct  SoundPair
 

Public Types

using Archetype = EffectArchetypes::ArchetypeID
 
using FilterValidation_t = bool(EffectSetting *, void *)
 
- 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

 ~EffectSetting () override
 
void ClearData () override
 
bool Load (TESFile *a_mod) override
 
void InitItemImpl () override
 
void Copy (TESForm *a_srcForm) override
 
const char * GetObjectTypeName () const override
 
bool HasKeyword (const BGSKeyword *a_keyword) const override
 
constexpr Archetype GetArchetype () const noexcept
 
constexpr ActorValue GetMagickSkill () const noexcept
 
constexpr std::int32_t GetMinimumSkillLevel () const noexcept
 
constexpr bool HasArchetype (Archetype a_type) const noexcept
 
bool HasKeyword (std::string_view a_editorID)
 
bool IsDetrimental () const noexcept
 
bool IsHostile () 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 Member Functions inherited from RE::BGSMenuDisplayObject
 ~BGSMenuDisplayObject () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
virtual TESBoundObjectGetMenuDisplayObject () const
 
- Public Member Functions inherited from RE::BGSKeywordForm
 ~BGSKeywordForm () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
virtual bool HasKeyword (const BGSKeyword *a_keyword) const
 
virtual BGSKeywordGetDefaultKeyword () const
 
bool AddKeyword (BGSKeyword *a_keyword)
 
bool AddKeywords (const std::vector< BGSKeyword * > &a_keywords)
 
bool ContainsKeywordString (std::string_view a_editorID) const
 
void ForEachKeyword (std::function< BSContainer::ForEachResult(BGSKeyword &)> a_callback) const
 
std::optional< BGSKeyword * > GetKeywordAt (std::uint32_t a_idx) const
 
std::optional< std::uint32_t > GetKeywordIndex (BGSKeyword *a_keyword) const
 
std::uint32_t GetNumKeywords () const
 
bool HasKeywordID (FormID a_formID) const
 
bool HasKeywordString (std::string_view a_editorID) const
 
bool RemoveKeyword (std::uint32_t a_index)
 
bool RemoveKeyword (BGSKeyword *a_keyword)
 
bool RemoveKeywords (const std::vector< RE::BGSKeyword * > &a_keywords)
 
std::span< BGSKeyword * > GetKeywords ()
 
std::span< BGSKeyword *const > GetKeywords () const
 

Public Attributes

FilterValidation_tfilterValidationFunction
 
void * filterValidationItem
 
EffectSettingData data
 
BSSimpleList< EffectSetting * > counterEffects
 
BSTArray< SoundPaireffectSounds
 
BSFixedString magicItemDescription
 
std::int32_t effectLoadedCount
 
std::int32_t associatedItemLoadedCount
 
TESCondition conditions
 
- 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::BGSMenuDisplayObject
TESBoundObjectmenuDispObject
 
- Public Attributes inherited from RE::BGSKeywordForm
BGSKeyword ** keywords
 
std::uint32_t numKeywords
 
std::uint32_t pad14
 

Static Public Attributes

static constexpr auto RTTI = RTTI_EffectSetting
 
static constexpr auto VTABLE = VTABLE_EffectSetting
 
static constexpr auto FORMTYPE = FormType::MagicEffect
 
- 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::BGSMenuDisplayObject
static constexpr auto RTTI = RTTI_BGSMenuDisplayObject
 
- Static Public Attributes inherited from RE::BGSKeywordForm
static constexpr auto RTTI = RTTI_BGSKeywordForm
 

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

◆ Archetype

◆ FilterValidation_t

Constructor & Destructor Documentation

◆ ~EffectSetting()

RE::EffectSetting::~EffectSetting ( )
override

Member Function Documentation

◆ ClearData()

void RE::EffectSetting::ClearData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ Copy()

void RE::EffectSetting::Copy ( TESForm a_srcForm)
overridevirtual

Reimplemented from RE::TESForm.

◆ GetArchetype()

constexpr Archetype RE::EffectSetting::GetArchetype ( ) const
inlineconstexprnoexcept

◆ GetMagickSkill()

constexpr ActorValue RE::EffectSetting::GetMagickSkill ( ) const
inlineconstexprnoexcept

◆ GetMinimumSkillLevel()

constexpr std::int32_t RE::EffectSetting::GetMinimumSkillLevel ( ) const
inlineconstexprnoexcept

◆ GetObjectTypeName()

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

Reimplemented from RE::TESForm.

◆ HasArchetype()

constexpr bool RE::EffectSetting::HasArchetype ( Archetype  a_type) const
inlineconstexprnoexcept

◆ HasKeyword() [1/2]

bool RE::EffectSetting::HasKeyword ( const BGSKeyword a_keyword) const
overridevirtual

Reimplemented from RE::BGSKeywordForm.

◆ HasKeyword() [2/2]

bool RE::EffectSetting::HasKeyword ( std::string_view  a_editorID)
inline

◆ InitItemImpl()

void RE::EffectSetting::InitItemImpl ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ IsDetrimental()

bool RE::EffectSetting::IsDetrimental ( ) const
inlinenoexcept

◆ IsHostile()

bool RE::EffectSetting::IsHostile ( ) const
inlinenoexcept

◆ Load()

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

Reimplemented from RE::TESForm.

Member Data Documentation

◆ associatedItemLoadedCount

std::int32_t RE::EffectSetting::associatedItemLoadedCount

◆ conditions

TESCondition RE::EffectSetting::conditions

◆ counterEffects

BSSimpleList<EffectSetting*> RE::EffectSetting::counterEffects

◆ data

EffectSettingData RE::EffectSetting::data

◆ effectLoadedCount

std::int32_t RE::EffectSetting::effectLoadedCount

◆ effectSounds

BSTArray<SoundPair> RE::EffectSetting::effectSounds

◆ filterValidationFunction

FilterValidation_t* RE::EffectSetting::filterValidationFunction

◆ filterValidationItem

void* RE::EffectSetting::filterValidationItem

◆ FORMTYPE

constexpr auto RE::EffectSetting::FORMTYPE = FormType::MagicEffect
inlinestaticconstexpr

◆ magicItemDescription

BSFixedString RE::EffectSetting::magicItemDescription

◆ RTTI

constexpr auto RE::EffectSetting::RTTI = RTTI_EffectSetting
inlinestaticconstexpr

◆ VTABLE

constexpr auto RE::EffectSetting::VTABLE = VTABLE_EffectSetting
inlinestaticconstexpr

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