
打开导航
Hytale用户界面的导航。一个为你的模组提供返回按钮和面包屑导航的库,无需自己编写历史记录。
OpenNavigation
🧭 面向 Hytale 的用户界面导航。返回按钮与面包屑路径,无需自己编写历史记录。
这是一个供模组作者使用的库。单独使用时,它不会向玩家展示任何内容:它是其他模组的基础依赖。
🤔 它解决的问题
Hytale 服务器同一时间只持有一个自定义页面。打开第二个页面时,第一个页面会被无提示地关闭。因此,一旦你的两个界面都需要返回路径,或者两个不同的模组都想使用某个界面,就必须有人记住玩家之前所在的位置。
OpenNavigation 就是那个“有人”。它维护玩家的历史记录,并在需要绘制时通知界面的所有者。
✨ 你能获得什么
🔙 一个可用的返回按钮。 调用 pop,玩家就回到之前所在的位置。无需自己维护栈,也无需处理页面 ID。
🧠 会记忆的界面。 每个界面都有自己的导航,即一个路由器。关闭你的界面,再通过命令重新打开,玩家会回到离开时的位置。期间另一个模组打开它自己的界面不会造成任何影响。
🪟 同时使用多个导航。 一个界面可以并排驱动两个路由器,形成分屏视图,每个窗格各自保留自己的返回路径。
🍞 面包屑路径。 从玩家当前位置往回追溯,即可得到路径,每一步的深度已经计算好。
🗂️ 会记忆的标签页。 每个标签页都有自己的历史记录。离开一个标签页再回来,玩家会回到离开时的位置,而不是标签页顶部。
🎒 每个路由上的上下文。 将任务、商店、页面(无论该位置是关于什么的内容)挂载到路由本身,并以带类型的方式读回。
🤝 多个模组共享一个历史记录(如果你需要)。 路由携带拥有它的模组的命名空间。从你的界面返回到另一个模组的界面可以正常工作,因为被通知绘制的是那个模组。
🚫 它从不绘制。 没有我们提供的框架、样式表或文档需要适配。你的界面始终属于你自己。
✅ 已测试。 模型是纯 Java,不依赖服务器,每次构建都会运行单元测试覆盖。
🧩 工作原理
一个路由器,三次调用和一个事件。
RouterId shop = new RouterId("mymod", "shop");
// Open your interface where the player left it, or fresh the first time
NavigationService.get().resume(player, shop, () -> new StackRoute("mymod", "shop"));
// Go one level in
NavigationService.get().push(player, shop, new StackRoute("mymod", "shop:item:" + id));
// The back button
NavigationService.get().pop(player, shop);
以上代码不会打开任何页面。每次移动都会发出通知,由你来绘制:
plugin.getEventRegistry().register(RouteChangedEvent.class, "mymod", event -> {
// event.getRoute() is where the player now stands. Open your page, or redraw it.
});
订阅自己的命名空间意味着你只会收到关于自己路由的通知,而不会被其他模组的通知打扰;没有模组声明的路由会进入 registerUnhandled,而不是悄无声息地什么都不做。
🗺️ 路由的类型
| 类型 | 说明 |
|---|---|
StackRoute |
一个位置,最多携带另一个位置。常规的前进方式。 |
TabRoute |
同时持有多个位置,同一时间显示一个。每个标签页保留自己的历史记录。 |
两者都可以扩展,因此你的路由可以是自己的类,携带任何它需要的内容。
🛠️ 完整的服务
root · resume · push · pop · navigate · replace · reload · setActiveTab · search · getRoute
navigate 会回到已经访问过的位置,并截断其后的历史;如果玩家从未到过那里,则将其压入。这就是面包屑点击,一次调用完成。
📦 安装
运行服务器? 将 jar 放入 mods/ 即可。无需编辑任何内容:需要 OpenNavigation 的模组已经声明了该依赖。
编写模组? 在你自己的模组附带的 manifest.json 中声明它:
"Dependencies": {
"MartelStudios:OpenNavigation": "*"
}
路由器的生命周期与会话相同,且从不写入磁盘:玩家所在的位置是关于当前状态的事实,如果重启后将其恢复,会让玩家停留在他从未打开过的界面后面。
👀 实际使用案例
OpenQuests 将其用于任务日志:标签页、跨嵌套任务的路径、从一个任务返回到另一个任务的路径,以及重新打开时回到上次关闭位置的日志。
📄 许可证
MIT。源码位于 GitHub。
正在加载版本记录…
正在加载评论…
评论在新手盒子客户端中发表,这里同步展示。