Skip to content

How to react when a player breaks a block in a Minecraft mod

Block breaking has an event that runs on the server. Fabric API’s PlayerBlockBreakEvents.AFTER runs after a player broke a block (BEFORE can stop it). Forge’s and NeoForge’s BlockEvent.BreakEvent runs just before, and cancelling it keeps the block. Both give you the level, the player, the position and the block’s state.

Works on Minecraft 1.20.1 to 26.3 on NeoForge; Minecraft 1.16.5 to 26.3 on Fabric; Minecraft 1.16.5 to 1.20.1 on Forge; Minecraft 1.12.2 on Forge. Each example was compiled against its loader and version before it shipped in Linen.

  1. Listen to the break event when your mod starts.
  2. Check which block it was (state.is(…) or state.getBlock() on 1.13 and newer).
  3. Do what you need, or cancel the break (BEFORE on Fabric, setCanceled on Forge and NeoForge).

The example mod is examplemod in the package com.example.examplemod. Use your own mod id and package.

Fabric 1.16.5 to 1.21.1, Fabric 1.21.2 to 1.21.11

Section titled “Fabric 1.16.5 to 1.21.1, Fabric 1.21.2 to 1.21.11”

Uses:

  • PlayerBlockBreakEvents.AFTER
  • Player.displayClientMessage
  • Block.getName

src/main/java/com/example/examplemod/event/MiningNoticeBreakEvents.java

package com.example.examplemod.event;
import net.fabricmc.fabric.api.event.player.PlayerBlockBreakEvents;
// Runs on the server after a player broke a block (Fabric API: PlayerBlockBreakEvents.AFTER; BEFORE can stop the break).
public final class MiningNoticeBreakEvents {
private MiningNoticeBreakEvents() {
}
// Called from the mod's onInitialize.
public static void register() {
PlayerBlockBreakEvents.AFTER.register((level, player, pos, state, blockEntity) -> player.displayClientMessage(state.getBlock().getName(), true));
}
}

In your main mod class, inside onInitialize:

MiningNoticeBreakEvents.register();

NeoForge 1.20.2 to 1.21.1, NeoForge 1.21.2 to 1.21.11

Section titled “NeoForge 1.20.2 to 1.21.1, NeoForge 1.21.2 to 1.21.11”

Uses:

  • BlockEvent.BreakEvent
  • Player.displayClientMessage
  • Block.getName

src/main/java/com/example/examplemod/event/MiningNoticeBreakEvents.java

package com.example.examplemod.event;
import net.neoforged.neoforge.common.NeoForge;
import net.neoforged.neoforge.event.level.BlockEvent;
// Fired on the server just before a player breaks a block; setCanceled(true) keeps it (NeoForge: BlockEvent.BreakEvent).
public final class MiningNoticeBreakEvents {
private MiningNoticeBreakEvents() {
}
// Called from the mod's constructor.
public static void register() {
NeoForge.EVENT_BUS.addListener(MiningNoticeBreakEvents::onBreak);
}
private static void onBreak(BlockEvent.BreakEvent event) {
event.getPlayer().displayClientMessage(event.getState().getBlock().getName(), true);
}
}

In your main mod class, inside <init>:

MiningNoticeBreakEvents.register();

Uses:

  • BlockEvent.BreakEvent
  • Player.displayClientMessage
  • Block.getName

src/main/java/com/example/examplemod/event/MiningNoticeBreakEvents.java

package com.example.examplemod.event;
import net.neoforged.neoforge.common.NeoForge;
import net.neoforged.neoforge.event.level.block.BreakBlockEvent;
// Fired on the server just before a player breaks a block; setCanceled(true) keeps it (NeoForge: BreakBlockEvent).
public final class MiningNoticeBreakEvents {
private MiningNoticeBreakEvents() {
}
// Called from the mod's constructor.
public static void register() {
NeoForge.EVENT_BUS.addListener(MiningNoticeBreakEvents::onBreak);
}
private static void onBreak(BreakBlockEvent event) {
event.getPlayer().sendOverlayMessage(event.getState().getBlock().getName());
}
}

In your main mod class, inside <init>:

MiningNoticeBreakEvents.register();

Uses:

  • BlockEvent.BreakEvent
  • Player.sendOverlayMessage
  • Block.getName

src/main/java/com/example/examplemod/event/MiningNoticeBreakEvents.java

package com.example.examplemod.event;
import net.neoforged.neoforge.common.NeoForge;
import net.neoforged.neoforge.event.level.BlockEvent;
// Fired on the server just before a player breaks a block; setCanceled(true) keeps it (NeoForge: BlockEvent.BreakEvent).
public final class MiningNoticeBreakEvents {
private MiningNoticeBreakEvents() {
}
// Called from the mod's constructor.
public static void register() {
NeoForge.EVENT_BUS.addListener(MiningNoticeBreakEvents::onBreak);
}
private static void onBreak(BlockEvent.BreakEvent event) {
event.getPlayer().sendOverlayMessage(event.getState().getBlock().getName());
}
}

