Package org.bukkit.event.block

Class BlockReceiveGameEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.block.BlockEvent

org.bukkit.event.block.BlockReceiveGameEvent

All Implemented Interfaces:

Cancellable

public class BlockReceiveGameEvent
extends BlockEvent
implements Cancellable

Called when a Sculk sensor receives a game event and hence might activate. Will be called cancelled if the block's default behavior is to ignore the event.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.block.BlockEvent

block

Constructor Summary

Constructors

Constructor	Description
BlockReceiveGameEvent(@NotNull GameEvent event, @NotNull Block block, @Nullable Entity entity)

Method Summary

Modifier and Type	Method	Description
@Nullable Entity	getEntity()	Get the entity which triggered this event, if present.
@NotNull GameEvent	getEvent()	Get the underlying event.
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.

Methods inherited from class org.bukkit.event.block.BlockEvent

getBlock

Methods inherited from class org.bukkit.event.Event

asynchronous, callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

BlockReceiveGameEvent

public BlockReceiveGameEvent(@NotNull
 @NotNull GameEvent event,
 @NotNull
 @NotNull Block block,
 @Nullable
 @Nullable Entity entity)

Method Details

getEvent

@NotNull
public @NotNull GameEvent getEvent()

Get the underlying event.

Returns:

the event

getEntity

@Nullable
public @Nullable Entity getEntity()

Get the entity which triggered this event, if present.

Returns:

triggering entity or null

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

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

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()