Environment

CLIENT FUNCTIONS

get_weather_name

Returns the weather name from a given hash.

Parameters

• hash: number

Returns

• string

bdtk.get_weather_name(hash)

---

get_game_time

Returns current game time and formatted version.

Returns

• table

bdtk.get_game_time()

---

get_game_date

Returns current game date and formatted version.

Returns

• table

bdtk.get_game_date()

---

get_sunrise_sunset_times

Returns sunrise and sunset times for given weather.

Parameters

• weather: string

Returns

• table

bdtk.get_sunrise_sunset_times(weather)

---

is_daytime

Checks if it is currently daytime.

Returns

• boolean

bdtk.is_daytime()

---

is_nighttime

Checks if it is currently nighttime.

Returns

• boolean

bdtk.is_nighttime()

---

is_midday

Checks if it is currently midday.

Returns

• boolean

bdtk.is_midday()

---

get_current_season

Returns current season.

Returns

• string

bdtk.get_current_season()

---

get_distance_to_water

Returns distance from player to nearest water body.

Returns

• number

bdtk.get_distance_to_water()

---

get_zone_scumminess

Returns the zone scumminess level.

Returns

• integer

bdtk.get_zone_scumminess()

---

get_ground_material

Returns ground material hash at player's position.

Returns

• number

bdtk.get_ground_material()

---

get_wind_direction

Returns wind direction as a compass value.

Returns

• string

bdtk.get_wind_direction()

---

get_altitude

Returns player's altitude above sea level.

Returns

• number

bdtk.get_altitude()

---

get_environment_details

Returns a summary of environmental data.

Returns

• table

bdtk.get_environment_details()