# Environment

The Environment module provides utility functions to query and process in-game environmental data such as weather, time, season, terrain, and more.

***

## Accessing the Module

```lua
local ENVIRONMENT <const> = exports.boii_utils:get("modules.environment")
```

***

## Client

### get\_weather\_name(hash)

Returns the readable name of a weather type from its hash.

#### Parameters

| Name | Type     | Description                       |
| ---- | -------- | --------------------------------- |
| hash | `number` | The hash key of the weather type. |

#### Example

```lua
local weather = ENVIRONMENT.get_weather_name(GetPrevWeatherTypeHashName())
print("Current Weather:", weather)
```

***

### get\_game\_time()

Returns current game time (hour + minute) in both raw and formatted format.

#### Returns

| Name      | Type     | Description               |
| --------- | -------- | ------------------------- |
| time      | `table`  | `{ hour, minute }`        |
| formatted | `string` | Time formatted as `HH:MM` |

#### Example

```lua
local time = ENVIRONMENT.get_game_time()
print("Game Time:", time.formatted)
```

***

### get\_game\_date()

Returns current in-game date in both raw and formatted format.

#### Returns

| Name      | Type     | Description                    |
| --------- | -------- | ------------------------------ |
| date      | `table`  | `{ day, month, year }`         |
| formatted | `string` | Date formatted as `DD/MM/YYYY` |

#### Example

```lua
local date = ENVIRONMENT.get_game_date()
print("Game Date:", date.formatted)
```

***

### get\_sunrise\_sunset\_times(weather)

Returns sunrise and sunset times based on weather type.

#### Parameters

| Name    | Type     | Description                          |
| ------- | -------- | ------------------------------------ |
| weather | `string` | The weather type name (e.g. "CLEAR") |

#### Example

```lua
local times = ENVIRONMENT.get_sunrise_sunset_times("CLOUDS")
print("Sunrise:", times.sunrise, "Sunset:", times.sunset)
```

***

### is\_daytime()

Checks if the current time is between 06:00 and 18:00.

#### Returns

| Type      | Description                          |
| --------- | ------------------------------------ |
| `boolean` | `true` if daytime, otherwise `false` |

#### Example

```lua
if ENVIRONMENT.is_daytime() then
    print("It's daytime!")
end
```

***

### get\_current\_season()

Returns the current season based on in-game month.

#### Returns

| Type     | Description                                            |
| -------- | ------------------------------------------------------ |
| `string` | Season name: "Winter", "Spring", "Summer", or "Autumn" |

#### Example

```lua
local season = ENVIRONMENT.get_current_season()
print("Season:", season)
```

***

### get\_distance\_to\_water()

Calculates the vertical distance from player to nearest water surface.

#### Returns

| Type     | Description                                  |
| -------- | -------------------------------------------- |
| `number` | Distance to water or `-1` if no water nearby |

#### Example

```lua
local dist = ENVIRONMENT.get_distance_to_water()
print("Water Distance:", dist)
```

***

### get\_zone\_scumminess()

Returns the "scumminess" level of the player's current zone.

#### Returns

| Type      | Description                        |
| --------- | ---------------------------------- |
| `integer` | Value from 0-5, or -1 if not found |

#### Example

```lua
print("Zone Scumminess:", ENVIRONMENT.get_zone_scumminess())
```

***

### get\_ground\_material()

Returns the hash of the ground material at the player's feet.

#### Returns

| Type     | Description         |
| -------- | ------------------- |
| `number` | Material hash value |

#### Example

```lua
print("Ground Material Hash:", ENVIRONMENT.get_ground_material())
```

***

### get\_wind\_direction()

Returns the wind direction as a compass direction (N, NE, etc).

#### Returns

| Type     | Description       |
| -------- | ----------------- |
| `string` | Compass direction |

#### Example

```lua
print("Wind Direction:", ENVIRONMENT.get_wind_direction())
```

***

### get\_altitude()

Returns the player's current altitude above sea level.

#### Returns

| Type     | Description    |
| -------- | -------------- |
| `number` | Altitude value |

#### Example

```lua
print("Altitude:", ENVIRONMENT.get_altitude())
```

***

### get\_environment\_details()

Returns a detailed breakdown of the current environment.

#### Returns

| Key                 | Type      | Description               |
| ------------------- | --------- | ------------------------- |
| weather             | `string`  | Current weather name      |
| time                | `table`   | Table of game time info   |
| date                | `table`   | Table of game date info   |
| season              | `string`  | Current season            |
| sunrise\_sunset     | `table`   | Sunrise/sunset times      |
| is\_daytime         | `boolean` | True if daytime           |
| distance\_to\_water | `number`  | Distance to nearest water |
| scumminess          | `number`  | Zone scumminess level     |
| ground\_material    | `number`  | Ground hash               |
| rain\_level         | `number`  | Current rain amount       |
| wind\_speed         | `number`  | Current wind speed        |
| wind\_direction     | `string`  | Compass wind direction    |
| snow\_level         | `number`  | Current snow amount       |
| altitude            | `number`  | Player's altitude         |

#### Example

```lua
local env = ENVIRONMENT.get_environment_details()
print(json.encode(env))
```


---

# 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://docs.boii.dev/old-docs/boii_utils/api/environment.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.