CommonLibSSE NG
Loading...
Searching...
No Matches
RE::TESWaterForm Class Reference

#include <TESWaterForm.h>

Inheritance diagram for RE::TESWaterForm:
RE::TESForm RE::TESFullName RE::TESAttackDamageForm RE::BaseFormComponent RE::BaseFormComponent RE::BaseFormComponent

Classes

struct  RecordFlags
 

Public Types

enum class  Flag { kNone = 0 , kCauseDamage = 1 << 0 , kEnableFlowmap = 1 << 3 , kBlendNormals = 1 << 4 }
 
- 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 Member Functions

 ~TESWaterForm () override
 
void InitializeData () override
 
bool Load (TESFile *a_mod) override
 
void InitItemImpl () override
 
bool GetDangerous () const override
 
bool Activate (TESObjectREFR *a_targetRef, TESObjectREFR *a_activatorRef, std::uint8_t a_arg3, TESBoundObject *a_object, std::int32_t a_targetCount) override
 
- 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 TESFormCreateDuplicateForm (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 TESFileGetDescriptionOwnerFile () 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 TESObjectREFRAsReference1 ()
 
virtual const TESObjectREFRAsReference2 () 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
 
TESObjectREFRAsReference ()
 
const TESObjectREFRAsReference () const
 
TESFileGetFile (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
 
FormID GetRawFormID () const
 
FormID GetLocalFormID () const
 
const char * GetName () const
 
float GetWeight () const
 
bool HasKeywordInArray (const std::vector< BGSKeyword * > &a_keywords, bool a_matchAll) const
 
bool HasKeywordInList (BGSListForm *a_keywordList, bool a_matchAll) 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 IsInventoryObject () const
 
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::TESAttackDamageForm
 ~TESAttackDamageForm () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
virtual std::uint16_t GetAttackDamage () const
 

Public Attributes

bool needUpdate
 
std::uint8_t pad41
 
std::uint16_t pad42
 
NiColorA texScroll [3]
 
std::uint32_t pad074
 
TESTexture noiseTextures [4]
 
std::int8_t alpha
 
stl::enumeration< Flag, std::uint8_t > flags
 
std::uint16_t pad0BA
 
std::uint32_t pad0BC
 
BGSMaterialTypematerialType
 
BGSSoundDescriptorFormwaterSound
 
WaterShaderData data
 
TESWaterFormwaterWeatherControl [3]
 
std::int32_t currentTextureSelect [2]
 
std::uint32_t frequencyX
 
std::uint32_t frequencyY
 
std::int32_t octaves
 
float amplitude
 
float lacunarity
 
float bias
 
float gain
 
std::uint32_t pad1F4
 
SpellItemcontactSpell
 
NiPointer< NiTexturenoiseTextureData [4]
 
TESObjectACTIplaceableAutoWater
 
TESObjectACTIplaceableLODWater
 
BSWaterShaderMaterialwaterShaderMaterial
 
bool resetNoiseTextures
 
std::uint8_t pad239
 
std::uint16_t pad23A
 
std::uint32_t pad23C
 
TESImageSpaceimageSpace
 
NiPoint3 linearVelocity
 
NiPoint3 angularVelocity
 
- 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::TESAttackDamageForm
std::uint16_t attackDamage
 
std::uint16_t pad0A
 
std::uint32_t pad0C
 

Static Public Attributes

static constexpr auto RTTI = RTTI_TESWaterForm
 
static constexpr auto VTABLE = VTABLE_TESWaterForm
 
static constexpr auto FORMTYPE = FormType::Water
 
- 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::TESAttackDamageForm
static constexpr auto RTTI = RTTI_TESAttackDamageForm
 

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 TESFormLookupByID (FormID a_formID)
 
template<class T >
static T * LookupByID (FormID a_formID)
 
static TESFormLookupByEditorID (const std::string_view &a_editorID)
 
template<class T >
static T * LookupByEditorID (const std::string_view &a_editorID)
 

Member Enumeration Documentation

◆ Flag

enum class RE::TESWaterForm::Flag
strong
Enumerator
kNone 
kCauseDamage 
kEnableFlowmap 
kBlendNormals 

Constructor & Destructor Documentation

◆ ~TESWaterForm()

RE::TESWaterForm::~TESWaterForm ( )
override

Member Function Documentation

◆ Activate()

bool RE::TESWaterForm::Activate ( TESObjectREFR a_targetRef,
TESObjectREFR a_activatorRef,
std::uint8_t  a_arg3,
TESBoundObject a_object,
std::int32_t  a_targetCount 
)
overridevirtual

Reimplemented from RE::TESForm.

◆ GetDangerous()

bool RE::TESWaterForm::GetDangerous ( ) const
overridevirtual

Reimplemented from RE::TESForm.

◆ InitializeData()

void RE::TESWaterForm::InitializeData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ InitItemImpl()

void RE::TESWaterForm::InitItemImpl ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ Load()

bool RE::TESWaterForm::Load ( TESFile a_mod)
overridevirtual

Reimplemented from RE::TESForm.

Member Data Documentation

◆ alpha

std::int8_t RE::TESWaterForm::alpha

◆ amplitude

float RE::TESWaterForm::amplitude

◆ angularVelocity

NiPoint3 RE::TESWaterForm::angularVelocity

◆ bias

float RE::TESWaterForm::bias

◆ contactSpell

SpellItem* RE::TESWaterForm::contactSpell

◆ currentTextureSelect

std::int32_t RE::TESWaterForm::currentTextureSelect[2]

◆ data

WaterShaderData RE::TESWaterForm::data

◆ flags

stl::enumeration<Flag, std::uint8_t> RE::TESWaterForm::flags

◆ FORMTYPE

constexpr auto RE::TESWaterForm::FORMTYPE = FormType::Water
inlinestaticconstexpr

◆ frequencyX

std::uint32_t RE::TESWaterForm::frequencyX

◆ frequencyY

std::uint32_t RE::TESWaterForm::frequencyY

◆ gain

float RE::TESWaterForm::gain

◆ imageSpace

TESImageSpace* RE::TESWaterForm::imageSpace

◆ lacunarity

float RE::TESWaterForm::lacunarity

◆ linearVelocity

NiPoint3 RE::TESWaterForm::linearVelocity

◆ materialType

BGSMaterialType* RE::TESWaterForm::materialType

◆ needUpdate

bool RE::TESWaterForm::needUpdate

◆ noiseTextureData

NiPointer<NiTexture> RE::TESWaterForm::noiseTextureData[4]

◆ noiseTextures

TESTexture RE::TESWaterForm::noiseTextures[4]

◆ octaves

std::int32_t RE::TESWaterForm::octaves

◆ pad074

std::uint32_t RE::TESWaterForm::pad074

◆ pad0BA

std::uint16_t RE::TESWaterForm::pad0BA

◆ pad0BC

std::uint32_t RE::TESWaterForm::pad0BC

◆ pad1F4

std::uint32_t RE::TESWaterForm::pad1F4

◆ pad239

std::uint8_t RE::TESWaterForm::pad239

◆ pad23A

std::uint16_t RE::TESWaterForm::pad23A

◆ pad23C

std::uint32_t RE::TESWaterForm::pad23C

◆ pad41

std::uint8_t RE::TESWaterForm::pad41

◆ pad42

std::uint16_t RE::TESWaterForm::pad42

◆ placeableAutoWater

TESObjectACTI* RE::TESWaterForm::placeableAutoWater

◆ placeableLODWater

TESObjectACTI* RE::TESWaterForm::placeableLODWater

◆ resetNoiseTextures

bool RE::TESWaterForm::resetNoiseTextures

◆ RTTI

constexpr auto RE::TESWaterForm::RTTI = RTTI_TESWaterForm
inlinestaticconstexpr

◆ texScroll

NiColorA RE::TESWaterForm::texScroll[3]

◆ VTABLE

constexpr auto RE::TESWaterForm::VTABLE = VTABLE_TESWaterForm
inlinestaticconstexpr

◆ waterShaderMaterial

BSWaterShaderMaterial* RE::TESWaterForm::waterShaderMaterial

◆ waterSound

BGSSoundDescriptorForm* RE::TESWaterForm::waterSound

◆ waterWeatherControl

TESWaterForm* RE::TESWaterForm::waterWeatherControl[3]

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