Skip to content
On this page

Athena.systems.defaults.weather

Functions

disable

Usage

Athena.systems.defaults.weather.disable(): void

Disable the default weather from updating players.

Example

ts
Athena.systems.defaults.weather.disable();

Returns

void

Defined in

server/systems/defaults/weather.ts:91


getCurrentWeather

Usage

Athena.systems.defaults.weather.getCurrentWeather(asString): number

Get the current weather as a string or number.

Parameters

NameType
asStringfalse

Returns

number

Defined in

server/systems/defaults/weather.ts:117

Usage

Athena.systems.defaults.weather.getCurrentWeather(asString): string

Get the current weather as a string or number.

Parameters

NameType
asStringtrue

Returns

string

Defined in

server/systems/defaults/weather.ts:118


setWeatherCycle

Usage

Athena.systems.defaults.weather.setWeatherCycle(newWeatherCycle): void

Used to override the default weather cycle.

Parameters

NameType
newWeatherCycleWEATHER_KEY[]

Returns

void

Defined in

server/systems/defaults/weather.ts:108


updatePlayer

Usage

Athena.systems.defaults.weather.updatePlayer(player): void

Updates the player weather to match current weather system.

Parameters

NameTypeDescription
playerPlayerAn alt:V Player Entity

Returns

void

Defined in

server/systems/defaults/weather.ts:72

Created by Stuyk | Est. 2020