FindWeather - Weather

From Creation Kit
Jump to: navigation, search

Member of: Weather Script

Finds a weather of the given type for the currently occupied region (if applicable) or climate.

Syntax

Weather Function FindWeather(int auiType) native global

Parameters

  • auiType - The type of weather you want:
    • 0 - Pleasant
    • 1 - Cloudy
    • 2 - Rainy
    • 3 - Snow

Return Value

The Weather with the highest chance of occurring in the player's currently occupied region (or, alternatively, the climate for the current world space) which has the classification specified by the given parameter.

Examples

;Finds a cloudy weather
Weather cloudy = Weather.FindWeather(1)

Notes

The weather settings which correspond to the type can be found on the Precipitation tab in the Weather Dialog in the Creation Kit (under "Weather Classification").

See Also

Weather Script