Differences

This shows you the differences between two versions of the page.

--- zh_cn:tutorial:blockentity [2022/05/26 09:24] – Add a prompt to actively trigger BlockEntity synchronization moheng
+++ zh_cn:tutorial:blockentity [2025/04/01 12:20] (current) – [方块实体刻] solidblock
@@ Line 1: / Line 1: @@
-====== 添加一个方块实体 ======
+====== 添加方块实体 ======
 ===== 介绍 =====
+**方块实体**主要用于在方块内存储数据。创建之前，您需要一个[[blocks|方块]]。本教程将介绍 BlockEntity 类的创建及其注册。
-BlockEntity主要用于在方块内存储数据。创建之前，您需要一个[[zh_cn:tutorial:blocks|方块]]。本教程将介绍BlockEntity类的创建及其注册。
+===== 创建方块实体 =====
-===== 创建一个方块实体 =====
+最简单的方块实体仅继承 ''BlockEntity''，并使用默认构造函数。这是完全有效的，但不会给予方块任何特殊功能。
-最简单的方块实体仅继承''BlockEntity''，并使用默认构造函数。 这是完全有效的，但不会给予方块任何特殊功能。
+<code java DemoBlockEntity.java>
-<code java>
 public class DemoBlockEntity extends BlockEntity {
     public DemoBlockEntity(BlockPos pos, BlockState state) {
-        super(ExampleMod.DEMO_BLOCK_ENTITY, pos, state);
+        super(TutorialBlockEntityTypes.DEMO_BLOCK, pos, state);
     }
 }
 </code>
