tes3weatherRain⚓︎
A structure that contains weather information for the rain weather type.
This type inherits the following: tes3weather.
Properties⚓︎
ambientDayColor⚓︎
The weather's ambient day color. The values can 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⚓︎
The weather's ambient night color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
ambientPlaying⚓︎
The weather's ambient playing flag.
Returns:
result(boolean)
ambientSunriseColor⚓︎
The weather's ambient sunrise color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
ambientSunsetColor⚓︎
The weather's ambient sunset color. The values can 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⚓︎
The weather's fog day color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
fogNightColor⚓︎
The weather's fog night color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
fogSunriseColor⚓︎
The weather's fog sunrise color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
fogSunsetColor⚓︎
The weather's fog sunset color. The values can 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⚓︎
The weather's land fog day depth value.
Returns:
result(number)
landFogNightDepth⚓︎
The weather's land fog night depth value.
Returns:
result(number)
maxParticles⚓︎
The weather's maximum particles.
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)
particleEntranceSpeed⚓︎
The weather's particle entrance speed.
Returns:
result(number)
particleHeightMax⚓︎
The weather's particle maximum height.
Returns:
result(number)
particleHeightMin⚓︎
The weather's particle minimum height.
Returns:
result(number)
particleRadius⚓︎
The weather's particle radius.
Returns:
result(number)
rainActive⚓︎
Read-only. The weather's active rain flag.
Returns:
result(boolean)
rainLoopSound⚓︎
The weather's rain loop sound object. This value is only modifiable for legacy compatibility. The current rain sound should be changed by setting rainLoopSoundId.
Returns:
result(tes3sound)
rainLoopSoundId⚓︎
The weather's rain loop sound ID. This can be changed, and the sound will switch over when the weather is active
Returns:
result(string)
skyDayColor⚓︎
The weather's sky day color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
skyNightColor⚓︎
The weather's sky night color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
skySunriseColor⚓︎
The weather's sky sunrise color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
skySunsetColor⚓︎
The weather's sky sunset color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
sunDayColor⚓︎
The weather's sun day color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
sundiscSunsetColor⚓︎
The weather's sundisc sunset color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
sunNightColor⚓︎
The weather's sun night color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
sunSunriseColor⚓︎
The weather's sun sunrise color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
sunSunsetColor⚓︎
The weather's sun sunset color. The values can range from 0 to 1.
Returns:
result(tes3vector3)
threshold⚓︎
The weather's threshold value.
Returns:
result(number)
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)