ReferenceEffectController.h

Go to the documentation of this file.

#pragma once
 
#include "RE/B/BSFixedString.h"
#include "RE/M/MemoryManager.h"
 
namespace RE
{
    class BGSArtObject;
    class BGSLoadGameBuffer;
    class BGSSaveGameBuffer;
    class NiAVObject;
    class NiNode;
    class NiPoint3;
    class ReferenceEffect;
    class TESEffectShader;
    class TESObjectREFR;
 
    class ReferenceEffectController
    {
    public:
        inline static constexpr auto RTTI = RTTI_ReferenceEffectController;
        inline static constexpr auto VTABLE = VTABLE_ReferenceEffectController;
 
        virtual ~ReferenceEffectController() = default;  // 00
 
        // add
        virtual void             HandleEvent(const BSFixedString& a_event);                 // 01 - { return; }
        virtual float            GetElapsedTime();                                          // 02 - { return 0.0; }
        virtual float            GetScale();                                                // 03 - { return 1.0; }
        virtual void             SwitchAttachedRoot(NiNode* a_root, NiNode* a_attachRoot);  // 04 - { return; }
        virtual const NiPoint3&  GetSourcePosition();                                       // 05 - { return NiPoint3(); }
        virtual bool             GetUseSourcePosition();                                    // 06 - { return true; }
        virtual bool             GetNoInitialFlare();                                       // 07 - { return false; }
        virtual bool             GetEffectPersists();                                       // 08 - { return true; }
        virtual bool             GetGoryVisuals();                                          // 09 - { return false; }
        virtual void             RemoveHitEffect(ReferenceEffect* a_refEffect);             // 0A - { return; }
        virtual TESObjectREFR*   GetTargetReference() = 0;                                  // 0B
        virtual BGSArtObject*    GetHitEffectArt() = 0;                                     // 0C
        virtual TESEffectShader* GetHitEffectShader() = 0;                                  // 0D
        virtual bool             GetManagerHandlesSaveLoad() = 0;                           // 0E
        virtual NiAVObject*      GetAttachRoot();                                           // 0F - { auto ref = GetTargetReference(); return ref ? ref->Get3D() : 0; }
        virtual float            GetParticleAttachExtent();                                 // 10 - { return 0.0; }
        virtual bool             GetUseParticleAttachExtent();                              // 11 - { return false; }
        virtual bool             GetDoParticles();                                          // 12 - { return true; }
        virtual bool             GetParticlesUseLocalSpace();                               // 13 - { return false; }
        virtual bool             GetUseRootWorldRotate();                                   // 14 - { return false; }
        virtual bool             GetIsRootActor();                                          // 15 - { auto ref = GetTargetReference(); return ref ? ref->formType = FormType::ActorCharacter : false; }
        virtual bool             GetClearWhenCellIsUnloaded();                              // 16 - { return false; }
        virtual bool             EffectShouldFaceTarget();                                  // 17 - { return false; }
        virtual TESObjectREFR*   GetFacingTarget();                                         // 18 - { return 0; }
        virtual bool             GetShaderUseParentCell();                                  // 19 - { return true; }
        virtual bool             EffectAttachesToCamera();                                  // 1A - { return false; }
        virtual bool             EffectRotatesWithCamera();                                 // 1B - { return false; }
        virtual bool             GetAllowTargetRoot();                                      // 1C - { return true; }
        virtual bool             IsReadyForAttach();                                        // 1D - { return true; }
        virtual void             SetWindPoint(const NiPoint3& a_point);                     // 1E - { return; }
        virtual const NiPoint3&  GetWindPoint();                                            // 1F - { return NiPoint3(); }
        virtual bool             GetAllowNo3D();                                            // 20 - { return false; }
        virtual void             SaveGame(BGSSaveGameBuffer* a_buf);                        // 21 - { return; }
        virtual void             LoadGame(BGSLoadGameBuffer* a_buf);                        // 22 - { return; }
 
        void Start(ReferenceEffect** a_effectOut = nullptr);
        void Stop();
 
        TES_HEAP_REDEFINE_NEW();
 
    private:
        KEEP_FOR_RE()
    };
    static_assert(sizeof(ReferenceEffectController) == 0x8);
}