Package org.bukkit.event.hanging
Class HangingBreakEvent
- java.lang.Object
-
- org.bukkit.event.Event
-
- org.bukkit.event.hanging.HangingEvent
-
- org.bukkit.event.hanging.HangingBreakEvent
-
- All Implemented Interfaces:
Cancellable
- Direct Known Subclasses:
HangingBreakByEntityEvent
public class HangingBreakEvent extends HangingEvent implements Cancellable
Triggered when a hanging entity is removed
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HangingBreakEvent.RemoveCause
An enum to specify the cause of the removal-
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
-
Field Summary
-
Fields inherited from class org.bukkit.event.hanging.HangingEvent
hanging
-
-
Constructor Summary
Constructors Constructor Description HangingBreakEvent(@NotNull Hanging hanging, HangingBreakEvent.RemoveCause cause)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description HangingBreakEvent.RemoveCause
getCause()
Gets the cause for the hanging entity's removalstatic @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.-
Methods inherited from class org.bukkit.event.hanging.HangingEvent
getEntity
-
Methods inherited from class org.bukkit.event.Event
getEventName, isAsynchronous
-
-
-
-
Constructor Detail
-
HangingBreakEvent
public HangingBreakEvent(@NotNull @NotNull Hanging hanging, @NotNull HangingBreakEvent.RemoveCause cause)
-
-
Method Detail
-
getCause
@NotNull public HangingBreakEvent.RemoveCause getCause()
Gets the cause for the hanging entity's removal- Returns:
- the RemoveCause for the hanging entity's removal
-
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
@NotNull public @NotNull HandlerList getHandlers()
- Specified by:
getHandlers
in classEvent
-
getHandlerList
@NotNull public static @NotNull HandlerList getHandlerList()
-
-