org.spongepowered.api.world.weather

Interface WeatherUniverse

All Known Subinterfaces:

World

public interface WeatherUniverse

A universe affected by Weather.

Method Summary

Modifier and Type	Method and Description
long	getRemainingDuration() Gets the remaining duration of the current Weather.
long	getRunningDuration() Gets the duration the current Weather has been running for.
Weather	getWeather() Gets the current Weather in this volume.
void	setWeather(Weather weather) Sets the Weather of the volume with a random duration.
void	setWeather(Weather weather, long duration) Sets the Weather of the volume with the specified duration.

Method Detail

getWeather

Weather getWeather()

Gets the current Weather in this volume.

Returns:

The current weather.

getRemainingDuration

long getRemainingDuration()

Gets the remaining duration of the current Weather.

Returns:

The remaining weather duration.

getRunningDuration

long getRunningDuration()

Gets the duration the current Weather has been running for.

Returns:

The running weather duration.

setWeather

void setWeather(Weather weather)

Sets the Weather of the volume with a random duration.

Parameters:

weather - The new Weather.

setWeather

void setWeather(Weather weather,
                long duration)

Sets the Weather of the volume with the specified duration.

Parameters:

weather - The new Weather.

duration - The specified duration.