org.spongepowered.api.event.world

Interface ChangeWorldWeatherEvent

All Superinterfaces:

Cancellable, Event, TargetWorldEvent

public interface ChangeWorldWeatherEvent
extends TargetWorldEvent, Cancellable

Called when a WeatherUniverse's Weather changes.

Method Summary

Modifier and Type	Method and Description
int	getDuration() Sets the duration of the Weather (in ticks).
Weather	getInitialWeather() Gets the Weather that was happening before this event.
int	getOriginalDuration() Gets the original duration of getWeather() that would run after event.
Weather	getOriginalWeather() Gets the original Weather that the event is creating.
Weather	getWeather() Gets the Weather that this event is creating.
void	setDuration(int duration) Sets the duration of the Weather (in ticks).
void	setWeather(Weather weather) Sets what the new Weather should be with a random duration.

Methods inherited from interface org.spongepowered.api.event.world.TargetWorldEvent

getTargetWorld

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getOriginalWeather

Weather getOriginalWeather()

Gets the original Weather that the event is creating.

Returns:

The original Weather

getInitialWeather

Weather getInitialWeather()

Gets the Weather that was happening before this event.

Returns:

The Weather before the event was called

getWeather

Weather getWeather()

Gets the Weather that this event is creating.

Returns:

The Weather after this event is called

setWeather

void setWeather(Weather weather)

Sets what the new Weather should be with a random duration.

Parameters:

weather - The new Weather

getOriginalDuration

int getOriginalDuration()

Gets the original duration of getWeather() that would run after event.

Returns:

The original duration

getDuration

int getDuration()

Sets the duration of the Weather (in ticks).

Returns:

The duration of the weather (in ticks)

setDuration

void setDuration(int duration)

Sets the duration of the Weather (in ticks).

Parameters:

duration - The duration of the weather (in ticks)