YSeries Phone FiveM Script Weather Widget Configuration

Allows server owners to dynamically control the weather temperature and icon displayed on phone widgets.

Live Weather Updates: Temperature and weather icons can be updated in real-time
Server Owner Control: Complete control over weather data through exports
Automatic Sync: Weather data automatically syncs to all connected phones
Fallback System: Graceful fallback to default values if weather system is disabled
Force Update Option: Optional immediate sync to all clients
NOTE: The weather widget is available only for Humanoid(android) phones as of now.

In config/config.misc.lua:

lua

Config.Weather = {}
Config.Weather.Enabled = true                           -- Enable/disable live weather system
Config.Weather.DefaultTemperature = 21                  -- Default temperature in Celsius
Config.Weather.DefaultIcon = 'humanoid/utils/cloudy.png' -- Default weather icon path
Config.Weather.UpdateInterval = 60000                   -- Update interval in milliseconds (1 minute)

All export functions accept an optional forceUpdate parameter. When set to true, the weather data will be immediately synchronized to all connected clients instead of waiting for the next update cycle.

Parameters:

forceUpdate (boolean, optional): If true, immediately syncs data to all clients

lua

-- Set temperature to 25°C
local success, errorMsg = exports.yseries:SetTemperature(25)
if not success then
    print("Error setting temperature: " .. errorMsg)
end

-- Set temperature with immediate update to all clients
local success, errorMsg = exports.yseries:SetTemperature(25, true)

lua

-- Set custom weather icon
local success, errorMsg = exports.yseries:SetWeatherIcon('humanoid/utils/sunny.png')

-- Set weather icon with immediate update to all clients
local success, errorMsg = exports.yseries:SetWeatherIcon('humanoid/utils/sunny.png', true)

lua

-- Update multiple weather properties
local weatherData = {
    temperature = 28,
    icon = 'humanoid/utils/sunny.png'
}

local success, errorMsg = exports.yseries:SetWeatherData(weatherData)

-- Update with immediate sync to all clients
local success, errorMsg = exports.yseries:SetWeatherData(weatherData, true)

lua

local weatherData = exports.yseries:GetWeatherData()
print("Current temperature: " .. weatherData.temperature .. "°C")
print("Current icon: " .. weatherData.icon)

lua

-- Example: Sync with OpenWeatherMap API
CreateThread(function()
    while true do
        -- Fetch weather data from external API
        local weatherData = GetExternalWeatherData() -- Your implementation
        
        if weatherData then
            exports.yseries:SetWeatherData({
                temperature = weatherData.temp,
                icon = GetWeatherIcon(weatherData.condition) -- Map to your icons
            }, true) -- Force update to all clients
        end
        
        Wait(300000) -- Update every 5 minutes
    end
end)

humanoid/utils/cloudy.png - Cloudy weather
Add your own custom icons to the UI assets

Add your weather icon files to ui/public/humanoid/utils/
Reference them in the icon path: humanoid/utils/your-icon.png

Check if Config.Weather.Enabled is set to true
Verify the weather system is loaded.
Check for any error messages when calling exports

Ensure icon paths are correct and files exist in ui/public/
Check browser console for 404 errors on image requests

The default update interval is 60 seconds to balance real-time updates with performance
Consider longer intervals for production servers with many players
Weather data is cached and only sent when phones are open

⛅ Weather Widget

Features

Configuration

Enable/Disable Weather System

Server Exports

Basic Usage

Set Temperature

Set Weather Icon

Set Multiple Values at Once

Get Current Weather Data

Advanced Examples

Integration with External Weather APIs

Weather Icons

Default Icons Available

Custom Weather Icons

Troubleshooting

Weather Not Updating

Icons Not Displaying

Performance Considerations

On this page