注册员

注册员

SkyNotTheLimit的注册助手

基础库

Registrar

一个用于 Minecraft 模组开发的注册表辅助工具

将 Registrar 添加到你的项目

Modrinth Maven

如果你的 repositories 块中没有 Modrinth maven,请按如下方式添加:

build.gradle:

maven {
    url("https://api.modrinth.com/maven")
    content {
        includeGroupAndSubgroups("maven.modrinth")
    }
}

或 build.gradle.kts:

maven("https://api.modrinth.com/maven") {
    content {
        includeGroupAndSubgroups("maven.modrinth")
    }
}

然后,将此项目添加到你的依赖项中。

如果你使用的是去混淆的 Minecraft:

api("maven.modrinth:registrar:${project.registrar_version}") // 或 implementation
include("maven.modrinth:registrar:${project.registrar_version}")

如果你使用的是混淆的 Minecraft:

modApi("maven.modrinth:registrar:${project.registrar_version}") // 或 modImplementation
include("maven.modrinth:registrar:${project.registrar_version}")
mavenLocal

首先,fork 或下载此仓库并将其发布到你的 mavenLocal。

然后,将以下内容添加到你的 repositories 块中:

mavenLocal()

然后,将此项目添加到你的依赖项中。

如果你使用的是去混淆的 Minecraft:

api("survivalblock.atmosphere:registrar:${project.registrar_version}") // 或 implementation
include("survivalblock.atmosphere:registrar:${project.registrar_version}")

如果你使用的是混淆的 Minecraft:

modApi("survivalblock.atmosphere:registrar:${project.registrar_version}") // 或 modImplementation
include("survivalblock.atmosphere:registrar:${project.registrar_version}")

普通注册器

首先,创建你所需类型的 Registrant 实例,如下所示:

private static final BlockRegistrant BLOCK_REGISTRANT = new BlockRegistrant(ExampleMod.MOD_ID);

如果所需类型的注册器不存在,你可以创建一个!

private static final Registrant RECIPE_SERIALIZER_REGISTRANT = new Registrant(ExampleMod.MOD_ID, BuiltinRegistries.RECIPE_SERIALIZER);

如果你需要添加其他常用注册器,欢迎提交 issue 通知我。

要注册一个对象,只需调用 Registrant#register。

REGISTRANT.register("name", THING);

请注意,某些注册器类有特殊的注册方法。 例如,ItemRegistrant 有一个接受三个参数的注册方法。

ITEM_REGISTRANT.register("name", Item::new, new Item.Properties());

ItemRegistrant 还能通过单独的 register 重载来注册 BlockItem。 更多信息请参阅文档。

延迟注册器

所有普通注册器都有一个延迟版本,可在 delayed 包中找到。

延迟注册器与普通注册器完全相同,只有一个例外: 必须调用 DelayedRegistrant#consumeAll 才能真正注册对象。

public static void init() {
  REGISTRANT.consumeAll();
}

动态注册器

动态注册器是用于动态注册表的注册器。 目前,基础库中仅存在 DamageType 和 Enchantment 的注册器。 请参阅这些链接以获取注册伤害类型和附魔的示例。

要为数据生成添加注册器,请在你的模组的 DataGeneratorEntrypoint 中重写 buildRegistry,如下所示:

@Override
public void buildRegistry(RegistrySetBuilder registryBuilder) {
    DYNAMIC_REGISTRANT.bootstrap(registryBuilder);
}

其中 bootstrap 是 registryBuilder.addRegistry(REGISTRY_KEY, DYNAMIC_REGISTRANT::bootstrap); 的简写。

特殊注册器

特殊注册器是没有底层 Registry 的注册器。它们可能扩展 Registrant,也可能不扩展。(请注意,1.21.11 之前的 GameRuleRegistrant 技术上属于特殊注册器。)

目前,这仅包括 AttachmentTypeRegistrant。

文档

