Registed

模组

· 作者 KrLite

一个为你带来带注释注册表的库!

0 本站下载 0 关注 更新于 3 年前

需要前置:Fabric API

最新 1.0.0-mc1.20 · 1.20.2 · Fabric / Quilt

一键开服(送7天)

Registed

实现

首先,通过 Gradle 实现 Registed:

使用 Groovy
build.gradle
repositories {
	maven { url "https://api.modrinth.com/maven" }
}

dependencies {
	modApi "maven.modrinth:registed:$project.registed_version"
}
gradle.properties
registed_version=?

将 ? 替换为 Registed 的最新 标签名称。

使用 Kotlin
build.gradle.kts
repositories {
	maven("https://api.modrinth.com/maven")
}

dependencies {
	modApi("maven.modrinth:registed:${property("registedVersion")}")
}
gradle.properties
registedVersion=?

将 ? 替换为 Registed 的最新 标签名称。

接下来,在 fabric.mod.json 中将 Registed 引用为依赖项:

fabric.mod.json
{
  // 其他内容

  "depends": {
    "registed": "*"
  },

  // 其他内容
}

Registed 不应嵌套在你的项目中。你应将 Registed 始终视为一个独立的模组。

用法

要注册一个对象,请执行以下操作:

full.path.to.ClassName.java
@RegistryId("modid")
public class ClassName {
	@ho.artisan.registed.annotation.registries.Item
	public static final Item ITEM = ...;
}

你必须使用 @RegistryID^@RegistryID_classpath 注解你的注册类,以告知 Registed 使用哪个命名空间。

之后,记得在 fabric.mod.json 中引用此类:

fabric.mod.json
{
  // 其他内容

  "entrypoints": {
    "registed": [
      "full.path.to.ClassName"
    ]
  },

  // 其他内容
}

Registed 支持 Registries 类^Registries_classpath 中的所有 Registry<?> 类型。你应该将目标注册表类型名称从 UPPER_SNAKE_CASE(全大写蛇形命名法)转换为 CamelCase(驼峰命名法)以找到所需的注解,例如 Registries.LOOT_NBT_PROVIDER_TYPE 对应的注解是 @LootNBTProviderType。

所有可用于注册对象的注解均位于包 ho.artisan.registed.annotation.registries 下。

这些注解只能应用于字段,且你应始终确保你的注册对象是 static 和 final 字段。

默认情况下,注册的 object 将使用其字段名的 snake_case(蛇形命名法)作为其在游戏内的标识符路径,例如字段 MY_EXAMPLE_ITEM 的标识符路径将是 my_example_item。我们建议使用 UPPER_SNAKE_CASE 来命名你的字段,因为它们应该是 static 和 final 的,并且只有在蛇形命名法下,Registed 才会保留下划线。

若要自定义注册对象的游戏内标识符路径,你可以对目标字段应用 @RegistryID^@RegistryID_classpath 注解:

@RegistryID("my_item")
@ho.artisan.registed.annotation.registries.Item
public static final Item ITEM = ...;

@RegistryID[@^RegistryID_classpath] 提供的标识符路径将被直接消耗,不进行任何进一步的处理。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源