Package org.bukkit.event.weather

Class ThunderChangeEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.weather.WeatherEvent

org.bukkit.event.weather.ThunderChangeEvent

All Implemented Interfaces:

Cancellable

public class ThunderChangeEvent
extends WeatherEvent
implements Cancellable

Stores data for thunder state changing in a world

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ThunderChangeEvent.Cause

Nested 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

Constructors

Constructor	Description
ThunderChangeEvent(@NotNull World world, boolean newThunderState)	Deprecated, for removal: This API element is subject to removal in a future version.
ThunderChangeEvent(@NotNull World world, boolean newThunderState, @NotNull ThunderChangeEvent.Cause cause)

Method Summary

Modifier and Type	Method	Description
@NotNull ThunderChangeEvent.Cause	getCause()	Gets the cause of the weather change.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
boolean	toThunderState()	Gets the state of thunder that the world is being set to

Methods inherited from class org.bukkit.event.weather.WeatherEvent

getWorld

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

ThunderChangeEvent

@Internal
public ThunderChangeEvent(@NotNull
 @NotNull World world,
 boolean newThunderState,
 @NotNull
 @NotNull ThunderChangeEvent.Cause cause)

ThunderChangeEvent

@Internal
@Deprecated(forRemoval=true)
public ThunderChangeEvent(@NotNull
 @NotNull World world,
 boolean newThunderState)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

toThunderState

public boolean toThunderState()

Gets the state of thunder that the world is being set to

Returns:

true if the weather is being set to thundering, false otherwise

getCause

@NotNull
public @NotNull ThunderChangeEvent.Cause 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 interface Cancellable

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 interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()