Skip to content

tes3weatherAsh⚓︎

A structure that contains weather information for the ashstorm weather type.

This type inherits the following: tes3weather

Properties⚓︎

ambientDayColor⚓︎

Read-only. The weather's ambient day color. The values can range from 0 to 1.

Returns:

ambientLoopSound⚓︎

Read-only. The weather's ambient looping sound. The current ambient sound should be changed by setting ambientLoopSoundId.

Returns:

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⚓︎

Read-only. The weather's ambient night color. The values can range from 0 to 1.

Returns:

ambientPlaying⚓︎

Read-only. The weather's ambient playing flag.

Returns:

  • result (boolean)

ambientSunriseColor⚓︎

Read-only. The weather's ambient sunrise color. The values can range from 0 to 1.

Returns:

ambientSunsetColor⚓︎

Read-only. The weather's ambient sunset color. The values can range from 0 to 1.

Returns:

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:

fogDayColor⚓︎

Read-only. The weather's fog day color. The values can range from 0 to 1.

Returns:

fogNightColor⚓︎

Read-only. The weather's fog night color. The values can range from 0 to 1.

Returns:

fogSunriseColor⚓︎

Read-only. The weather's fog sunrise color. The values can range from 0 to 1.

Returns:

fogSunsetColor⚓︎

Read-only. The weather's fog sunset color. The values can range from 0 to 1.

Returns:

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:

landFogDayDepth⚓︎

The weather's land fog day depth value.

Returns:

  • result (number)

landFogNightDepth⚓︎

The weather's land fog night depth value.

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⚓︎

Read-only. The weather's sky day color. The values can range from 0 to 1.

Returns:

skyNightColor⚓︎

Read-only. The weather's sky night color. The values can range from 0 to 1.

Returns:

skySunriseColor⚓︎

Read-only. The weather's sky sunrise color. The values can range from 0 to 1.

Returns:

skySunsetColor⚓︎

Read-only. The weather's sky sunset color. The values can range from 0 to 1.

Returns:

stormOrigin⚓︎

The origin point of weather particles. The storm will appear to blow outwards from this point.

Returns:

sunDayColor⚓︎

Read-only. The weather's sun day color. The values can range from 0 to 1.

Returns:

sundiscSunsetColor⚓︎

Read-only. The weather's sundisc sunset color. The values can range from 0 to 1.

Returns:

sunNightColor⚓︎

Read-only. The weather's sun night color. The values can range from 0 to 1.

Returns:

sunSunriseColor⚓︎

Read-only. The weather's sun sunrise color. The values can range from 0 to 1.

Returns:

sunSunsetColor⚓︎

Read-only. The weather's sun sunset color. The values can range from 0 to 1.

Returns:

threshold⚓︎

The weather's threshold value.

Returns:

  • result (number)

transitionDelta⚓︎

The weather's transition delta.

Returns:

  • result (number)

underwaterSoundState⚓︎

Read-only. 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)