SetWeather

setWeather

Changes the authoritative weather and replicates it to every connected player.

Syntax

bool setWeather(string weather [, int transitionMs = 3000])

Parameters

Name	Type	Required	Description
weather	string	yes	Earlier releases: sunny, cloudy, rain1, rain2 or rain3. From 0.1.9: any canonical name or alias in Weather catalog, including snow, fog and sandstorms; query getWeatherTypes.
transitionMs	int	no	Transition duration from 0 to 300000 milliseconds. Defaults to 3000; 0 applies an immediate transition.

Returns

Returns true when the weather name and transition are accepted; otherwise returns false.

Examples

Example 1

Create a five-second transition into a storm:

if not setWeather("rain3", 5000) then
    outputDebugString("The server rejected the weather change")
end

Example 2

Register a simple sunny-weather command:

addCommandHandler("sunny", function(playerId)
    if setWeather("sunny", 3000) then
        outputChatBox("Clear weather enabled.", playerId)
    end
end)

Notes

• Available only in server-side resource scripts.
• The new state is retained for late joiners.
• A successful change increments the weather revision and triggers onWeatherChange.

Extended weather from 0.1.9

Available from 0.1.9. Use matching updated clients and server.

This existing API retains its call shape; the catalog is extended, not restricted to five names. See Weather and Weather catalog. Server target/revision and client acknowledgement are not proof of the final rendered image. The new presets still require in-game visual qualification; use compatible clients and test late join, indoor areas and returning to ordinary weather.