Unified API

Unified API

一个多加载器API,旨在简化跨加载器模组开发

统一API

统一API是一个适用于Fabric和NeoForge的跨加载器API,让您无需额外努力即可创建多加载器模组。

这是通过统一API的自定义注册表、事件和辅助方法实现的,它们取代了对特定平台代码的需求,转而使用统一API提供的通用友好、文档完善的替代方案。

统一API没有依赖项——在Fabric上只需Fabric API,在NeoForge上只需基础NeoForge。

有关全面的文档和设置指南,请查看 unified-api.dev (注:原链接为跳转链接,此处已转换为实际地址)

为什么使用统一API而不是其他API?

  • 延迟注册表允许您为任何原版或模组注册表注册内容
  • 大量易用且文档完善的事件——包括一些非常强大的事件,如战利品表、默认数据组件或生物群系修改事件
  • 辅助方法用于处理任何常见的特定于加载器的代码,通常以扩展功能的方式实现(例如 BLOCK_CONVERSIONS、STRUCTURE_MUSIC 或 CREATIVE_ENTRIES)
  • 数据组件驱动的功能,如熔炉燃料或堆肥组件
  • 在同一Minecraft版本中API没有破坏性更改,并且在完整MC版本之间进行的API更改在迁移指南中有详尽记录 (注:原链接为跳转链接,此处已转换为实际地址)
  • 节省时间的内容构建器,可快速、简单地创建木材套装、工具、盔甲等
  • 持续移植到最新版本,并针对这些版本设计功能

注册表包括:

  • 延迟注册表
  • 物品
  • 方块
  • 实体类型
  • 方块实体类型
  • 创造标签页
  • 数据组件类型
  • 声音事件
  • 按键映射

辅助方法包括:

  • 平台(检查模组 / 模组加载器 / 其他实例信息)
  • 数据包(注册内部数据 / 资源包)
  • 创造条目(将物品插入创造标签页)
  • 网络(注册、发送和处理数据包)
  • 生物群系修改(类似于fabric生物群系API,轻松修改任何生物群系的特征、雕刻器、效果、属性或气候)
  • 方块转换(自定义方块交换行为,如可剥离的原木)
  • 粒子提供器(为客户端创建自定义粒子)
  • 实体渲染器(为自定义实体 / 方块实体模型和纹理设置渲染)
  • 工具提示(将自定义客户端工具提示信息绑定到工具提示,类似于收纳袋)
  • 数据组件(将自定义组件附加到方块 / 物品,如熔炉燃料或堆肥行为,或任何其他组件)
  • 结构音乐(为任何结构注册独特的音乐池)
  • 幼年盔甲(自动调整大小,并可选择重新缩放,使成年盔甲适配幼年生物,无需专用纹理)

事件包括:

  • 默认数据组件(过滤和修改任何物品上的默认组件)
  • 战利品表(向任何战利品表追加新池,或直接编辑现有战利品条目)
  • 命令(创建自定义命令)
  • 玩家(在玩家事件如加入/离开/重生时运行代码)
  • 刻(在客户端刻的开始/结束时运行代码,例如自定义按键绑定代码)
  • 图形界面(追加HUD渲染,如准星和快捷栏渲染)
  • 屏幕(访问 AbstractContainerScreen 以创建自定义鼠标行为)
  • 服务器(在服务器启动/停止/数据包加载/服务器刻/世界刻时运行代码)

组件包括:

  • 熔炉燃料(轻松为任何物品指定自定义熔炉燃料持续时间)
  • 堆肥(使任何物品以给定的浮点概率可堆肥)

构建器包括:

  • 装备套装(工具和盔甲,具有完善的组件和属性修改系统)
  • 木材套装(可自定义、完整木材套装所需的所有方块、物品和实体)
  • 方块套装(这样您就不必单独创建整套石头或砖块)

标签包括:

  • 持久冷却(对标记物品强制实行每个玩家跨世界加载的物品冷却时间)

再次提醒,请务必查看 unified-api.dev (注:原链接为跳转链接,此处已转换为实际地址) 以获取文档和完整功能集。