Skip to content

tes3weatherController⚓︎

A data structure that handles the weather.

Properties⚓︎

ambientPostSunriseTime⚓︎

Each weather's ambiental color has one color for day and night states each. The day color will be used when the game hour is between ambientPostSunriseTime and ambientPreSunsetTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

ambientPostSunsetTime⚓︎

Each weather's ambiental color has one color for day and night states each. The night color will be used when the game hour is between ambientPostSunsetTime and ambientPreSunriseTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

ambientPreSunriseTime⚓︎

Each weather's ambiental color has one color for day and night states each. The night color will be used when the game hour is between ambientPostSunsetTime and ambientPreSunriseTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

ambientPreSunsetTime⚓︎

Each weather's ambiental color has one color for day and night states each. The day color will be used when the game hour is between ambientPostSunriseTime and ambientPreSunsetTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

currentFogColor⚓︎

The current fog color. The values can range from 0 to 1.

Returns:

currentSkyColor⚓︎

The current sky color. The values can range from 0 to 1.

Returns:

currentWeather⚓︎

Read-only. The current weather.

Returns:

daysRemaining⚓︎

The days remaining for the current weather.

Returns:

  • result (number)

fogDepthChangeSpeed⚓︎

Controls the speed of how fast the fog comes in. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

fogPostSunriseTime⚓︎

Each weather's fog color has one color for day and night states each. The day color will be used when the game hour is between fogPostSunriseTime and fogPreSunsetTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

fogPostSunsetTime⚓︎

Each weather's fog color has one color for day and night states each. The night color will be used when the game hour is between fogPostSunsetTime and fogPreSunriseTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

fogPreSunriseTime⚓︎

Each weather's fog color has one color for day and night states each. The night color will be used when the game hour is between fogPostSunsetTime and fogPreSunriseTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

fogPreSunsetTime⚓︎

Each weather's fog color has one color for day and night states each. The day color will be used when the game hour is between fogPostSunriseTime and fogPreSunsetTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

hoursBetweenWeatherChanges⚓︎

The hours between weather changes. Stored as a float value.

Returns:

  • result (number)

hoursRemaining⚓︎

The hours remaining.

Returns:

  • result (number)

lastActiveRegion⚓︎

Read-only. Provides read-only access to last active region object.

Returns:

masser⚓︎

Read-only. Provides read-only access to the Masser moon object.

Returns:

nextWeather⚓︎

Read-only. The next weather.

Returns:

particlesActive⚓︎

Read-only. Provides a list of active weather particles.

Returns:

particlesInactive⚓︎

Read-only. Provides a list of inactive weather particles.

Returns:

precipitationFallSpeed⚓︎

The z component of the rain or snow fall particle velocity (not including blizzards). Snow fall velocity is also multiplied by snowFallSpeedScale. This value is initialized by the "Precipitation Gravity" entry in morrowind.ini.

Returns:

  • result (number)

sceneAtmosphere⚓︎

Read-only. Provides access to the scene atmosphere skydome NiNode.

Returns:

sceneClouds⚓︎

Read-only. Provides access to the scene clouds root NiNode.

Returns:

sceneNightSky⚓︎

Read-only. Provides access to the scene night sky (stars and nebula) NiNode.

Returns:

sceneRainRoot⚓︎

Read-only. Provides access to the scene rain root NiNode.

Returns:

sceneSkyLight⚓︎

Read-only. Provides access to the scene sky light directional light.

Returns:

sceneSkyRoot⚓︎

Read-only. Provides access to the scene sky root NiNode.

Returns:

sceneSnowRoot⚓︎

Read-only. Provides access to the scene snow root NiNode.

Returns:

sceneStormRoot⚓︎

Read-only. Provides access to the scene storm root NiNode.

Returns:

sceneSunBase⚓︎

Read-only. Provides read-only access to the scenesun base NiNode.

Returns:

sceneSunGlare⚓︎

Read-only. Provides read-only access to the scene sun glare NiNode.

Returns:

sceneSunVis⚓︎

Read-only. Provides read-only access to the scene sun vis NiNode.

Returns:

secunda⚓︎

Read-only. Provides read-only access to the Secunda moon object.

Returns:

skyPostSunriseTime⚓︎

The sky has one color for day and night states each. The day color will be used when the game hour is between skyPostSunriseTime and skyPreSunsetTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

skyPostSunsetTime⚓︎

