net.risingworld.api.events.world

Class WeatherChangeEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.world.WeatherChangeEvent

All Implemented Interfaces:

Cancellable

public final class WeatherChangeEvent
extends Event
implements Cancellable

Called when the weather changes. More precisely, this event is called twice: Once the weather transition begins, and once it is completed.

Constructor Summary

Constructors

Constructor and Description
WeatherChangeEvent(Weather currentWeather, Weather nextWeather, boolean completed)

Method Summary

Modifier and Type	Method and Description
Weather	getCurrentWeather() Gets the current weather.
Weather	getNextWeather() Gets the next, target weather.
boolean	isCancelled() Determines if the event is cancelled.
boolean	isTransitionCompleted() Gets weather or not the transition is completed.
void	setCancelled(boolean cancel) Cancels this event.
void	setNextWeather(Weather weather) Changes the next weather.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WeatherChangeEvent

public WeatherChangeEvent(Weather currentWeather,
                          Weather nextWeather,
                          boolean completed)

Method Detail

getCurrentWeather

public Weather getCurrentWeather()

Gets the current weather.

Returns:

the current weather.

getNextWeather

public Weather getNextWeather()

Gets the next, target weather.

Returns:

the next weather.

setNextWeather

public void setNextWeather(Weather weather)

Changes the next weather. This does not work if the transition is already completely (which can be checked with isTransitionCompleted()).

Parameters:

weather - the next weather.

isTransitionCompleted

public boolean isTransitionCompleted()

Gets weather or not the transition is completed. Usually the WeatherChangeEvent will be called twice, once the transition begins, and once it is completed. If the transition is completed, this function returns true, otherwise it returns false.
Note: If the weather changes instantly (via command), this event is only called once, and this function returns true.

Returns:

true if the weather transition is completed, false if not.

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.