#include <SpellItem.h>

Inheritance diagram for RE::SpellItem:

Classes
class	Data

struct	RecordFlags

Public Types
enum class	SpellFlag { kNone = 0 , kCostOverride = 1 << 0 , kFoodItem = 1 << 1 , kExtendDuration = 1 << 3 , kPCStartSpell = 1 << 17 , kInstantCast = 1 << 18 , kIgnoreLOSCheck = 1 << 19 , kIgnoreResistance = 1 << 20 , kNoAbsorb = 1 << 21 , kNoDualCastMods = 1 << 23 }

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 Types inherited from RE::BGSEquipType
enum class	EQUIPPED_ITEM_TYPE { kSpell = 24 , kShield = 25 , kTorch = 26 , kTotal }

Public Member Functions
	~SpellItem () override

void	InitializeData () override

void	ClearData () override

void	InitItemImpl () override

MagicSystem::SpellType	GetSpellType () const override

void	SetCastingType (MagicSystem::CastingType a_type) override

MagicSystem::CastingType	GetCastingType () const override

void	SetDelivery (MagicSystem::Delivery a_type) override

MagicSystem::Delivery	GetDelivery () const override

float	GetFixedCastDuration () const override

float	GetRange () const override

bool	IgnoresResistance () const override

bool	IgnoreLOS () const override

bool	GetNoAbsorb () const override

bool	GetNoDualCastModifications () const override

bool	GetSkillUsageData (SkillUsageData &a_data) const override

void	AdjustCost (float &a_cost, Actor *a_actor) const override

float	GetChargeTime () const override

ActorValue	GetAssociatedSkill () const override

bool	IsTwoHanded () const override

std::uint32_t	GetChunkID () override

void	CopyMagicItemData (MagicItem *a_src) override

void	LoadMagicItemChunk (TESFile *a_mod, std::uint32_t a_chunkID) override

void	LoadChunkDataPostProcess (TESFile *a_mod) override

const MagicItem::Data *	GetData1 () const override

MagicItem::Data *	GetData2 () override

std::uint32_t	GetDataSize () const override

void	InitFromChunk (TESFile *a_mod) override

void	InitChunk () override

TESBoundObject *	GetMenuDisplayObject () const override

Public Member Functions inherited from RE::MagicItem
	~MagicItem () override

void	InitializeData () override

bool	Load (TESFile *a_mod) override

void	InitItemImpl () override

bool	IsMagicItem () const override

void	Copy (TESForm *a_srcForm) override

bool	IsAutoCalc () const override

bool	HasKeyword (const BGSKeyword *a_keyword) const override

virtual MagicSystem::SpellType	GetSpellType () const =0

virtual void	SetCastingType (MagicSystem::CastingType a_type)

virtual MagicSystem::CastingType	GetCastingType () const =0

virtual void	SetDelivery (MagicSystem::Delivery a_delivery)

virtual MagicSystem::Delivery	GetDelivery () const =0

virtual bool	IsValidDelivery (MagicSystem::Delivery a_delivery)

virtual float	GetFixedCastDuration () const

virtual float	GetRange () const

virtual bool	IgnoresResistance () const

virtual bool	IgnoreLOS () const

virtual bool	IsFood () const

virtual bool	GetNoAbsorb () const

virtual bool	GetNoDualCastModifications () const

virtual bool	GetSkillUsageData (SkillUsageData &a_data) const

virtual bool	IsPoison () const

virtual bool	IsMedicine () const

virtual void	AdjustCost (float &a_cost, Actor *a_actor) const

virtual float	GetChargeTime () const

virtual std::uint32_t	GetMaxEffectCount () const

virtual ActorValue	GetAssociatedSkill () const

virtual bool	IsTwoHanded () const

virtual std::uint32_t	GetChunkID ()=0

virtual void	CopyMagicItemData (MagicItem *a_src)=0

virtual void	LoadMagicItemChunk (TESFile *a_mod, std::uint32_t a_chunkID)

virtual void	LoadChunkDataPostProcess (TESFile *a_mod)

virtual const Data *	GetData1 () const =0

virtual Data *	GetData2 ()=0

virtual std::uint32_t	GetDataSize () const =0

virtual void	InitFromChunk (TESFile *a_mod)=0