The sky has one color for day and night states each. The night color will be used when the game hour is between skyPostSunsetTime and skyPreSunriseTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

skyPreSunriseTime⚓︎

The sky has one color for day and night states each. The night color will be used when the game hour is between skyPostSunsetTime and skyPreSunriseTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

skyPreSunsetTime⚓︎

The sky has one color for day and night states each. The day color will be used when the game hour is between skyPostSunriseTime and skyPreSunsetTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

snowFallSpeedScale⚓︎

A multipler for the z component of snow fall particle velocity (not including blizzards). The z component is set by precipitationFallSpeed * snowFallSpeedScale. This value is initialized by the "Snow Gravity Scale" entry in morrowind.ini.

Returns:

  • result (number)

starsFadingDuration⚓︎

The stars will fade in starsPostSunsetStart hours after the sunset. They fade out starsPreSunriseFinish hours before sunrise. This value represents the duration of the fading. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

starsPostSunsetStart⚓︎

The stars will start to fade in (appear) starsPostSunsetStart hours before sunrise. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

starsPreSunriseFinish⚓︎

The stars will start to fade out (disappear) starsPreSunriseFinish hours before sunrise. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

sunglareFaderAngleMax⚓︎

The sunglare fader maximum angle.

Returns:

  • result (number)

sunglareFaderColor⚓︎

The sunglare fader color. The values can range from 0 to 1.

Returns:

sunglareFaderMax⚓︎

The sunglare fader maximum.

Returns:

  • result (number)

sunPostSunriseTime⚓︎

The Sun has one color for day and night states each. The day color will be used when the game hour is between sunPostSunriseTime and sunPreSunsetTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

sunPostSunsetTime⚓︎

The Sun has one color for day and night states each. The night color will be used when the game hour is between sunPostSunsetTime and sunPreSunriseTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

sunPreSunriseTime⚓︎

The Sun has one color for day and night states each. The night color will be used when the game hour is between sunPostSunsetTime and sunPreSunriseTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

sunPreSunsetTime⚓︎

The Sun has one color for day and night states each. The day color will be used when the game hour is between sunPostSunriseTime and sunPreSunsetTime. This corresponds to the setting of the same name in Morrowind.ini file.

Returns:

  • result (number)

sunriseDuration⚓︎

The sunrise duration.

Returns:

  • result (number)

sunriseHour⚓︎

The sunrise hour.

Returns:

  • result (number)

sunsetDuration⚓︎

The sunset duration.

Returns:

  • result (number)

sunsetHour⚓︎

The sunset hour.

Returns:

  • result (number)

timescaleClouds⚓︎

The timescale for clouds.

Returns:

  • result (string)

transitionScalar⚓︎

The scalar transition.

Returns:

  • result (number)

underwaterColor⚓︎

The underwater color, represented as a vector. The values can range from 0 to 1.

Returns:

underwaterColorWeight⚓︎

The underwater color weight.

Returns:

  • result (number)

underwaterDayFog⚓︎

The underwater day fog value.

Returns:

  • result (number)

underwaterIndoorFog⚓︎

The underwater indoor fog value.

Returns:

  • result (number)

underwaterNightFog⚓︎

The underwater night fog value.

Returns:

  • result (number)

underwaterSunriseFog⚓︎

The underwater sunrise fog value.

Returns:

  • result (number)

underwaterSunsetFog⚓︎

The underwater sunset fog value.

Returns:

  • result (number)

weathers⚓︎

Read-only. Array-style table with weather objects for each weather type. The indices in the table map to the values in the tes3.weather table.

Returns:

windVelocityCurrWeather⚓︎

The wind velocity for the current weather.

Returns:

windVelocityNextWeather⚓︎

The wind velocity for the next weather.

Returns:

Methods⚓︎

calcSunDamageScalar⚓︎

Calculates the sun damage based on the current weather.

local result = myObject:calcSunDamageScalar()

Parameters:

Returns:

  • result (number)

switchImmediate⚓︎

Immediately switches the weather to the provided weather parameter.

myObject:switchImmediate(weatherId)

Parameters:

switchTransition⚓︎

Transitions the weather to the provided weather parameter based on the weather controller settings.

myObject:switchTransition(weatherId)

Parameters:

updateVisuals⚓︎

Updates the weather controller visuals. This should be called after any weather transitions.

myObject:updateVisuals()

Parameters: