net.tridentsdk.world

Interface WeatherConditions

@ThreadSafe
public interface WeatherConditions

Obtains the state of the weather, and allows control of the Weather in a world

Since:

0.4-alpha

Author:

The TridentSDK Team

Method Summary

Modifier and Type	Method and Description
boolean	isRaining() Checks if it is raining in a world
boolean	isSunny() Whether or not any weather is occurring within the world
boolean	isThundering() Checks if it is thundering in a world
int	rainTime() Gets the number of ticks before raining is toggled
void	setRaining(boolean raining) Sets raining to the provided boolean
void	setSunny() Sets the world to sunny, stopping both thundering and raining if present
void	setThundering(boolean thundering) Sets thundering to the boolean provided
int	thunderTime() Gets the number of ticks before thundering is toggled
void	toggleRain(int ticks) Toggles raining within the world
void	toggleThunder(int ticks) Toggles thundering within the world

Method Detail

isRaining

boolean isRaining()

Checks if it is raining in a world

Returns:

True if it is raining in a world

rainTime

int rainTime()

Gets the number of ticks before raining is toggled

Returns:

The number of ticks before raining is toggled

toggleRain

void toggleRain(int ticks)

Toggles raining within the world

Parameters:

ticks - the ticks until the next rain toggle, or 0 to toggle immediately

setRaining

void setRaining(boolean raining)

Sets raining to the provided boolean

Parameters:

raining - true to start raining, false to stop

isThundering

boolean isThundering()

Checks if it is thundering in a world

Returns:

True if it is thundering in a world

thunderTime

int thunderTime()

Gets the number of ticks before thundering is toggled

Returns:

The number of ticks before thundering is toggled

toggleThunder

void toggleThunder(int ticks)

Toggles thundering within the world

Parameters:

ticks - the amount of ticks until the next thunder toggle, 0 to toggle immediately

setThundering

void setThundering(boolean thundering)

Sets thundering to the boolean provided

Parameters:

thundering - true to start thundering, false to stop

isSunny

boolean isSunny()

Whether or not any weather is occurring within the world

Returns:

true if no weather is occurring, false if it is

setSunny

void setSunny()

Sets the world to sunny, stopping both thundering and raining if present