CommonLibSSE (Parapets fork)
RE::TESGrass Class Reference

#include <TESGrass.h>

Inheritance diagram for RE::TESGrass:
RE::TESBoundObject RE::TESModel RE::TESObject RE::BaseFormComponent RE::TESForm RE::BaseFormComponent

Classes

struct  GRASS_DATA
 
struct  RecordFlags
 

Public Types

enum class  GRASS_WATER_STATE {
  kAboveOnlyAtLeast = 0 , kAboveOnlyAtMost = 1 , kBelowOnlyAtLeast = 2 , kBelowOnlyAtMost = 3 ,
  kBothAtLeast = 4 , kBothAtMost = 5 , kBothAtMostAbove = 6 , kBothAtMostBelow = 7
}
 
- 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

 ~TESGrass () override
 
void InitializeData () override
 
bool Load (TESFile *a_mod) override
 
void InitItemImpl () override
 
virtual std::uint8_t GetDensity () const
 
virtual bool SetDensity (std::uint8_t a_density)
 
virtual std::uint8_t GetMinSlopeDegrees () const
 
virtual bool SetMinSlopeDegrees (std::uint8_t a_minSlope)
 
virtual std::uint8_t GetMaxSlopeDegrees () const
 
virtual bool SetMaxSlopeDegrees (std::uint8_t a_maxSlope)
 
virtual float GetMinSlope () const
 
virtual float GetMaxSlope () const
 
virtual std::uint16_t GetDistanceFromWaterLevel () const
 
virtual void SetDistanceFromWaterLevel (std::uint16_t a_unitsFromWater)
 
virtual GRASS_WATER_STATE GetUnderwaterState () const
 
virtual void SetUnderwaterState (GRASS_WATER_STATE a_waterState)
 
virtual float GetPositionRange () const
 
virtual bool SetPositionRange (float a_positionRange)
 
virtual float GetHeightRange () const
 
virtual bool SetHeightRange (float a_heightRange)
 
virtual float GetColorRange () const
 
virtual bool SetColorRange (float a_colorRange)
 
virtual float GetWavePeriod () const
 
virtual bool SetWavePeriod (float a_wavePeriod)
 
virtual bool GetVertexLighting () const
 
virtual void SetVertexLighting (bool a_set)
 
virtual bool GetUniformScaling () const
 
virtual void SetUniformScaling (bool a_set)
 
virtual bool GetFitToSlope () const
 
virtual void SetFitToSlope (bool a_set)
 
- Public Member Functions inherited from RE::TESBoundObject
 ~TESBoundObject () override
 
void LoadObjectBound (TESFile *a_mod) override
 
bool IsBoundObject () const override
 
bool Activate (TESObjectREFR *a_targetRef, TESObjectREFR *a_activatorRef, std::uint8_t a_arg3, TESBoundObject *a_object, std::int32_t a_targetCount) override
 
NiAVObjectClone3D (TESObjectREFR *a_ref, bool a_arg3) override
 
bool ReplaceModel () override
 
virtual void SetObjectVoiceType (BGSVoiceType *a_voiceType)
 
virtual BGSVoiceTypeGetObjectVoiceType () const
 
virtual NiAVObjectClone3D (TESObjectREFR *a_ref)
 
virtual bool ReplaceModel (const char *a_str)
 
virtual bool GetActivateText (TESObjectREFR *a_activator, BSString &a_dst)
 
virtual bool CalculateDoFavor (Actor *a_activator, bool a_arg2, TESObjectREFR *a_toActivate, float a_arg3)
 
virtual void HandleRemoveItemFromContainer (TESObjectREFR *a_container)
 
virtual void OnRemove3D (NiAVObject *a_obj3D)
 
virtual void OnCheckModels ()
 
virtual void OnCopyReference ()
 
virtual void OnFinishScale ()
 
- Public Member Functions inherited from RE::TESObject
 ~TESObject () override
 
bool IsObject () const override
 
std::uint32_t GetRefCount () const override
 
virtual void Unk_3B (void)
 
virtual bool IsBoundAnimObject ()
 
virtual TESWaterFormGetWaterType () const
 
virtual bool IsAutoCalc () const
 
virtual void SetAutoCalc (bool a_autoCalc)
 
virtual void UnClone3D (TESObjectREFR *a_ref)
 
virtual bool IsMarker ()
 
virtual bool IsOcclusionMarker ()
 
virtual std::uint32_t IncRef ()
 
virtual std::uint32_t DecRef ()
 
virtual NiAVObjectLoadGraphics (TESObjectREFR *a_ref)
 
- Public Member Functions inherited from RE::TESForm
 ~TESForm () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
virtual void ClearData ()
 
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 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 bool IsMagicItem () const
 
virtual bool IsWater () const
 
virtual TESObjectREFRAsReference1 ()
 
virtual const TESObjectREFRAsReference2 () 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 void SetFormID (FormID a_id, bool a_updateFile)
 
virtual const char * GetObjectTypeName () const
 
virtual bool QAvailableInGame () const
 
template<class T >
 requires (std::is_class_v< T >) T *As() noexcept
 
template<class T >
 requires (requires { T::FORMTYPE;}) const T *As() const noexcept
 
template<class T >
 requires (!requires { T::FORMTYPE;}) 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
 
const char * GetName () const
 
float GetWeight () const
 
bool HasVMAD () const
 
bool HasWorldModel () const noexcept
 
void InitItem ()
 
bool Is (FormType a_type) const noexcept
 
