
InteractAPI
InteractAPI 允许模组和整合包开发者使用沉浸式按键提示。
InteractAPI
一个用于可自定义世界空间交互提示与快速反应事件(QTE)的轻量级库。
InteractAPI 为其他模组提供显示层,可直接在世界中渲染悬浮交互图标、按键提示以及交互式 QTE 序列。
特性
- 附加于方块、实体或任意位置的世界空间交互提示
- 可自定义纹理、缩放、颜色、不透明度以及渲染距离
- 朝向相机的公告板或固定的世界朝向
- 自动为移动中的实体和方块实体进行定位
- 平滑的距离淡出以及可选的满亮度渲染
- 可选的穿墙渲染
- 自定义文本标签与进度指示器
- 当玩家重新绑定按键时自动更新的动态按键图标
- 手柄按键图标与备用输入布局
- 内置提示动画与按键反馈
- 当目标失效或世界卸载时自动清理提示
快速反应事件(QTE)
InteractAPI 还包含一套内置的 QTE 系统,用于创建交互式序列和连按挑战。
- 连按事件(Mash Events) - 在时间耗尽前反复按键以填满进度条。
- 序列事件(Sequence Events) - 在计时器到期前依次按下显示的一系列按键。
- 街机风格(Arcade Style) - 明亮特效、动画、音效以及奖励反馈。
- 恐怖风格(Horror Style) - 暗化视觉效果、心跳效果、画面扭曲以及逐渐增强的反馈。
- 自定义结果(Custom Results) - 获取成功、失败、取消、得分、命中次数以及时序信息。
无障碍
玩家可以通过客户端设置自定义 QTE 难度:
- 按住按键代替反复连按
- 通过时间倍率延长事件持续时间
- 自动完成 QTE
为开发者而设计
InteractAPI 是一个渲染与呈现库。它有意不决定交互应在何时发生。
对于普通提示,InteractAPI:
- 不读取按键输入
- 不执行射线检测
- 不激活方块或实体
- 不发送网络数据包
- 不判断目标是否可交互
你的模组负责处理所有交互逻辑,并告知 InteractAPI 在何时、何处显示提示。
该 API 支持持久与临时提示、可复用的提示 ID、动态锚点以及线程安全的注册。
QTE 是一项独立功能,在事件进行期间自行处理输入,并将结果返回给你的模组。
兼容性
| 要求 | 版本 |
|---|---|
| Minecraft | 1.20.1 |
| Forge | 47.x |
| Java | 17 |
开发者安装
在你的项目中添加 InteractAPI 作为依赖。
dependencies {
implementation fg.deobf("com.raiiiden.interactapi:interactapi:1.20.1-1.0.2")
}
在你的 mods.toml 中声明依赖:
[[dependencies.yourmodid]]
modId="interactapi"
mandatory=true
versionRange="[1.0.0,)"
ordering="AFTER"
side="BOTH"
鸣谢与支持
由 Zarra Studios 开发。
如需支持、错误报告或关于将 InteractAPI 集成到你的模组中的问题,请加入 Discord。
正在加载版本记录…
正在加载评论…
评论在新手盒子客户端中发表,这里同步展示。