How to make a block entity that ticks in a Minecraft mod
A block entity (a tile entity before 1.17) holds data and code for one placed block: a BlockEntity subclass, registered as a BlockEntityType for its block. From 1.17 the block extends BaseEntityBlock: newBlockEntity makes the entity, getTicker hands the game a method to call every tick (createTickerHelper checks the type), and getRenderShape returns MODEL so the block is drawn. saveAdditional and loadAdditional keep its data in the world (load before 1.20.5).
Works on Minecraft 1.20.1 to 26.3 on NeoForge; Minecraft 1.18 to 26.3 on Fabric; Minecraft 1.16.5 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.
- Make the BlockEntity class with a tick method and its save and load methods.
- Register a BlockEntityType for it (BlockEntityType.Builder.of(…).build(null)).
- Make the block extend BaseEntityBlock with newBlockEntity, getTicker and getRenderShape.
- Register the block with your class.
For each loader and version
Section titled “For each loader and version”The example mod is examplemod in the package com.example.examplemod. Use your own mod id and package.
NeoForge 1.20.1
Section titled “NeoForge 1.20.1”Uses:
BlockEntityType.Builder.ofDeferredRegister.createRegistries.BLOCK_ENTITY_TYPEDeferredHolderBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override public RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER.get(), TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER.get(), pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag) { super.saveAdditional(tag); tag.putInt("ticks", ticks); }
@Override public void load(CompoundTag tag) { super.load(tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;import net.minecraftforge.registries.RegistryObject;
public final class ModBlockEntities { public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(ForgeRegistries.BLOCK_ENTITY_TYPES, ExampleMod.MOD_ID);
public static final RegistryObject<BlockEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()).build(null));
private ModBlockEntities() { }
// Called from the ExampleMod constructor: puts the block entity types on the mod event bus. public static void register() { BLOCK_ENTITY_TYPES.register(FMLJavaModLoadingContext.get().getModEventBus()); }}In your main mod class, inside <init>:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
NeoForge 1.20.4
Section titled “NeoForge 1.20.4”Uses:
BlockEntityType.Builder.ofDeferredRegister.createRegistries.BLOCK_ENTITY_TYPEDeferredHolderBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.mojang.serialization.MapCodec;import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public static final MapCodec<TickCounterBlock> CODEC = simpleCodec(TickCounterBlock::new);
public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override public RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER.get(), TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER.get(), pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag) { super.saveAdditional(tag); tag.putInt("ticks", ticks); }
@Override public void load(CompoundTag tag) { super.load(tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.registries.Registries;import net.minecraft.world.level.block.entity.BlockEntityType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModBlockEntities { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(Registries.BLOCK_ENTITY_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<BlockEntityType<?>, BlockEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()).build(null));
private ModBlockEntities() { }}In your main mod class, inside <init>:
ModBlockEntities.BLOCK_ENTITY_TYPES.register(modEventBus);It’s registered like any other block, as TickCounterBlock: see a new block.
NeoForge 1.20.2
Section titled “NeoForge 1.20.2”Uses:
BlockEntityType.Builder.ofDeferredRegister.createRegistries.BLOCK_ENTITY_TYPEDeferredHolderBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override public RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER.get(), TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER.get(), pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag) { super.saveAdditional(tag); tag.putInt("ticks", ticks); }
@Override public void load(CompoundTag tag) { super.load(tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.registries.Registries;import net.minecraft.world.level.block.entity.BlockEntityType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModBlockEntities { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(Registries.BLOCK_ENTITY_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<BlockEntityType<?>, BlockEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()).build(null));
private ModBlockEntities() { }}In your main mod class, inside <init>:
ModBlockEntities.BLOCK_ENTITY_TYPES.register(modEventBus);It’s registered like any other block, as TickCounterBlock: see a new block.
Fabric 1.19.3 to 1.20.2
Section titled “Fabric 1.19.3 to 1.20.2”Uses:
BlockEntityType.Builder.ofBuiltInRegistries.BLOCK_ENTITY_TYPEBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
Before 1.20.5 a block entity saves with saveAdditional(CompoundTag) and loads with load(CompoundTag), without a HolderLookup.Provider. Before 1.20.3 a block does not need a codec(): BaseEntityBlock has only a constructor.
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override public RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER, TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER, pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag) { super.saveAdditional(tag); tag.putInt("ticks", ticks); }
@Override public void load(CompoundTag tag) { super.load(tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.level.block.entity.BlockEntityType;
public final class ModBlockEntities { public static final BlockEntityType<TickCounterBlockEntity> TICK_COUNTER = Registry.register(BuiltInRegistries.BLOCK_ENTITY_TYPE, ExampleMod.id("tick_counter"), BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER).build(null));
private ModBlockEntities() { }
// Called from ExampleMod#onInitialize after ModBlocks; loading this class registers the block entity types above. public static void register() { }}In your main mod class, inside onInitialize:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
Fabric 1.20.3 to 1.20.4
Section titled “Fabric 1.20.3 to 1.20.4”Uses:
BlockEntityType.Builder.ofBuiltInRegistries.BLOCK_ENTITY_TYPEBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
Before 1.20.5 a block entity saves with saveAdditional(CompoundTag) and loads with load(CompoundTag), without a HolderLookup.Provider.
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.mojang.serialization.MapCodec;import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public static final MapCodec<TickCounterBlock> CODEC = simpleCodec(TickCounterBlock::new);
public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override public RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER, TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER, pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag) { super.saveAdditional(tag); tag.putInt("ticks", ticks); }
@Override public void load(CompoundTag tag) { super.load(tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.level.block.entity.BlockEntityType;
public final class ModBlockEntities { public static final BlockEntityType<TickCounterBlockEntity> TICK_COUNTER = Registry.register(BuiltInRegistries.BLOCK_ENTITY_TYPE, ExampleMod.id("tick_counter"), BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER).build(null));
private ModBlockEntities() { }
// Called from ExampleMod#onInitialize after ModBlocks; loading this class registers the block entity types above. public static void register() { }}In your main mod class, inside onInitialize:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
Fabric 1.20.5 to 1.21.1
Section titled “Fabric 1.20.5 to 1.21.1”Uses:
BlockEntityType.Builder.ofBuiltInRegistries.BLOCK_ENTITY_TYPEBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.mojang.serialization.MapCodec;import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public static final MapCodec<TickCounterBlock> CODEC = simpleCodec(TickCounterBlock::new);
public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER, TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.core.HolderLookup;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER, pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.saveAdditional(tag, registries); tag.putInt("ticks", ticks); }
@Override protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.loadAdditional(tag, registries); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.level.block.entity.BlockEntityType;
public final class ModBlockEntities { public static final BlockEntityType<TickCounterBlockEntity> TICK_COUNTER = Registry.register(BuiltInRegistries.BLOCK_ENTITY_TYPE, ExampleMod.id("tick_counter"), BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER).build(null));
private ModBlockEntities() { }
// Called from ExampleMod#onInitialize after ModBlocks; loading this class registers the block entity types above. public static void register() { }}In your main mod class, inside onInitialize:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
NeoForge 1.20.5 to 1.21.1
Section titled “NeoForge 1.20.5 to 1.21.1”Uses:
BlockEntityType.Builder.ofDeferredRegister.createRegistries.BLOCK_ENTITY_TYPEDeferredHolderBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.mojang.serialization.MapCodec;import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public static final MapCodec<TickCounterBlock> CODEC = simpleCodec(TickCounterBlock::new);
public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER.get(), TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.core.HolderLookup;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER.get(), pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.saveAdditional(tag, registries); tag.putInt("ticks", ticks); }
@Override protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.loadAdditional(tag, registries); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.registries.Registries;import net.minecraft.world.level.block.entity.BlockEntityType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModBlockEntities { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(Registries.BLOCK_ENTITY_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<BlockEntityType<?>, BlockEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()).build(null));
private ModBlockEntities() { }}In your main mod class, inside <init>:
ModBlockEntities.BLOCK_ENTITY_TYPES.register(modEventBus);It’s registered like any other block, as TickCounterBlock: see a new block.
Fabric 1.21.2 to 1.21.4
Section titled “Fabric 1.21.2 to 1.21.4”Uses:
BlockEntityType.Builder.ofBuiltInRegistries.BLOCK_ENTITY_TYPEBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.mojang.serialization.MapCodec;import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public static final MapCodec<TickCounterBlock> CODEC = simpleCodec(TickCounterBlock::new);
public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER, TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.core.HolderLookup;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER, pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.saveAdditional(tag, registries); tag.putInt("ticks", ticks); }
@Override protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.loadAdditional(tag, registries); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.fabricmc.fabric.api.object.builder.v1.block.entity.FabricBlockEntityTypeBuilder;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.level.block.entity.BlockEntityType;
public final class ModBlockEntities { public static final BlockEntityType<TickCounterBlockEntity> TICK_COUNTER = Registry.register(BuiltInRegistries.BLOCK_ENTITY_TYPE, ExampleMod.id("tick_counter"), FabricBlockEntityTypeBuilder.create(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER).build());
private ModBlockEntities() { }
// Called from ExampleMod#onInitialize after ModBlocks; loading this class registers the block entity types above. public static void register() { }}In your main mod class, inside onInitialize:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
NeoForge 1.21.2 to 1.21.4
Section titled “NeoForge 1.21.2 to 1.21.4”Uses:
BlockEntityType.Builder.ofDeferredRegister.createRegistries.BLOCK_ENTITY_TYPEDeferredHolderBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.mojang.serialization.MapCodec;import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public static final MapCodec<TickCounterBlock> CODEC = simpleCodec(TickCounterBlock::new);
public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER.get(), TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.core.HolderLookup;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER.get(), pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.saveAdditional(tag, registries); tag.putInt("ticks", ticks); }
@Override protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.loadAdditional(tag, registries); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.registries.Registries;import net.minecraft.world.level.block.entity.BlockEntityType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModBlockEntities { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(Registries.BLOCK_ENTITY_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<BlockEntityType<?>, BlockEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> new BlockEntityType<>(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()));
private ModBlockEntities() { }}In your main mod class, inside <init>:
ModBlockEntities.BLOCK_ENTITY_TYPES.register(modEventBus);It’s registered like any other block, as TickCounterBlock: see a new block.
NeoForge 1.21.5
Section titled “NeoForge 1.21.5”Uses:
BlockEntityType.Builder.ofDeferredRegister.createRegistries.BLOCK_ENTITY_TYPEDeferredHolderBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.mojang.serialization.MapCodec;import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public static final MapCodec<TickCounterBlock> CODEC = simpleCodec(TickCounterBlock::new);
public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER.get(), TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.core.HolderLookup;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER.get(), pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.saveAdditional(tag, registries); tag.putInt("ticks", ticks); }
@Override protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.loadAdditional(tag, registries); ticks = tag.getIntOr("ticks", 0); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.registries.Registries;import net.minecraft.world.level.block.entity.BlockEntityType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModBlockEntities { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(Registries.BLOCK_ENTITY_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<BlockEntityType<?>, BlockEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> new BlockEntityType<>(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()));
private ModBlockEntities() { }}In your main mod class, inside <init>:
ModBlockEntities.BLOCK_ENTITY_TYPES.register(modEventBus);It’s registered like any other block, as TickCounterBlock: see a new block.
Fabric 1.21.5
Section titled “Fabric 1.21.5”Uses:
BlockEntityType.Builder.ofBuiltInRegistries.BLOCK_ENTITY_TYPEBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.mojang.serialization.MapCodec;import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public static final MapCodec<TickCounterBlock> CODEC = simpleCodec(TickCounterBlock::new);
public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER, TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.core.HolderLookup;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER, pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.saveAdditional(tag, registries); tag.putInt("ticks", ticks); }
@Override protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) { super.loadAdditional(tag, registries); ticks = tag.getIntOr("ticks", 0); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.fabricmc.fabric.api.object.builder.v1.block.entity.FabricBlockEntityTypeBuilder;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.level.block.entity.BlockEntityType;
public final class ModBlockEntities { public static final BlockEntityType<TickCounterBlockEntity> TICK_COUNTER = Registry.register(BuiltInRegistries.BLOCK_ENTITY_TYPE, ExampleMod.id("tick_counter"), FabricBlockEntityTypeBuilder.create(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER).build());
private ModBlockEntities() { }
// Called from ExampleMod#onInitialize after ModBlocks; loading this class registers the block entity types above. public static void register() { }}In your main mod class, inside onInitialize:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
NeoForge 1.21.6 to 26.2
Section titled “NeoForge 1.21.6 to 26.2”Uses:
BlockEntityType.Builder.ofDeferredRegister.createRegistries.BLOCK_ENTITY_TYPEDeferredHolderBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
Since 1.21.6 a block entity saves and loads through ValueOutput and ValueInput instead of CompoundTag.
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.mojang.serialization.MapCodec;import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public static final MapCodec<TickCounterBlock> CODEC = simpleCodec(TickCounterBlock::new);
public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER.get(), TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;import net.minecraft.world.level.storage.ValueInput;import net.minecraft.world.level.storage.ValueOutput;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER.get(), pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(ValueOutput output) { super.saveAdditional(output); output.putInt("ticks", ticks); }
@Override protected void loadAdditional(ValueInput input) { super.loadAdditional(input); ticks = input.getIntOr("ticks", 0); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.registries.Registries;import net.minecraft.world.level.block.entity.BlockEntityType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModBlockEntities { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(Registries.BLOCK_ENTITY_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<BlockEntityType<?>, BlockEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> new BlockEntityType<>(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()));
private ModBlockEntities() { }}In your main mod class, inside <init>:
ModBlockEntities.BLOCK_ENTITY_TYPES.register(modEventBus);It’s registered like any other block, as TickCounterBlock: see a new block.
Fabric 1.21.6 to 26.2
Section titled “Fabric 1.21.6 to 26.2”Uses:
BlockEntityType.Builder.ofBuiltInRegistries.BLOCK_ENTITY_TYPEBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.mojang.serialization.MapCodec;import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public static final MapCodec<TickCounterBlock> CODEC = simpleCodec(TickCounterBlock::new);
public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER, TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;import net.minecraft.world.level.storage.ValueInput;import net.minecraft.world.level.storage.ValueOutput;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER, pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(ValueOutput output) { super.saveAdditional(output); output.putInt("ticks", ticks); }
@Override protected void loadAdditional(ValueInput input) { super.loadAdditional(input); ticks = input.getIntOr("ticks", 0); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.fabricmc.fabric.api.object.builder.v1.block.entity.FabricBlockEntityTypeBuilder;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.level.block.entity.BlockEntityType;
public final class ModBlockEntities { public static final BlockEntityType<TickCounterBlockEntity> TICK_COUNTER = Registry.register(BuiltInRegistries.BLOCK_ENTITY_TYPE, ExampleMod.id("tick_counter"), FabricBlockEntityTypeBuilder.create(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER).build());
private ModBlockEntities() { }
// Called from ExampleMod#onInitialize after ModBlocks; loading this class registers the block entity types above. public static void register() { }}In your main mod class, inside onInitialize:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
NeoForge 26.3
Section titled “NeoForge 26.3”Uses:
BlockEntityType.Builder.ofDeferredRegister.createRegistries.BLOCK_ENTITY_TYPEDeferredHolderBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
Since 1.21.6 a block entity saves and loads through ValueOutput and ValueInput instead of CompoundTag.
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER.get(), TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;import net.minecraft.world.level.storage.ValueInput;import net.minecraft.world.level.storage.ValueOutput;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER.get(), pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(ValueOutput output) { super.saveAdditional(output); output.putInt("ticks", ticks); }
@Override protected void loadAdditional(ValueInput input) { super.loadAdditional(input); ticks = input.getIntOr("ticks", 0); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.registries.Registries;import net.minecraft.world.level.block.entity.BlockEntityType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModBlockEntities { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(Registries.BLOCK_ENTITY_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<BlockEntityType<?>, BlockEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> new BlockEntityType<>(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()));
private ModBlockEntities() { }}In your main mod class, inside <init>:
ModBlockEntities.BLOCK_ENTITY_TYPES.register(modEventBus);It’s registered like any other block, as TickCounterBlock: see a new block.
Fabric 26.3
Section titled “Fabric 26.3”Uses:
BlockEntityType.Builder.ofBuiltInRegistries.BLOCK_ENTITY_TYPEBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER, TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;import net.minecraft.world.level.storage.ValueInput;import net.minecraft.world.level.storage.ValueOutput;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER, pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(ValueOutput output) { super.saveAdditional(output); output.putInt("ticks", ticks); }
@Override protected void loadAdditional(ValueInput input) { super.loadAdditional(input); ticks = input.getIntOr("ticks", 0); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.fabricmc.fabric.api.object.builder.v1.block.entity.FabricBlockEntityTypeBuilder;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.level.block.entity.BlockEntityType;
public final class ModBlockEntities { public static final BlockEntityType<TickCounterBlockEntity> TICK_COUNTER = Registry.register(BuiltInRegistries.BLOCK_ENTITY_TYPE, ExampleMod.id("tick_counter"), FabricBlockEntityTypeBuilder.create(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER).build());
private ModBlockEntities() { }
// Called from ExampleMod#onInitialize after ModBlocks; loading this class registers the block entity types above. public static void register() { }}In your main mod class, inside onInitialize:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
Forge 1.17.1
Section titled “Forge 1.17.1”Uses:
BaseEntityBlock.getTickerBlockEntityTickerDeferredRegister.createForgeRegistries.BLOCK_ENTITY_TYPES
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override public RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER.get(), TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER.get(), pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override public CompoundTag save(CompoundTag tag) { super.save(tag); tag.putInt("ticks", ticks); return tag; }
@Override public void load(CompoundTag tag) { super.load(tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;import net.minecraftforge.fmllegacy.RegistryObject;
public final class ModBlockEntities { public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(ForgeRegistries.BLOCK_ENTITIES, ExampleMod.MOD_ID);
public static final RegistryObject<BlockEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()).build(null));
private ModBlockEntities() { }
// Called from the ExampleMod constructor: puts the block entity types on the mod event bus. public static void register() { BLOCK_ENTITY_TYPES.register(FMLJavaModLoadingContext.get().getModEventBus()); }}In your main mod class, inside <init>:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
Forge 1.18.2
Section titled “Forge 1.18.2”Uses:
BaseEntityBlock.getTickerBlockEntityTickerDeferredRegister.createForgeRegistries.BLOCK_ENTITY_TYPES
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override public RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER.get(), TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER.get(), pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag) { super.saveAdditional(tag); tag.putInt("ticks", ticks); }
@Override public void load(CompoundTag tag) { super.load(tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;import net.minecraftforge.registries.RegistryObject;
public final class ModBlockEntities { public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(ForgeRegistries.BLOCK_ENTITIES, ExampleMod.MOD_ID);
public static final RegistryObject<BlockEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()).build(null));
private ModBlockEntities() { }
// Called from the ExampleMod constructor: puts the block entity types on the mod event bus. public static void register() { BLOCK_ENTITY_TYPES.register(FMLJavaModLoadingContext.get().getModEventBus()); }}In your main mod class, inside <init>:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
Forge 1.19 to 1.20.1
Section titled “Forge 1.19 to 1.20.1”Uses:
BaseEntityBlock.getTickerBlockEntityTickerDeferredRegister.createForgeRegistries.BLOCK_ENTITY_TYPES
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override public RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER.get(), TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER.get(), pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag) { super.saveAdditional(tag); tag.putInt("ticks", ticks); }
@Override public void load(CompoundTag tag) { super.load(tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;import net.minecraftforge.registries.RegistryObject;
public final class ModBlockEntities { public static final DeferredRegister<BlockEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(ForgeRegistries.BLOCK_ENTITY_TYPES, ExampleMod.MOD_ID);
public static final RegistryObject<BlockEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()).build(null));
private ModBlockEntities() { }
// Called from the ExampleMod constructor: puts the block entity types on the mod event bus. public static void register() { BLOCK_ENTITY_TYPES.register(FMLJavaModLoadingContext.get().getModEventBus()); }}In your main mod class, inside <init>:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
Fabric 1.19.2
Section titled “Fabric 1.19.2”Uses:
BlockEntityType.Builder.ofRegistry.BLOCK_ENTITY_TYPEBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override public RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER, TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER, pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag) { super.saveAdditional(tag); tag.putInt("ticks", ticks); }
@Override public void load(CompoundTag tag) { super.load(tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.Registry;import net.minecraft.world.level.block.entity.BlockEntityType;
public final class ModBlockEntities { public static final BlockEntityType<TickCounterBlockEntity> TICK_COUNTER = Registry.register(Registry.BLOCK_ENTITY_TYPE, ExampleMod.id("tick_counter"), BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER).build(null));
private ModBlockEntities() { }
// Called from ExampleMod#onInitialize after ModBlocks; loading this class registers the block entity types above. public static void register() { }}In your main mod class, inside onInitialize:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
Fabric 1.18 to 1.19.1
Section titled “Fabric 1.18 to 1.19.1”Uses:
BlockEntityType.Builder.ofRegistry.BLOCK_ENTITY_TYPEBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.BlockEntityTicker;import net.minecraft.world.level.block.entity.BlockEntityType;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks on the server (getTicker).public class TickCounterBlock extends BaseEntityBlock { public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override public RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) { return new TickCounterBlockEntity(pos, state); }
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state, BlockEntityType<T> type) { return level.isClientSide() ? null : createTickerHelper(type, ModBlockEntities.TICK_COUNTER, TickCounterBlockEntity::tick); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.core.BlockPos;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.Level;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity { private int ticks;
public TickCounterBlockEntity(BlockPos pos, BlockState state) { super(ModBlockEntities.TICK_COUNTER, pos, state); }
// Called every server tick through the block's getTicker. public static void tick(Level level, BlockPos pos, BlockState state, TickCounterBlockEntity entity) { entity.ticks++; if (entity.ticks % 20 == 0) { entity.setChanged(); } }
public int ticks() { return ticks; }
@Override protected void saveAdditional(CompoundTag tag) { super.saveAdditional(tag); tag.putInt("ticks", ticks); }
@Override public void load(CompoundTag tag) { super.load(tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.fabricmc.fabric.api.object.builder.v1.block.entity.FabricBlockEntityTypeBuilder;import net.minecraft.core.Registry;import net.minecraft.world.level.block.entity.BlockEntityType;
public final class ModBlockEntities { public static final BlockEntityType<TickCounterBlockEntity> TICK_COUNTER = Registry.register(Registry.BLOCK_ENTITY_TYPE, ExampleMod.id("tick_counter"), FabricBlockEntityTypeBuilder.create(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER).build());
private ModBlockEntities() { }
// Called from ExampleMod#onInitialize after ModBlocks; loading this class registers the block entity types above. public static void register() { }}In your main mod class, inside onInitialize:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
Forge 1.16.5
Section titled “Forge 1.16.5”Uses:
ITickableTileEntity.tickTileEntity.saveTileEntity.loadDeferredRegister.createForgeRegistries.TILE_ENTITIES
In 1.16.5 the tile entity implements ITickableTileEntity and its tick() method runs every tick; the block makes it in createTileEntity, so there is no BaseEntityBlock or getTicker.
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import net.minecraft.block.AbstractBlock;import net.minecraft.block.Block;import net.minecraft.block.BlockState;import net.minecraft.tileentity.TileEntity;import net.minecraft.world.IBlockReader;
// Tick Counter: a block with a tile entity, TickCounterBlockEntity, that ticks on the server (it implements ITickableTileEntity).public class TickCounterBlock extends Block { public TickCounterBlock(AbstractBlock.Properties properties) { super(properties); }
// 1.16.5: a block with a tile entity says so and creates it here. @Override public boolean hasTileEntity(BlockState state) { return true; }
@Override public TileEntity createTileEntity(BlockState state, IBlockReader world) { return new TickCounterBlockEntity(); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.block.BlockState;import net.minecraft.nbt.CompoundNBT;import net.minecraft.tileentity.ITickableTileEntity;import net.minecraft.tileentity.TileEntity;
// The tile entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends TileEntity implements ITickableTileEntity { private int ticks;
public TickCounterBlockEntity() { super(ModBlockEntities.TICK_COUNTER.get()); }
// Called every tick, in the client and on the server: the game changes only on the server. @Override public void tick() { if (level == null || level.isClientSide()) { return; } ticks++; if (ticks % 20 == 0) { setChanged(); } }
public int ticks() { return ticks; }
@Override public CompoundNBT save(CompoundNBT tag) { super.save(tag); tag.putInt("ticks", ticks); return tag; }
@Override public void load(BlockState state, CompoundNBT tag) { super.load(state, tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.tileentity.TileEntityType;import net.minecraftforge.fml.RegistryObject;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;
public final class ModBlockEntities { public static final DeferredRegister<TileEntityType<?>> BLOCK_ENTITY_TYPES = DeferredRegister.create(ForgeRegistries.TILE_ENTITIES, ExampleMod.MOD_ID);
public static final RegistryObject<TileEntityType<TickCounterBlockEntity>> TICK_COUNTER = BLOCK_ENTITY_TYPES.register("tick_counter", () -> TileEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER.get()).build(null));
private ModBlockEntities() { }
// Called from the ExampleMod constructor: puts the tile entity types on the mod event bus. public static void register() { BLOCK_ENTITY_TYPES.register(FMLJavaModLoadingContext.get().getModEventBus()); }}In your main mod class, inside <init>:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
Fabric 1.16.5
Section titled “Fabric 1.16.5”Uses:
BlockEntityType.Builder.ofRegistry.BLOCK_ENTITY_TYPEBaseEntityBlock.createTickerHelperEntityBlock.getTickerBlockEntity.saveAdditional
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import net.minecraft.world.level.BlockGetter;import net.minecraft.world.level.block.BaseEntityBlock;import net.minecraft.world.level.block.RenderShape;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.state.BlockBehaviour;import net.minecraft.world.level.block.state.BlockState;
// Tick Counter: a block with a block entity, TickCounterBlockEntity, that ticks (TickableBlockEntity).public class TickCounterBlock extends BaseEntityBlock { public TickCounterBlock(BlockBehaviour.Properties properties) { super(properties); }
// BaseEntityBlock draws nothing unless told: draw the block's model. @Override public RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockGetter level) { return new TickCounterBlockEntity(); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import com.example.examplemod.registry.ModBlockEntities;import net.minecraft.nbt.CompoundTag;import net.minecraft.world.level.block.entity.BlockEntity;import net.minecraft.world.level.block.entity.TickableBlockEntity;import net.minecraft.world.level.block.state.BlockState;
// The block entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends BlockEntity implements TickableBlockEntity { private int ticks;
public TickCounterBlockEntity() { super(ModBlockEntities.TICK_COUNTER); }
// Called every tick, on the server and in the client, by the world. @Override public void tick() { if (level == null || level.isClientSide()) { return; } ticks++; if (ticks % 20 == 0) { setChanged(); } }
public int ticks() { return ticks; }
@Override public CompoundTag save(CompoundTag tag) { super.save(tag); tag.putInt("ticks", ticks); return tag; }
@Override public void load(BlockState state, CompoundTag tag) { super.load(state, tag); ticks = tag.getInt("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.core.Registry;import net.minecraft.world.level.block.entity.BlockEntityType;
public final class ModBlockEntities { public static final BlockEntityType<TickCounterBlockEntity> TICK_COUNTER = Registry.register(Registry.BLOCK_ENTITY_TYPE, ExampleMod.id("tick_counter"), BlockEntityType.Builder.of(TickCounterBlockEntity::new, ModBlocks.TICK_COUNTER).build(null));
private ModBlockEntities() { }
// Called from ExampleMod#onInitialize after ModBlocks; loading this class registers the block entity types above. public static void register() { }}In your main mod class, inside onInitialize:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
Forge 1.12.2
Section titled “Forge 1.12.2”Uses:
ITickable.updateTileEntity.writeToNBTTileEntity.readFromNBTGameRegistry.registerTileEntity
In 1.12.2 the tile entity implements ITickable and its update() method runs every tick; it saves with writeToNBT and readFromNBT and is registered with GameRegistry.registerTileEntity.
src/main/java/com/example/examplemod/block/TickCounterBlock.java
package com.example.examplemod.block;
import net.minecraft.block.Block;import net.minecraft.block.material.Material;import net.minecraft.block.state.IBlockState;import net.minecraft.tileentity.TileEntity;import net.minecraft.world.World;
// Tick Counter: a block with a tile entity, TickCounterBlockEntity, that ticks (it implements ITickable).public class TickCounterBlock extends Block { public TickCounterBlock() { super(Material.ROCK); }
// 1.12.2: a block with a tile entity says so and creates it here. @Override public boolean hasTileEntity(IBlockState state) { return true; }
@Override public TileEntity createTileEntity(World world, IBlockState state) { return new TickCounterBlockEntity(); }}src/main/java/com/example/examplemod/block/TickCounterBlockEntity.java
package com.example.examplemod.block;
import net.minecraft.nbt.NBTTagCompound;import net.minecraft.tileentity.TileEntity;import net.minecraft.util.ITickable;
// The tile entity of Tick Counter: it counts the ticks it has been in the world and keeps the count when the world is saved.public class TickCounterBlockEntity extends TileEntity implements ITickable { private int ticks;
// Called every tick, in the client and on the server: the game changes only on the server. @Override public void update() { if (world == null || world.isRemote) { return; } ticks++; if (ticks % 20 == 0) { markDirty(); } }
public int ticks() { return ticks; }
@Override public NBTTagCompound writeToNBT(NBTTagCompound tag) { super.writeToNBT(tag); tag.setInteger("ticks", ticks); return tag; }
@Override public void readFromNBT(NBTTagCompound tag) { super.readFromNBT(tag); ticks = tag.getInteger("ticks"); }}src/main/java/com/example/examplemod/registry/ModBlockEntities.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.block.TickCounterBlockEntity;import net.minecraft.util.ResourceLocation;import net.minecraftforge.fml.common.registry.GameRegistry;
public final class ModBlockEntities { private ModBlockEntities() { }
// Called from preInit: a 1.12.2 tile entity is registered by its class and a name. public static void register() { GameRegistry.registerTileEntity(TickCounterBlockEntity.class, new ResourceLocation(ExampleMod.MOD_ID, "tick_counter")); }}In your main mod class, inside preInit:
ModBlockEntities.register();It’s registered like any other block, as TickCounterBlock: see a new block.
Sources
Section titled “Sources”- https://docs.fabricmc.net/1.21.1/develop/blocks/block-entities
- https://docs.neoforged.net/docs/1.21.1/blockentities/
Related how-tos
Section titled “Related how-tos”- A recipe type of your own
- A block that holds an item
- A block that does something when clicked
- A block that gives off particles
- A mob with attributes and a spawn egg
In Linen
Section titled “In Linen”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.