GetWeatherTransitionDuration

getWeatherTransitionDuration

Returns the transition duration associated with the current authoritative weather state.

Syntax

int transitionMs = getWeatherTransitionDuration()

Parameters

This function does not accept parameters.

Returns

Returns the transition duration in milliseconds.

Examples

Display the current weather and transition duration:

local message = string.format(
    "Weather: %s (%d ms)",
    getWeather(),
    getWeatherTransitionDuration())
outputDebugString(message)

Notes

• Available only in server-side resource scripts.
• A value of 0 indicates an immediate weather transition.