tes3weather⚓︎
A structure that contains base weather information shared by inheriting weather structures.
Properties⚓︎
ambientDayColor⚓︎
Daytime endpoint for the weather's ambient-light color cycle. It is used after the sunrise transition and before the sunset transition. Values range from 0 to 1.
Returns:
result(tes3vector3)
ambientLoopSound⚓︎
The weather's ambient looping sound. The current ambient sound should be changed by setting ambientLoopSoundId.
Returns:
result(tes3sound)
ambientLoopSoundId⚓︎
The weather's ambient looping sound ID. This can be changed, and the sound will switch over when the weather is active.
Returns:
result(string)
ambientNightColor⚓︎
Nighttime endpoint for the weather's ambient-light color cycle. It is used outside the sunrise and sunset transition windows. Values range from 0 to 1.
Returns:
result(tes3vector3)
ambientPlaying⚓︎
The weather's ambient playing flag.
Returns:
result(boolean)
ambientSunriseColor⚓︎
Intermediate ambient-light color used at the midpoint of the sunrise transition, between ambientNightColor and ambientDayColor. Values range from 0 to 1.
Returns:
result(tes3vector3)
ambientSunsetColor⚓︎
Intermediate ambient-light color used at the midpoint of the sunset transition, between ambientDayColor and ambientNightColor. Values range from 0 to 1.
Returns:
result(tes3vector3)
cloudsMaxPercent⚓︎
The weather's cloud maximum percentage.
Returns:
result(number)
cloudsSpeed⚓︎
The weather's cloud speed.
Returns:
result(number)
cloudTexture⚓︎
The weather's cloud texture path.
Returns:
result(string)
controller⚓︎
Read-only. The weather's weather controller.
Returns:
result(tes3weatherController)
fogDayColor⚓︎
Daytime endpoint for the weather's fog color cycle. It is used after the fog sunrise transition and before the fog sunset transition. Values range from 0 to 1.
Returns:
result(tes3vector3)
fogNightColor⚓︎
Nighttime endpoint for the weather's fog color cycle. It is used outside the fog sunrise and sunset transition windows. Values range from 0 to 1.
Returns:
result(tes3vector3)
fogSunriseColor⚓︎
Intermediate fog color used at the midpoint of the sunrise transition, between fogNightColor and fogDayColor. Values range from 0 to 1.
Returns:
result(tes3vector3)
fogSunsetColor⚓︎
Intermediate fog color used at the midpoint of the sunset transition, between fogDayColor and fogNightColor. Values range from 0 to 1.
Returns:
result(tes3vector3)
glareView⚓︎
The weather's glare view.
Returns:
result(number)
index⚓︎
Read-only. The weather's index ID. Maps to values in the tes3.weather table.
Returns:
result(tes3.weather)
landFogDayDepth⚓︎
Land-fog depth used during daytime. The controller interpolates toward this value from landFogNightDepth over fogDepthChangeSpeed hours after sunriseHour.
Returns:
result(number)
landFogNightDepth⚓︎
Land-fog depth used at night. The controller interpolates toward this value from landFogDayDepth over fogDepthChangeSpeed hours after sunsetHour.
Returns:
result(number)
name⚓︎
Read-only. The weather's user-friendly name, hardcoded in English to match the INI settings name. These values can be "Ashstorm", "Blight", "Blizzard", "Clear", "Cloudy", "Foggy", "Overcast", "Rain", "Snow", or "Thunderstorm" as appropriate.
Returns:
result(string)
skyDayColor⚓︎
Daytime endpoint for the weather's sky-color cycle. It is used after the sky sunrise transition and before the sky sunset transition. Values range from 0 to 1.
Returns:
result(tes3vector3)
skyNightColor⚓︎
Nighttime endpoint for the weather's sky-color cycle. It is used outside the sky sunrise and sunset transition windows. Values range from 0 to 1.
Returns:
result(tes3vector3)
skySunriseColor⚓︎
Intermediate sky color used at the midpoint of the sunrise transition, between skyNightColor and skyDayColor. Values range from 0 to 1.
Returns:
result(tes3vector3)
skySunsetColor⚓︎
Intermediate sky color used at the midpoint of the sunset transition, between skyDayColor and skyNightColor. Values range from 0 to 1.
Returns:
result(tes3vector3)
sunDayColor⚓︎
Daytime endpoint for the weather's directional sunlight color cycle. It is used after the sun sunrise transition and before the sun sunset transition. Values range from 0 to 1.
Returns:
result(tes3vector3)
sundiscSunsetColor⚓︎
Sun-disc tint used during sunset. The disc blends from white toward this color from sunsetHour - sunPreSunsetTime through sunsetHour; it is separate from sunSunsetColor. Values range from 0 to 1.
Returns:
result(tes3vector3)
sunNightColor⚓︎
Nighttime endpoint for the weather's directional sunlight color cycle. It is used outside the sun sunrise and sunset transition windows. Values range from 0 to 1.
Returns:
result(tes3vector3)
sunSunriseColor⚓︎
Intermediate directional sunlight color used at the midpoint of the sunrise transition, between sunNightColor and sunDayColor. Values range from 0 to 1.
Returns:
result(tes3vector3)
sunSunsetColor⚓︎
Intermediate directional sunlight color used at the midpoint of the sunset transition, between sunDayColor and sunNightColor. Values range from 0 to 1.
Returns:
result(tes3vector3)
transitionDelta⚓︎
The weather's transition delta.
Returns:
result(number)
underwaterSoundState⚓︎
The weather's underwater sound state flag. This value will be true, while the player is underwater.
Returns:
result(boolean)
windSpeed⚓︎
The weather's wind speed.
Returns:
result(number)
Methods⚓︎
isValid⚓︎
Checks to see if the object still points to valid memory. This should be done any time when the object may have been deleted since the variable's last use (e.g. in timer callbacks).
local valid = myObject:isValid()
Returns:
valid(boolean)