# Hz-Weather Pro

## Overview

**Hz-Weather Pro** is a premium, all-in-one weather engine for FiveM. It replaces every weather resource on your server with a single, optimized script. Dynamic weather, climate zones, seasons, temperature, natural disasters, and a full admin panel — everything in one resource.

### Key Features

* **Weather Zones** — Unlimited custom zones with independent weather and smooth transitions
* **Season System** — 4 season presets with automatic cycling or real-time calendar sync
* **Temperature** — Per-zone dynamic temperature with day/night curves and gameplay effects
* **Natural Disasters** — Physicalized tornado and rising-water tsunami
* **Admin Panel** — Modern React NUI interface with 6 tabs
* **Gameplay Effects** — Vehicle traction, visibility, wipers, lightning, blackout, player effects
* **Wind System** — Dynamic speed and direction with random gusts
* **Forecast System** — Real-time weather predictions with exports and callbacks for any resource
* **Phone Weather Apps** — Dedicated apps for [LB Phone](https://hzscripts.com/shop/7330046) and [QS Smartphone Pro](https://hzscripts.com/shop/7330054)
* **50+ Exports** — Complete API for integration with any script
* **Multi-framework** — Standalone, QBCore, QBX, ESX (auto-detected)
* **Compatibility** — Drop-in replacement for `qb-weathersync` and `cd_easytime`

### Performance

| Metric          | Value   |
| --------------- | ------- |
| Client (idle)   | 0.00 ms |
| Client (events) | 0.08 ms |
| Server          | 0.00 ms |

### Requirements

* FiveM Server (latest recommended)
* [ox\_lib](https://github.com/overextended/ox_lib) v3.0+
* [oxmysql](https://github.com/overextended/oxmysql) v2.0+
* [PolyZone](https://github.com/mkafrin/PolyZone)

***

{% hint style="info" %}
**Need help?** Join our [Discord](https://discord.gg/D2jMNswvBM) and open a ticket in #support.
{% endhint %}

## Features In-Depth

### Weather Engine

13 native GTA V weather types with realistic multi-step transitions, configurable change intervals, weather freeze, manual override, and database persistence across restarts.

**Supported types:** `EXTRASUNNY`, `CLEAR`, `CLOUDS`, `OVERCAST`, `RAIN`, `THUNDER`, `CLEARING`, `FOGGY`, `SMOG`, `SNOW`, `SNOWLIGHT`, `BLIZZARD`, `XMAS`

### Weather Zones

Create unlimited zones (circle or polygon) with independent weather per area. Players experience smooth distance-based transitions — no pop-in. A zone influence system ensures neighboring zones blend naturally.

Built-in zones: Los Santos, Mount Chiliad, Sandy Shores Desert, Paleto Forest, Coastal Area, Cayo Perico.

### Season System

4 full season presets (Spring, Summer, Autumn, Winter), each with its own weather sequence, temperature curve, wind profile, and gameplay effects. Three cycle modes:

* **Disabled** — Manual control only
* **Auto** — Rotates seasons automatically on a configurable timer
* **Realtime** — Maps real calendar months to seasons (January = Winter, etc.)

### Temperature System

Per-zone temperatures calculated from zone settings, weather type, and time of day. Three modes: `zone`, `weather`, or `hybrid`. Includes day/night curve interpolation, random variation, and Celsius/Fahrenheit display.

Gameplay effects: freezing animations and screen frost below the cold threshold, heatstroke distortion above the heat threshold.

### Natural Disasters

#### Tornado

Fully physicalized with a 3-force vortex model (pull, lift, spin). Multi-layer particle system with debris. Throws vehicles, NPCs, and the player. Moves across the map with ground-following AI. Server-synced for all players.

#### Tsunami

Rising water system using GTA native `LoadWaterFromPath`. Configurable max height, rise/recede speed, peak duration. Forces THUNDER weather, camera shake, screen overlay, and dark timecycle.

### Gameplay Effects

| Effect             | Description                                            |
| ------------------ | ------------------------------------------------------ |
| Vehicle traction   | Reduced grip in rain (70%), snow (50%), blizzard (30%) |
| Reduced visibility | Fog and overlay in FOGGY, RAIN, BLIZZARD               |
| Auto wipers        | Activates wipers automatically in rain/snow            |
| Auto headlights    | Headlights at night or during bad weather              |
| Player effects     | Cold shivering, heat distortion, screen FX             |
| Speed reduction    | Slower sprint in blizzard                              |
| Synced lightning   | All players see the same flash during THUNDER          |
| Ambient sounds     | Rain, thunder, wind loops with indoor attenuation      |
| Blackout           | Global or per-zone power outage with exceptions        |

### Admin Panel (React NUI)

Modern React + Tailwind interface. Seven tabs:

1. **Weather** — Set weather per zone or globally, freeze toggle
2. **Zones** — Create, edit, delete zones, teleport to zone
3. **Time** — Set time, time scale slider, freeze toggle, presets
4. **Seasons** — Apply presets, start/stop cycles, countdown display
5. **Temperature** — View/edit per-zone ranges, toggle C/F
6. **Events** — Start/stop tornado and tsunami, configure parameters
7. **Forecast** — View, edit, insert, and remove upcoming weather entries with live countdown

All changes persist to the database.

### Phone Weather Apps

Dedicated weather apps available for **LB Phone** and **QS Smartphone Pro**:

* Interactive satellite map with zone markers and live weather overlay
* Dynamic animated backgrounds based on current weather
* Hourly forecast per zone with scrollable timeline
* Animated sun tracker with sunrise/sunset curve
* Wind speed & direction, season info cards
* Auto-synced game time from the server

[LB Phone App](https://hzscripts.com/shop/7330046) | [QS Smartphone Pro App](https://hzscripts.com/shop/7330054)

### Embeddable Weather Map

A standalone satellite map page (`map.html`) designed for iframe embedding in any FiveM phone resource (lb-phone, qs-phone, HZ-Phone, etc.). Displays zone weather, temperature, wind, and season info with auto-refresh.

```html
<iframe src="https://cfx-nui-HZ-Weather/web/dist/map.html"
  style="width:100%;height:100%;border:none" />
```

***

## Quick Navigation

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Installation</strong></td><td>Step-by-step guide to install Hz-Weather Pro on your server</td><td><a href="hz-weather-pro/installation">installation</a></td></tr><tr><td><strong>Configuration</strong></td><td>Customize weather, time, zones, seasons, effects, disasters and more</td><td><a href="hz-weather-pro/configuration">configuration</a></td></tr><tr><td><strong>Phone Weather Apps</strong></td><td>Install the weather app for LB Phone or QS Smartphone Pro</td><td><a href="hz-weather-pro/phone-apps">phone-apps</a></td></tr><tr><td><strong>Exports &#x26; Events</strong></td><td>50+ exports and events for integration with your scripts</td><td><a href="hz-weather-pro/exports">exports</a></td></tr><tr><td><strong>FAQ</strong></td><td>Answers to frequently asked questions</td><td><a href="hz-weather-pro/faq">faq</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://hz-script.gitbook.io/hz-script-docs/scripts/hz-weather-pro.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
