MenuKit
MenuKit 是用于 Fabric 模组的 UI 库。它包含了 Minecraft 界面的各个部分(按钮、滑块、选项卡、面板、HUD 读数以及设置控件),并将它们放置在 HUD、原版屏幕或模组自行打开的屏幕上。模组可以使用它来构建菜单和覆盖层,而无需从零开始编写原版屏幕代码。
我最初是为自己的模组构建了这个库,随后将其开源,以便其他模组开发者也能使用。如果你是玩家,并且另一个模组要求你安装 MenuKit,只需将其与该模组一起放入你的 mods 文件夹即可。单独运行时,它的变化非常小:按住按钮时会有按下效果的视觉反馈;单个箱子、 barrel、末影箱和潜影盒的界面会被裁剪为与背包界面相同的高度,使你的背包在所有这些界面中都保持在同一位置;“控制”界面会新增一个“移动面板”按键,在未绑定之前该按键无效。
UI 绘制在客户端进行。MenuKit 也会在服务器上加载,因为基于它构建的库可以运行服务器端代码,但仅负责绘制 UI 的模组可以保持纯客户端。对于插槽功能,有一个 SlotKit,这是另一个基于 MenuKit 构建的独立库,它能够查找并对任何菜单中的插槽进行操作,并构建真实的插槽和自定义菜单。
功能特性
- 一套组件适用于五种上下文:HUD、容器屏幕、其他原版屏幕、锚点(Anchors)和独立屏幕。锚点是模组在任何屏幕上命名并提供的一个矩形区域,例如暂停菜单中的一列按钮。
- 提供按钮、开关、复选框、单选按钮、滑块、下拉菜单(单选和多选)、文本字段、标签、信息框、工具提示、图标、物品显示(可选彩色轮廓)、进度条、分隔线、滚动容器、运行时行(
Flow,普通模式或卡片绘制模式)、可折叠区域、选项卡、颜色字段、物品选择器以及确认和警告对话框。 - 所有构建器使用相同的命名方法(
at、size、visibleWhen、disabledWhen、tooltip、state、onClick)。每个显示值的控件都会读取和写入模组拥有的字段。 - 组件被分组到面板中。面板作为一个单元进行渲染、接收输入以及显示或隐藏,且一个
disabledWhen条件会使整个面板变灰。 - 面板的位置只需在面板上声明一次,并且可以根据游戏模式有所不同,因此面板可以在创造模式下位于其他位置。面板会根据 GUI 缩放比例自动调整大小,并在需要时进行换行和滚动。
- 多个模组可以向同一个屏幕添加 UI。共享区域的面板按优先级顺序堆叠,而不是重叠,并且在每次启动时顺序一致。协同工作的模组还可以共享一个面板,当数量超过模组设定的阈值时,它会折行进入第二列。
- 面板覆盖的内容是无交互的。不透明面板占据其矩形的所有像素,而半透明面板仅占据其控件所在的区域。位于面板下方的插槽或小部件不会高亮、响应点击或显示工具提示。
- 控件具备原版的点击音效、语音朗读和键盘焦点功能。
- 每个元素根据其所在的屏幕类型进行绘制。背包和箱子采用“Panel”外观,而选项、控制及其他类似屏幕采用“Default”外观(即原版暂停菜单的外观)。文本根据角色(标题、正文、淡化或禁用)着色,确保在两种外观下均清晰可读。
- 在容器屏幕上,箱子及其下方打开的子容器可以堆叠在一个滚动列表中,上方是一个固定不动的背包面板。其他模组的按钮和配方查看器在这两者周围仍可正常工作。
- 类似创意背包那样的选项卡可以出现在除创意背包本身之外的所有容器屏幕上。如果模组希望,每个玩家打开的容器都可以拥有独立的选项卡,以组的形式在标题下滑动展开。
- 当窗口高度不足以容纳插槽网格时,网格会在其所在面板内滚动;模组也可以为此功能开启原版箱子自身的行。
- 模组可以更改插槽中物品的绘制方式,例如开启盖子的潜影盒,或者替换为其他物品,并可配合缓动动画实现。
- 模组可以在任意容器插槽的物品上方或下方绘制标记,例如锁形图标或显示应放置物品的淡色幽灵图像,并附带独立的工具提示。同一插槽上多个模组的标记均可同时显示。
- 当一个容器屏幕替代另一个打开时,帧会从旧的大小和位置平滑过渡到新的大小和位置,而不是直接跳转。
- 面板可以置于屏幕的最底层,从而永远不会遮挡其他模组的按钮。
- 玩家可以移动面板。默认未绑定的“移动面板”按键允许玩家拖拽任何未被模组固定在原位的面板,MenuKit 会记住其放置位置。
- 颜色字段允许设置页面选择颜色,支持 Minecraft 的 16 种染料颜色,也支持带有十六进制输入框的完整拾色器。
- 物品选择器将单个物品或物品列表作为设置值存储。其对话框以创意背包的方式列出所有物品及其变体,并允许编辑名称、数量、附魔和其他组件。使用一个共享的比较器进行堆栈比较,且绝不会从玩家的背包中移除任何物品。
- 由其他库制作的小部件(例如配置库自带的控件)可以嵌入到面板中。它会随面板一起滚动和裁剪,并能响应点击、按键输入、获取焦点以及语音朗读。
- 插槽会裁剪至其所在的滚动区域,因此超出边缘部分的插槽仅在可见区域内绘制、悬停和高亮响应。插槽库会向 MenuKit 报告其插槽,SlotKit 也会这样做。
- 列表会跟随模组拥有的数据源动态变化,并可选地提供添加、删除、重排序、搜索和排序控件,以及一个用于打开行操作菜单的按钮。
- 文本字段支持使用 Escape 键取消编辑,而无需关闭屏幕。
- 快捷栏旁提供了一个循环条,任何将手持槽位中的堆栈转换为环形切换的模组均可使用。每次切换时,该条带会滑动显示。
- HUD 上在心棒和饥饿条之间设有一个状态列,用于堆叠显示来自多个模组的小型图标。
- 工具提示可以通过一个共享的检查项进行隐藏、停靠、换行、保持屏幕内或滚动浏览。
兼容大多数资源包
使用 MenuKit 构建的菜单会跟随你游玩时使用的资源包,就像 Minecraft 自带的屏幕一样。面板的边框、背景和槽位来自资源包的容器艺术素材,按钮、开关、复选框和下拉菜单来自资源包自身的按钮,而文本仅在资源包的颜色会导致难以阅读时才改变颜色。基于 MenuKit 构建的模组无需额外工作即可获得此功能,且未安装任何资源包时外观不会有任何变化。
- 深色模式资源包、高分辨率资源包以及重新着色或重新设计容器样式的资源包均能正常工作。过于精细而无法干净切割的艺术素材(例如完全绘制的背景)将保留 MenuKit 自身的外观。
- 在容器列表中,每个容器都保留其自身的艺术素材,因此位于箱子下方的潜影盒看起来与其单独屏幕上的样子一致。当资源包隐藏容器标题时,如果有多个容器,盒子会重新显示它们的名称。
- 安装了 OptiGUI 后,为每个潜影盒提供独立屏幕颜色的资源包会按盒子应用,因此位于箱子下方的 lime(青柠色)盒子会获得 lime 艺术素材。
- 资源包作者可以直接使用 MenuKit 自身的精灵图对其进行主题化:
menukit:panel_raised用于面板,menukit:control_raised集用于按钮。资源包列出了它们。
示例
HUD 读数,从客户端入口点注册一次。
HudPanel.builder("mymod:readout", ModeScope.BOTH)
.region(InsideRegion.CENTER)
.padding(4)
.style(PanelStyle.NONE)
.visibleWhen(() -> Minecraft.getInstance().gui.screen() == null)
.text(0, 0, () -> "Hello from MenuKit")
.build();
在游戏过程中,文本直接渲染在准星下方,并在打开任何屏幕时消失。
入门指南
Minecraft 26.3 是非混淆版本,因此 MenuKit 直接放在 implementation 配置中。
repositories {
maven { url 'https://api.modrinth.com/maven' }
}
dependencies {
implementation 'maven.modrinth:menukit:7.5.0+26.3'
}
在 fabric.mod.json 中声明它,包含上下界,用空格分隔(原因)。
"depends": { "menukit": ">=7.5.0 <8.0.0" }
玩家需单独安装 MenuKit。Trevlar 模组列表在其 Modrinth 页面上将其列为必需依赖项,而不是打包在一起。
仓库中的源代码作为父级 Gradle 工作区项目的一部分进行构建,而该工作区不在仓库中,因此它们目前无法单独构建。
要求
- Fabric API,MenuKit 使用它来实现入口点和事件。
兼容性
- Minecraft 26.3,搭配 Fabric Loader 0.15.0 或更高版本。
- 客户端必需。服务器端可选,除非基于 MenuKit 构建的模组需要在服务器端使用它。
- Inventory Plus、Keybindery 和少数其他 Trevlar 模组的旧版本(针对早期 MenuKit 版本构建)标记为不兼容。请随 MenuKit 一起更新它们。
被以下模组使用
- SlotKit
- Keybindery
- Inventory Plus
- Sandboxes
- Shulker Palette
- Hotbar Pockets
- Simple Elytra Slot
- Simple Totem Slot
- Headcount
使用方法
本指南按照模组通常接触 MenuKit 的顺序进行介绍,从第一个面板到设置屏幕。每一部分都链接到完整的开发者文档。
公共 API
API 是名为 api 的软件包中的所有类型(com.trevlar.menukit.api.*),版本合约涵盖这些内容。其他所有软件包均为内部实现,标记为 @ApiStatus.Internal,可能在任何发行版中更改。如果一个任务似乎需要内部类型,那是 API 的缺失,请为此提交 issue。
| 软件包 | 包含 |
|---|---|
api |
MK,HUD 外观类,用于注册 HUD 面板和通知、发送通知以及读取或设置配方书。Declarations,MenuKit 及其上构建的所有库通过它声明的唯一冻结项。 |
api.element |
所有元素,以及它们渲染和接收输入的上下文 |
api.layout, api.dialog |
放置一次的行和列,以及确认、警告和编辑对话框 |
api.panel |
Panel、放置(Placement、PanelPosition 和区域)和 ModeScope、将面板放置在原版屏幕周围和锚点附近的适配器、容器列表(ContainerRegion)、容器标签(ContainerTabs)、屏幕边框(ScreenFrames)、槽位物品外观和装饰(SlotItemLooks、SlotDecorations)、共享面板(SharedPanels)和 MKScreen |
api.hud |
HUD 面板、通知和循环条 |
api.host |
适用于自带屏幕的库。它持有屏幕自身面板的主机、将输入路由到面板中绘制的槽位的钩子,以及 SlotClip,后者将这些槽位裁剪到滚动区域 |
HUD 上的第一个面板
HudPanel.builder(id, scope) 在游戏窗口注册一个面板,如上面的示例所示。scope 指定它在哪个游戏模式中显示:ModeScope.SURVIVAL、CREATIVE 或 BOTH。它位于九个 InsideRegion 位置之一,距离所接触的屏幕边缘向内 4 像素。.offset(dx, dy) 可微调其位置,.priority(n) 用于对处于同一位置的多个面板进行排序。使用 .region(OutsideRegion.X) 时,HUD 面板将位于原版快捷栏的该侧。HUD 面板仅负责绘制,不接受输入。请在客户端初始化器中注册它们,因为一旦客户端完成启动,注册即会关闭。Getting started 提供了逐步指南,而 Recipes 包含一个 HUD 栏以及快捷栏旁边的图标。
容器屏幕上的面板和元素
Panel 持有一个有序的元素列表,且面板之间不支持嵌套。每个元素都通过 X.builder()、所需设置参数以及 build() 构建,构建完成后便不可更改。用于显示值的控件接受针对模组自身字段的 state(get, set),并且自身不存储任何数据。ScreenPanelAdapter 将面板放置在容器屏幕上。如果没有指定目标,则会在所有容器屏幕上显示;而 .on(InventoryScreen.class) 或 .onPlayerInventory() 可将其限制在特定屏幕上。面板 ID 是全局唯一的,因此请为每个面板 ID 加上模组 ID 前缀。若希望面板仅在特定条件下显示,请为其提供 visibleWhen 条件,而不是移除其适配器。Concepts 列出了所有元素及共享的构建器方法。
放置与区域
面板通过 Panel.builder(id).in(scope, placement) 声明其位置,需为每个它要显示的游戏模式分别调用一次:可以是 ModeScope.BOTH,也可以将 SURVIVAL 和 CREATIVE 分开设置,从而使面板在创造模式下位于其他位置。Placement.screen(position) 使其紧贴屏幕边缘,Placement.around(anchor, position) 围绕锚点的矩形框放置,Placement.at(anchor, dx, dy) 则位于距锚点矩形框固定偏移量的位置。在定位选项中,PanelPosition.region(OutsideRegion) 将其放置在屏幕框架的一条边之外,screenAnchor(InsideRegion) 放置在九个屏幕位置之一,center() 作为顶层覆盖层居中显示,pixel(...) 放置在每帧读取的原点处,main() 则作为独立屏幕的居中框架。.priority(n) 用于对共享同一区域的面板进行排序(默认值为 100),.gap(n) 设置面板前的间距,.offset(dx, dy) 可在面板放置后对其进一步微调。面板会自动包裹其放置区域所允许的最大宽度,并在高度超出可用空间时启用滚动。有关详细信息,请参阅 Concepts 中的 Mode scope、Placement 和 Region 章节。
其他屏幕与锚点
VanillaScreenPanelAdapter 可将面板放置在非容器类的原版屏幕上,例如暂停菜单或选项界面,并需要配合 .on(...) 或 .onAny() 使用。Anchor 是一个矩形区域,由模组命名并通过 Anchor.of(id, screen -> box) 按屏幕提供,使用 Placement.around(anchor, position) 放置的面板会根据与菜单框架相同的区域规则围绕该锚点排列,并通过 AnchorPanelAdapter 添加到屏幕上。若传入 null 矩形框,则表示该锚点在当前屏幕上不存在。适配器和锚点需在初始化阶段声明,且在游戏运行期间无法添加或移除。Recipes 展示了如何在暂停菜单按钮下方锚定一行内容。
面板的遮挡范围
显示中的面板会占用其所覆盖的区域,因此其后的内容不会高亮、响应点击或显示工具提示。面板默认是不透明的,并占据其整个矩形区域。.opaque(false) 可使面板变为透明,此时只有其按钮和其他控件会阻挡背后的内容。.popover() 会在屏幕上每个普通面板之上绘制一个面板,而模态对话框仍会在此之上打开。有关层级顺序的详细说明,请参阅 Concepts 中的 Claims 章节。
库存上方的容器
ContainerRegion.section(id, scope) 向容器屏幕的容器列表中添加一个区块,这将使箱子自身的网格及其下方打开的任何箱子在一个滚动列中堆叠于玩家库存上方。插槽属于菜单自身,屏幕边界则是涵盖两个面板的矩形区域,因此其他模组的按钮和配方查看器会环绕在这些面板周围。区块的 source(...) 指定了它所显示的容器或物品,从而在资源包下呈现该容器的艺术风格外观及其名称。ContainerRegion.CONTAINERS、ContainerRegion.INVENTORY 和 ContainerRegion.anchor(sectionId) 分别是列表旁、库存旁或某个箱子旁的按钮锚点。有关详细信息,请参阅 Concepts 中的 Container region 章节,而 Recipes 提供了构建此类布局的示例。
对于玩家在屏幕开启期间打开的箱子,ContainerRegion.sections(kind, scope, keys) 可声明一种类型的区块,每个键对应一个区块,且每帧都会读取。ContainerRegion.fitted(scope, screens) 使列表和库存面板合并为一个整体框架,高度根据当前显示的区块自适应,并为每个区块配备标签页和 visibleWhen 条件,以便模组实现类似创造模式库存那样一次只显示一个页面的效果。隐藏区块的插槽在客户端会被禁用,而当Shift+点击将物品放入其中一个隐藏区块时,会触发 onHiddenLanding(...)。参见 Show one container at a time under tabs。
容器屏幕上的标签页
ContainerTabs.tab(id, scope) 在容器屏幕的边缘放置一个类似创造模式背包的标签页:位于容器列表上方或下方,以及物品栏面板上方或下方。同一边缘上所有模组的标签页共享一行,按 order 排序。MenuKit 绘制该行、为其留出空间,并在溢出时使用箭头进行分页。其余部分由模组自行处理,每帧读取:onClick、图标(物品、精灵或使用 icon(Icon) 绘制的模组自定义内容)、tooltip、visibleWhen、selectedWhen 和 disabledWhen。MenuKit 不维护任何选中状态。当容器区域未展开时,顶部和底部行基于屏幕自身的框架站立。ContainerTabs.keyed(id, scope, keys) 为每个键创建一个标签页,而带有 header(...) 的带键列表是一个组,其子标签页在 expandedWhen(...) 成立时从标题下方滑出。ContainerTabs.groups(id, scope, groups, keys) 声明动态添加和移除的组,每组对应一个组键,各自拥有独立的标题和子标签页,顺序由模组指定。若某组的键是另一组键之一,则嵌套在其中。ContainerTabs.frameStaysWhen(scope, screens, when) 在标签页行出现和消失时保持屏幕框架处于原版位置,仅当某行无法容纳时才移动它。参见 Container tabs。
可滚动的槽位网格
SlotScroll.builder() 创建一个高度随其实时行数变化的槽位网格,在有空间时保持完整行数,一旦超出空间则开始滚动,且始终保留至少三行。单元格由槽位库的元素构成,每个槽位对应一个单元格,通过 cells(count, cell) 根据每个单元格的索引和位置生成。narrows() 在滚动时减少一列,以便滚动条适应面板宽度,适用于捆绑场景。对于原版屏幕自带的网格,ScreenFrames.scrollsWhenShort(scope, screens) 会在适应窗口的框架内滚动其行,并在能够完全容纳时让屏幕保持原版的绘制方式。参见 Scroll a slot grid when it doesn't fit。
槽位物品的绘制样式
SlotItemLooks.declare(id, look) 允许模组针对每个槽位和每帧指定槽位物品使用的 ItemAnimation 及其播放进度。数量、耐久度条、高亮、提示框和点击事件仍由原版处理。ItemAnimation.OPEN_LID 可在资源包模型中打开潜影盒或箱子的盖子,posed(...) 可在动画播放期间缩放和移动物品,Transition.of(millis, easing) 则按关键帧控制时间。一种外观还可以用另一个物品堆叠替换当前物品进行绘制。参见 Slot item looks。
SlotDecorations.under(id, decoration) 和 SlotDecorations.over(id, decoration) 在所有容器槽位(无论是否为空)上绘制装饰元素,无需模组自身的 mixin。槽位先绘制背景,然后绘制 under 装饰,接着绘制物品及其数量,最后绘制 over 装饰,因此属于空槽位的物品虚影会显示在下方,而锁扣则显示在上方。所有模组的装饰按 id 顺序绘制。装饰可为鼠标所在槽位部分提供提示框,替代物品自身的提示框。参见 Slot decorations。
位于最底层的面板
Panel.Builder.background() 将面板设为屏幕背景的一部分。屏幕上其他所有内容,包括其他模组的按钮,都会在其上方绘制并保持可点击,而面板仅在其余所有元素拒绝点击后才接收点击或滚轮事件。容器列表的两个面板即以此方式构建。参见 background panel recipe。
共享面板与可移动面板
协同工作的模组可以将它们的元素放入同一个面板中。每个模组通过约定的 id 在其客户端初始化器中使用 SharedPanels.join(id, contribution) 加入该面板,MenuKit 按顺序将所有贡献合并为一个面板。Contribution.Builder.wrapAfter(scope, n) 限制共享面板中每行(垂直面板则为每列)容纳的贡献数量,超出部分自动换行。当仅安装一个模组时,它是一个普通面板。玩家绑定 MenuKit 的“移动面板”按键后即可移动面板:他们可将面板拖到 desired 位置,适用于两种游戏模式或仅限当前模式,MenuKit 会通过面板 id 保存位置。若某个面板的位置是其功能定义的一部分,则可将其标记为 fixed()。Shared panels 和 Moving panels 章节详细说明了这两者。
独立屏幕与屏幕类型
模组的自定义屏幕继承自 MKScreen。元素会根据其所处的屏幕类型进行绘制。ScreenKind.PANEL 采用 Panel 外观,即 MenuKit 的灰色风格;ScreenKind.DEFAULT 采用 Default 外观,即原版暂停菜单的风格。注入到原版屏幕中的面板会从所属屏幕获取类型。独立屏幕使用 super(title, ScreenKind.DEFAULT, panels) 一次性声明其类型,未声明任何类型的屏幕默认为 Panel 屏幕。文本颜色根据其角色(TextRole.HEADING、BODY、MUTED 或 DISABLED)自动调整,确保在两种类型下均清晰可读。Recipes 提供了在暂停菜单外观下构建完整设置屏幕的示例。
布局、标签页与分区
Row 和 Column 仅在面板的首次布局阶段放置元素一次。Flow 是运行时行,而 Flow.spacer() 可将控件固定在任何宽度的设置行的右边缘。Flow.Builder.wrapAfter(n) 限制在换行之前列或行容纳的子项数量,而 keepLast() 保留垂直 Flow 中第一列的最后一批子项。Flow.builder().boxed() 会在行后方绘制卡片背景,从而使它们像原版世界列表那样对齐排列。Tabs 有三种模式:WRAP、SIDE_SCROLL 和 SIDEBAR,选中的标签页由模组自身状态决定。在 SIDEBAR 菜单上调用 tabColumn(false) 可隐藏标签页列,使单页菜单看起来与其带标签页的兄弟菜单一致,而 fitShownTab() 则将 Tabs 的大小调整为当前显示的标签页大小。Section 是可折叠的分组。其他模组可以通过 Tabs.addTo(id, tab) 向命名菜单添加标签页。Concepts 中的 Tabs、Section 和 Layout helpers 章节对它们进行了详细说明。
颜色设置
ColorField 显示色样并在使用时打开对话框,Basic 选项卡包含 16 种染料颜色,Custom 选项卡则提供带有十六进制输入框的完整拾色器。该值为一个整数,格式为 0xRRGGBB;若启用 alpha(true),则为 0xAARRGGBB。更改会立即写入,点击 Done 确认保留,点击 Cancel 或按 Escape 则恢复之前的颜色。在 HUD 上没有对话框,仅显示色样。参见 color setting recipe。
物品设置
ItemPicker 接受一个透镜(lens)。state 按类型保存单个物品,stack 保存单个物品组,stacks 保存一组物品组,而 rule 和 rules 则是各自携带匹配模式的物品组。match(...) 设置物品组的比较方式:仅按物品类型比较(ITEM,默认值)、按精确的物品组比较(EXACT),或按物品及规则设定的至少部分组件进行比较(CONTAINS)。对话框包含 Search 选项卡,对于 EXACT 和 CONTAINS 模式,还包含用于 /give 语法的 Edit 选项卡以编辑组件。在游戏内,rule.matches(stack) 或 ItemMatch.matches(...) 执行比较操作,而 ItemMatch.CODEC 用于保存规则。ItemMatch 是通用代码,因此它同样适用于服务器端。参见 item setting recipe。
来自其他库的小部件
WidgetHost.builder().widget(supplier).size(w, h) 可将任何原版风格的小部件放入面板中。主机随面板及其滚动位置移动小部件,将其裁剪至其边界框内,并传递点击、拖拽、滚轮、按键输入、焦点和叙述事件。如果小部件不是原版的 LayoutElement,则需要一个 place(...) 钩子;如果需要在其下方打开列表,则需要 overflow() 使其绘制在所有元素之上。参见 widget host recipe。
提示框
MKTooltip.hideWhen(...) 可在条件满足时隐藏所有提示框,或仅隐藏物品提示框或其他提示框。wrapWhen、clampWhen 和 avoidCoverWhen 可确保提示框留在屏幕上且不遮挡视线,而配合 scrollBy 使用的 onWheel 允许模组滚动长提示框。除非模组从客户端初始化时注册这些功能,否则它们默认均为关闭状态。Concepts 中的 Claims 章节解释了每个开关的作用。
循环条
HudCycleStrip 在原版快捷栏右侧绘制一个小型快捷栏,显示一组环绕堆叠的物品,并随着持有槽位的变化进行切换。模组编写一个返回快捷栏槽位对应环状物品的源数据,通过 HudCycleStrip.register(...) 注册一次,并在环状物品切换后调用 slide。Cycle strip 提供了完整指南。
槽位
MenuKit 不包含任何槽位代码。需要槽位组、创建槽位或自定义菜单的模组还需依赖 SlotKit。负责在面板中放置槽位的槽位库会通过 SlotClip.shown 报告每个槽位,从而使槽位裁剪到其滚动区域内。SlotKit 的槽位元素已内置此功能。
限制与版本控制
Limits 列出了 MenuKit 未实现的功能及开放缺口。Versioning 解释了版本号所承诺的内容以及为何上下界都至关重要。reference 是 api 包生成的 Javadoc。README 和 docs/ 目录中的所有 Java 示例均在发布前针对上一版本进行编译。
升级指南
升级至 7.5.0
基于 7.4.0 构建的模组仍可照常运行,无需任何更改。使用 7.5.0 中新功能的模组需声明 "menukit": ">=7.5.0 <8.0.0"。Upgrading。
升级至 7.4.0
基于 7.3.0 构建的模组仍可照常运行,但有两个例外。针对 OutsideRegion 的 switch 语句需要新增 LEFT_CENTER 和 RIGHT_CENTER 的 case 分支;自定义元素若绘制超出其自身边界框,当该边界框完全不可见时将不再绘制。那些未指明面板所属游戏模式的表单(例如 Panel.Builder.position(p) 现已变为 in(ModeScope.BOTH, Placement.screen(p)))已被弃用,将在 8.0.0 中移除。原本通过 menukit:panel_raised 为主题化 MenuKit 按钮的资源包,现在应通过 menukit:control_raised 进行主题化。使用 7.4.0 中新功能的模组需声明 "menukit": ">=7.4.0 <8.0.0"。Upgrading 包含了所有替换方案及两项检查说明。
较早版本(从 7.3.0 回溯至 3.0.0)请参阅 Upgrading from older versions。
许可证
MIT。详见 LICENSE。请在 github.com/trevorschoeny/menukit/issues 报告问题。
MenuKit
MenuKit is a UI library for Fabric mods. It has the parts of a Minecraft interface (buttons, sliders, tabs, panels, HUD readouts, and settings controls) and places them on the HUD, on vanilla screens, or on screens a mod opens itself. A mod builds its menus and overlays with it instead of writing vanilla screen code from scratch.
I built it for my own mods, then opened it up so other modders can use it too. If you're a player and another mod asked you to install MenuKit, put it in your mods folder alongside that mod and you're done. On its own it changes very little. Buttons get a pressed look while you hold them down, single chest, barrel, ender chest, and shulker box screens are trimmed to the inventory screen's height so your inventory sits in the same place on all of them, and Controls gets a Move panels key that does nothing until you bind it.
The UI draws on the client. MenuKit also loads on a server, because libraries built on it run server code, but a mod that only draws UI can stay client-only. For slots, there is SlotKit, a separate library built on MenuKit that finds and acts on the slots in any menu and builds real slots and custom menus.
Features
- One set of components for five contexts, which are the HUD, container screens, other vanilla screens, anchors, and standalone screens. An anchor is a rectangle a mod names and supplies on any screen, such as the pause menu's column of buttons.
- Buttons, toggles, checkboxes, radio buttons, sliders, dropdowns (single and multi-select), text fields, labels, info boxes, tooltips, icons, item displays (with an optional colored outline), progress bars, dividers, scroll containers, runtime rows (
Flow, plain or drawn as cards), collapsible sections, tabs, color fields, item pickers, and confirm and alert dialogs. - Every builder uses the same method names (
at,size,visibleWhen,disabledWhen,tooltip,state,onClick). Every control that shows a value reads and writes a field the mod owns. - Components are grouped into panels. A panel renders, takes input, and shows or hides as a unit, and one
disabledWhengrays the whole panel. - A panel's placement is one declaration on the panel, and it can differ by game mode, so a panel can sit somewhere else in creative. The panel sizes itself to fit at any GUI scale, wrapping and scrolling as needed.
- Several mods can add UI to the same screen. Panels that share a region stack in priority order instead of overlapping, in the same order on every launch. Mods that work together can also share one panel, which wraps into a second column past a count the mod sets.
- What a panel covers is inert. An opaque panel takes every point of its rectangle, and a see-through one takes only its controls. A slot or widget under a panel does not highlight, take a click, or show a tooltip.
- Controls have vanilla's click sound, narration, and keyboard focus.
- Each element draws for the kind of screen it is on. Inventories and chests get the Panel look, and Options, Controls, and similar screens get the Default look, which is vanilla's pause-menu look. Text is colored by role (heading, body, muted, or disabled), so it reads on either kind.
- On container screens, a chest and the boxes opened below it can stack in one scrolling list, above an inventory panel that stays put. Other mods' buttons and recipe viewers keep working around both.
- Tabs like the creative inventory's can go on every container screen except the creative inventory itself, one per box the player has open if a mod wants, in groups that slide open under a header.
- A grid of slots scrolls inside its panel when the window is too short for it, and a mod can turn this on for a vanilla chest's own rows.
- A mod can change what a slot's item draws as, such as a shulker box whose lid opens or a different item in its place, timed with its own easing.
- A mod can draw marks under or over the item in any container slot, such as a padlock or a faded ghost of what belongs there, with a tooltip of its own. Several mods' marks on one slot all show.
- When one container screen opens in place of another, the frame moves from the old size and place to the new one instead of jumping.
- Panels can sit behind everything on a screen, so they never block other mods' buttons.
- Players can move panels. A Move panels key, unbound by default, lets them drag any panel a mod hasn't fixed in place, and MenuKit remembers where they put it.
- A color field lets a settings page pick a color, from Minecraft's 16 dye colors or from a full picker with a hex field.
- An item picker holds one item or a list of them as a setting value. Its dialog lists every item and variant the way the creative inventory does, and edits names, counts, enchantments, and other components. One shared matcher compares stacks, and nothing is ever taken from the player's inventory.
- A widget made by another library, such as a config library's own control, can sit inside a panel. It scrolls and clips with the panel, and gets clicks, typed keys, focus, and narration.
- Slots clip to the scroll area they sit in, so a slot half past the edge draws, hovers, and takes clicks only where it shows. Slot libraries report their slots to MenuKit, and SlotKit does.
- Lists that follow a list the mod owns as it changes, with optional add, remove, reorder, search, and sort controls, and a button that opens a menu of actions for a row.
- Text fields cancel an edit with Escape, without closing the screen.
- A cycle strip beside the hotbar is available to any mod that turns a ring of stacks through the held slot. It slides on each turn.
- A status column on the HUD, between the hearts and the hunger bar, holds small icons from several mods, stacked.
- Tooltips can be hidden, docked, wrapped, kept on screen, or scrolled through one shared check.
Works with most resource packs
Menus built with MenuKit follow the resource pack you play with, the way Minecraft's own screens do. A panel's frame, background, and slots come from the pack's container art, buttons, toggles, checkboxes, and dropdowns from the pack's own buttons, and text changes color only where the pack's colors would make it hard to read. Mods built on MenuKit get this with no work of their own, and with no pack installed nothing looks different.
- Dark mode packs, high-resolution packs, and packs that recolor or restyle containers all work. Art too detailed to cut up cleanly, such as a fully painted background, keeps MenuKit's own look.
- In a container list, each container keeps its own art, so a shulker box below a chest looks the way it does on its own screen. Where a pack hides container titles, the boxes get their names back once there's more than one.
- With OptiGUI installed, packs that give each shulker box color its own screen apply per box, so a lime box below a chest gets the lime art.
- Pack authors can theme MenuKit directly with its own sprites:
menukit:panel_raisedfor panels and themenukit:control_raisedset for buttons. Resource packs lists them.
Example
A HUD readout, registered once from the client entry point.
HudPanel.builder("mymod:readout", ModeScope.BOTH)
.region(InsideRegion.CENTER)
.padding(4)
.style(PanelStyle.NONE)
.visibleWhen(() -> Minecraft.getInstance().gui.screen() == null)
.text(0, 0, () -> "Hello from MenuKit")
.build();
The text renders directly below the crosshair during play and disappears while any screen is open.
Getting started
Minecraft 26.3 is unobfuscated, so MenuKit goes on the plain implementation configuration.
repositories {
maven { url 'https://api.modrinth.com/maven' }
}
dependencies {
implementation 'maven.modrinth:menukit:7.5.0+26.3'
}
Declare it in fabric.mod.json with both bounds, separated by a space (why).
"depends": { "menukit": ">=7.5.0 <8.0.0" }
Players install MenuKit separately. The Trevlar mods list it as a required dependency on their Modrinth pages rather than bundling it.
The sources in the repository build as a project of a parent Gradle workspace that is not in the repository, so they don't build on their own yet.
Requirements
- Fabric API, which MenuKit uses for its entry points and events.
Compatibility
- Minecraft 26.3, with Fabric Loader 0.15.0 or newer.
- Required on the client. Optional on the server, unless a mod built on MenuKit needs it there.
- Older releases of Inventory Plus, Keybindery, and a few other Trevlar mods built for earlier MenuKit versions are marked incompatible. Update them alongside MenuKit.
Used by
- SlotKit
- Keybindery
- Inventory Plus
- Sandboxes
- Shulker Palette
- Hotbar Pockets
- Simple Elytra Slot
- Simple Totem Slot
- Headcount
How to use
This guide follows the order a mod usually meets MenuKit, from a first panel to settings screens. Each part links to the full developer docs.
The public API
The API is every type in a package named api (com.trevlar.menukit.api.*), and the version contract covers those. Every other package is internal, marked @ApiStatus.Internal, and can change in any release. A task that seems to need an internal type is a gap in the API, so open an issue for it.
| Package | Holds |
|---|---|
api |
MK, the HUD facade, which registers HUD panels and notifications, sends a notification, and reads or sets the recipe book. Declarations, the one freeze that MenuKit and every library built on it declare through. |
api.element |
Every element, and the contexts they render and take input in |
api.layout, api.dialog |
Rows and columns placed once, and confirm, alert, and edit dialogs |
api.panel |
Panel, placement (Placement, PanelPosition and the regions) and ModeScope, the adapters that put panels on vanilla screens and around anchors, the container list (ContainerRegion), container tabs (ContainerTabs), screen frames (ScreenFrames), slot item looks and decorations (SlotItemLooks, SlotDecorations), shared panels (SharedPanels), and MKScreen |
api.hud |
HUD panels, notifications, and the cycle strip |
api.host |
For a library that ships its own screens. It holds the host of a screen's own panels, the hook that routes input to slots drawn in panels, and SlotClip, which clips those slots to a scroll area |
A first panel on the HUD
HudPanel.builder(id, scope) registers a panel on the game window, as in the example above. The scope is the game mode it shows in: ModeScope.SURVIVAL, CREATIVE, or BOTH. It sits on one of nine InsideRegion spots, 4 pixels in from the edges it touches. .offset(dx, dy) nudges it, and .priority(n) orders it among other panels on the same spot. With .region(OutsideRegion.X) a HUD panel sits on that side of the vanilla hotbar instead. HUD panels draw only and take no input. Register them from the client initializer, since registration closes when the client finishes starting. Getting started walks through it, and Recipes has a HUD bar and an icon beside the hotbar.
Panels and elements on a container screen
A Panel holds an ordered list of elements, and panels don't nest. Every element is built with X.builder(), the settings it needs, and build(), and doesn't change after that. A control that shows a value takes state(get, set) over the mod's own field and stores nothing itself. A ScreenPanelAdapter puts the panel on container screens. With no target it shows on every container screen, and .on(InventoryScreen.class) or .onPlayerInventory() narrows it. Panel ids are global, so prefix each one with the mod id. To show a panel only some of the time, give it a visibleWhen rather than removing its adapter. Concepts lists every element and the shared builder methods.
Placement and regions
A panel declares where it sits with Panel.builder(id).in(scope, placement), once for each game mode it shows in: ModeScope.BOTH, or SURVIVAL and CREATIVE apart, so a panel can sit somewhere else in creative. Placement.screen(position) places it against the screen, Placement.around(anchor, position) around an anchor's box, and Placement.at(anchor, dx, dy) at a fixed offset from the box. In a position, PanelPosition.region(OutsideRegion) places it outside the screen's frame along one edge, screenAnchor(InsideRegion) on one of nine screen spots, center() as an overlay on top, pixel(...) at an origin read every frame, and main() as a standalone screen's centered frame. .priority(n) orders panels that share a region (the default is 100), .gap(n) sets the space before a panel, and .offset(dx, dy) nudges one panel after it is placed. A panel wraps to the width its placement leaves and scrolls when it is taller than its room. The Mode scope, Placement, and Region sections of Concepts have the details.
Other screens and anchors
VanillaScreenPanelAdapter puts a panel on a vanilla screen that isn't a container, such as the pause screen or Options, and needs .on(...) or .onAny(). An Anchor is a rectangle a mod names and supplies per screen with Anchor.of(id, screen -> box), and a panel placed with Placement.around(anchor, position) sits around it by the same region rules as a menu frame, put on screen by an AnchorPanelAdapter. A null box means the anchor isn't on that screen. Adapters and anchors are declared at init and can't be added or removed during play. Recipes anchors a row under the pause menu's buttons.
What a panel covers
A shown panel claims the points it covers, so nothing behind it highlights, takes a click, or shows a tooltip. Panels are opaque by default and claim their whole rectangle. .opaque(false) makes a panel see-through, and then only its buttons and other controls block what is behind them. .popover() draws a panel above every ordinary panel on the screen, and a modal dialog still opens above that. The Claims section of Concepts covers the order.
Containers above the inventory
ContainerRegion.section(id, scope) adds a section to a container screen's container list, which stacks the chest's own grid and any boxes opened below it in one scrolling column above the player's inventory. The slots are the menu's own, and the screen's bounds are the rectangle around both panels, so other mods' buttons and recipe viewers go around them. A section's source(...), the placed container or item it shows, gives it that container's art under a resource pack, and its name. ContainerRegion.CONTAINERS, ContainerRegion.INVENTORY, and ContainerRegion.anchor(sectionId) are anchors for a button by the list, by the inventory, or by one box. The Container region section of Concepts covers it, and Recipes builds one.
For boxes the player opens while the screen is up, ContainerRegion.sections(kind, scope, keys) declares a kind of section with one section per key, read every frame. ContainerRegion.fitted(scope, screens) makes the list and the inventory panel one frame, as tall as the shown sections need, and with tabs and a visibleWhen on each section a mod can show one container at a time, the way the creative inventory shows one page. A hidden section's slots are off on the client, and onHiddenLanding(...) runs when a shift-click lands an item in one. See Show one container at a time under tabs.
Tabs on container screens
ContainerTabs.tab(id, scope) puts a tab like the creative inventory's on an edge of a container screen: above or below the container list, or above or below the inventory panel. Every mod's tabs on one edge share one row, ordered by order. MenuKit draws the row, makes room for it, and pages it with arrows when it overflows. Everything else is the mod's, read every frame: onClick, the icon (an item, a sprite, or the mod's own drawing with icon(Icon)), tooltip, visibleWhen, selectedWhen, and disabledWhen. MenuKit keeps no selection. Where the container region isn't up, the top and bottom rows stand on the screen's own frame. ContainerTabs.keyed(id, scope, keys) makes one tab per key, and a keyed list with a header(...) is a group whose sub-tabs slide out from under the header while expandedWhen(...) holds. ContainerTabs.groups(id, scope, groups, keys) declares groups that come and go at runtime, one per group key, each with its own header and sub-tabs, in the order the mod gives. A group whose key is one of another group's keys nests inside it. ContainerTabs.frameStaysWhen(scope, screens, when) keeps the screen's frame at vanilla's place while tab rows come and go, moving it only when a row wouldn't fit. See Container tabs.
A grid of slots that scrolls
SlotScroll.builder() makes a grid of slots that is as tall as its live rows while there is room and scrolls once there isn't, never under three rows. The cells are a slot library's elements, one per slot, made from each cell's index and place with cells(count, cell). narrows() drops a column while it scrolls so the scrollbar fits in the panel's width, for a bundle. For a vanilla screen's own grid, ScreenFrames.scrollsWhenShort(scope, screens) scrolls its rows inside a frame that fits the window, and leaves the screen exactly as vanilla draws it whenever it fits. See Scroll a slot grid when it doesn't fit.
What a slot's item draws as
SlotItemLooks.declare(id, look) lets a mod say, per slot and per frame, which ItemAnimation a slot's item draws with and how far through it is. The count, durability bar, highlight, tooltip, and clicks stay vanilla's. ItemAnimation.OPEN_LID opens a shulker box's or chest's lid in the resource pack's model, posed(...) scales and moves the item as it plays, and Transition.of(millis, easing) times it per key. A look can also draw another stack in the item's place. See Slot item looks.
SlotDecorations.under(id, decoration) and SlotDecorations.over(id, decoration) draw on every container slot, empty or not, without a mixin of the mod's own. A slot draws its background, then the under decorations, then the item and its count, then the over decorations, so a ghost of the item that belongs in an empty slot goes under and a padlock goes over. Every mod's decorations draw, in id order. A decoration can answer a tooltip for the part of the slot under the mouse, in place of the item's own. See Slot decorations.
Panels behind everything
Panel.Builder.background() makes a panel part of the screen's own background. Everything else on the screen, other mods' buttons included, draws over it and stays clickable, and the panel gets a click or the wheel only after everything else declined it. The container list's two panels are built this way. See the background panel recipe.
Shared panels and moving panels
Mods that work together can put their elements in one panel. Each joins it from its client initializer with SharedPanels.join(id, contribution) under an agreed id, and MenuKit builds one panel from every contribution, in order. Contribution.Builder.wrapAfter(scope, n) caps how many contributions the shared panel holds in a row, or in a column for a vertical panel, for a game mode, and the rest wrap. With one mod installed it is an ordinary panel. Players can move panels once they bind MenuKit's Move panels key: they drag a panel where they want it, for both game modes or only the current one, and MenuKit keeps the position by panel id. A mod marks a panel fixed() where its place is part of what it means. The Shared panels and Moving panels sections of Concepts cover both.
Standalone screens and screen kinds
A mod's own screen subclasses MKScreen. Elements draw for the kind of screen they are on. ScreenKind.PANEL is the Panel look, MenuKit's gray, and ScreenKind.DEFAULT is the Default look, vanilla's pause-menu look. Panels injected into vanilla screens take the kind from the screen. A standalone screen declares its kind once, with super(title, ScreenKind.DEFAULT, panels), and one that declares nothing is a Panel screen. Text takes its color from a role (TextRole.HEADING, BODY, MUTED, or DISABLED), so it reads on both kinds. Recipes builds a whole settings screen in the pause-menu look.
Layout, tabs, and sections
Row and Column place elements once, at the panel's first layout pass. Flow is the runtime row, and Flow.spacer() pins a control to the right edge of a settings row at any width. Flow.Builder.wrapAfter(n) caps how many children a column or row holds before it wraps, and keepLast() keeps the last ones in a vertical Flow's first column. Flow.builder().boxed() draws a card behind a row, so a list of them lines up like vanilla's world list. Tabs has three modes, WRAP, SIDE_SCROLL, and SIDEBAR, and the selected tab is the mod's own state. tabColumn(false) on a SIDEBAR menu hides the tab column so a one-page menu looks like its tabbed siblings, and fitShownTab() sizes a Tabs to the tab it shows. Section is a collapsible group. Other mods can add tabs to a named menu with Tabs.addTo(id, tab). The Tabs, Section, and Layout helpers sections of Concepts cover them.
Color settings
ColorField shows a swatch and opens a dialog when clicked, with the 16 dye colors on a Basic tab and a full picker with a hex field on a Custom tab. The value is an int, 0xRRGGBB, or 0xAARRGGBB with alpha(true). Changes are written at once, Done keeps them, and Cancel or Escape puts back the color from before. On the HUD there is no dialog, only the swatch. See the color setting recipe.
Item settings
ItemPicker takes one lens. state holds one item by kind, stack one stack, stacks a list of stacks, and rule and rules stacks that each carry their own match mode. match(...) sets how stacks compare, by the kind of item only (ITEM, the default), by the exact stack (EXACT), or by the item plus at least the components the rule sets (CONTAINS). The dialog has a Search tab and, for EXACT and CONTAINS, an Edit tab for components in /give syntax. In play, rule.matches(stack) or ItemMatch.matches(...) does the comparing, and ItemMatch.CODEC saves a rule. ItemMatch is common code, so it works on a server too. See the item setting recipe.
Widgets from other libraries
WidgetHost.builder().widget(supplier).size(w, h) puts any vanilla-style widget in a panel. The host moves it with the panel and its scroll, clips it to its box, and passes it clicks, drags, the wheel, typed keys, focus, and narration. A widget that isn't a vanilla LayoutElement needs a place(...) hook, and one that opens a list below itself needs overflow() to draw it over everything. See the widget host recipe.
Tooltips
MKTooltip.hideWhen(...) hides every tooltip, or only item tooltips or only the others, while a condition holds. wrapWhen, clampWhen, and avoidCoverWhen keep tooltips on screen and out of the way, and onWheel with scrollBy lets a mod scroll a long one. All of them are off unless a mod registers them from client init. The Claims section of Concepts explains each switch.
The cycle strip
HudCycleStrip draws a small hotbar just right of the vanilla one, showing a ring of stacks that turns through the held slot. A mod writes a source that returns the ring for a hotbar slot, registers it once with HudCycleStrip.register(...), and calls slide after the ring turns. Cycle strip has the full guide.
Slots
MenuKit keeps no slot code. A mod that needs slot groups, created slots, or custom menus depends on SlotKit as well. A slot library that places slots in panels reports each one with SlotClip.shown, so the slot clips to its scroll area. SlotKit's slot elements already do this.
Limits and versioning
Limits lists what MenuKit doesn't do and the open gaps. Versioning explains what a version number promises and why both bounds matter. The reference is the generated javadoc for the api packages. Every Java sample in the README and in docs/ is compiled against the release before it ships.
Upgrading
To 7.5.0
Mods built for 7.4.0 work as before, with nothing to change. A mod that uses anything new in 7.5.0 declares "menukit": ">=7.5.0 <8.0.0". Upgrading.
To 7.4.0
Mods built for 7.3.0 work as before, with two exceptions. A switch over OutsideRegion needs cases for the new LEFT_CENTER and RIGHT_CENTER, and a custom element that draws past its own box isn't drawn while that box is wholly out of view. The forms that don't say which game mode a panel is for, such as Panel.Builder.position(p) (now in(ModeScope.BOTH, Placement.screen(p))), are deprecated and go in 8.0.0. A resource pack that themed MenuKit's buttons through menukit:panel_raised themes them through menukit:control_raised now. A mod that uses anything new in 7.4.0 declares "menukit": ">=7.4.0 <8.0.0". Upgrading has every replacement and both checks.
Older releases, from 7.3.0 back to 3.0.0, are in Upgrading from older versions.
License
MIT. See LICENSE. Report issues at github.com/trevorschoeny/menukit/issues.
下载 MenuKit
下载 MenuKit
下载 MenuKit
下载 MenuKit
下载 MenuKit
下载 MenuKit
下载 MenuKit
下载 MenuKit
下载 MenuKit
下载 MenuKit
7.4.0
此版本为新增功能:容器区域、背景面板、跟随资源包的 Panel-look 面板、按游戏模式区分的放置方式、多个模组共享的面板,以及玩家可移动的面板。未移除任何内容,为 7.3.0 构建的模组照常运行,仅在 升级 中提到的两种情况下除外。无游戏模式的表单已弃用。通过 menukit:panel_raised 为主题化 MenuKit 按钮的资源包,现改为通过 menukit:control_raised 进行主题化。
新增
-
在容器屏幕的背包上方有一个可滚动的列。
ContainerRegion.section(id, scope)为屏幕的容器区域添加一个部分:箱子自身的网格、其下方打开的一个盒子、再下方的另一个盒子,所有这些堆叠在一个位于玩家背包上方的单列中。每个屏幕只有一个区域,无论有多少模组向其中添加内容。屏幕变为两个面板,每个面板都有自己的框架:容器列表(其滚动条位于框架内)和其下方的背包面板(不会滚动)。列表在滚动之前会先增长。只要两个面板能够容纳,它们就作为一个整体居中于屏幕上,列表顶部向上移动,背包面板向下移动各自增长量的一半(如果窗口高度不足以容纳原版边距,则空间较少的一侧保持不动,直到整个块居中)。只有当它们触及屏幕的顶部和底部边距时,列表才会通过共享滚动条按像素滚动。调整大小会重新布局,且列表永远不会比屏幕自身的容器部分更短。屏幕的leftPos、topPos、imageWidth和imageHeight始终是围绕这两个面板的矩形,因此菜单框架上的其他面板、其他模组的按钮和配方查看器都会围绕两者排列,且在两者之间的间隙中持有物品点击不会掉落任何物品;原版的背包槽位和标签随背包面板移动,读取leftPos + slot.x的模组定位到的也是该槽位。ContainerRegion.CONTAINERS和ContainerRegion.INVENTORY分别是每个面板的锚点。ContainerRegion.anchor(sectionId)是单个部分的锚点,以便按钮可以位于列表中的每个盒子旁边,并在其部分隐藏或滚出视野时隐藏。滚轮可以从屏幕的任何位置滚动该区域,但仅在没有任何其他操作使用滚轮转动时才生效,因此在槽位上时,使用滚轮移动物品的模组会保留其功能,配方查看器的列表也是如此。Shift+点击其中一个已滚出视野的槽位会滚动至那里,并将物品携带至其顶部或底部边缘也会触发滚动,越靠近边缘滚动越快。两个面板都是屏幕的背景。屏幕上的所有内容,包括其他模组的按钮和配方查看器,都绘制在它们以及区域的槽位之上,它们不会阻挡任何内容。在该区域激活时,屏幕背景照常运行,包括其他模组在其中的钩子。仅排除原版自身的容器纹理和屏幕标题,由面板和各部分的标题取而代之。概念,配方。 -
当屏幕打开期间布局发生变化时,容器区域会像窗口调整大小时一样(使用
Screen.resize以屏幕自身尺寸)重新布局屏幕。每个模组都从其自身的初始化钩子中根据新的边界再次添加其小部件,因此屏幕边缘旁的另一个模组的按钮会随着部分的打开或关闭而跟随其所在的面板。这绝不会发生在滚动时,并且无论有多少部分发生变化,每帧最多发生一次。调整大小所保留的内容(光标上的物品、滚动位置、打开的部分、铁砧的名称)都会被保留。概念。 -
容器区域的部分仅在其内容可见时显示,因此自行隐藏的内容(例如,未在当前打开菜单上的槽位组的槽位库元素)会将其部分一并隐藏。
ContainerRegion.Builder.title(...)在原版绘制容器标题的位置绘制部分的标题。当资源包在其他部分显示时将该标题留白时,该部分由其容器调用,以便玩家仍能区分不同的容器。名称是其来源的自定义名称或其方块在玩家语言中的名称(如“浅绿色潜影盒”),或者对于没有后方方块的部使用name(...)。配方。 -
容器屏幕面板上的标签页。
ContainerTabs.tab(id, scope)将标签页放置在容器区域面板的边缘,类似于创造模式背包:edge(...)可以是容器列表的顶部(默认)或底部,也可以是背包面板的顶部或底部。标签页的所有属性和行为均由模组定义,并每帧读取:onClick(左键点击,带有原版的点击音效)、图标(icon(Supplier<ItemStack>),或使用icon(Identifier)显示模组自带的精灵)、tooltip、order、visibleWhen、selectedWhen和disabledWhen(变灰,不可点击)。MenuKit 不保存选择状态。同一边缘上所有模组的标签页共享一行,按order排序,并排且紧密相连。该行即为原版的创造模式标签页,因此它会遵循重绘这些标签页的资源包,选中的标签页会展开至其框架内。它位于其面板之外,从不覆盖槽位,区域会为其预留空间并将其计入屏幕边界。超出可视范围的部分,行末的箭头每次翻页一个标签页;该行不使用滚轮。当区域未激活时(玩家背包、潜影盒、无部分显示的箱子、模组自有的容器屏幕),顶行位于屏幕自身框架的顶部边缘,底行位于其底部边缘,框架与两行作为一个整体居中,框架从原版的位置移动,连同原版从该位置放置的所有内容一起移动,因此相同大小的屏幕会将该行置于同一位置。在区域的面板上,位于块外部边缘的行也与其一同居中。在一屏替换另一屏打开时,行会保留其页码。概念,配方。 -
每个按键对应一个标签页。
ContainerTabs.keyed(id, scope, keys)声明一个标签页列表,其中每个keys提供的键对应一个标签页,每帧读取一次,因此模组可以为玩家打开的每个容器显示一个标签页,无论数量多少,且它们之间没有分隔区域。tab((key, tab) -> ...)在键出现的那一帧设置每个键的标签页;只要键存在,它就会保留,并且该行的页面和选中的标签页会跟随其后。列表中的标签页按照列表的order和edge排列在键的顺序中,位于屏幕自身的框架或区域的侧边栏上。当有标签页进出时,该行的页面始终保持在当前可见的第一个标签页上。概念。 -
标签页组。带有
header(...)的带键标签页列表构成一个组:一个标题标签页和其后的键对应的标签页作为同一行上的较小子标签页。模组通过onClick决定单击标题时的行为,并通过expandedWhen(...)控制子标签页何时展开。MenuKit 会将它们从标题下方滑出至右侧,并以相同的缓动方式滑回标题下方,中途转向则会从当前位置返回。如果滑动导致行翻页,则同时打开箭头按钮的空间,标签页要么完整显示,要么完全不显示。屏幕的第一帧会按原样显示所有组,不进行滑动。箭头按钮用于浏览已展开的标签页。带有pinnedWhen(...)的标题或子标签页在其条件成立时保持固定:即使被翻页带过,它仍停留在其所在行的末尾,后续标签页移至其后方,与该组的其他固定标签页并列,直到下一个组的标题(在最左侧)或前一个组的固定标签页(在最右侧)将其推走。概念。 -
模组绘制的标签页大小与图标。
size(width, height)设置单个标签页的大小,tabSize(width, height)设置带键列表中所有标签页的大小。一行的高度由其最高的标签页决定,且标签页图像在任何尺寸下都能保持角部完整。icon(Icon)每帧在标签页的图标框内运行模组自带的绘制逻辑,图标框会随标签页变小而缩小,因此图标可以是物品、精灵动画、动画或其他任何内容。物品和精灵形式填充相同的图标框。 -
原版容器屏幕尺寸统一。潜影盒高度为 167,单格箱子、桶和末影箱为 168,而背包及几乎所有其他容器屏幕均为 166,因此当一个容器替代另一个打开时,框架和玩家的背包位置保持不变。每个箱子尺寸也去除了原版保留在其图像下方的空白行。
ScreenFrames.stretch(screen, seam, by)使模组自定义屏幕在布局的一行处变高或变矮,以匹配尺寸。概念。 -
在一个容器之上打开的另一个容器屏幕,其框架会在 0.15 秒内从旧尺寸和位置平滑过渡到新尺寸和位置,而非直接跳转,采用资源包的视觉风格,新屏幕的内容立即显示在框架内部,标签页行位于边缘。适用于任何模组屏幕,无需额外代码。
-
槽位物品的渲染样式。
SlotItemLooks.declare(id, look)允许模组指定任意容器屏幕上每个槽位、每帧使用的ItemAnimation及其播放进度;物品数量、耐久条、高亮、工具提示和点击操作仍由原版处理。ItemAnimation.OPEN_LID使用资源包模型和纹理中潜影盒与箱子物品渲染器所采用的开启盖子效果(模组也可编写自己的实现),并配合posed(...)对物品进行缩放和平移。Transition.of(millis, easing)按键控制播放时间(正向播放并保持,或反向播放),中途转向会从当前位置返回,基于原版时钟(Transition.eachWay的反向缓动曲线趋向于 0,而正向趋向于 1,而非对称曲线),因此当一个屏幕替代另一个打开时,可接续已完成动画的位置继续播放。Easing提供四种曲线,任何函数均可作为缓动曲线。概念。 -
运行时动态打开的容器区域分区。
ContainerRegion.sections(kind, scope, keys)声明一种分区类型,每个在当前屏幕打开的键对应一个分区,每帧读取一次,因此模组可以显示玩家打开的任意数量的容器,无需提前为每个容器单独声明。每个键对应的分区在其出现时构建,在其关闭时移除;每个键对应一个标签页,通过针对相同键的ContainerTabs.keyed实现。概念。 -
自适应框架。
ContainerRegion.fitted(scope, screens)将容器列表和这些屏幕上的背包面板合并为一个框架,如同原版的图像那样,高度根据显示的分区需求调整,若分区更小,则低于屏幕自身容器部分的高度。列表顶部边缘的标签页行位于框架之上,分区标题位于其下方,对应原版标题的位置。结合标签页、visibleWhen和此功能,模组可以一次只显示一个容器,类似于创造模式背包分页显示的方式。 -
隐藏容器区域分区的槽位在客户端处于禁用状态(
Slot.isActive()为 false),因此不会在此处绘制、悬停或响应点击。未分配给任何分区的容器自带槽位仍视为屏幕自身容器的第一个分区(无来源)。ContainerRegion.openedOn()返回打开当前屏幕的容器,即其分区的来源。ContainerRegion.Builder.onHiddenLanding(...)在右键点击将物品放入隐藏分区时触发,以便模组进行处理;滚动仅能定位到已显示分区中的槽位。 -
位于所有元素之后的面板。
Panel.Builder.background()会将面板设为屏幕背景的一部分。它会在屏幕绘制图像的区域进行渲染,因此屏幕上的小部件、标签和槽位、其他模组的小部件以及所有其他面板都会在其上方绘制。它不占用任何交互区域,因此其上方的内容保持可交互状态;只有当屏幕的小部件拒绝点击后,该面板的元素才会获得点击响应;并且只有在所有其他元素都拒绝滚轮操作后,滚轮才会作用于它。它所显示的槽位会紧随其后绘制,并被裁剪至面板范围内,因此槽位位于面板之上、所有小部件之下。如果一个按钮覆盖在某个槽位上,则该槽位会被隐藏,且此时不会对该槽位进行悬停检测。每个槽位都会经过屏幕自身的extractSlot处理,因此其他模组的槽位标记也会显示出来。配方。 -
“面板外观”风格的面板遵循资源包设置。在容器屏幕上、模组自有的“面板外观”界面中,或作为对话框使用时,“面板外观”中的凸起面板会从资源包的箱子艺术素材中提取边框、填充和槽位边框。这些素材从纹理中切割并平铺,永不拉伸,支持任意分辨率。在容器区域内,列表的每个部分会使用其各自的容器纹理,例如箱子列表中展示的海晶盒会呈现其在独立界面上的样子,而物品栏面板则使用屏幕纹理的物品栏半区。无法干净切割的艺术素材(如带有纹理的填充)将保留 MenuKit 的默认样式;若无资源包,则无任何变化。模组无需额外适配。资源包。
-
“面板外观”控件遵循资源包重新设计的原版小部件。按钮、切换开关、下拉菜单、菜单按钮、颜色字段色样以及物品对话框的控件,会在资源包重新设计过的位置使用原版的
widget/button精灵图,并采用原版的标签颜色;复选框则使用原版的复选框图标。资源包也可以直接对 MenuKit 进行主题化,使用menukit:panel_raised以及新增的menukit:control_raised、control_raised_highlighted、control_raised_pressed和control_raised_disabled,这些样式优先级高于原版。控件的所有状态均源自同一基础源,若源中缺少某状态的精灵图,则基于正常状态派生,因此控件在不同状态下外观保持一致。资源包。 -
“面板外观”面板上的文本在任何资源包的填充背景下均可正常阅读。标题、正文和淡化文本在与其填充背景对比明显时(正文文本对比度需达到 4.5:1)保持原有颜色,在无对比处则采用由填充背景衍生出的颜色。对于深色模式资源包,若其文本着色器重绘了原版的灰色标签,MenuKit 的灰色将被保留以供着色器处理。自定义元素可通过
AbstractPanelElement.textColor获取此行为。 -
容器区域的部分可以指定其所展示的容器名称。
ContainerRegion.Builder.source(...)用于命名容器,其中ContainerRegion.Source.of(BlockEntity)用于已放置的实体,Source.of(ItemStack)用于通过物品打开的容器(非方块物品不提供方块信息)。该部分将从其来源获取容器纹理和名称。未指定来源的部分默认为屏幕自身的容器,即打开屏幕时准星下方的方块(前提是屏幕持有与屏幕尺寸匹配的容器且具有标题)。 -
通过 OptiGUI 实现按部分区分容器艺术素材。安装 OptiGUI 2.x 后,MenuKit 会根据每个容器区域部分的来源,评估资源包中的 OptiGUI 和 OptiFine 规则,从而使位于箱子上方的海晶盒显示青色艺术素材,而箱子保留其自身素材。未安装 OptiGUI 时,这些规则不会被读取。配方。
-
ContainerRegion.Builder.texture(...)用于为没有对应方块来源的容器部分指定容器纹理,例如模组自有的槽位组,可选值为ContainerRegion.CHEST(默认值)或ContainerRegion.SHULKER_BOX。来源方块的优先级更高,因此海晶盒会显示海晶盒纹理,箱子、末影箱或木桶则会显示箱子纹理。ContainerRegion.GAP表示两个部分之间的间距,ContainerRegion.CONTENT_WIDTH表示滚动条出现前部分的宽度。Panel.isBackground()用于判断面板是否是通过background()构建的。 -
每个游戏模式一个放置位置。
ModeScope为SURVIVAL、CREATIVE或BOTH,源自玩家拥有无限材料(创造模式即拥有这些材料的玩家),每帧读取,因此打开屏幕时使用/gamemode切换将在下一帧生效。若无玩家则仅适用BOTH。它是 MenuKit 通用代码中的普通值,因此在服务端进行判断的库使用相同的类型。Panel.Builder.in(scope, placement)指定面板在每个模式中的位置,每个作用域声明一次。每帧时,面板采用当前模式的放置位置,否则采用其BOTH位置的设置;若两者皆无,则该模式下不显示。Placement.screen(position)是相对于主机自身的参考点,Placement.around(anchor, position)位于锚点盒周围的区域,而Placement.at(anchor, dx, dy)位于盒子的左上角加上偏移量,以自然大小显示,无堆叠、预算或裁剪限制。屏幕适配器将面板的锚定放置位置置于其目标屏幕上的锚点主机中,且当放置位置命名了锚点时,AnchorPanelAdapter无需on(...)。Panel.placements()列出它们,getPosition()获取当前生效的位置。HudPanel.builder(id, scope)、OwnHost.add(panel, padding)和ContainerRegion.section(id, scope)均为作用域形式。in与已弃用的position不能混用于同一个面板,每个作用域只能声明一次;如果两个面板都会在生存模式或创造模式中显示main()(各自通过该模式的放置位置,否则是其BOTH位置),则在注册时会抛出异常,并指明两个面板及对应的模式。若AnchorPanelAdapter的面板具有Placement.screen(...)但无on(...),则在首次打开屏幕时抛出异常,指明面板及对应模式,而不是在该模式下将其省略。Panel.Builder.fixed()标记为玩家无法移动的面板,Panel.isFixed()读取此状态。概念,配方。 -
OutsideRegion.LEFT_CENTER和RIGHT_CENTER位于参考点旁边,垂直居中于它,如同TOP_CENTER和BOTTOM_CENTER分别位于其上方和下方,因此紧邻锚点盒子(例如护甲槽)的一列将与盒子的中间对齐。多个元素会直接堆叠在远离参考点的位置,每个都居中。现在每一侧都有起始对齐、居中和结束对齐的区域。对OutsideRegion使用switch表达式时若无default分支,则需要包含这些新区域的情况(升级指南)。 -
对于槽位库,
SlotClip.clipOf(slot)返回槽位在屏幕空间中显示的矩形区域,若无裁剪则为null,从而让库能够区分被滚动边缘截断的槽位和完全可见的槽位,例如隐藏锚定于被截断槽位的面板。 -
PanelElement.renderCulled(ctx),每帧调用一次,替代原本针对因完全位于裁剪区域之外而被跳过的显示元素的render方法,例如从ScrollContainer或ListView中滚出的一行,或超出视图范围的容器区域部分。这样槽位元素可以在其不可见时保持槽位驻留,而不是将原版槽位发送回菜单自身的位置,否则它会覆盖其他部分。隐藏的元素不会收到此调用。Flow、ScrollContainer、Section(开启状态下)、Tabs(其标题和显示页面)以及ListView会将此调用转发给其显示子项,而ChildDispatch.renderCulled对自定义容器执行相同操作。概念。 -
共享面板。协同工作的模组将其元素放入同一个面板中。每个模组在其客户端初始化器中使用
SharedPanels.join(id, contribution)加入该面板,使用约定的纯字符串 ID。Contribution携带其元素、排序号、其作用域范围以及自身的visibleWhen,以及面板自身的声明(每个模式的放置位置、样式、轴线和间距)。MenuKit 在客户端启动时构建一次面板,按顺序和模组 ID 将所有贡献者放入一个流程中。隐藏或超出作用域的贡献者,或其所有元素均被隐藏的贡献者,不占用空间;若全部隐藏,则不放置该面板。当贡献者在声明上存在分歧时,最低排序号的声明胜出,并警告涉及的两个模组。具有屏幕放置位置的共享面板会在所有容器屏幕上显示。仅安装一个模组时,它是一个普通面板。概念,配方。 -
玩家可移动面板。默认未绑定的“Move panels”键可为当前打开的屏幕开启编辑模式,或在游戏内 HUD 上方显示一个清除屏幕。编辑期间,面板带有轮廓且其他元素无法被点击。拖拽以移动面板(适用于所有游戏模式,或按住 Shift 仅移动当前模式),右键将其放回原位,按 Esc 或该键完成操作。位置会基于屏幕每个轴上的最近三分之一处进行吸附,因此能保留窗口大小调整和 GUI 比例变更后的状态,并按面板 ID 存储在
config/menukit/panel-positions.json中。MenuKit 无法读取的条目会被跳过,其余部分保持不变。完全非 JSON 格式的文件会在旁边保存为panel-positions.json.corrupt。完全无法读取的文件(如被锁定或无权限)将保持原样,直到下次启动才会保存移动。移动后的面板仅在其声明位置显示,并脱离其所在区域的流动布局。编辑模式随屏幕关闭而结束,丢弃进行中的拖拽操作;当文本字段获取键盘焦点或控制屏幕等待按键绑定时,该键无效。Panel.Builder.fixed()、HudPanel.Builder.fixed()和Contribution.Builder.fixed()可使面板固定在模组设定的位置。背景面板、叠加层、弹出层以及屏幕的主面板不可移动,循环条固定不动。Concepts。 -
一个在面板内容超出时内部滚动的槽位网格。
SlotScroll.builder()从槽位库的元素构建,每个单元格对应一个元素,通过索引和放置方式生成(cells(count, cell))。在有空间时高度与实时行数一致,空间不足时整行归还高度,最低不低于minRows(3),随后开始滚动。作为容器区域部分,当窗口高度足够时显示所有行,过短时则滚动。narrows()使其在滚动时减少一列一行,滚动条位于腾出的列中,适用于不得加宽面板的捆绑包;否则滚动条车道位于其旁,框架随之加宽。liveCount(...)使其终止于最后一个活跃槽位,每帧读取一次。Shift+左键点击滚动出视图的行时会滚动至该行。Concepts, recipe。 -
原版屏幕自带的网格在框架不适配时滚动,由模组启用。
ScreenFrames.scrollsWhenShort(scope, screens)接受其命名的屏幕(例如大型箱子):当屏幕框架及其标签行比窗口上下各留 4 像素的高度更高时,其自身的容器网格在适配的框架内滚动,标题、物品栏和快捷栏保持静止。当窗口使框架适配时,屏幕呈现原版像素级效果;若无声明则不滚动网格(标准 166 像素高度和移动框架始终存在)。网格槽位为原版自带,每个按其绘制位置显示,因此配方查看器和读取slot.x/y的模组可在正确位置找到它。 -
适配空间的滚动区域。
ScrollContainer.Builder.fitRoom(step)创建高度与内容一致的滚动区域,在有空间时保留高度并在空间不足时以完整步长归还,不低于声明高度,一旦容器询问即生效:在容器区域部分,当窗口高度足够时显示所有行,列表仅在网格处于最小状态时滚动。laneOutside()将滚动条车道置于声明宽度旁,仅在滚动时占用,区域框架相应加宽。 -
ScrollContainer.scrolls()表示滚动区域当前是否滚动(内容高于视口),ContainerRegion.scrolls(screen)表示屏幕上的容器列表或其自身网格是否滚动:任一为真时,其上方的滚轮属于滚动控件,因此使用滚轮切换标签页的模组在此处不受影响。
已更改
- 容器区域永远不会位于玩家自己的物品栏(无论是生存模式还是创造模式)中,无论某区域的
targeting属性如何设置。玩家物品栏的槽位是在每一帧从菜单持有的槽位中移动放置的,因此另一个模组在屏幕打开时添加的槽位也会随之进入物品栏面板;关闭屏幕时,被移动的槽位会精确地移回原位。 - 容器区域区域的内容会根据该区域的宽度进行布局(九个槽位,即
ContainerRegion.CONTENT_WIDTH),因此换行内容(水平Flow、槽位库中的换行槽位行、长标签文本)会在此处换行,而不是在一行中继续延伸。 SlotClip.panelShowing(slot)通过槽位的容器、索引和类来保留最后显示该槽位的面板,因此为同一位置重新生成的槽位(例如在切换标签页时的创造模式物品栏槽位)会保持其答案。当打开另一个容器屏幕时,此记录会被清除,因此玩家物品栏槽位(在每个屏幕上都是相同的槽位)不会将一个屏幕的面板状态带到下一个屏幕。- 对容器屏幕中某个小部件的点击永远不会被视为在槽位面板的间隙或被滚动边缘截断的隐藏槽位部分上的点击。该点击由小部件接收。
- 完全位于其绘制裁剪区域之外的元素会在每个深度层级都被跳过,而不仅仅是
ScrollContainer自身的子元素。位于滚动区域内的Flow中的一排槽位在不可见时不会被绘制,因此其槽位库会将其停放,并且没有滚出视口的元素会覆盖超出边缘的部分,例如滚动网格下方的物品栏。具有打开弹出层(popover)的元素仍会被绘制。自定义元素如果在其自身边界框之外绘制,当其边界框完全处于裁剪区域之外时(包括溢出部分)将不会被绘制(升级指南)。 - 如果一个槽位在同一帧中被两个面板展示,它在所有方面都属于上层面板(即能够同时处理两者上方点击的面板)。它在该面板之后绘制,位于该面板的位置及其裁剪区域内。在此之前,它与下层面板一起绘制,但其悬停状态、裁剪区域以及
SlotClip.panelShowing跟随上层面板。MenuKit 会为每对冲突的面板各记录一次日志。 - Panel 样式下的抬起控件现在使用 MenuKit 新的
menukit:control_raised精灵图,而不是menukit:panel_raised,因此资源包可以分别独立地对面板和控件进行主题定制。之前通过覆盖panel_raised来重定义 MenuKit 按钮的资源包,现在需要覆盖control_raised。在没有资源包的情况下,它们的外观与之前相同。 - 按住按钮时的按下外观(包括 MenuKit 自带按钮和原版按钮)是一个相对于按钮素材绘制的单一变换效果,因此在资源包的深色或彩色按钮上也能正常显示,同时也适用于原版按钮。对于原版按钮本身,其按下外观与旧版按下外观的差别仅在斜面高光级别上有细微差异。
SlotRendering.drawSlotBackground在 Panel 样式的面板上绘制一个 18x18 的槽位背景,使用资源包定义的槽位样式,裁剪自容器素材或其重定义的container/slot。在其他情况下,绘制方式保持不变。
已弃用
以下方法仍可正常工作,含义等同于 ModeScope.BOTH,并将在 8.0.0 版本中移除。升级指南。
Panel.Builder.position(position)已被替换为in(ModeScope.BOTH, Placement.screen(position))。AnchorPanelAdapter.on(anchors)已被替换为放置在定位中的锚点,即Placement.around(anchor, position)。HudPanel.builder(id)已被替换为HudPanel.builder(id, scope)。OwnHost.add(panel, position, padding)已被替换为OwnHost.add(panel, padding),后者会读取面板的定位信息。
7.4.0
此版本为新增功能:容器区域、背景面板、跟随资源包的面板外观、按游戏模式划分的放置方式、多个模组共享的面板,以及玩家可移动的面板。未移除任何内容,为 7.3.0 构建的模组照常工作,仅有两个例外情况 升级 名称。无游戏模式的表单已弃用。现在,通过 menukit:panel_raised 为主题化 MenuKit 按钮的资源包改为使用 menukit:control_raised 进行主题化。
新增
-
在容器界面的物品栏上方有一个可滚动的列。
ContainerRegion.section(id, scope)向界面的容器区域添加一个区块:箱子自身的网格、其下方打开的一个箱子、再下方的另一个箱子,所有这些堆叠在一个位于玩家物品栏上方的单列中。每个界面只有一个区域,无论有多少模组向其添加内容。界面变为两个面板,每个面板都有各自的框架:容器列表(带有位于其框架内的滚动条)和位于其下方的物品栏面板(永不滚动)。列表在滚动之前会先增长。当两个面板都能容纳时,它们作为一个整体保持在屏幕中央,列表顶部向上移动,物品栏面板向下移动增量的二分之一(如果窗口高度不足以容纳原版边距,则空间较少的一侧保持不动,直到该整体居中)。只有当它们触及屏幕的上下边距时,列表才会通过共享的滚动条以像素为单位滚动。调整大小时会重新布局,且列表的高度永远不会小于屏幕自身容器部分的高度。界面的leftPos、topPos、imageWidth和imageHeight始终是围绕这两个面板的矩形,因此菜单框架上的其他面板、其他模组的按钮以及配方查看器都会环绕这两个面板放置,且手持物品点击两者之间的间隙不会丢弃任何物品;原版的物品栏槽位和标签随物品栏面板移动,读取leftPos + slot.x的模组定位也会落在对应的槽位上。ContainerRegion.CONTAINERS和ContainerRegion.INVENTORY分别是每个面板的锚点。ContainerRegion.anchor(sectionId)是单个区块的锚点,以便按钮可以放置在列表中的每个箱子旁边,并在其所属区块隐藏或滚出视图时隐藏。滚轮可以在屏幕的任何位置滚动该区域,但仅在未用于其他操作的转动时才生效,因此在槽位上方使用滚轮移动物品的模组保留该行为,配方查看器的列表也是如此。Shift+点击其中一个已滚出视图的槽位会滚动至该处,手持物品拖曳至其顶部或底部边缘也会触发滚动,越靠近边缘滚动越快。两个面板均作为界面的背景。界面上的所有内容,包括其他模组的按钮和配方查看器,都绘制在它们以及该区域的槽位之上,且它们不会阻挡任何内容。在该区域显示时,界面的背景照常运行,包括其他模组在其内部的钩子。仅排除原版自身的容器纹理和界面标题,由面板和各区块的标题取而代之。概念,配方。 -
当界面打开期间布局发生变化时(类似于窗口调整大小时的行为,即调用屏幕自身大小的
Screen.resize),容器区域会重新进行界面布局。每个模组都会从其自身的初始化钩子中根据新的边界重新添加其组件,因此屏幕边缘的另一个模组的按钮会在区块打开或关闭时跟随其所在的面板移动。这绝不会在滚动时发生,且无论多少个区块发生变化,每帧最多只发生一次。调整大小时保留的状态(光标上的物品、滚动位置、已打开的区块、铁砧的名称)会被保留。概念。 -
容器区域区块仅在其内容可见时显示,因此那些自行隐藏的内容(例如不在当前打开菜单上的槽位库元素)会将其所在的区块一并隐藏。
ContainerRegion.Builder.title(...)在原版绘制容器标题的位置绘制区块标题。当资源包将某个标题留白而其他区块显示时,该区块以其所属容器命名,以便玩家仍能区分不同的容器。名称为其来源的自定义名称或其方块名称(如“青绿色潜影盒”),采用玩家的语言,或者对于没有对应方块的区块使用name(...)。配方。 -
容器界面面板上的标签页。
ContainerTabs.tab(id, scope)在容器区域面板的边缘放置一个标签页,类似于创造模式物品栏中的样式:edge(...)可以是容器列表的顶部(默认值)或底部,也可以是物品栏面板的顶部或底部。标签页的所有属性和行为均由模组定义,并逐帧读取:onClick(左键点击,伴随原版的点击音效)、图标(icon(Supplier<ItemStack>),或使用icon(Identifier)的模组自有精灵)、tooltip、order、visibleWhen、selectedWhen和disabledWhen(灰色显示,不可点击)。MenuKit 不维护任何选中状态。同一边缘上的所有模组的标签页共享一行,按order排序,彼此相邻且紧密相连。该行等同于原版的创造模式标签页,因此会遵循对其重新样式的资源包,且选中的标签页会展开至其框架内。它位于面板外部,从不覆盖任何槽位,区域会为其预留空间并将其计入界面的边界范围。超出可视范围的部分,行末的箭头每次翻动一个标签页;该行不接受滚轮操作。当区域未激活时(玩家物品栏、潜影盒、无区块显示的箱子、模组自带的容器界面),顶行位于屏幕自身框架的顶部边缘,底行位于其底部边缘,框架与两行作为一个整体居中,框架从原版的位置移动,伴随原版从中放置的所有内容,因此相同尺寸的界面会将该行置于同一位置。在区域的面板上,位于整体外侧边缘的行也与其居中。当一个界面替换另一个界面打开时,该行会保留其分页状态。概念,配方。 -
每个按键对应一个标签页。
ContainerTabs.keyed(id, scope, keys)声明一个标签页列表,其中每个keys提供的键对应一个标签页,每帧读取一次,因此模组可以为玩家打开的每一个箱子显示一个标签页,无论有多少个,且它们后面没有分隔区域。tab((key, tab) -> ...)在键出现的帧上设置每个键的标签页;只要该键存在,它就会保留,并且行所在的页面和选中的标签页会跟随其后保持在视图中。列表中的标签页按照列表的order和edge所指定的顺序排列,位于屏幕自身的框架或区域的面板上。随着之前标签页的出现和消失,行的页面始终保持在当前可见的第一个标签页上。概念。 -
标签页组。带有
header(...)的带键标签页列表是一个组:一个标题标签页及其后的键对应的标签页作为同一行上的较小子标签页。模组通过onClick决定点击标题时的行为,并通过expandedWhen(...)控制子标签页何时展开。MenuKit 会将它们从标题下方滑出到右侧,然后再滑回标题下方,两个方向的滑动都使用相同的缓动效果,如果在中途切换方向,则会从当前位置返回。如果滑动导致行页面变化,则同时打开箭头所在的空间,此时标签页要么完整显示,要么完全不显示。屏幕的第一帧会按原样显示所有组,不包含滑动效果。箭头用于翻阅已展开的标签页。带有pinnedWhen(...)的标题或子标签页在其条件满足时被固定:即使翻页经过它,它也会停留在其原本应离开的行的末尾,其后的标签页会移动到它后面,与该组的其它固定标签页并排,直到被下一个组的标题(位于左端)或前一个组的固定标签页(位于右端)推走为止。概念。 -
模组绘制的标签页大小和图标。
size(width, height)设置单个标签页的大小,tabSize(width, height)设置带键列表中所有标签页的大小。一行的高度由其最高的标签页决定,标签页精灵在任何尺寸下都能保持角部完整。icon(Icon)每帧在标签页的图标框内运行模组自身的绘制逻辑,当标签页变小时图标框也会缩小,因此图标可以是物品、精灵、动画或其他任何内容。物品和精灵形式填充相同的框体。 -
原版容器屏幕尺寸统一。潜影盒为 167 高,单箱、桶和末影箱为 168,而背包以及几乎所有其他容器屏幕均为 166,因此当一个屏幕替代另一个打开时,框架和玩家的背包位置保持不变。每个尺寸的箱子也都失去了原版在其图像下方保留的空行。
ScreenFrames.stretch(screen, seam, by)使模组自定义的屏幕在其布局的一行处变高或变矮,以匹配对应尺寸。概念。 -
替代打开的容器屏幕会将其框架从旧尺寸和位置平滑过渡到新尺寸和位置,耗时 0.15 秒,而非直接跳转。在资源包的视觉风格下,新屏幕的内容会立即显示在框架内部,边缘显示标签页行。适用于任何模组的屏幕,无需编写额外代码。
-
槽位物品的绘制样式。
SlotItemLooks.declare(id, look)允许模组指定任意容器屏幕上每个槽位、每帧所使用的ItemAnimation及其播放进度;数量显示、耐久条、高亮、工具提示和点击交互仍保持原版行为。ItemAnimation.OPEN_LID使用原版潜影盒和箱子物品渲染器所采用的开盖透明度来打开箱子盖子,采用资源包中的模型和纹理,模组也可以编写自己的实现。posed(...)可在播放过程中缩放和移动物品。Transition.of(millis, easing)基于键值设定播放时间,支持正向播放并保持,或反向播放,若中途改变方向则从当前位置返回;使用原版时钟计时(Transition.eachWay在反向时向 0 缓动,而正向时向 1 缓动,并非简单的曲线反转),因此当一个屏幕替代另一个打开时,可以接续已完成动画的位置继续播放。Easing提供四种曲线,任何函数均可作为缓动函数使用。概念。 -
运行时动态生成的容器区域分区。
ContainerRegion.sections(kind, scope, keys)声明一种分区类型,其中每个在当前屏幕上打开的键对应一个分区,每帧读取一次,因此模组可以显示玩家打开的所有箱子,而无需提前为每个箱子单独声明。每个键对应的分区在其出现时构建,在其消失时销毁;每个键对应的标签页可通过对相同键使用ContainerTabs.keyed来实现。概念。 -
适配式框架。
ContainerRegion.fitted(scope, screens)将容器列表与这些屏幕上的背包面板合并为一个框架,如同原版的图像一样,高度根据所需显示的分区自动调整,当分区较小时,整体高度小于屏幕自身容器部分的高度。标签页行位于列表顶部边缘,分区标题位于其下方,对应原版标题的位置。结合标签页、visibleWhen以及此功能,模组可以一次只显示一个容器,类似于创造模式背包中一次只显示一页的方式。 -
隐藏容器区域分区的槽位在客户端处于非活动状态(
Slot.isActive()为 false),因此不会有任何绘制、悬停提示或点击响应。尚未分配给任何分区的容器自身槽位被视为屏幕自身容器的第一个分区,其来源为空。ContainerRegion.openedOn()返回打开当前屏幕时所基于的容器,即其自身分区的来源。ContainerRegion.Builder.onHiddenLanding(...)在Shift+点击将物品放入隐藏分区时触发,以便模组进行相应处理;区域滚动仅能滚动至已显示分区内的槽位。 -
位于所有元素下方的面板。
Panel.Builder.background()可将面板设为屏幕背景的一部分。它会在屏幕绘制其图像的位置进行绘制,因此屏幕的小部件、标签和槽位、其他模组的小部件以及其他面板都会在其上方绘制。它不占用任何区域,因此上方的内容保持可交互状态;只有当屏幕的小部件拒绝点击后,该面板的元素才会获得点击响应;并且只有在所有内容都拒绝滚轮操作后,滚轮才会对其生效。它所显示的槽位会在其后立即绘制,并裁剪至面板范围内,因此槽位位于面板之上、所有小部件之下。按钮会遮挡住下方的槽位,而按钮上方的槽位则不会被悬停。每个槽位都会经过屏幕自身的extractSlot方法处理,因此其他模组的槽位标记依然可见。配方。 -
“面板外观”风格的面板遵循资源包设定。在容器屏幕上、“面板外观”风格的模组自有屏幕或对话框中,“面板外观”风格的面板会从资源包的箱子艺术图中提取边框、填充和槽位边框。这些素材从纹理中切割并平铺,绝不拉伸,且适配任意分辨率。在容器区域内,列表的每个部分都会使用其对应的容器纹理,因此箱子列表中展示的潜影盒看起来与其在自身屏幕上的显示一致,而背包面板则使用屏幕纹理的背包半区。无法干净切割的艺术素材(例如带纹理的填充)将保留 MenuKit 的默认外观;若无资源包,则无任何变化。模组无需做任何适配。资源包。
-
“面板外观”风格的控件遵循资源包对原版小部件的重绘效果。按钮、开关、下拉菜单、菜单按钮、颜色字段中的色块以及物品对话框中的控件,在资源包重绘了原版
widget/button贴图时,会使用原版贴图及原版标签颜色;复选框则使用原版的复选框贴图。资源包也可以通过menukit:panel_raised以及新增的menukit:control_raised、control_raised_highlighted、control_raised_pressed和control_raised_disabled直接为主题化 MenuKit,这些样式优先级高于原版。控件的所有状态均源自同一来源,若来源中缺少某状态的贴图,则该状态将从正常状态衍生而来,因此控件在不同状态下外观保持一致。资源包。 -
“面板外观”风格面板上的文本在任何资源包的填充背景下均可读。标题、正文和弱化文本在能够从填充背景中凸显出来时(正文文本对比度为 4.5:1)保持原有颜色,在无法凸显时则采用由填充背景派生的颜色。对于深色模式资源包,若其文本着色器会重绘原版的灰色标签,MenuKit 的灰色将留给该着色器处理。自定义元素可通过
AbstractPanelElement.textColor获取此行为。 -
容器区域的部分可以指定其所展示的容器。
ContainerRegion.Builder.source(...)用于命名该容器:对于已放置的实体,使用ContainerRegion.Source.of(BlockEntity);对于通过物品打开的容器,使用Source.of(ItemStack)(非方块物品不提供方块信息)。该部分从其源对象获取容器纹理和名称。未指定源的部分则为屏幕自身的容器,即打开屏幕时准星所指的方块(前提是屏幕持有与屏幕尺寸匹配的容器且屏幕具有标题)。 -
通过 OptiGUI 实现按部分的容器艺术图支持。安装 OptiGUI 2.x 后,MenuKit 会根据每个容器区域部分的源对象,评估资源包的 OptiGUI 和 OptiFine 规则,因此位于箱子下方的绿宝石盒子会应用绿宝石盒子的艺术图,而箱子则保留其自身的艺术图。未安装 OptiGUI 时,不会读取相关规则。配方。
-
ContainerRegion.Builder.texture(...)用于在没有源对象方块提供纹理的情况下,为部分指定容器纹理,例如模组自有的槽位组。可选值为ContainerRegion.CHEST(默认值)或ContainerRegion.SHULKER_BOX。源对象的方块优先级更高,因此潜影盒会使用潜影盒的纹理,而箱子、末影箱或桶则会使用箱子的纹理。ContainerRegion.GAP表示两个部分之间的间距,ContainerRegion.CONTENT_WIDTH表示滚动条出现前部分的宽度。Panel.isBackground()用于判断面板是否是通过background()构建的。 -
每个游戏模式一个放置位置。
ModeScope为SURVIVAL、CREATIVE或BOTH,从玩家的无限材料(创造模式拥有该权限)中读取,每帧读取一次,因此使用/gamemode命令并在屏幕打开时生效于下一帧。若无玩家参与,仅BOTH适用。这是 MenuKit 通用代码中的一个普通值,因此在服务端进行判断的库也使用相同类型。Panel.Builder.in(scope, placement)指定面板在每个模式中的位置,每个作用域声明一次。每帧面板采用当前模式的放置位置,否则采用其BOTH位置;若两者皆无,则在该模式中不显示。Placement.screen(position)相对于宿主自身的参考点,Placement.around(anchor, position)位于锚点盒周围的区域,Placement.at(anchor, dx, dy)位于盒的左上角加上偏移量,以自然尺寸显示,无堆叠、预算或裁剪限制。屏幕适配器将面板的锚定放置位置置于目标屏幕上的锚点宿主中,而AnchorPanelAdapter在放置位置命名了锚点时无需on(...)。Panel.placements()列出它们,getPosition()返回当前生效的位置。HudPanel.builder(id, scope)、OwnHost.add(panel, padding)和ContainerRegion.section(id, scope)是带作用域的形式。in与已弃用的position不能混用于同一个面板,每个作用域仅声明一次,两个面板若在生存或创造模式下都会显示main()(各自通过该模式的放置位置,否则为其BOTH位置),则在注册时抛出异常,指明两个面板及该模式。若AnchorPanelAdapter的面板具有Placement.screen(...)且无on(...),则在首次打开屏幕时抛出异常,指明面板及该模式,而不是在该模式中省略它。Panel.Builder.fixed()标记玩家无法移动的面板,Panel.isFixed()读取该状态。概念,配方。 -
OutsideRegion.LEFT_CENTER和RIGHT_CENTER位于参考点旁边,垂直居中于其上,如同TOP_CENTER和BOTTOM_CENTER分别位于其上方和下方,因此锚点盒(例如盔甲槽)旁边的列与盒的中间对齐。多个元素直接从参考点向外堆叠,每个均居中。现在每一侧都有一个起始对齐、居中和末尾对齐的区域。对OutsideRegion的switch表达式若无default分支,则需要涵盖这些区域(升级指南)。 -
对于槽位库,
SlotClip.clipOf(slot)返回槽位在屏幕空间中显示的矩形区域,若无裁剪则为null,以便库可以区分被滚动边缘截断的槽位与完全可见的槽位,例如隐藏锚定在被截断槽位上的面板。 -
PanelElement.renderCulled(ctx),每帧调用此方法替代render,用于因完全位于裁剪区域之外而被跳过的已显示元素,例如从ScrollContainer或ListView中滚出的一行,或超出视野的容器区域部分。这样槽位元素在不可见时仍可保持槽位停放,而不是将原版槽位发送回菜单自身的位置,否则会覆盖其他部分。隐藏的元素不会收到此调用。Flow、ScrollContainer、Section(开启时)、Tabs(其标题和显示页面)和ListView将其转发给它们的显示子项,ChildDispatch.renderCulled对自定义容器执行相同操作。概念。 -
共享面板。协同工作的模组将其元素放入同一个面板。每个模组通过其客户端初始化程序使用
SharedPanels.join(id, contribution)加入面板,使用约定的 ID(普通字符串)。Contribution携带其元素、顺序号、其模式作用域及其自身的visibleWhen,以及面板自身的声明(每种模式的放置位置、样式、轴和间距)。MenuKit 在客户端启动时构建面板一次,贡献按顺序和模组 ID 排列在一个流中。隐藏或超出作用域者,或其所有元素均被隐藏者,不占用空间;若全部隐藏,则不放置该面板。当贡献者在声明上存在分歧时,最低顺序者的声明胜出,并警告涉及的两个模组。具有屏幕放置位置的共享面板会在所有容器屏幕上显示。仅安装一个模组时,它表现为普通面板。概念,配方。 -
玩家可移动面板。默认未绑定的“移动面板”键可为当前打开的屏幕开启编辑模式,或在游戏内 HUD 上方显示一个用于清除/重置的屏幕。在编辑模式下,面板会显示轮廓,且其他元素无法被点击。拖拽即可移动面板,适用于所有游戏模式;按住 Shift 仅对当前模式生效;右键点击可将面板恢复原位;按 Esc 或该键即可完成操作。位置会根据屏幕每个轴上最近的三分之一区域进行保存,因此能适应窗口大小调整和 GUI 缩放变化,并按面板 ID 存储在
config/menukit/panel-positions.json中。如果 MenuKit 无法读取某条记录,则跳过该条目并保留其余部分。如果文件完全不是 JSON 格式,则将其保留在原处并重命名为panel-positions.json.corrupt。如果文件完全无法读取(如被锁定或无权限),则保持原样,直到下次启动前都不会保存任何移动操作。已移动的面板仅在其声明位置显示,并脱离其所在区域的流动布局。当包含该面板的屏幕关闭时,编辑模式结束,正在进行的拖拽操作会被丢弃且未保存。如果文本字段拥有键盘焦点,或者控制设置屏幕正在等待绑定,则该键无效。Panel.Builder.fixed()、HudPanel.Builder.fixed()和Contribution.Builder.fixed()可使面板固定在模组设定的位置。背景面板、叠加层、弹出层以及屏幕的主面板均不可移动,循环条也是固定的。概念。 -
一个插槽网格,当其内容超出面板范围时会在面板内部滚动。
SlotScroll.builder()可从插槽库的元素创建此类网格,每个单元格对应一个元素,每个元素由其索引和位置定义(cells(count, cell))。在有空间时,其高度与活动行数一致;当空间不足时,整行整行地缩减高度,但绝不会低于minRows(3);随后开始滚动。作为容器区域的一部分,当窗口高度足够时显示所有行,一旦过短则开始滚动。narrows()可在滚动时将列数减少一行,将滚动条置于腾出的列中,适用于不允许加宽面板的情况;否则,滚动条车道位于其旁边,框架随之加宽。liveCount(...)以最后一个活动的插槽作为结束点,每帧读取一次。Shift+单击已滚出视图的行中的插槽,会将视图滚动至该行。概念,配方。 -
原版屏幕自身的网格在框架无法容纳时会滚动,这由模组启用。
ScreenFrames.scrollsWhenShort(scope, screens)接受指定的屏幕(例如大型工作台):当某个屏幕的框架及其标签行总高度超过窗口上下各留 4 像素后的剩余高度时,其自身的容器网格会在适配的框架内滚动,而标题栏、物品栏和快捷栏保持固定。当窗口足够大以至于框架可以完全容纳时,屏幕呈现为原版像素级效果;如果没有相关声明,网格不会滚动(标准的 166 像素高度和移动的框架无论如何都会保留)。网格中的插槽是原版自带的,每个插槽都在其绘制位置显示,因此食谱查看器和读取slot.x/y的模组都能找到它们。 -
一个适应空间的滚动区域。
ScrollContainer.Builder.fitRoom(step)创建一个滚动区域,在有空间时其高度与内容一致,并在空间不足时以完整的步长缩减高度,但绝不会低于声明的高度,前提是容器发出请求:在容器区域部分中,当窗口高度足够时显示所有行,仅当此类网格处于最小状态时才由列表自身滚动。laneOutside()将滚动条车道置于声明宽度的旁边,仅在滚动时占用该空间,并使区域框架相应加宽。 -
ScrollContainer.scrolls()表示滚动区域当前是否正在滚动(即其内容高度大于视口高度),ContainerRegion.scrolls(screen)表示屏幕上的容器列表或其内部的某个网格是否在滚动:只要其中任一条件为真,该区域上方的滚轮就属于滚动控件,因此使用滚轮切换标签页的模组在此处不会干扰滚动。
已更改
- 容器区域绝不会出现在玩家自身的物品栏(生存或创造模式)中,无论某部分的
targeting如何设置。玩家物品栏的槽位是从菜单持有的槽位中每帧移动放置的,因此另一个模组在屏幕打开时添加的槽位也会随物品栏面板一起移动,而关闭屏幕时会精确移回之前移动的槽位。 - 容器区域部分的内容会根据该部分的宽度进行布局,即九个槽位宽(
ContainerRegion.CONTENT_WIDTH),因此会在此处换行(水平Flow、槽位库中的换行槽位行、长标签等),而不是在一行内继续延伸。 SlotClip.panelShowing(slot)根据槽位的容器、索引和类来保留最后显示该槽位的面板,因此为相同位置重新创建的槽位(例如切换标签页时的创造模式物品栏槽位)会保留其答案。当另一个容器屏幕打开时,此信息会被遗忘,因此玩家物品栏槽位(在每个屏幕上都是相同的槽位)不会将一个屏幕的面板带到下一个屏幕。- 点击容器屏幕上的某个小部件永远不会被当作点击槽位面板的间隙或被滚动边缘裁剪掉的隐藏槽位部分。小部件会接收该点击。
- 完全位于其绘制裁剪区域之外的元素会在每个深度都被跳过,不仅限于
ScrollContainer的子元素。滚动区域内的Flow中的一行槽位在不可见时不会被绘制,因此其槽位库会将其停放,且没有任何被滚动的内容会覆盖超出边缘的部分,例如滚动网格下方的物品栏。具有打开弹出窗口的元素仍会被绘制。自定义元素如果在其自身边界框外绘制,当其边界框完全位于裁剪区域之外时(包括溢出部分),不会被绘制(升级指南)。 - 一个槽位在一个帧内被两个面板显示时,属于最顶层的面板(即同时接受两者点击的面板),在所有方面均如此。它在顶层面板之后绘制,位于其位置及其裁剪区域内。在此之前,它随下层面板绘制,尽管其悬停状态、裁剪区域和
SlotClip.panelShowing遵循上层面板。MenuKit 会为每对冲突的面板记录一次日志。 - Panel 外观的提升控件现在使用 MenuKit 新的
menukit:control_raised精灵图,而不是menukit:panel_raised,因此资源包可以分别定制面板和控件的外观。如果资源包覆盖了panel_raised以重设 MenuKit 按钮的外观,现在应改为覆盖control_raised。在没有资源包的情况下,它们看起来与以前一样。 - 按住按钮时的按下外观(包括 MenuKit 自带的和原版的)是一个相对于按钮艺术素材绘制的单一变换,因此它能很好地适配资源包的深色或彩色按钮以及原版按钮。在原版的按钮上,它与旧的按下外观几乎一致,仅在斜面等级上有几级的差异。
SlotRendering.drawSlotBackground在 Panel 外观的面板上绘制 18x18 的槽位,使用资源包的槽位图像,从容器艺术素材或其重设样式的container/slot中裁剪。在其他地方则按之前的方式绘制。
已弃用
这些功能仍然有效,等效于 ModeScope.BOTH,并将在 8.0.0 版本中移除。升级指南。
Panel.Builder.position(position)已被in(ModeScope.BOTH, Placement.screen(position))取代。AnchorPanelAdapter.on(anchors)已被放置中的锚点取代,即Placement.around(anchor, position)。HudPanel.builder(id)已被HudPanel.builder(id, scope)取代。OwnHost.add(panel, position, padding)已被OwnHost.add(panel, padding)取代,后者会读取面板的放置配置。
7.4.0
此版本为新增功能:容器区域、背景面板、跟随资源包的面板外观、按游戏模式划分的放置方式、多个模组共享的面板,以及玩家可移动的面板。未移除任何内容,为 7.3.0 构建的模组照常工作,仅有两个例外情况 升级 名称。无游戏模式的表单已弃用。现在,通过 menukit:panel_raised 为主题化 MenuKit 按钮的资源包改为使用 menukit:control_raised 进行主题化。
新增
-
在容器界面的物品栏上方有一个可滚动的列。
ContainerRegion.section(id, scope)向界面的容器区域添加一个区块:箱子自身的网格、其下方打开的一个箱子、再下方的另一个箱子,所有这些堆叠在一个位于玩家物品栏上方的单列中。每个界面只有一个区域,无论有多少模组向其添加内容。界面变为两个面板,每个面板都有各自的框架:容器列表(带有位于其框架内的滚动条)和位于其下方的物品栏面板(永不滚动)。列表在滚动之前会先增长。当两个面板都能容纳时,它们作为一个整体保持在屏幕中央,列表顶部向上移动,物品栏面板向下移动增量的二分之一(如果窗口高度不足以容纳原版边距,则空间较少的一侧保持不动,直到该整体居中)。只有当它们触及屏幕的上下边距时,列表才会通过共享的滚动条以像素为单位滚动。调整大小时会重新布局,且列表的高度永远不会小于屏幕自身容器部分的高度。界面的leftPos、topPos、imageWidth和imageHeight始终是围绕这两个面板的矩形,因此菜单框架上的其他面板、其他模组的按钮以及配方查看器都会环绕这两个面板放置,且手持物品点击两者之间的间隙不会丢弃任何物品;原版的物品栏槽位和标签随物品栏面板移动,读取leftPos + slot.x的模组定位也会落在对应的槽位上。ContainerRegion.CONTAINERS和ContainerRegion.INVENTORY分别是每个面板的锚点。ContainerRegion.anchor(sectionId)是单个区块的锚点,以便按钮可以放置在列表中的每个箱子旁边,并在其所属区块隐藏或滚出视图时隐藏。滚轮可以在屏幕的任何位置滚动该区域,但仅在未用于其他操作的转动时才生效,因此在槽位上方使用滚轮移动物品的模组保留该行为,配方查看器的列表也是如此。Shift+点击其中一个已滚出视图的槽位会滚动至该处,手持物品拖曳至其顶部或底部边缘也会触发滚动,越靠近边缘滚动越快。两个面板均作为界面的背景。界面上的所有内容,包括其他模组的按钮和配方查看器,都绘制在它们以及该区域的槽位之上,且它们不会阻挡任何内容。在该区域显示时,界面的背景照常运行,包括其他模组在其内部的钩子。仅排除原版自身的容器纹理和界面标题,由面板和各区块的标题取而代之。概念,配方。 -
当界面打开期间布局发生变化时(类似于窗口调整大小时的行为,即调用屏幕自身大小的
Screen.resize),容器区域会重新进行界面布局。每个模组都会从其自身的初始化钩子中根据新的边界重新添加其组件,因此屏幕边缘的另一个模组的按钮会在区块打开或关闭时跟随其所在的面板移动。这绝不会在滚动时发生,且无论多少个区块发生变化,每帧最多只发生一次。调整大小时保留的状态(光标上的物品、滚动位置、已打开的区块、铁砧的名称)会被保留。概念。 -
容器区域区块仅在其内容可见时显示,因此那些自行隐藏的内容(例如不在当前打开菜单上的槽位库元素)会将其所在的区块一并隐藏。
ContainerRegion.Builder.title(...)在原版绘制容器标题的位置绘制区块标题。当资源包将某个标题留白而其他区块显示时,该区块以其所属容器命名,以便玩家仍能区分不同的容器。名称为其来源的自定义名称或其方块名称(如“青绿色潜影盒”),采用玩家的语言,或者对于没有对应方块的区块使用name(...)。配方。 -
容器界面面板上的标签页。
ContainerTabs.tab(id, scope)在容器区域面板的边缘放置一个标签页,类似于创造模式物品栏中的样式:edge(...)可以是容器列表的顶部(默认值)或底部,也可以是物品栏面板的顶部或底部。标签页的所有属性和行为均由模组定义,并逐帧读取:onClick(左键点击,伴随原版的点击音效)、图标(icon(Supplier<ItemStack>),或使用icon(Identifier)的模组自有精灵)、tooltip、order、visibleWhen、selectedWhen和disabledWhen(灰色显示,不可点击)。MenuKit 不维护任何选中状态。同一边缘上的所有模组的标签页共享一行,按order排序,彼此相邻且紧密相连。该行等同于原版的创造模式标签页,因此会遵循对其重新样式的资源包,且选中的标签页会展开至其框架内。它位于面板外部,从不覆盖任何槽位,区域会为其预留空间并将其计入界面的边界范围。超出可视范围的部分,行末的箭头每次翻动一个标签页;该行不接受滚轮操作。当区域未激活时(玩家物品栏、潜影盒、无区块显示的箱子、模组自带的容器界面),顶行位于屏幕自身框架的顶部边缘,底行位于其底部边缘,框架与两行作为一个整体居中,框架从原版的位置移动,伴随原版从中放置的所有内容,因此相同尺寸的界面会将该行置于同一位置。在区域的面板上,位于整体外侧边缘的行也与其居中。当一个界面替换另一个界面打开时,该行会保留其分页状态。概念,配方。 -
每个按键对应一个标签页。
ContainerTabs.keyed(id, scope, keys)声明一个标签页列表,其中每个keys提供的键对应一个标签页,每帧读取一次,因此模组可以为玩家打开的每一个箱子显示一个标签页,无论有多少个,且它们后面没有分隔区域。tab((key, tab) -> ...)在键出现的帧上设置每个键的标签页;只要该键存在,它就会保留,并且行所在的页面和选中的标签页会跟随其后保持在视图中。列表中的标签页按照列表的order和edge所指定的顺序排列,位于屏幕自身的框架或区域的面板上。随着之前标签页的出现和消失,行的页面始终保持在当前可见的第一个标签页上。概念。 -
标签页组。带有
header(...)的带键标签页列表是一个组:一个标题标签页及其后的键对应的标签页作为同一行上的较小子标签页。模组通过onClick决定点击标题时的行为,并通过expandedWhen(...)控制子标签页何时展开。MenuKit 会将它们从标题下方滑出到右侧,然后再滑回标题下方,两个方向的滑动都使用相同的缓动效果,如果在中途切换方向,则会从当前位置返回。如果滑动导致行页面变化,则同时打开箭头所在的空间,此时标签页要么完整显示,要么完全不显示。屏幕的第一帧会按原样显示所有组,不包含滑动效果。箭头用于翻阅已展开的标签页。带有pinnedWhen(...)的标题或子标签页在其条件满足时被固定:即使翻页经过它,它也会停留在其原本应离开的行的末尾,其后的标签页会移动到它后面,与该组的其它固定标签页并排,直到被下一个组的标题(位于左端)或前一个组的固定标签页(位于右端)推走为止。概念。 -
模组绘制的标签页大小和图标。
size(width, height)设置单个标签页的大小,tabSize(width, height)设置带键列表中所有标签页的大小。一行的高度由其最高的标签页决定,标签页精灵在任何尺寸下都能保持角部完整。icon(Icon)每帧在标签页的图标框内运行模组自身的绘制逻辑,当标签页变小时图标框也会缩小,因此图标可以是物品、精灵、动画或其他任何内容。物品和精灵形式填充相同的框体。 -
原版容器屏幕尺寸统一。潜影盒为 167 高,单箱、桶和末影箱为 168,而背包以及几乎所有其他容器屏幕均为 166,因此当一个屏幕替代另一个打开时,框架和玩家的背包位置保持不变。每个尺寸的箱子也都失去了原版在其图像下方保留的空行。
ScreenFrames.stretch(screen, seam, by)使模组自定义的屏幕在其布局的一行处变高或变矮,以匹配对应尺寸。概念。 -
替代打开的容器屏幕会将其框架从旧尺寸和位置平滑过渡到新尺寸和位置,耗时 0.15 秒,而非直接跳转。在资源包的视觉风格下,新屏幕的内容会立即显示在框架内部,边缘显示标签页行。适用于任何模组的屏幕,无需编写额外代码。
-
槽位物品的绘制样式。
SlotItemLooks.declare(id, look)允许模组指定任意容器屏幕上每个槽位、每帧所使用的ItemAnimation及其播放进度;数量显示、耐久条、高亮、工具提示和点击交互仍保持原版行为。ItemAnimation.OPEN_LID使用原版潜影盒和箱子物品渲染器所采用的开盖透明度来打开箱子盖子,采用资源包中的模型和纹理,模组也可以编写自己的实现。posed(...)可在播放过程中缩放和移动物品。Transition.of(millis, easing)基于键值设定播放时间,支持正向播放并保持,或反向播放,若中途改变方向则从当前位置返回;使用原版时钟计时(Transition.eachWay在反向时向 0 缓动,而正向时向 1 缓动,并非简单的曲线反转),因此当一个屏幕替代另一个打开时,可以接续已完成动画的位置继续播放。Easing提供四种曲线,任何函数均可作为缓动函数使用。概念。 -
运行时动态生成的容器区域分区。
ContainerRegion.sections(kind, scope, keys)声明一种分区类型,其中每个在当前屏幕上打开的键对应一个分区,每帧读取一次,因此模组可以显示玩家打开的所有箱子,而无需提前为每个箱子单独声明。每个键对应的分区在其出现时构建,在其消失时销毁;每个键对应的标签页可通过对相同键使用ContainerTabs.keyed来实现。概念。 -
适配式框架。
ContainerRegion.fitted(scope, screens)将容器列表与这些屏幕上的背包面板合并为一个框架,如同原版的图像一样,高度根据所需显示的分区自动调整,当分区较小时,整体高度小于屏幕自身容器部分的高度。标签页行位于列表顶部边缘,分区标题位于其下方,对应原版标题的位置。结合标签页、visibleWhen以及此功能,模组可以一次只显示一个容器,类似于创造模式背包中一次只显示一页的方式。 -
隐藏容器区域分区的槽位在客户端处于非活动状态(
Slot.isActive()为 false),因此不会有任何绘制、悬停提示或点击响应。尚未分配给任何分区的容器自身槽位被视为屏幕自身容器的第一个分区,其来源为空。ContainerRegion.openedOn()返回打开当前屏幕时所基于的容器,即其自身分区的来源。ContainerRegion.Builder.onHiddenLanding(...)在Shift+点击将物品放入隐藏分区时触发,以便模组进行相应处理;区域滚动仅能滚动至已显示分区内的槽位。 -
位于所有元素下方的面板。
Panel.Builder.background()可将面板设为屏幕背景的一部分。它会在屏幕绘制其图像的位置进行绘制,因此屏幕的小部件、标签和槽位、其他模组的小部件以及其他面板都会在其上方绘制。它不占用任何区域,因此上方的内容保持可交互状态;只有当屏幕的小部件拒绝点击后,该面板的元素才会获得点击响应;并且只有在所有内容都拒绝滚轮操作后,滚轮才会对其生效。它所显示的槽位会在其后立即绘制,并裁剪至面板范围内,因此槽位位于面板之上、所有小部件之下。按钮会遮挡住下方的槽位,而按钮上方的槽位则不会被悬停。每个槽位都会经过屏幕自身的extractSlot方法处理,因此其他模组的槽位标记依然可见。配方。 -
“面板外观”风格的面板遵循资源包设定。在容器屏幕上、“面板外观”风格的模组自有屏幕或对话框中,“面板外观”风格的面板会从资源包的箱子艺术图中提取边框、填充和槽位边框。这些素材从纹理中切割并平铺,绝不拉伸,且适配任意分辨率。在容器区域内,列表的每个部分都会使用其对应的容器纹理,因此箱子列表中展示的潜影盒看起来与其在自身屏幕上的显示一致,而背包面板则使用屏幕纹理的背包半区。无法干净切割的艺术素材(例如带纹理的填充)将保留 MenuKit 的默认外观;若无资源包,则无任何变化。模组无需做任何适配。资源包。
-
“面板外观”风格的控件遵循资源包对原版小部件的重绘效果。按钮、开关、下拉菜单、菜单按钮、颜色字段中的色块以及物品对话框中的控件,在资源包重绘了原版
widget/button贴图时,会使用原版贴图及原版标签颜色;复选框则使用原版的复选框贴图。资源包也可以通过menukit:panel_raised以及新增的menukit:control_raised、control_raised_highlighted、control_raised_pressed和control_raised_disabled直接为主题化 MenuKit,这些样式优先级高于原版。控件的所有状态均源自同一来源,若来源中缺少某状态的贴图,则该状态将从正常状态衍生而来,因此控件在不同状态下外观保持一致。资源包。 -
“面板外观”风格面板上的文本在任何资源包的填充背景下均可读。标题、正文和弱化文本在能够从填充背景中凸显出来时(正文文本对比度为 4.5:1)保持原有颜色,在无法凸显时则采用由填充背景派生的颜色。对于深色模式资源包,若其文本着色器会重绘原版的灰色标签,MenuKit 的灰色将留给该着色器处理。自定义元素可通过
AbstractPanelElement.textColor获取此行为。 -
容器区域的部分可以指定其所展示的容器。
ContainerRegion.Builder.source(...)用于命名该容器:对于已放置的实体,使用ContainerRegion.Source.of(BlockEntity);对于通过物品打开的容器,使用Source.of(ItemStack)(非方块物品不提供方块信息)。该部分从其源对象获取容器纹理和名称。未指定源的部分则为屏幕自身的容器,即打开屏幕时准星所指的方块(前提是屏幕持有与屏幕尺寸匹配的容器且屏幕具有标题)。 -
通过 OptiGUI 实现按部分的容器艺术图支持。安装 OptiGUI 2.x 后,MenuKit 会根据每个容器区域部分的源对象,评估资源包的 OptiGUI 和 OptiFine 规则,因此位于箱子下方的绿宝石盒子会应用绿宝石盒子的艺术图,而箱子则保留其自身的艺术图。未安装 OptiGUI 时,不会读取相关规则。配方。
-
ContainerRegion.Builder.texture(...)用于在没有源对象方块提供纹理的情况下,为部分指定容器纹理,例如模组自有的槽位组。可选值为ContainerRegion.CHEST(默认值)或ContainerRegion.SHULKER_BOX。源对象的方块优先级更高,因此潜影盒会使用潜影盒的纹理,而箱子、末影箱或桶则会使用箱子的纹理。ContainerRegion.GAP表示两个部分之间的间距,ContainerRegion.CONTENT_WIDTH表示滚动条出现前部分的宽度。Panel.isBackground()用于判断面板是否是通过background()构建的。 -
每个游戏模式一个放置位置。
ModeScope为SURVIVAL、CREATIVE或BOTH,从玩家的无限材料(创造模式拥有该权限)中读取,每帧读取一次,因此使用/gamemode命令并在屏幕打开时生效于下一帧。若无玩家参与,仅BOTH适用。这是 MenuKit 通用代码中的一个普通值,因此在服务端进行判断的库也使用相同类型。Panel.Builder.in(scope, placement)指定面板在每个模式中的位置,每个作用域声明一次。每帧面板采用当前模式的放置位置,否则采用其BOTH位置;若两者皆无,则在该模式中不显示。Placement.screen(position)相对于宿主自身的参考点,Placement.around(anchor, position)位于锚点盒周围的区域,Placement.at(anchor, dx, dy)位于盒的左上角加上偏移量,以自然尺寸显示,无堆叠、预算或裁剪限制。屏幕适配器将面板的锚定放置位置置于目标屏幕上的锚点宿主中,而AnchorPanelAdapter在放置位置命名了锚点时无需on(...)。Panel.placements()列出它们,getPosition()返回当前生效的位置。HudPanel.builder(id, scope)、OwnHost.add(panel, padding)和ContainerRegion.section(id, scope)是带作用域的形式。in与已弃用的position不能混用于同一个面板,每个作用域仅声明一次,两个面板若在生存或创造模式下都会显示main()(各自通过该模式的放置位置,否则为其BOTH位置),则在注册时抛出异常,指明两个面板及该模式。若AnchorPanelAdapter的面板具有Placement.screen(...)且无on(...),则在首次打开屏幕时抛出异常,指明面板及该模式,而不是在该模式中省略它。Panel.Builder.fixed()标记玩家无法移动的面板,Panel.isFixed()读取该状态。概念,配方。 -
OutsideRegion.LEFT_CENTER和RIGHT_CENTER位于参考点旁边,垂直居中于其上,如同TOP_CENTER和BOTTOM_CENTER分别位于其上方和下方,因此锚点盒(例如盔甲槽)旁边的列与盒的中间对齐。多个元素直接从参考点向外堆叠,每个均居中。现在每一侧都有一个起始对齐、居中和末尾对齐的区域。对OutsideRegion的switch表达式若无default分支,则需要涵盖这些区域(升级指南)。 -
对于槽位库,
SlotClip.clipOf(slot)返回槽位在屏幕空间中显示的矩形区域,若无裁剪则为null,以便库可以区分被滚动边缘截断的槽位与完全可见的槽位,例如隐藏锚定在被截断槽位上的面板。 -
PanelElement.renderCulled(ctx),每帧调用此方法替代render,用于因完全位于裁剪区域之外而被跳过的已显示元素,例如从ScrollContainer或ListView中滚出的一行,或超出视野的容器区域部分。这样槽位元素在不可见时仍可保持槽位停放,而不是将原版槽位发送回菜单自身的位置,否则会覆盖其他部分。隐藏的元素不会收到此调用。Flow、ScrollContainer、Section(开启时)、Tabs(其标题和显示页面)和ListView将其转发给它们的显示子项,ChildDispatch.renderCulled对自定义容器执行相同操作。概念。 -
共享面板。协同工作的模组将其元素放入同一个面板。每个模组通过其客户端初始化程序使用
SharedPanels.join(id, contribution)加入面板,使用约定的 ID(普通字符串)。Contribution携带其元素、顺序号、其模式作用域及其自身的visibleWhen,以及面板自身的声明(每种模式的放置位置、样式、轴和间距)。MenuKit 在客户端启动时构建面板一次,贡献按顺序和模组 ID 排列在一个流中。隐藏或超出作用域者,或其所有元素均被隐藏者,不占用空间;若全部隐藏,则不放置该面板。当贡献者在声明上存在分歧时,最低顺序者的声明胜出,并警告涉及的两个模组。具有屏幕放置位置的共享面板会在所有容器屏幕上显示。仅安装一个模组时,它表现为普通面板。概念,配方。 -
玩家可移动面板。默认未绑定的“移动面板”键可为当前打开的屏幕开启编辑模式,或在游戏内 HUD 上方显示一个用于清除/重置的屏幕。在编辑模式下,面板会显示轮廓,且其他元素无法被点击。拖拽即可移动面板,适用于所有游戏模式;按住 Shift 仅对当前模式生效;右键点击可将面板恢复原位;按 Esc 或该键即可完成操作。位置会根据屏幕每个轴上最近的三分之一区域进行保存,因此能适应窗口大小调整和 GUI 缩放变化,并按面板 ID 存储在
config/menukit/panel-positions.json中。如果 MenuKit 无法读取某条记录,则跳过该条目并保留其余部分。如果文件完全不是 JSON 格式,则将其保留在原处并重命名为panel-positions.json.corrupt。如果文件完全无法读取(如被锁定或无权限),则保持原样,直到下次启动前都不会保存任何移动操作。已移动的面板仅在其声明位置显示,并脱离其所在区域的流动布局。当包含该面板的屏幕关闭时,编辑模式结束,正在进行的拖拽操作会被丢弃且未保存。如果文本字段拥有键盘焦点,或者控制设置屏幕正在等待绑定,则该键无效。Panel.Builder.fixed()、HudPanel.Builder.fixed()和Contribution.Builder.fixed()可使面板固定在模组设定的位置。背景面板、叠加层、弹出层以及屏幕的主面板均不可移动,循环条也是固定的。概念。 -
一个插槽网格,当其内容超出面板范围时会在面板内部滚动。
SlotScroll.builder()可从插槽库的元素创建此类网格,每个单元格对应一个元素,每个元素由其索引和位置定义(cells(count, cell))。在有空间时,其高度与活动行数一致;当空间不足时,整行整行地缩减高度,但绝不会低于minRows(3);随后开始滚动。作为容器区域的一部分,当窗口高度足够时显示所有行,一旦过短则开始滚动。narrows()可在滚动时将列数减少一行,将滚动条置于腾出的列中,适用于不允许加宽面板的情况;否则,滚动条车道位于其旁边,框架随之加宽。liveCount(...)以最后一个活动的插槽作为结束点,每帧读取一次。Shift+单击已滚出视图的行中的插槽,会将视图滚动至该行。概念,配方。 -
原版屏幕自身的网格在框架无法容纳时会滚动,这由模组启用。
ScreenFrames.scrollsWhenShort(scope, screens)接受指定的屏幕(例如大型工作台):当某个屏幕的框架及其标签行总高度超过窗口上下各留 4 像素后的剩余高度时,其自身的容器网格会在适配的框架内滚动,而标题栏、物品栏和快捷栏保持固定。当窗口足够大以至于框架可以完全容纳时,屏幕呈现为原版像素级效果;如果没有相关声明,网格不会滚动(标准的 166 像素高度和移动的框架无论如何都会保留)。网格中的插槽是原版自带的,每个插槽都在其绘制位置显示,因此食谱查看器和读取slot.x/y的模组都能找到它们。 -
一个适应空间的滚动区域。
ScrollContainer.Builder.fitRoom(step)创建一个滚动区域,在有空间时其高度与内容一致,并在空间不足时以完整的步长缩减高度,但绝不会低于声明的高度,前提是容器发出请求:在容器区域部分中,当窗口高度足够时显示所有行,仅当此类网格处于最小状态时才由列表自身滚动。laneOutside()将滚动条车道置于声明宽度的旁边,仅在滚动时占用该空间,并使区域框架相应加宽。 -
ScrollContainer.scrolls()表示滚动区域当前是否正在滚动(即其内容高度大于视口高度),ContainerRegion.scrolls(screen)表示屏幕上的容器列表或其内部的某个网格是否在滚动:只要其中任一条件为真,该区域上方的滚轮就属于滚动控件,因此使用滚轮切换标签页的模组在此处不会干扰滚动。
已更改
- 容器区域绝不会出现在玩家自身的物品栏(生存或创造模式)中,无论某部分的
targeting如何设置。玩家物品栏的槽位是从菜单持有的槽位中每帧移动放置的,因此另一个模组在屏幕打开时添加的槽位也会随物品栏面板一起移动,而关闭屏幕时会精确移回之前移动的槽位。 - 容器区域部分的内容会根据该部分的宽度进行布局,即九个槽位宽(
ContainerRegion.CONTENT_WIDTH),因此会在此处换行(水平Flow、槽位库中的换行槽位行、长标签等),而不是在一行内继续延伸。 SlotClip.panelShowing(slot)根据槽位的容器、索引和类来保留最后显示该槽位的面板,因此为相同位置重新创建的槽位(例如切换标签页时的创造模式物品栏槽位)会保留其答案。当另一个容器屏幕打开时,此信息会被遗忘,因此玩家物品栏槽位(在每个屏幕上都是相同的槽位)不会将一个屏幕的面板带到下一个屏幕。- 点击容器屏幕上的某个小部件永远不会被当作点击槽位面板的间隙或被滚动边缘裁剪掉的隐藏槽位部分。小部件会接收该点击。
- 完全位于其绘制裁剪区域之外的元素会在每个深度都被跳过,不仅限于
ScrollContainer的子元素。滚动区域内的Flow中的一行槽位在不可见时不会被绘制,因此其槽位库会将其停放,且没有任何被滚动的内容会覆盖超出边缘的部分,例如滚动网格下方的物品栏。具有打开弹出窗口的元素仍会被绘制。自定义元素如果在其自身边界框外绘制,当其边界框完全位于裁剪区域之外时(包括溢出部分),不会被绘制(升级指南)。 - 一个槽位在一个帧内被两个面板显示时,属于最顶层的面板(即同时接受两者点击的面板),在所有方面均如此。它在顶层面板之后绘制,位于其位置及其裁剪区域内。在此之前,它随下层面板绘制,尽管其悬停状态、裁剪区域和
SlotClip.panelShowing遵循上层面板。MenuKit 会为每对冲突的面板记录一次日志。 - Panel 外观的提升控件现在使用 MenuKit 新的
menukit:control_raised精灵图,而不是menukit:panel_raised,因此资源包可以分别定制面板和控件的外观。如果资源包覆盖了panel_raised以重设 MenuKit 按钮的外观,现在应改为覆盖control_raised。在没有资源包的情况下,它们看起来与以前一样。 - 按住按钮时的按下外观(包括 MenuKit 自带的和原版的)是一个相对于按钮艺术素材绘制的单一变换,因此它能很好地适配资源包的深色或彩色按钮以及原版按钮。在原版的按钮上,它与旧的按下外观几乎一致,仅在斜面等级上有几级的差异。
SlotRendering.drawSlotBackground在 Panel 外观的面板上绘制 18x18 的槽位,使用资源包的槽位图像,从容器艺术素材或其重设样式的container/slot中裁剪。在其他地方则按之前的方式绘制。
已弃用
这些功能仍然有效,等效于 ModeScope.BOTH,并将在 8.0.0 版本中移除。升级指南。
Panel.Builder.position(position)已被in(ModeScope.BOTH, Placement.screen(position))取代。AnchorPanelAdapter.on(anchors)已被放置中的锚点取代,即Placement.around(anchor, position)。HudPanel.builder(id)已被HudPanel.builder(id, scope)取代。OwnHost.add(panel, position, padding)已被OwnHost.add(panel, padding)取代,后者会读取面板的放置配置。
关于这个资源的讨论、问题反馈与使用心得
还没有讨论,来发第一帖吧
你是这个资源的作者?登录后可认领此资源。
相似资源
模组
一个用于收集生物掉落物的多区块模组。
模组
显示你正在注视的方块的信息。(适用于 Minecraft 1.16+ 的 Hwyla/Waila 分支)
模组
使用 JavaScript 编辑配方、添加自定义物品、编写世界事件!
模组
查看物品与配方
模组
在游戏画面角落显示附近世界地形、玩家、生物和实体的地图。可创建路径点,帮助你找到标记过的位置。
模组
AE2:一款流行的自动化与存储模组
评论 0
登录后参与评分
还没有评论,来抢沙发吧