食品 API

食品 API

一个面向NeoForge的灵活食物系统API。通过属性添加可配置的饥饿容量和消耗速度,支持多行的动态食物条渲染,以及基于提供者的图标替换系统,以实现无缝的模组集成。

食物

🍖 Food API

一个适用于 NeoForge 的灵活饥饿系统库

MODRINTH GITHUB

📖 关于

Food API 是一个面向开发者的库,它移除了 Minecraft 原版饥饿系统的硬编码限制。它将饥饿容量和消耗速度暴露为实体属性,增加了多行饥饿条渲染,并提供了一个简洁的基于提供者的系统来替换食物图标——所有这些都带有对热门 HUD 模组的可选兼容性。

✨ 特性

▶ 动态饥饿容量 — 最大饥饿值现在是一个属性,支持最多 2 行(40 单位)。

▶ 可配置的消耗速度 — 通过一个倍率属性控制饥饿值消耗的速度。

▶ 多行饥饿条 — 第二行无缝渲染在第一行上方,与原版的抖动动画完全同步。

▶ 图标提供者系统 — 通过简单的注册 API,可以按玩家、按行、按槽位替换任何食物图标(空、半、满、饥饿、覆盖层、饱和)。

▶ 可选的模组兼容 — 原生支持 Overflowing Bars 和 AppleSkin(如果存在)。

🖼️ 截图

原版渲染 — 单行,标准图标



搭配 Overflowing Bars — 行计数器,覆盖图标堆叠在上方

📦 新增属性

Food API 加载时会自动注册两个新的玩家属性:

属性 ID 默认值 范围 描述
Max Hunger food_api:max_hunger 20 1 – 40 最大饥饿容量。20 = 一行,40 = 两行。
Hunger Rate food_api:hunger_rate 1.0 0.0 – 10.0 饥饿消耗速度倍率。0 = 不消耗,2 = 两倍速度。

这两个属性都会同步到客户端,可以通过命令、其他模组或直接在代码中修改:

// 示例:给予玩家双倍饥饿容量
player.getAttribute(AttributeRegistries.MAX_HUNGER)
      .setBaseValue(40);

// 示例:将饥饿消耗减慢到一半速度
player.getAttribute(AttributeRegistries.HUNGER_RATE)
      .setBaseValue(0.5);

🔧 API 用法

替换食物图标

使用 ID 和优先级注册一个提供者。优先级更高者胜出。返回 null 以继续交给下一个提供者处理。

FoodIconRegistry.register(
    ResourceLocation.fromNamespaceAndPath("mymod", "my_provider"),
    10, // 优先级 — 越高越先检查(原版 = 0)
    (player, iconIndex, row, type) -> {
        // iconIndex: 0 = 最右侧图标,9 = 最左侧
        // row: 0 = 底行,1 = 顶行
        return switch (type) {
            case FULL  -> ResourceLocation.fromNamespaceAndPath("mymod", "hud/my_food_full");
            case HALF  -> ResourceLocation.fromNamespaceAndPath("mymod", "hud/my_food_half");
            case EMPTY -> ResourceLocation.fromNamespaceAndPath("mymod", "hud/my_food_empty");
            default    -> null; // 让其他提供者或原版处理其余部分
        };
    }
);

图标类型

类型 描述
EMPTY 背景(空槽位)
HALF 半满图标
FULL 全满图标
EMPTY_HUNGER 饥饿效果期间的背景
HALF_HUNGER 饥饿效果期间的半满图标
FULL_HUNGER 饥饿效果期间的全满图标
HALF_OVERLAY 顶行的半满图标*(仅 Overflowing Bars)*
FULL_OVERLAY 顶行的全满图标*(仅 Overflowing Bars)*
SATURATION 饱和覆盖纹理*(仅 AppleSkin)*

在正确的时机注册

在 FMLClientSetupEvent 期间或更早调用 FoodIconRegistry.register(...):

@SubscribeEvent
public static void onClientSetup(FMLClientSetupEvent event) {
    FoodIconRegistry.register(...);
}

🔗 可选依赖

Food API 可独立运行。以下模组存在时会解锁额外功能:

  • Overflowing Bars — 启用行计数器显示和顶行的覆盖图标渲染
  • AppleSkin — 启用通过 FoodIconType.SATURATION 替换饱和覆盖图标

由 ArimoV2 用 🩷 制作