Exports

Return the current weather snapshot for this client.

local w = exports.nx_fourseasons:GetCurrentWeather()
print(w.weather, w.intensity, w.temperature)

Return the current temperature in Celsius.

local temp = exports.nx_fourseasons:GetCurrentTemperature()
if temp < 0 then
    -- Player is in sub-zero conditions
end

Return the active season id.

local season = exports.nx_fourseasons:GetCurrentSeason()

Return the synced clock for this client.

local t = exports.nx_fourseasons:GetCurrentTime()
print(('%02d:%02d'):format(t.hour, t.minute))

Return the current storm state broadcast by the server. Nil if storms are disabled.

local storm = exports.nx_fourseasons:GetCurrentStormState()

Return whether the player is currently detected as indoors. Uses a cached check so it is cheap to poll.

if exports.nx_fourseasons:IsPlayerIndoors() then
    -- Skip outdoor-only FX
end

Return the local player's current body-temperature exposure. level is 0 (comfortable) to 3 (severe). kind is the direction of the danger, or false when comfortable. Available only while Config.Exposure.Enabled is true.

local e = exports.nx_fourseasons:GetExposureLevel()
if e.level >= 2 and e.kind == 'cold' then
    -- Player is in cold danger
end

Return the server-provided forecast. With no argument, returns the full forecast array. With a day offset, returns that single day.

-- Full forecast
local days = exports.nx_fourseasons:GetForecast()

-- Single day
local tomorrow = exports.nx_fourseasons:GetForecast(1)
print(tomorrow.weather, tomorrow.temperature)

Pause or resume weather and time sync on this client. Pending updates are replayed on resume.

-- Freeze weather during a cutscene
exports.nx_fourseasons:PauseSync(true)

-- Resume after
exports.nx_fourseasons:PauseSync(false)

Ask the server to resend the full weather, forecast, and storm state to this client.

exports.nx_fourseasons:RequestSync()

Return whether sync is currently paused on this client.

if exports.nx_fourseasons:IsSyncPaused() then
    exports.nx_fourseasons:PauseSync(false)
end

Enable or disable the active weather-driven road effect on a vehicle.

local veh = GetVehiclePedIsIn(PlayerPedId(), false)
exports.nx_fourseasons:ToggleCurrentRoadEffects(veh, false)

Override the traction reduction applied to a vehicle. Value replaces the active weather default.

exports.nx_fourseasons:SetVehicleRoadEffect(veh, 0.5)

Return the road-effect state currently tracked for a vehicle.

Clear any override set by SetVehicleRoadEffect and reapply the active weather default.

Enable or disable screen-space rain drops.

Toggle screen-space rain drops and return the new state.

Enable or disable the full screen weather overlay (umbrella of screen-space FX driven by the active weather).

Toggle the full screen weather overlay and return the new state.

Return the current weather type. Nil before the first sync.

local weather = exports.nx_fourseasons:GetWeather()

Return the active season id.

Return the current ambient temperature in Celsius.

Return the merged weather state blob. This is the same shape published on GlobalState.nxWeather and passed to the onWeatherChanged event.

local s = exports.nx_fourseasons:GetWeatherState()
print(s.weather, s.feelsLike, s.snowDepth, s.isBlackout)

Return the current storm state (blackout, strike, and ocean fields). Nil if storms are disabled.

Return the full server forecast array. Each entry carries a nested stats table with humidity, wind, UV, dew point, and feels-like.

Return today's intraday prediction slots (the timeline that betting settles against). Nil if the forecast is not ready.

Return whether a storm blackout pulse is currently active.

Return the current tracked snow depth in metres. Also published on GlobalState.nxSnowDepth.

Return a player's body-temperature exposure. Also mirrored on the player statebag nxExposure. Returns level 0 with kind false when exposure is disabled or the player has no record.

local e = exports.nx_fourseasons:GetPlayerExposure(source)
if e.level >= 2 then
    -- Player is in a danger tier
end

Request a weather type at default priority 10. Returns a token, or false if control is disabled or the caller is unattributable. Auto-expires after opts.durationMs when provided.

-- Ask for thunder for 10 minutes
local token = exports.nx_fourseasons:RequestWeather('THUNDER', { durationMs = 600000 })

Lock a weather type at default priority 100. A lock never auto-expires: any durationMs is ignored. Returns a token, or false if control is disabled or the caller is unattributable.

local token = exports.nx_fourseasons:LockWeather('EXTRASUNNY')
-- ... later
exports.nx_fourseasons:ReleaseWeather(token)

Release the calling resource's lock. The token must match the lock owned by the invoking resource. A nil token releases the caller's own lock unconditionally. Returns true when a lock was released.

Return the resource name whose lock is currently applied, or nil when no lock is active.