MagicItem.h

Go to the documentation of this file.

#pragma once
 
#include "RE/A/ActorValues.h"
#include "RE/B/BGSKeywordForm.h"
#include "RE/B/BSTArray.h"
#include "RE/B/BSTSmartPointer.h"
#include "RE/E/EffectArchetypes.h"
#include "RE/M/MagicItemDataCollector.h"
#include "RE/M/MagicItemTraversalFunctor.h"
#include "RE/M/MagicSystem.h"
#include "RE/T/TESBoundObject.h"
#include "RE/T/TESFullName.h"
 
namespace RE
{
    class Actor;
    class ActorValueInfo;
    class Character;
    class EffectItem;
    class EffectSetting;
    class QueuedFile;
    class TESModel;
    class TESObjectWEAP;
    struct Effect;
 
    class MagicItem :
        public TESBoundObject,  // 00
        public TESFullName,     // 30
        public BGSKeywordForm   // 40
    {
    public:
        inline static constexpr auto RTTI = RTTI_MagicItem;
 
        class PreloadableVisitor
        {
        public:
            // add
            virtual void VisitModel(TESModel* a_model) = 0;         // 00
            virtual void VisitWeapon(TESObjectWEAP* a_weapon) = 0;  // 01
        };
        static_assert(sizeof(PreloadableVisitor) == 0x8);
 
        struct SkillUsageData
        {
        public:
            // members
            EffectItem*   effect;     // 00
            ActorValue    skill;      // 08
            float         magnitude;  // 0C
            bool          custom;     // 10
            std::uint8_t  pad11;      // 11
            std::uint16_t pad12;      // 12
            std::uint32_t pad14;      // 14
        };
        static_assert(sizeof(SkillUsageData) == 0x18);
 
        class Data
        {
        public:
            // members
            std::int32_t  costOverride;  // 0
            std::uint32_t flags;         // 4
        };
        static_assert(sizeof(Data) == 0x8);
 
        ~MagicItem() override;  // 00
 
        // override (TESBoundObject)
        void InitializeData() override;          // 04 - { TESForm::InitDefaults(); }
        bool Load(TESFile* a_mod) override;      // 06
        void InitItemImpl() override;            // 13
        bool IsMagicItem() const override;       // 29 - { return true; }
        void Copy(TESForm* a_srcForm) override;  // 2F
        bool IsAutoCalc() const override;        // 3E - { return (GetData().flags & 1) == 0; }
 
        // override (BGSKeywordForm)
        bool HasKeyword(const BGSKeyword* a_keyword) const override;  // 04
 
        // add
        [[nodiscard]] virtual MagicSystem::SpellType   GetSpellType() const = 0;                                     // 53
        virtual void                                   SetCastingType(MagicSystem::CastingType a_type);              // 54 - { return; }
        [[nodiscard]] virtual MagicSystem::CastingType GetCastingType() const = 0;                                   // 55
        virtual void                                   SetDelivery(MagicSystem::Delivery a_delivery);                // 56 - { return; }
        [[nodiscard]] virtual MagicSystem::Delivery    GetDelivery() const = 0;                                      // 57
        [[nodiscard]] virtual bool                     IsValidDelivery(MagicSystem::Delivery a_delivery);            // 58 - { return true; }
        [[nodiscard]] virtual float                    GetFixedCastDuration() const;                                 // 59 - { return 0.0; }
        [[nodiscard]] virtual float                    GetRange() const;                                             // 5A - { return 0.0; }
        [[nodiscard]] virtual bool                     IgnoresResistance() const;                                    // 5B - { return false; }
        [[nodiscard]] virtual bool                     IgnoreLOS() const;                                            // 5C - { return false; }
        [[nodiscard]] virtual bool                     IsFood() const;                                               // 5D - { return false; }
        [[nodiscard]] virtual bool                     GetNoAbsorb() const;                                          // 5E - { return false; }
        [[nodiscard]] virtual bool                     GetNoDualCastModifications() const;                           // 5F - { return false; }
        virtual bool                                   GetSkillUsageData(SkillUsageData& a_data) const;              // 60 - { return false; }
        [[nodiscard]] virtual bool                     IsPoison() const;                                             // 61 - { return GetSpellType() == MagicSystem::SpellType::kPoison; }
        [[nodiscard]] virtual bool                     IsMedicine() const;                                           // 62 - { return false; }
        virtual void                                   AdjustCost(float& a_cost, Actor* a_actor) const;              // 63 - { return; }
        [[nodiscard]] virtual float                    GetChargeTime() const;                                        // 64 - { return 0.0; }
        [[nodiscard]] virtual std::uint32_t            GetMaxEffectCount() const;                                    // 65 - { return 0; }
        [[nodiscard]] virtual ActorValue               GetAssociatedSkill() const;                                   // 66 - { return ActorValue::kNone; }
        [[nodiscard]] virtual bool                     IsTwoHanded() const;                                          // 67 - { return false; }
        [[nodiscard]] virtual std::uint32_t            GetChunkID() = 0;                                             // 68
        virtual void                                   CopyMagicItemData(MagicItem* a_src) = 0;                      // 69
        virtual void                                   LoadMagicItemChunk(TESFile* a_mod, std::uint32_t a_chunkID);  // 6A - { return; }
        virtual void                                   LoadChunkDataPostProcess(TESFile* a_mod);                     // 6B - { return; }
        [[nodiscard]] virtual const Data*              GetData1() const = 0;                                         // 6C
        [[nodiscard]] virtual Data*                    GetData2() = 0;                                               // 6D
        [[nodiscard]] virtual std::uint32_t            GetDataSize() const = 0;                                      // 6E
        virtual void                                   InitFromChunk(TESFile* a_mod) = 0;                            // 6F
        virtual void                                   InitChunk() = 0;                                              // 70
 
        [[nodiscard]] float                  CalculateMagickaCost(Actor* a_caster) const;
        [[nodiscard]] float                  CalculateTotalGoldValue(Actor* a_caster = nullptr) const;
        [[nodiscard]] MagicItemDataCollector CollectData() const;
        [[nodiscard]] EffectSetting*         GetAVEffect() const;
        [[nodiscard]] Effect*                GetCostliestEffectItem(MagicSystem::Delivery a_delivery = MagicSystem::Delivery::kTotal, bool a_positiveArea = false) const;
        [[nodiscard]] Data*                  GetData();
        [[nodiscard]] const Data*            GetData() const;
        [[nodiscard]] bool                   IsValid() const;
        [[nodiscard]] std::int32_t           GetLargestArea() const;
        [[nodiscard]] std::uint32_t          GetLongestDuration() const;
        [[nodiscard]] bool                   HasEffect(EffectArchetype a_archetype);
        [[nodiscard]] bool                   IsHostile() const;
        [[nodiscard]] bool                   IsPermanent() const;
        void                                 Traverse(MagicItemTraversalFunctor& a_visitor) const;
 
        // members
        BSTArray<Effect*>           effects;          // 58
        std::int32_t                hostileCount;     // 70
        std::uint32_t               pad74;            // 74
        EffectSetting*              avEffectSetting;  // 78
        std::uint32_t               preloadCount;     // 80
        std::uint32_t               pad84;            // 84
        BSTSmartPointer<QueuedFile> preloadedItem;    // 88
 
    protected:
        float CalculateCost(Actor* a_caster) const;
    };
    static_assert(sizeof(MagicItem) == 0x90);
}