CommonLibSSE (Parapets fork)
RE::TESWeather Class Reference

#include <TESWeather.h>

Inheritance diagram for RE::TESWeather:
RE::TESForm RE::BaseFormComponent

Classes

struct  ColorTimes
 
struct  ColorTypes
 
struct  Data
 
struct  FogData
 
struct  RecordFlags
 
struct  WeatherSound
 
struct  WeatherSoundList
 

Public Types

enum  { kTotalLayers = 32 }
 
enum class  SoundType { kDefault = 0 , kPrecip = 1 , kWind = 2 , kThunder = 3 }
 
enum class  WeatherDataFlag {
  kNone = 0 , kPleasant = 1 << 0 , kCloudy = 1 << 1 , kRainy = 1 << 2 ,
  kSnow = 1 << 3 , kPermAurora = 1 << 4 , kAuroraFollowsSun = 1 << 5
}
 
using ColorTime = ColorTimes::ColorTime
 
- 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

 ~TESWeather () override
 
void InitializeData () override
 
void ClearData () override
 
bool Load (TESFile *a_mod) override
 
void InitItemImpl () override
 
- Public Member Functions inherited from RE::TESForm
 ~TESForm () override
 
void InitializeDataComponent () override
 
void ClearDataComponent () override
 
void CopyComponent (BaseFormComponent *a_rhs) override
 
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 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 >
 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 Attributes

TESTexture1024 cloudTextures [kTotalLayers]
 
std::int8_t cloudLayerSpeedY [kTotalLayers]
 
std::int8_t cloudLayerSpeedX [kTotalLayers]
 
Color cloudColorData [kTotalLayers][ColorTime::kTotal]
 
float cloudAlpha [kTotalLayers][ColorTime::kTotal]
 
std::uint32_t cloudLayerDisabledBits
 
Data data
 
FogData fogData
 
Color colorData [ColorTypes::kTotal][ColorTime::kTotal]
 
WeatherSoundList sounds
 
BSTArray< TESObjectSTAT * > skyStatics
 
std::uint32_t numCloudLayers
 
std::uint32_t pad7D4
 
TESImageSpaceimageSpaces [ColorTime::kTotal]
 
BGSDirectionalAmbientLightingColors directionalAmbientLightingColors [ColorTime::kTotal]
 
TESModel aurora
 
BGSLensFlaresunGlareLensFlare
 
BGSVolumetricLightingvolumetricLighting [ColorTime::kTotal]
 
BGSShaderParticleGeometryDataprecipitationData
 
BGSReferenceEffectreferenceEffect
 
- 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
 

Static Public Attributes

static constexpr auto RTTI = RTTI_TESWeather
 
static constexpr auto FORMTYPE = FormType::Weather
 
- 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
 

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 Typedef Documentation

◆ ColorTime

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kTotalLayers 

◆ SoundType

Enumerator
kDefault 
kPrecip 
kWind 
kThunder 

◆ WeatherDataFlag

Enumerator
kNone 
kPleasant 
kCloudy 
kRainy 
kSnow 
kPermAurora 
kAuroraFollowsSun 

Constructor & Destructor Documentation

◆ ~TESWeather()

RE::TESWeather::~TESWeather ( )
override

Member Function Documentation

◆ ClearData()

void RE::TESWeather::ClearData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ InitializeData()

void RE::TESWeather::InitializeData ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ InitItemImpl()

void RE::TESWeather::InitItemImpl ( )
overridevirtual

Reimplemented from RE::TESForm.

◆ Load()

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

Reimplemented from RE::TESForm.

Member Data Documentation

◆ aurora

TESModel RE::TESWeather::aurora

◆ cloudAlpha

float RE::TESWeather::cloudAlpha[kTotalLayers][ColorTime::kTotal]

◆ cloudColorData

Color RE::TESWeather::cloudColorData[kTotalLayers][ColorTime::kTotal]

◆ cloudLayerDisabledBits

std::uint32_t RE::TESWeather::cloudLayerDisabledBits

◆ cloudLayerSpeedX

std::int8_t RE::TESWeather::cloudLayerSpeedX[kTotalLayers]

◆ cloudLayerSpeedY

std::int8_t RE::TESWeather::cloudLayerSpeedY[kTotalLayers]

◆ cloudTextures

TESTexture1024 RE::TESWeather::cloudTextures[kTotalLayers]

◆ colorData

Color RE::TESWeather::colorData[ColorTypes::kTotal][ColorTime::kTotal]

◆ data

Data RE::TESWeather::data

◆ directionalAmbientLightingColors

BGSDirectionalAmbientLightingColors RE::TESWeather::directionalAmbientLightingColors[ColorTime::kTotal]

◆ fogData

FogData RE::TESWeather::fogData

◆ FORMTYPE

constexpr auto RE::TESWeather::FORMTYPE = FormType::Weather
inlinestaticconstexpr

◆ imageSpaces

TESImageSpace* RE::TESWeather::imageSpaces[ColorTime::kTotal]

◆ numCloudLayers

std::uint32_t RE::TESWeather::numCloudLayers

◆ pad7D4

std::uint32_t RE::TESWeather::pad7D4

◆ precipitationData

BGSShaderParticleGeometryData* RE::TESWeather::precipitationData

◆ referenceEffect

BGSReferenceEffect* RE::TESWeather::referenceEffect

◆ RTTI

constexpr auto RE::TESWeather::RTTI = RTTI_TESWeather
inlinestaticconstexpr

◆ skyStatics

BSTArray<TESObjectSTAT*> RE::TESWeather::skyStatics

◆ sounds

WeatherSoundList RE::TESWeather::sounds

◆ sunGlareLensFlare

BGSLensFlare* RE::TESWeather::sunGlareLensFlare

◆ volumetricLighting

BGSVolumetricLighting* RE::TESWeather::volumetricLighting[ColorTime::kTotal]

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