FearlessStudios

applyPattern

Server export to apply a saved weather pattern

applyPattern

Applies a saved pattern by id, enables pattern mode, and syncs clients.

Weather changes use Config.WeatherTransitionSeconds by default. Pass true as the second argument to apply instantly. Weather freeze remains active until explicitly disabled.

Usage

server.lua
local ok = exports["FS-Weather"]:applyPattern(1)

Parameters

Prop

Type

Returns

  • boolean: True when the pattern exists and was applied.