Package 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.

  • Method Details

    • getCurrentWeather

      public WeatherDefs.Weather getCurrentWeather()
      Gets the current weather.
      Returns:
      the current weather.

    • getNextWeather

      public WeatherDefs.Weather getNextWeather()
      Gets the next, target weather.
      Returns:
      the next weather.

    • setNextWeather

      public void setNextWeather(int id)
      Changes the next weather. This does not work if the transition is already completely (which can be checked with isTransitionCompleted()).
      Parameters:
      id - the next weather id.

    • 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.

      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      cancel - set to true if you want to cancel this event.
      Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area
      1//Listener class
      2public class PlayerListener implements Listener{
      3 @EventMethod
      4 public void onEnterArea(PlayerEnterAreaEvent evt){
      5 //Now the player will not be able to enter the area, i.e.
      6 //he will be teleported back to his old position (outside the area)
      7 evt.setCancelled(true);
      8 }
      9}