FearlessStudios

setPatternMode

Server export to enable or disable pattern mode

setPatternMode

Enables or disables 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"]:setPatternMode(true)

Parameters

Prop

Type

Returns

  • boolean: True when pattern mode was updated.