CommonLibSSE NG
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
RE::BGSKeywordForm Class Reference

#include <BGSKeywordForm.h>

Inheritance diagram for RE::BGSKeywordForm:
RE::BaseFormComponent RE::BGSLocation RE::EffectSetting RE::MagicItem RE::TESActorBase RE::TESAmmo RE::TESObjectACTI RE::TESObjectARMO RE::TESObjectBOOK RE::TESObjectMISC RE::TESObjectWEAP RE::TESRace

Public Member Functions

 ~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 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 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 Attributes

BGSKeyword ** keywords
 
std::uint32_t numKeywords
 
std::uint32_t pad14
 

Static Public Attributes

static constexpr auto RTTI = RTTI_BGSKeywordForm
 
- Static Public Attributes inherited from RE::BaseFormComponent
static constexpr auto RTTI = RTTI_BaseFormComponent
 

Constructor & Destructor Documentation

◆ ~BGSKeywordForm()

RE::BGSKeywordForm::~BGSKeywordForm ( )
override

Member Function Documentation

◆ AddKeyword()

bool RE::BGSKeywordForm::AddKeyword ( BGSKeyword *  a_keyword)

◆ AddKeywords()

bool RE::BGSKeywordForm::AddKeywords ( const std::vector< BGSKeyword * > &  a_keywords)

◆ ClearDataComponent()

void RE::BGSKeywordForm::ClearDataComponent ( )
overridevirtual

Implements RE::BaseFormComponent.

◆ ContainsKeywordString()

bool RE::BGSKeywordForm::ContainsKeywordString ( std::string_view  a_editorID) const

◆ CopyComponent()

void RE::BGSKeywordForm::CopyComponent ( BaseFormComponent *  a_rhs)
overridevirtual

Reimplemented from RE::BaseFormComponent.

◆ ForEachKeyword()

void RE::BGSKeywordForm::ForEachKeyword ( std::function< BSContainer::ForEachResult(BGSKeyword &)>  a_callback) const

◆ GetDefaultKeyword()

virtual BGSKeyword * RE::BGSKeywordForm::GetDefaultKeyword ( ) const
virtual

Reimplemented in RE::AlchemyItem, RE::IngredientItem, RE::TESAmmo, RE::TESKey, RE::TESObjectARMO, RE::TESObjectBOOK, RE::TESObjectMISC, RE::TESObjectWEAP, and RE::TESSoulGem.

◆ GetKeywordAt()

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

◆ GetKeywordIndex()

std::optional< std::uint32_t > RE::BGSKeywordForm::GetKeywordIndex ( BGSKeyword *  a_keyword) const

◆ GetKeywords() [1/2]

std::span< BGSKeyword * > RE::BGSKeywordForm::GetKeywords ( )
inline

◆ GetKeywords() [2/2]

std::span< BGSKeyword *const > RE::BGSKeywordForm::GetKeywords ( ) const
inline

◆ GetNumKeywords()

std::uint32_t RE::BGSKeywordForm::GetNumKeywords ( ) const

◆ HasKeyword()

virtual bool RE::BGSKeywordForm::HasKeyword ( const BGSKeyword *  a_keyword) const
virtual

Reimplemented in RE::EffectSetting, and RE::MagicItem.

◆ HasKeywordID()

bool RE::BGSKeywordForm::HasKeywordID ( FormID  a_formID) const

◆ HasKeywordString()

bool RE::BGSKeywordForm::HasKeywordString ( std::string_view  a_editorID) const

◆ InitializeDataComponent()

void RE::BGSKeywordForm::InitializeDataComponent ( )
overridevirtual

Implements RE::BaseFormComponent.

◆ RemoveKeyword() [1/2]

bool RE::BGSKeywordForm::RemoveKeyword ( BGSKeyword *  a_keyword)

◆ RemoveKeyword() [2/2]

bool RE::BGSKeywordForm::RemoveKeyword ( std::uint32_t  a_index)

◆ RemoveKeywords()

bool RE::BGSKeywordForm::RemoveKeywords ( const std::vector< RE::BGSKeyword * > &  a_keywords)

Member Data Documentation

◆ keywords

BGSKeyword** RE::BGSKeywordForm::keywords

◆ numKeywords

std::uint32_t RE::BGSKeywordForm::numKeywords

◆ pad14

std::uint32_t RE::BGSKeywordForm::pad14

◆ RTTI

constexpr auto RE::BGSKeywordForm::RTTI = RTTI_BGSKeywordForm
inlinestaticconstexpr
The documentation for this class was generated from the following file: