自定义界面 1.20.4

学习如何给你的模组创建自定义界面。

WARNING

本页面适用于 1.20.4 版本。 针对旧版本的文档可能不完整。

INFO

本文所述均指一般的、未涉及同步的界面，这类界面是由玩家独自在客户端打开的，不需要服务端的参与。

界面是指玩家可以交互的 GUI，比如标题界面、暂停界面等。

您可以创建自己的界面来展示自定义内容、自定义配置目录等。

创建界面

要创建界面，您需要继承 Screen 类并覆写 init 方法。您可能还需要覆写 render 方法，但是请保证调用 super.render， 否则背景和组件都不会渲染。

您需要注意：

• 组件不应该在 Screen 的构造方法里创建，因为此时界面还没有初始化，并且某些变量（比如界面的宽 width 和高 height）也还没有正确地初始化。
• 当界面正在初始化时，init 方法将被调用，这是创建组件对象的最佳时机。
  • 您可以通过 addRenderableWidget 方法来添加组件，这个方法接收任何实现了 Renderable 和 GuiEventListener 接口的组件对象。
• render 方法将在每一帧被调用，您可以在这个方法里获取诸多上下文，比如鼠标的位置。

举个例子，我们可以创建一个简单的界面，这个界面有一个按钮和一个按钮的标签。

No lines matched.

打开界面

您可以使用 MinecraftClient 类的 setScreen 方法来打开您的界面。您可以在许多地方做这件事，比如当一个按键触发时，当一条命令执行时，或者当客户端收到一个网络包时。

Minecraft.getInstance().setScreen(
  new CustomScreen(Component.empty())
);

关闭界面

当您想要关闭界面时，只需将界面设为 null 即可：

Minecraft.getInstance().setScreen(null);

如果您希望在关闭界面时回退到上一个界面，您可以将当前界面对象传入自定义的 CustomScreen 构造方法，把它保存为字段，然后覆写 close 方法，将实现修改为 this.client.setScreen(/* 您保存的上一个界面 */) 即可。

No lines matched.

现在，当您按照上面的步骤打开界面时，您可以给构造方法的第二个参数传入当前界面对象，这样当您调用 CustomScreen#close 的时候，游戏就会回到上一个界面。

Screen currentScreen = Minecraft.getInstance().currentScreen;
Minecraft.getInstance().setScreen(
  new CustomScreen(Component.empty(), currentScreen)
);