template<class... Args>
bool Is (Args... a_args) const noexcept requires(std
 
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 IsInitialized () const noexcept
 
bool IsKey () const noexcept
 
bool IsLockpick () const noexcept
 
bool IsNot (FormType a_type) const noexcept
 
template<class... Args>
bool IsNot (Args... a_args) const noexcept requires(std
 
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 ()
 
 TES_HEAP_REDEFINE_NEW ()
 
- Public Member Functions inherited from RE::TESModel
 ~TESModel () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
virtual const char * GetModel () const
 
virtual void SetModel (const char *a_model)
 
virtual TESModelTextureSwapGetAsModelTextureSwap ()
 

Public Attributes

GRASS_DATA data
 
- Public Attributes inherited from RE::TESBoundObject
BOUND_DATA boundData
 
std::uint32_t pad2C
 
- 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::TESModel
BSFixedString model
 
BSResource::IDtextures
 
std::uint32_t * addons
 
std::uint16_t numTextures
 
std::uint16_t numAddons
 
std::uint32_t pad24
 

Static Public Attributes

static constexpr auto RTTI = RTTI_TESGrass
 
static constexpr auto FORMTYPE = FormType::Grass
 
- Static Public Attributes inherited from RE::TESBoundObject
static constexpr auto RTTI = RTTI_TESBoundObject
 
- Static Public Attributes inherited from RE::TESObject
static constexpr auto RTTI = RTTI_TESObject
 
- 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::TESModel
static constexpr auto RTTI = RTTI_TESModel
 

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

◆ GRASS_WATER_STATE

Enumerator
kAboveOnlyAtLeast 
kAboveOnlyAtMost 
kBelowOnlyAtLeast 
kBelowOnlyAtMost 
kBothAtLeast 
kBothAtMost 
kBothAtMostAbove 
kBothAtMostBelow 

Constructor & Destructor Documentation

◆ ~TESGrass()

RE::TESGrass::~TESGrass ( )
override

Member Function Documentation

◆ GetColorRange()

virtual float RE::TESGrass::GetColorRange ( ) const
virtual

◆ GetDensity()

virtual std::uint8_t RE::TESGrass::GetDensity ( ) const
virtual

◆ GetDistanceFromWaterLevel()

virtual std::uint16_t RE::TESGrass::GetDistanceFromWaterLevel ( ) const
virtual

◆ GetFitToSlope()

virtual bool RE::TESGrass::GetFitToSlope ( ) const
virtual

◆ GetHeightRange()

virtual float RE::TESGrass::GetHeightRange ( ) const
virtual

◆ GetMaxSlope()

virtual float RE::TESGrass::GetMaxSlope ( ) const
virtual

◆ GetMaxSlopeDegrees()

virtual std::uint8_t RE::TESGrass::GetMaxSlopeDegrees ( ) const
virtual

◆ GetMinSlope()

virtual float RE::TESGrass::GetMinSlope ( ) const
virtual

◆ GetMinSlopeDegrees()

virtual std::uint8_t RE::TESGrass::GetMinSlopeDegrees ( ) const
virtual

◆ GetPositionRange()

virtual float RE::TESGrass::GetPositionRange ( ) const
virtual

◆ GetUnderwaterState()

virtual GRASS_WATER_STATE RE::TESGrass::GetUnderwaterState ( ) const
virtual

◆ GetUniformScaling()

virtual bool RE::TESGrass::GetUniformScaling ( ) const
virtual

◆ GetVertexLighting()

virtual bool RE::TESGrass::GetVertexLighting ( ) const
virtual

◆ GetWavePeriod()

virtual float RE::TESGrass::GetWavePeriod ( ) const
virtual

◆ InitializeData()

void RE::TESGrass::InitializeData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ InitItemImpl()

void RE::TESGrass::InitItemImpl ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ Load()

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

Reimplemented from RE::TESForm.

◆ SetColorRange()

virtual bool RE::TESGrass::SetColorRange ( float  a_colorRange)
virtual

◆ SetDensity()

virtual bool RE::TESGrass::SetDensity ( std::uint8_t  a_density)
virtual

◆ SetDistanceFromWaterLevel()

virtual void RE::TESGrass::SetDistanceFromWaterLevel ( std::uint16_t  a_unitsFromWater)
virtual

◆ SetFitToSlope()

virtual void RE::TESGrass::SetFitToSlope ( bool  a_set)
virtual

◆ SetHeightRange()

virtual bool RE::TESGrass::SetHeightRange ( float  a_heightRange)
virtual

◆ SetMaxSlopeDegrees()

virtual bool RE::TESGrass::SetMaxSlopeDegrees ( std::uint8_t  a_maxSlope)
virtual

◆ SetMinSlopeDegrees()

virtual bool RE::TESGrass::SetMinSlopeDegrees ( std::uint8_t  a_minSlope)
virtual

◆ SetPositionRange()

virtual bool RE::TESGrass::SetPositionRange ( float  a_positionRange)
virtual

◆ SetUnderwaterState()

virtual void RE::TESGrass::SetUnderwaterState ( GRASS_WATER_STATE  a_waterState)
virtual

◆ SetUniformScaling()

virtual void RE::TESGrass::SetUniformScaling ( bool  a_set)
virtual

◆ SetVertexLighting()

virtual void RE::TESGrass::SetVertexLighting ( bool  a_set)
virtual

◆ SetWavePeriod()

virtual bool RE::TESGrass::SetWavePeriod ( float  a_wavePeriod)
virtual

Member Data Documentation

◆ data

GRASS_DATA RE::TESGrass::data

◆ FORMTYPE

constexpr auto RE::TESGrass::FORMTYPE = FormType::Grass
inlinestaticconstexpr

◆ RTTI

constexpr auto RE::TESGrass::RTTI = RTTI_TESGrass
inlinestaticconstexpr

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