virtual void	InitChunk ()=0

float	CalculateMagickaCost (Actor *a_caster) const

float	CalculateTotalGoldValue (Actor *a_caster=nullptr) const

Effect *	GetCostliestEffectItem (std::uint32_t a_arg1=5, bool a_arg2=false)

Data *	GetData ()

const Data *	GetData () const

Public Member Functions inherited from RE::TESBoundObject
	~TESBoundObject () override

void	LoadObjectBound (TESFile *a_mod) override

bool	IsBoundObject () const override

bool	Activate (TESObjectREFR a_targetRef, TESObjectREFR a_activatorRef, std::uint8_t a_arg3, TESBoundObject *a_object, std::int32_t a_targetCount) override

NiAVObject *	Clone3D (TESObjectREFR *a_ref, bool a_arg3) override

bool	ReplaceModel () override

virtual void	SetObjectVoiceType (BGSVoiceType *a_voiceType)

virtual BGSVoiceType *	GetObjectVoiceType () const

virtual NiAVObject *	Clone3D (TESObjectREFR *a_ref)

virtual bool	ReplaceModel (const char *a_str)

virtual bool	GetActivateText (TESObjectREFR *a_activator, BSString &a_dst)

virtual bool	CalculateDoFavor (Actor a_activator, bool a_arg2, TESObjectREFR a_toActivate, float a_arg3)

virtual void	HandleRemoveItemFromContainer (TESObjectREFR *a_container)

virtual void	OnRemove3D (NiAVObject *a_obj3D)

virtual void	OnCheckModels ()

virtual void	OnCopyReference ()

virtual void	OnFinishScale ()

Public Member Functions inherited from RE::TESObject
	~TESObject () override

bool	IsObject () const override

std::uint32_t	GetRefCount () const override

virtual void	Unk_3B (void)

virtual bool	IsBoundAnimObject ()

virtual TESWaterForm *	GetWaterType () const

virtual bool	IsAutoCalc () const

virtual void	SetAutoCalc (bool a_autoCalc)

virtual NiAVObject *	Clone3D (TESObjectREFR *a_ref, bool a_arg3)

virtual void	UnClone3D (TESObjectREFR *a_ref)

virtual bool	IsMarker ()

virtual bool	IsOcclusionMarker ()

virtual bool	ReplaceModel ()

virtual std::uint32_t	IncRef ()

virtual std::uint32_t	DecRef ()

