Lodestone

模组

· 作者 Jaxydog

用于 Fabric 模组的自动内容加载器。

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

最新 1.8.0 · 1.21.8 · Fabric

一键开服(送7天)

一个用于 Fabric 模组的自动内容加载器。

用法

若要直接使用 Lodestone, 请确保你 将其作为模组的依赖项。 本模组本身不添加任何内容。

Lodestone 提供了基本的接口和 API, 以便在初始化期间轻松注册模组内容。 其中最重要的类型是 Loaded 接口, 整个模组都是围绕它构建的。 有关基本示例,请参阅 Cheese 模组。

要创建自动注册的类型, 只需实现目标环境的相关接口即可。

/** 在运行时加载的物品。 */
public class LoadedItem extends Item implements CommonLoaded {

    // `Loaded` 的所有实例都需要此方法。允许 Lodestone 按模组标识符对已注册的值进行分组。
    @Override
    public Identifier getLoaderId() {
        return Identifier.of(YourMod.MOD_ID, "your_item");
    }

    // 在运行时注册该值的函数。
    @Override
    public void loadCommon() {
        Registry.register(Registries.ITEM, this.getLoaderId(), this);
    }

}

每个模组环境都有其专用的接口:

  • CommonLoaded 在“通用”环境中加载值,即同时在客户端 和 服务器上加载。
  • ClientLoaded 仅 在客户端实例上加载值。
  • ServerLoaded 仅 在服务端实例上加载值。
  • DataGenerating 仅 在 Fabric 的数据生成任务期间加载值。

这些接口旨在在各模组的初始化程序中使用,以正确加载内容。

public class YourMod implements ModInitializer {

    public static final String MOD_ID = "your_mod";
    public static final LoadedItem YOUR_ITEM = new LoadedItem(new Settings());

    @Override
    public void onInitialize() {
        // 注册此物品以供后续加载。
        Lodestone.register(CommonLoaded.class, YOUR_ITEM);

        // 然后在下面执行加载操作。
        Lodestone.load(CommonLoaded.class, MOD_ID);
    }

}

Lodestone 还提供了一个抽象类和两个注解,用于值的自动注册。

public final class ItemLoader extends AutoLoader {

    @LoadingPriority(-1) // 控制加载顺序。在这种情况下,此项最后加载。
    public static final LoadedItem ITEM_1 = new LoadedItem("item_1", new Settings());
    public static final LoadedItem ITEM_2 = new LoadedItem("item_2", new Settings());
    public static final LoadedItem ITEM_3 = new LoadedItem("item_3", new Settings());
    public static final LoadedItem ITEM_4 = new LoadedItem("item_4", new Settings());
    public static final LoadedItem ITEM_5 = new LoadedItem("item_5", new Settings());

    @IgnoreLoading({ }) // 阻止此值被加载。
    public static final LoadedItem NULL = null;

    @Override
    public Identifier getLoaderId() {
        return Identifier.of(YourMod.MOD_ID, "items");
    }

}

其注册方式非常相似。

public class YourMod implements ModInitializer {

    public static final String MOD_ID = "your_mod";
    public static final ItemLoader ITEMS = new ItemLoader();

    @Override
    public void onInitialize() {
        // 注册所有物品以供后续加载。
        ITEMS.register();

        // 然后在下面执行加载操作。
        Lodestone.load(CommonLoaded.class, MOD_ID);
    }

}

依赖 Lodestone

Lodestone 的唯一用途是作为其他模组的库使用。 如果你想让你的 Fabric 模组依赖 Lodestone, 请在你的 Gradle 清单中添加以下内容:

# gradle.properties

lodestone_version = 1.8.0
// build.gradle

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    modImplementation "com.github.Jaxydog:Lodestone:${project.lodestone_version}"

    // 或者,选择性地依赖最新的提交版本:
    modImplementation 'com.github.Jaxydog:Lodestone:main-SNAPSHOT'
}

Lodestone 应该 能兼容许多较旧版本的 Minecraft, 但只有最新版本的游戏能保证获得适当的支持。 我目前不打算向后移植到大约 1.18 之前的版本, 但如果你遇到任何问题,欢迎随时告知我。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源