Package org.bukkit.event.weather
Class WeatherChangeEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.weather.WeatherEvent
org.bukkit.event.weather.WeatherChangeEvent
- All Implemented Interfaces:
Cancellable
Stores data for weather changing in a world
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.weather.WeatherEvent
world
-
Constructor Summary
ConstructorsConstructorDescriptionWeatherChangeEvent
(@NotNull World world, boolean newWeatherState) Deprecated, for removal: This API element is subject to removal in a future version.WeatherChangeEvent
(@NotNull World world, boolean newWeatherState, @NotNull WeatherChangeEvent.Cause cause) -
Method Summary
Modifier and TypeMethodDescriptiongetCause()
Gets the cause of the weather change.static @NotNull HandlerList
boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.boolean
Gets the state of weather that the world is being set toMethods inherited from class org.bukkit.event.weather.WeatherEvent
getWorld
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
WeatherChangeEvent
-
WeatherChangeEvent
@Internal @Deprecated(forRemoval=true) public WeatherChangeEvent(@NotNull @NotNull World world, boolean newWeatherState) Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Details
-
toWeatherState
public boolean toWeatherState()Gets the state of weather that the world is being set to- Returns:
true
if the weather is being set to raining,false
otherwise
-
getCause
Gets the cause of the weather change.- Returns:
- the weather change cause
-
isCancelled
public boolean isCancelled()Description copied from interface:Cancellable
Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins- Specified by:
isCancelled
in interfaceCancellable
- Returns:
true
if this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel) Description copied from interface:Cancellable
Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.- Specified by:
setCancelled
in interfaceCancellable
- Parameters:
cancel
-true
if you wish to cancel this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-