In your main mod class, inside <init>:

MiningNoticeBreakEvents.register();

Uses:

  • PlayerBlockBreakEvents.AFTER
  • Player.displayClientMessage
  • Block.getName

src/main/java/com/example/examplemod/event/MiningNoticeBreakEvents.java

package com.example.examplemod.event;
import net.fabricmc.fabric.api.event.player.PlayerBlockBreakEvents;
// Runs on the server after a player broke a block (Fabric API: PlayerBlockBreakEvents.AFTER; BEFORE can stop the break).
public final class MiningNoticeBreakEvents {
private MiningNoticeBreakEvents() {
}
// Called from the mod's onInitialize.
public static void register() {
PlayerBlockBreakEvents.AFTER.register((level, player, pos, state, blockEntity) -> player.sendOverlayMessage(state.getBlock().getName()));
}
}

In your main mod class, inside onInitialize:

MiningNoticeBreakEvents.register();

Uses:

  • BlockEvent.BreakEvent
  • Player.displayClientMessage
  • Block.getName

src/main/java/com/example/examplemod/event/MiningNoticeBreakEvents.java

package com.example.examplemod.event;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.level.BlockEvent;
// Fired on the server just before a player breaks a block; setCanceled(true) keeps it (Forge: BlockEvent.BreakEvent).
public final class MiningNoticeBreakEvents {
private MiningNoticeBreakEvents() {
}
// Called from the mod's constructor.
public static void register() {
MinecraftForge.EVENT_BUS.addListener(MiningNoticeBreakEvents::onBreak);
}
private static void onBreak(BlockEvent.BreakEvent event) {
event.getPlayer().displayClientMessage(event.getState().getBlock().getName(), true);
}
}

In your main mod class, inside <init>:

MiningNoticeBreakEvents.register();

Uses:

  • BlockEvent.BreakEvent
  • Player.displayClientMessage
  • Block.getName

src/main/java/com/example/examplemod/event/MiningNoticeBreakEvents.java

package com.example.examplemod.event;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.level.BlockEvent;
// Fired on the server just before a player breaks a block; setCanceled(true) keeps it (NeoForge: BlockEvent.BreakEvent).
public final class MiningNoticeBreakEvents {
private MiningNoticeBreakEvents() {
}
// Called from the mod's constructor.
public static void register() {
MinecraftForge.EVENT_BUS.addListener(MiningNoticeBreakEvents::onBreak);
}
private static void onBreak(BlockEvent.BreakEvent event) {
event.getPlayer().displayClientMessage(event.getState().getBlock().getName(), true);
}
}

In your main mod class, inside <init>:

MiningNoticeBreakEvents.register();

Uses:

  • BlockEvent.BreakEvent
  • PlayerEntity.displayClientMessage
  • Block.getName

src/main/java/com/example/examplemod/event/MiningNoticeBreakEvents.java

package com.example.examplemod.event;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.world.BlockEvent;
// Fired on the server just before a player breaks a block; setCanceled(true) keeps it (Forge: BlockEvent.BreakEvent).
public final class MiningNoticeBreakEvents {
private MiningNoticeBreakEvents() {
}
// Called from the mod's constructor.
public static void register() {
MinecraftForge.EVENT_BUS.addListener(MiningNoticeBreakEvents::onBreak);
}
private static void onBreak(BlockEvent.BreakEvent event) {
event.getPlayer().displayClientMessage(event.getState().getBlock().getName(), true);
}
}

In your main mod class, inside <init>:

MiningNoticeBreakEvents.register();

Uses:

  • BlockEvent.BreakEvent
  • EntityPlayer.displayClientMessage
  • Block.getName

src/main/java/com/example/examplemod/event/MiningNoticeBreakEvents.java

package com.example.examplemod.event;
import com.example.examplemod.ExampleMod;
import net.minecraft.util.text.TextComponentTranslation;
import net.minecraftforge.event.world.BlockEvent;
import net.minecraftforge.fml.common.Mod;
import net.minecraftforge.fml.common.eventhandler.SubscribeEvent;
// Fired on the server just before a player breaks a block; setCanceled(true) keeps it (Forge: BlockEvent.BreakEvent). The class registers itself on the event bus.
@Mod.EventBusSubscriber(modid = ExampleMod.MOD_ID)
public final class MiningNoticeBreakEvents {
private MiningNoticeBreakEvents() {
}
@SubscribeEvent
public static void onBreak(BlockEvent.BreakEvent event) {
event.getPlayer().sendStatusMessage(new TextComponentTranslation(event.getState().getBlock().getUnlocalizedName() + ".name"), true);
}
}

Linen’s How-tos library has this page too, with the example for your own mod’s loader and Minecraft version. Hover a name in your code and Linen points to the how-tos that explain it. Both are free. Download Linen.