fivem-ts

a library to speed up the development of Fivem scripts and frameworks

---

Project maintained by Purpose-Dev Hosted on GitHub Pages — Theme by mattgraham

fivem-ts - Documentation v0.7.5 • Docs

---

fivem-ts - Documentation v0.7.5 / Shared / WeatherEnum

Enumeration: WeatherEnum

Enum representing various weather types as string values.

This enum is used to manipulate and identify different weather conditions in environments such as game development, simulations, or any application that requires weather state management. Each value in this enum corresponds to a specific weather condition, represented by a descriptive string.

Example usage:

if (IsNextWeatherType(WeatherEnum.Clear)) {
  console.log("The next weather is clear.");
}

Enum Values:

• Unknown: Represents an unknown weather state, value -1.
• Blizzard: Represents blizzard conditions, value 'BLIZZARD'.
• Clear: Represents clear weather, value 'CLEAR'.
• Clearing: Represents clearing weather, value 'CLEARING'.
• Clouds: Represents cloudy weather, value 'CLOUDS'.
• Extrasunny: Represents extra sunny weather, value 'EXTRASUNNY'.
• Foggy: Represents foggy weather, value 'FOGGY'.
• Halloween: Represents Halloween-themed weather, value 'HALLOWEEN'.
• Neutral: Represents neutral weather conditions, value 'NEUTRAL'.
• Overcast: Represents overcast weather, value 'OVERCAST'.
• Rain: Represents rainy weather, value 'RAIN'.
• Smog: Represents smoggy weather, value 'SMOG'.
• Snow: Represents snowy weather, value 'SNOW'.
• Snowlight: Represents light snow, value 'SNOWLIGHT'.
• Thunder: Represents stormy weather with thunder, value 'THUNDER'.
• Xmas: Represents Christmas-themed weather, value 'XMAS'.

Enumeration Members

Blizzard

Blizzard: "BLIZZARD"

Represents blizzard conditions.

Defined in

shared/enums/WeatherEnum.ts:37

---

Clear

Clear: "CLEAR"

Represents clear weather.

Defined in

shared/enums/WeatherEnum.ts:39

---

Clearing

Clearing: "CLEARING"

Represents clearing weather.

Defined in

shared/enums/WeatherEnum.ts:41

---

Clouds

Clouds: "CLOUDS"

Represents cloudy weather.

Defined in

shared/enums/WeatherEnum.ts:43

---

Extrasunny

Extrasunny: "EXTRASUNNY"

Represents extra sunny weather.

Defined in

shared/enums/WeatherEnum.ts:45

---

Foggy

Foggy: "FOGGY"

Represents foggy weather.

Defined in

shared/enums/WeatherEnum.ts:47

---

Halloween

Halloween: "HALLOWEEN"

Represents Halloween-themed weather.

Defined in

shared/enums/WeatherEnum.ts:49

---

Neutral

Neutral: "NEUTRAL"

Represents neutral weather conditions.

Defined in

shared/enums/WeatherEnum.ts:51

---

Overcast

Overcast: "OVERCAST"

Represents overcast weather.

Defined in

shared/enums/WeatherEnum.ts:53

---

Rain

Rain: "RAIN"

Represents rainy weather.

Defined in

shared/enums/WeatherEnum.ts:55

---

Smog

Smog: "SMOG"

Represents smoggy weather.

Defined in

shared/enums/WeatherEnum.ts:57

---

Snow

Snow: "SNOW"

Represents snowy weather.

Defined in

shared/enums/WeatherEnum.ts:59

---

Snowlight

Snowlight: "SNOWLIGHT"

Represents light snow.

Defined in

shared/enums/WeatherEnum.ts:61

---

Thunder

Thunder: "THUNDER"

Represents stormy weather with thunder.

Defined in

shared/enums/WeatherEnum.ts:63

---

Unknown

Unknown: -1

Represents an unknown weather state.

Defined in

shared/enums/WeatherEnum.ts:35

---

Xmas

Xmas: "XMAS"

Represents Christmas-themed weather.

Defined in

shared/enums/WeatherEnum.ts:65