Registrar 提供了一些 javadoc,但如果你不想下载源码 jar 以避免我的多版本注释,请阅读此内容。

附件类型

AttachmentTypeRegistrant 包含使用构建器注册或使用方法参数注册的重载。

方块实体类型

BlockEntityTypeRegistrant 和 DelayedBlockEntityTypeRegistrant 实现了 IBlockEntityTypeRegistrant, 根据版本不同可以注册 BlockEntityType.Builder/FabricBlockEntityTypeBuilder。它 还可以接受方块实体的构造函数(作为 lambda)以及 Block 可变参数来构造 BlockEntityType。

方块

BlockRegistrant 和 DelayedBlockRegistrant 实现了 IBlockRegistrant,可以根据构造函数及其 BlockBehaviour$Properties 注册 Block。请注意,BlockBehaviour$Properties#setId 会为你调用。

根据类型,还可以创建并获取 ItemRegistrant 或 DelayedItemRegistrant。

registerAndPresent 返回一个 BlockPresenter,其中包含 Block 及其 ResourceKey(以及在支持的版本中的 BlockItemId)。用 ConstructItem 注解 BlockPresenter 将尝试 根据本文档 Items 部分列出的规则进行物品注册。请注意, IItemRegistrant#registerFromAnnotations 会忽略 BlockPresenter 字段。

ConstructBlock 注解可用于 Block 或 BlockPresenter 字段,以允许在无需为名称指定 String 的情况下注册方块。 将其应用于类将为所有字段解锁此行为。

在 26.2 中,可以使用 createId 方法来创建 BlockItemId。

游戏规则

由于 1.21.11 之前不存在 BuiltinRegistries.GAME_RULE,因此在那些版本中 GameRuleRegistrant 的 registry 为 null。在那些版本中,注册通过 Fabric API 的 GameRuleRegistry 完成,它不是真正的 Registry。

由于上述原因,1.21.11 之前不存在 DelayedGameRuleRegistrant。

GameRuleRegistrant 和 DelayedGameRuleRegistrant 都实现了 IGameRuleRegistrant,其中包含 根据版本注册 GameRules$Key/GameRule 的方法。存在注册布尔规则的重载,但由于 1.21.11 之前构造规则的方式差异较大,这些重载并不详尽。 建议根据需要编写自己的辅助方法。

IGameRuleRegistrant 还包含从 GameRules 获取值的少量多版本工具。这些 也可以在实际的注册器中找到,它们会为某些规则执行拆箱操作。

物品

ItemRegistrant 和 DelayedItemRegistrant 实现了 IItemRegistrant(有趣的双 I),可以根据构造函数及其 Item$Properties 注册 Item。请注意,Item$Properties#setId 会为你调用。

这两个 IItemRegistrant 还能通过其他注册重载注册 BlockItem。此外,还支持通过 ConstructItem 注解对 BlockItem 进行 反射注册。这需要调用 IItemRegistrant#registerFromAnnotations,它返回一个从 Block 到已注册 Item 的映射。类参数决定检查哪个类的字段,而 tryAllByDefault 将告诉注册器即使没有注解也构造物品。

在 ConstructItem 中将 useBlockTranslation 设置为 true 将调用 Item$Properties 上的 useBlockDescriptionPrefix。这在 1.21.1 中不是必需的,因为它由 BlockItem#getDescriptionId 决定。

你还可以使用 exclude = true 将物品排除在自动注册之外。当 BlockItem 的构造函数中除了 Block block, Item.Properties properties 之外还有更多参数(如告示牌和旗帜)而需要手动注册时,这很有用,因为反射注册不支持这些情况。 对于具有这些参数构造函数的类,你可以使用 constructor = CustomBlockItem.class 指定类。

ConstructItem 必须注解在 public static 的 Block 或 BlockItemId 字段上。请注意,在 26.2 之后以这种方式注解 Block 字段已被弃用,除非你在注解中 设置 suppressIdWarnings = true,否则会导致日志中大量警告。