setFreezeWeather
Server export to freeze or unfreeze weather changes
setFreezeWeather
Pauses or resumes automatic weather changes and syncs the dashboard. Freezing preserves the remaining countdown and removes upcoming forecast entries from the HUD. Unfreezing resumes that countdown. Manual weather changes still work while frozen.
To start frozen after a resource restart, set Config.DefaultFreezeWeather = true in config.lua.
This does not freeze the clock; use setFreezeTime separately.
Usage
local ok = exports["FS-Weather"]:setFreezeWeather(true)Parameters
Prop
Type
Returns
- boolean: True when the value was accepted.