Package net.minestom.server.instance.block

Interface BlockHandler

All Known Implementing Classes:

BlockHandler.Dummy

public interface BlockHandler

Interface used to provide block behavior. Set with Block.withHandler(BlockHandler).

Implementations are expected to be thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BlockHandler.Destroy
static final class	BlockHandler.Dummy	Handler used for loaded blocks with unknown namespace in order to do not lose the information while saving, and for runtime debugging purpose.
static final class	BlockHandler.Interaction
static class	BlockHandler.Placement	Represents an object forwarded to onPlace(Placement).
static final class	BlockHandler.PlayerDestroy
static final class	BlockHandler.PlayerPlacement
static final class	BlockHandler.Tick
static final class	BlockHandler.Touch

Method Summary

Modifier and Type	Method	Description
default byte	getBlockEntityAction()
default @NotNull Collection<Tag<?>>	getBlockEntityTags()	Specifies which block entity tags should be sent to the player.
@NotNull NamespaceID	getNamespaceId()	Gets the id of this handler.
default boolean	isTickable()
default void	onDestroy(@NotNull BlockHandler.Destroy destroy)	Called when a block has been destroyed or replaced.
default boolean	onInteract(@NotNull BlockHandler.Interaction interaction)	Handles interactions with this block.
default void	onPlace(@NotNull BlockHandler.Placement placement)	Called when a block has been placed.
default void	onTouch(@NotNull BlockHandler.Touch touch)	Defines custom behaviour for entities touching this block.
default void	tick(@NotNull BlockHandler.Tick tick)

Method Details

onPlace

default void onPlace(@NotNull
 @NotNull BlockHandler.Placement placement)

Called when a block has been placed.

Parameters:

placement - the placement details

onDestroy

default void onDestroy(@NotNull
 @NotNull BlockHandler.Destroy destroy)

Called when a block has been destroyed or replaced.

Parameters:

destroy - the destroy details

onInteract

default boolean onInteract(@NotNull
 @NotNull BlockHandler.Interaction interaction)

Handles interactions with this block. Can also block normal item use (containers should block when opening the menu, this prevents the player from placing a block when opening it for instance).

Parameters:

interaction - the interaction details

Returns:

true to let the block interaction happens, false to cancel

onTouch

default void onTouch(@NotNull
 @NotNull BlockHandler.Touch touch)

Defines custom behaviour for entities touching this block.

Parameters:

touch - the contact details

tick

default void tick(@NotNull
 @NotNull BlockHandler.Tick tick)

isTickable

default boolean isTickable()

getBlockEntityTags

@NotNull
default @NotNull Collection<Tag<?>> getBlockEntityTags()

Specifies which block entity tags should be sent to the player.

Returns:

The list of tags from this block's block entity that should be sent to the player

See Also:

• Block entity on the Minecraft wiki

getBlockEntityAction

default byte getBlockEntityAction()

getNamespaceId

@NotNull
@NotNull NamespaceID getNamespaceId()

Gets the id of this handler.

Used to write the block entity in the anvil world format.

Returns:

the namespace id of this handler