-下面将向您展示如何创建''ExampleMod.DEMO_BLOCK_ENTITY''字段。
+请确保这个构造方法只接收这两个参数，否则我们后面写的方法引用 ''DemoBlockEntity::new'' 将会无效。这个 ''TutorialBlockEntityTypes.DEMO_BLOCK'' 字段稍后再写。
-您可以简单地向此准系统类添加变量，或实现诸如''Tickable''和''Inventory''之类的接口以添加更多功能。''Tickable''提供了一个单独的''tick()''方法，该方法将会在世界加载的每一刻调用一次。而''Inventory''则允许您的BlockEntity与自动化进行交互，例如漏斗——稍后可能会有专门针对此接口的单独教程。
+方块实体支持一系列方法以支持一些功能，例如与 NBT 之间的序列化和反序列化、提供物品栏等。本教程提供方块实体功能的最常见一些实现。
-===== 注册你的方块实体 =====
+===== 注册方块和方块实体 =====
-一旦创建了''BlockEntity''类，您将需要对其进行注册以使其起作用。 此过程的第一步是创建一个''BlockEntityType''，它将''Block''和''BlockEntity''链接在一起。 假设您的''Block''已创建并保存到本地变量''DEMO_BLOCK''，则将在下面的行中创建匹配的''BlockEntityType''。在本教程中，方块实体的ID是''tutorial:demo_block_entity''。
+一旦创建了 ''BlockEntity'' 类，就需要注册它才起作用。这个过程的第一步是在我们的 ''TutorialBlockEntities'' 类中创建 ''BlockEntityType'' 对象，将 ''Block'' 和 ''BlockEntity'' 连接在一起。创建 ''Block'' 并保存到 ''TutorialBlocks'' 类的静态常量字段 ''DEMO_BLOCK'' 中。在本教程中，方块实体的 ID 是 ''tutorial:demo_block''。
-''BlockEntityType''应在您的''onInitialize''方法中注册，以确保它在正确的时候被注册。
+''BlockEntityType'' 应在类的初始化或 ''onInitialize'' 方法中注册，以确保在正确的时候注册。在这个例子中，我们在单独的类中注册（见 [[blocks]]）
-<code java>
+<code java TutorialBlocks.java>
-public static BlockEntityType<DemoBlockEntity> DEMO_BLOCK_ENTITY;
+public final class TutorialBlocks {
+    [...]
-@Override
-public void onInitialize() {
+    // 对于 1.21.2 之前的版本
-    DEMO_BLOCK_ENTITY = Registry.register(Registry.BLOCK_ENTITY_TYPE, "tutorial:demo_block_entity", FabricBlockEntityTypeBuilder.create(DemoBlockEntity::new, DEMO_BLOCK).build(null));
+    // public static final DemoBlock DEMO_BLOCK = register("demo_block", new DemoBlock(AbstractBlock.Settings.create()));
+    // 对于 1.21.2 及之后的版本
+    public static final DemoBlock DEMO_BLOCK = register("demo_block", DemoBlock::new, AbstractBlock.Settings.create());
+    [...]
 }
 </code>
-==== 将方块实体连接到方块 ====
+<code java TutorialBlockEntityTypes.java>
+public class TutorialBlockEntityTypes {
+  public static <T extends BlockEntityType<?>> T register(String path, T blockEntityType) {
+    return Registry.register(Registries.BLOCK_ENTITY_TYPE, Identifier.of("tutorial", path), blockEntityType);
+  }
-一旦创建并注册了''BlockEntityType''，就可以在''Block''类中简单地实现''BlockEntityProvider''。每次放置方块，就会产生对应的方块实体。
+  public static final BlockEntityType<DemoBlockEntity> DEMO_BLOCK = register(
+      "demo_block",
+      // 对于 1.21.2 之前的版本，请使用 BlockEntityType.Builder。
+      FabricBlockEntityTypeBuilder.create(DemoBlockEntity::new, TutorialBlocks.DEMO_BLOCK).build()
+  );
+  public static void initialize() {
+  }
+}
-<code java>
+</code>
-public class DemoBlock extends Block implements BlockEntityProvider {
+记得要在 ''ModInitializer'' 里面引用 ''initialize'' 方法：
+<code java ExampleMod.java>
+public class ExampleMod implements ModInitializer {
     [...]
     @Override
-    public BlockEntity createBlockEntity(BlockPos pos, BlockState state) {
+    public void onInitialize() {
-        return new DemoBlockEntity(pos, state);
+        [...]
+        TutorialBlockEntityTypes.initialize();
     }
 }
 </code>
-===== 序列化数据 =====
+对于旧版本，如果无法访问 ''BlockEntityType.Builder.create''，尝试 ''FabricBlockEntityTypeBuilder.create''。
-如果要将任何数据存储在 ''BlockEntity'' 中，则需要保存并加载，或者仅在加载 ''BlockEntity'' 时保留，并且只要您返回到它。幸运的是，保存和加载非常简单——只需要覆盖 ''writeNbt()'' 和 ''readNbt()'' 即可。
+这个方块实体类型定义了只有 ''TutorialBlocks.DEMO_BLOCK'' 可以拥有这个方块实体类型。如果你想要让方块实体类型支持更多方块，只需要将其添加到 ''FabricBlockEntityTypeBuilder.create'' 的参数中即可。如果方法引用 ''DemoBlockEntity::new'' 无法解析，检查 ''DemoBlockEntity'' 的构造方法的参数是否正确。
-''writeNbt()'' 返回一个 ''NBTCompound''，其中应包含 ''BlockEntity'' 中的所有数据。如果您需要将 ''BlockEntity'' 数据与客户端同步，则此数据将保存到磁盘并通过数据包发送。调用 ''writeNbt'' 的默认实现非常重要，因为它将“标识数据（Identifying data）''（位置和ID）''保存到标签中。否则，您尝试保存的所有其他数据都将丢失，因为它与位置和 ''BlockEntityType'' 不相关。知道了这一点，下面的示例演示了如何将 ''BlockEntity'' 中的整数保存到标签中。在此示例中，整数保存在键 ''number'' 下——您可以将其替换为任何字符串，但是标签中的每个键只能有一个条目（entry），并且需要记住该键以便以后检索数据。
+> **注意：**和其他方块一样，这个方块也需要方块模型和物品模型，可能也需要战利品表，关于如何创建请参见 [[blocks]]。对于战利品表，有[[blockentity_sync_itemstac|后续教程]]会提到如何改进战利品表表以包含方块实体数据。
-<code java>
+==== 将方块实体连接到方块 ====
-public class DemoBlockEntity extends BlockEntity {
-    // 储存数字的当前值
+一旦创建并注册了 ''BlockEntityType''，就需要与之关联的方块。你可以继承 ''BlockWithEntity''，或者简单地实现 ''BlockEntityProvider'' 并覆盖 ''createBlockEntity''。每次放置方块，就会产生对应的方块实体。
-    private int number = 7;
+<code java DemoBlock.java>
-    public DemoBlockEntity(BlockPos pos, BlockState state) {
+public class DemoBlock extends BlockWithEntity {
-        super(ExampleMod.DEMO_BLOCK_ENTITY, pos, state);
+    public DemoBlock(Settings settings) {
+        super(settings);
     }
-    // 序列化方块实体
     @Override
-    public voidwriteNbt(NbtCompound tag) {
+    protected MapCodec<? extends DemoBlock> getCodec() {
-        writeNbt(tag);
+        return createCodec(DemoBlock::new);
+    }
-        // Save the current value of the number to the tag
+    @Override
-        tag.putInt("number", number);
+    public BlockEntity createBlockEntity(BlockPos pos, BlockState state) {
+        return new DemoBlockEntity(pos, state);
     }
-}
-</code>
-为了以后检索数据，您还需要覆盖 ''readNBT''。 此方法与 ''writeNBT'' 相反——不会将数据保存到 ''NBTCompound''，而是您已经有了之前保存的标签，使您可以检索所需的任何数据。与 ''writeNbt'' 一样，必须调用 ''super.readNbt''，并且您将需要使用相同的键来检索保存的数据。要检索我们之前保存的数字，请参见下面的示例。
+    @Override
+    protected BlockRenderType getRenderType(BlockState state) {
-<code java>
+        return BlockRenderType.MODEL;
-// 取消序列化方块实体
+    }
-@Override
-public void readNbt(NbtCompound tag) {
-    super.readNbt(tag);
-    number = tag.getInt("number");
 }
 </code>
-一旦实现了 ''writeNbt'' 和 ''readNbt'' 方法，您只需要确保在合适的时候调用即可。每当您的 ''BlockEntity'' 数据发生更改并需要保存时，请调用 ''markDirty()''。这会将方块所在的区块标记为dirty，在世界下次保存时强制调用 ''writeNbt'' 方法。原则上，只要改变了 ''BlockEntity'' 类中的任何一个自定义变量，就只需要简单调用 ''markDirty''。
+覆盖''getRenderType'' 为因为 ''BlockWithEntity'' 会默认让它不可见。
-===== 将服务器数据同步至客户端 =====
-数据通常是在服务器世界读取的。有时候你需要将所有或者部分数据同步到客户端，比如用于渲染。
-对于 1.17.1 及以下版本，请实现 Fabric API 中的''BlockEntityClientSerializable''。此接口提供了 ''fromClientTag'' 和 ''toClientTag'' 方法，其作用与前面讨论的 ''readNbt'' 和 ''writeNbt'' 方法基本相同，只是专门用于发送和接收客户端上的数据。你可以简单地在 ''fromClientTag'' 和 ''toClientTag'' 两个方法中调用 ''readNbt'' 和 ''writeNbt''。
-对于 1.18 及以上版本，请覆盖 ''toUpdatePacket'' 和 ''toInitialChunkDataNbt''：
-<code java>
-  @Nullable
-  @Override
-  public Packet<ClientPlayPacketListener> toUpdatePacket() {
-    return BlockEntityUpdateS2CPacket.create(this);
-  }
-  @Override
-  public NbtCompound toInitialChunkDataNbt() {
-    return createNbt();
-  }
-</code>
-**警告**: 需要调用''world.updateListeners(pos, state, state, Block.NOTIFY_LISTENERS);''来触发数据的同步。
 ===== 方块实体刻 =====
-.17 添加了静态的刻，然后你就可以实现 ''Tickable'' 接口。对于需要计划刻的方块，你只需要使用 ''Block'' 中的 ''getTicker''，链接回到 ''Block Entity''。参考下面关于刻的一个常见的实现。
+刻是指方块在每一刻（每 1/20 秒）运行些什么。要让方块有刻，通常需要使用 ''Block'' 中的 ''getTicker''，链接回到 ''BlockEntity'' 中的静态方法 ''tick''。参考下面关于刻的常见的实现。
 在你的 ''Block'' 类中：
-<code java>
+<code java DemoBlock.java>
 public class DemoBlock extends BlockWithEntity {
     [...]
-    @Override
-    public BlockRenderType getRenderType(BlockState state) {
-        // 由于继承了BlockWithEntity，这个默认为INVISIBLE，所以我们需要更改它！
-        return BlockRenderType.MODEL;
-    }
     @Override
     public <T extends BlockEntity> BlockEntityTicker<T> getTicker(World world, BlockState state, BlockEntityType<T> type) {
-        return checkType(type, ExampleMod.DEMO_BLOCK_ENTITY, (world1, pos, state1, be) -> DemoBlockEntity.tick(world1, pos, state1, be));
+        // 如果只需要在服务器上有刻，确保检查 world.isClient
+        return validateTicker(type, ExampleMod.DEMO_BLOCK_ENTITY, DemoBlockEntity::tick);
     }
 </code>
-在你的 ''Block Entity'' 中：
-<code java>
+在你的 ''BlockEntity'' 类中：
-public class DemoBlockEntity extends BlockEntity {
+<code java DemoBlockEntity.java>
-    public DemoBlockEntity(BlockPos pos, BlockState state) {
+public class DemoBlockEntity extends BlockEntity implements BlockEntityTicker<DemoBlockEntity> {
-        super(ExampleMod.DEMO_BLOCK_ENTITY, pos, state);
+    [...]
-    }
-    public static void tick(World world, BlockPos pos, BlockState state, DemoBlockEntity be) {
+    @Override
+    public static void tick(World world, BlockPos pos, BlockState state, DemoBlockEntity blockEntity) {
         [...]
     }
@@ Line 140: / Line 135: @@
 </code>
-===== 概览 =====
+===== 下一步 =====
+现在，您应该拥有自己的 ''BlockEntity''，可以以各种方式扩展以适应您的需求。注册了 ''BlockEntityType''，并用它来将 ''Block'' 和 ''BlockEntity'' 类连接在一起。然后，继承了 ''BlockWithEntity'' 并使用了接口 ''BlockEntityProvider'' 以提供 ''BlockEntity'' 的新实例。
-现在，您应该拥有自己的 ''BlockEntity''，可以以各种方式扩展以适应您的需求。 您注册了 ''BlockEntityType''，并用它来将 ''Block'' 和 ''BlockEntity'' 类连接在一起。 然后，您在 ''Block'' 类中实现了 ''BlockEntityProvider''，并使用该接口提供了新 ''BlockEntity'' 的实例。 最后，您学习了如何将数据保存到 ''BlockEntity'' 中，以及如何检索以备后用。
+你也学习了如何为它添加课刻。下一步，可以尝试对方块实体进行一些复杂的操作，例如：
+  * [[blockentity_modify_data|修改方块实体数据]]
+  * [[inventory|作为物品栏在方块实体存储物品]]
+  * [[blockentityrenderers|使用方块实体渲染器动态渲染]]
+  * [[screenhandler|创建容器方块]]