V5 DocsAthena.systems.defaults.weather ​
Functions ​
disable ​
Usage
Athena.systems.defaults.weather.disable(): void
Disable the default weather from updating players.
Example ​
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 ​
| Name | Type |
|---|---|
asString | false |
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 ​
| Name | Type |
|---|---|
asString | true |
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 ​
| Name | Type |
|---|---|
newWeatherCycle | WEATHER_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 ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
Returns ​
void