virtual NiAVObject *	LoadGraphics (TESObjectREFR *a_ref)

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 TESForm *	CreateDuplicateForm (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 TESFile *	GetDescriptionOwnerFile () 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 TESObjectREFR *	AsReference1 ()

virtual const TESObjectREFR *	AsReference2 () 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

TESObjectREFR *	AsReference ()

const TESObjectREFR *	AsReference () const

TESFile *	GetFile (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> 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	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::BGSKeywordForm
	~BGSKeywordForm () override

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

virtual bool	HasKeyword (const BGSKeyword *a_keyword) const

virtual BGSKeyword *	GetDefaultKeyword () const

bool	HasKeyword (FormID a_formID) const

std::optional< BGSKeyword * >	GetKeywordAt (std::uint32_t a_idx) const

std::uint32_t	GetNumKeywords () const

Public Member Functions inherited from RE::BGSEquipType
	~BGSEquipType () override

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

virtual BGSEquipSlot *	GetEquipSlot () const

virtual void	SetEquipSlot (BGSEquipSlot *a_slot)

Public Member Functions inherited from RE::BGSMenuDisplayObject
	~BGSMenuDisplayObject () override

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

virtual TESBoundObject *	GetMenuDisplayObject () const

Public Member Functions inherited from RE::TESDescription
	~TESDescription () override

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

void	GetDescription (BSString &a_out, TESForm *a_parent, std::uint32_t a_fieldType='CSED')

Public Attributes
Data	data

Public Attributes inherited from RE::MagicItem
BSTArray< Effect * >	effects

std::int32_t	hostileCount

std::uint32_t	pad74

EffectSetting *	avEffectSetting

std::uint32_t	preloadCount

std::uint32_t	pad84

BSTSmartPointer< QueuedFile >	preloadedItem

Public Attributes inherited from RE::TESBoundObject
BOUND_DATA	boundData

std::uint32_t	pad2C

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::BGSKeywordForm
BGSKeyword **	keywords

std::uint32_t	numKeywords

std::uint32_t	pad14

Public Attributes inherited from RE::BGSEquipType
BGSEquipSlot *	equipSlot

Public Attributes inherited from RE::BGSMenuDisplayObject
TESBoundObject *	menuDispObject

Public Attributes inherited from RE::TESDescription
std::uint32_t	fileOffset

BGSLocalizedStringDL	descriptionText

Static Public Attributes
static constexpr auto	RTTI = RTTI_SpellItem

static constexpr auto	FORMTYPE = FormType::Spell

Static Public Attributes inherited from RE::MagicItem
static constexpr auto	RTTI = RTTI_MagicItem

Static Public Attributes inherited from RE::TESBoundObject
static constexpr auto	RTTI = RTTI_TESBoundObject

Static Public Attributes inherited from RE::TESObject
static constexpr auto	RTTI = RTTI_TESObject

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::BGSKeywordForm
static constexpr auto	RTTI = RTTI_BGSKeywordForm

Static Public Attributes inherited from RE::BGSEquipType
static constexpr auto	RTTI = RTTI_BGSEquipType

Static Public Attributes inherited from RE::BGSMenuDisplayObject
static constexpr auto	RTTI = RTTI_BGSMenuDisplayObject

Static Public Attributes inherited from RE::TESDescription
static constexpr auto	RTTI = RTTI_TESDescription

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 TESForm *	LookupByID (FormID a_formID)

template<class T >
static T *	LookupByID (FormID a_formID)

static TESForm *	LookupByEditorID (const std::string_view &a_editorID)

template<class T >
static T *	LookupByEditorID (const std::string_view &a_editorID)

Protected Member Functions inherited from RE::MagicItem
float	CalculateCost (Actor *a_caster) const

Member Enumeration Documentation

◆ SpellFlag

enum class RE::SpellItem::SpellFlag

strong

Enumerator
kNone
kCostOverride
kFoodItem
kExtendDuration
kPCStartSpell
kInstantCast
kIgnoreLOSCheck
kIgnoreResistance
kNoAbsorb
kNoDualCastMods

Constructor & Destructor Documentation

◆ ~SpellItem()

RE::SpellItem::~SpellItem ( )

override

Member Function Documentation

◆ AdjustCost()

void RE::SpellItem::AdjustCost	(	float &	a_cost,
		Actor *	a_actor
	)		const

overridevirtual

Reimplemented from RE::MagicItem.

◆ ClearData()

void RE::SpellItem::ClearData ( )

overridevirtual

Reimplemented from RE::TESForm.

◆ CopyMagicItemData()

void RE::SpellItem::CopyMagicItemData ( MagicItem * a_src )

overridevirtual

Implements RE::MagicItem.

◆ GetAssociatedSkill()

ActorValue RE::SpellItem::GetAssociatedSkill ( ) const

overridevirtual

Reimplemented from RE::MagicItem.

◆ GetCastingType()

MagicSystem::CastingType RE::SpellItem::GetCastingType ( ) const

overridevirtual

Implements RE::MagicItem.

◆ GetChargeTime()

float RE::SpellItem::GetChargeTime ( ) const

overridevirtual

Reimplemented from RE::MagicItem.

◆ GetChunkID()

std::uint32_t RE::SpellItem::GetChunkID ( )

overridevirtual

Implements RE::MagicItem.

◆ GetData1()

const MagicItem::Data * RE::SpellItem::GetData1 ( ) const

overridevirtual

Implements RE::MagicItem.

◆ GetData2()

MagicItem::Data * RE::SpellItem::GetData2 ( )

overridevirtual

Implements RE::MagicItem.

◆ GetDataSize()

std::uint32_t RE::SpellItem::GetDataSize ( ) const

overridevirtual

Implements RE::MagicItem.

◆ GetDelivery()

MagicSystem::Delivery RE::SpellItem::GetDelivery ( ) const

overridevirtual

Implements RE::MagicItem.

◆ GetFixedCastDuration()

float RE::SpellItem::GetFixedCastDuration ( ) const

overridevirtual

Reimplemented from RE::MagicItem.

◆ GetMenuDisplayObject()

TESBoundObject * RE::SpellItem::GetMenuDisplayObject ( ) const

overridevirtual

Reimplemented from RE::BGSMenuDisplayObject.

◆ GetNoAbsorb()

bool RE::SpellItem::GetNoAbsorb ( ) const

overridevirtual

Reimplemented from RE::MagicItem.

◆ GetNoDualCastModifications()

bool RE::SpellItem::GetNoDualCastModifications ( ) const

overridevirtual

Reimplemented from RE::MagicItem.

◆ GetRange()

float RE::SpellItem::GetRange ( ) const

overridevirtual

Reimplemented from RE::MagicItem.

◆ GetSkillUsageData()

bool RE::SpellItem::GetSkillUsageData ( SkillUsageData & a_data ) const

overridevirtual

Reimplemented from RE::MagicItem.

◆ GetSpellType()

MagicSystem::SpellType RE::SpellItem::GetSpellType ( ) const

overridevirtual

Implements RE::MagicItem.

◆ IgnoreLOS()

bool RE::SpellItem::IgnoreLOS ( ) const

overridevirtual

Reimplemented from RE::MagicItem.

◆ IgnoresResistance()

bool RE::SpellItem::IgnoresResistance ( ) const

overridevirtual

Reimplemented from RE::MagicItem.

◆ InitChunk()

void RE::SpellItem::InitChunk ( )

overridevirtual

Implements RE::MagicItem.

◆ InitFromChunk()

void RE::SpellItem::InitFromChunk ( TESFile * a_mod )

overridevirtual

Implements RE::MagicItem.

◆ InitializeData()

void RE::SpellItem::InitializeData ( )

overridevirtual

Reimplemented from RE::MagicItem.

◆ InitItemImpl()

void RE::SpellItem::InitItemImpl ( )

overridevirtual

Reimplemented from RE::MagicItem.

◆ IsTwoHanded()

bool RE::SpellItem::IsTwoHanded ( ) const

overridevirtual

Reimplemented from RE::MagicItem.

◆ LoadChunkDataPostProcess()

void RE::SpellItem::LoadChunkDataPostProcess ( TESFile * a_mod )

overridevirtual

Reimplemented from RE::MagicItem.

◆ LoadMagicItemChunk()

void RE::SpellItem::LoadMagicItemChunk	(	TESFile *	a_mod,
		std::uint32_t	a_chunkID
	)

overridevirtual

Reimplemented from RE::MagicItem.

◆ SetCastingType()

void RE::SpellItem::SetCastingType ( MagicSystem::CastingType a_type )

overridevirtual

Reimplemented from RE::MagicItem.

◆ SetDelivery()

void RE::SpellItem::SetDelivery ( MagicSystem::Delivery a_type )

overridevirtual

Reimplemented from RE::MagicItem.

Member Data Documentation

◆ data

Data RE::SpellItem::data

◆ FORMTYPE

constexpr auto RE::SpellItem::FORMTYPE = FormType::Spell

inlinestaticconstexpr

◆ RTTI

constexpr auto RE::SpellItem::RTTI = RTTI_SpellItem

inlinestaticconstexpr

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

CommonLibSSE/include/RE/S/SpellItem.h

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ SpellFlag

Constructor & Destructor Documentation

◆ ~SpellItem()

Member Function Documentation

◆ AdjustCost()

◆ ClearData()

◆ CopyMagicItemData()

◆ GetAssociatedSkill()

◆ GetCastingType()

◆ GetChargeTime()

◆ GetChunkID()

◆ GetData1()

◆ GetData2()

◆ GetDataSize()

◆ GetDelivery()

◆ GetFixedCastDuration()

◆ GetMenuDisplayObject()

◆ GetNoAbsorb()

◆ GetNoDualCastModifications()

◆ GetRange()

◆ GetSkillUsageData()

◆ GetSpellType()

◆ IgnoreLOS()

◆ IgnoresResistance()

◆ InitChunk()

◆ InitFromChunk()

◆ InitializeData()

◆ InitItemImpl()

◆ IsTwoHanded()

◆ LoadChunkDataPostProcess()

◆ LoadMagicItemChunk()

◆ SetCastingType()

◆ SetDelivery()

Member Data Documentation

◆ data

◆ FORMTYPE

◆ RTTI