BGSKeywordForm.h

Go to the documentation of this file.

#pragma once
 
#include "RE/B/BGSKeyword.h"
#include "RE/B/BSContainer.h"
#include "RE/B/BaseFormComponent.h"
 
namespace RE
{
    class BGSKeyword;
 
    class BGSKeywordForm : public BaseFormComponent
    {
    public:
        inline static constexpr auto RTTI = RTTI_BGSKeywordForm;
 
        ~BGSKeywordForm() override;  // 00
 
        // override (BaseFormComponent)
        void InitializeDataComponent() override;                // 01 - { return; }
        void ClearDataComponent() override;                     // 02
        void CopyComponent(BaseFormComponent* a_rhs) override;  // 03
 
        // add
        [[nodiscard]] virtual bool        HasKeyword(const BGSKeyword* a_keyword) const;  // 04
        [[nodiscard]] virtual BGSKeyword* GetDefaultKeyword() const;                      // 05 - { return 0; }
 
        bool                                       AddKeyword(BGSKeyword* a_keyword);
        bool                                       AddKeywords(const std::vector<BGSKeyword*>& a_keywords);
        [[nodiscard]] bool                         ContainsKeywordString(std::string_view a_editorID) const;
        void                                       ForEachKeyword(std::function<BSContainer::ForEachResult(BGSKeyword*)> a_callback) const;
        [[nodiscard]] std::optional<BGSKeyword*>   GetKeywordAt(std::uint32_t a_idx) const;
        [[nodiscard]] std::optional<std::uint32_t> GetKeywordIndex(BGSKeyword* a_keyword) const;
        [[nodiscard]] std::uint32_t                GetNumKeywords() const;
        [[nodiscard]] bool                         HasKeywordID(FormID a_formID) const;
        [[nodiscard]] 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<BGSKeyword*>& a_keywords);
 
        [[nodiscard]] std::span<BGSKeyword*> GetKeywords()
        {
            return { keywords, numKeywords };
        }
 
        [[nodiscard]] std::span<BGSKeyword* const> GetKeywords() const
        {
            return { keywords, numKeywords };
        }
 
        // members
        BGSKeyword**  keywords;     // 08 - KWDA
        std::uint32_t numKeywords;  // 10 - KSIZ
        std::uint32_t pad14;        // 14
 
    private:
        void CopyKeywords(const std::vector<RE::BGSKeyword*>& a_copiedData);
    };
    static_assert(sizeof(BGSKeywordForm) == 0x18);
}