Package org.bukkit.event.weather
Class LightningStrikeEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.weather.WeatherEvent
org.bukkit.event.weather.LightningStrikeEvent
- All Implemented Interfaces:
Cancellable
Stores data for lightning striking
-
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
ConstructorsConstructorDescriptionLightningStrikeEvent
(@NotNull World world, @NotNull LightningStrike bolt) Deprecated, for removal: This API element is subject to removal in a future version.LightningStrikeEvent
(@NotNull World world, @NotNull LightningStrike bolt, @NotNull LightningStrikeEvent.Cause cause) -
Method Summary
Modifier and TypeMethodDescriptiongetCause()
Gets the cause of this lightning strike.static @NotNull HandlerList
Gets the bolt which is striking the earth.boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.Methods inherited from class org.bukkit.event.weather.WeatherEvent
getWorld
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
LightningStrikeEvent
@Internal @Deprecated(since="1.13.1", forRemoval=true) public LightningStrikeEvent(@NotNull @NotNull World world, @NotNull @NotNull LightningStrike bolt) Deprecated, for removal: This API element is subject to removal in a future version. -
LightningStrikeEvent
@Internal public LightningStrikeEvent(@NotNull @NotNull World world, @NotNull @NotNull LightningStrike bolt, @NotNull @NotNull LightningStrikeEvent.Cause cause)
-
-
Method Details
-
getLightning
Gets the bolt which is striking the earth.- Returns:
- lightning entity
-
getCause
Gets the cause of this lightning strike.- Returns:
- strike 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
-