Skip to content
On this page

插件指令

ChaUI 的主指令是 /chaui,也可以使用简写 /cui。指令用于打开编辑器、向玩家展示页面、管理世界页面实例,以及重新载入页面配置。

大部分管理指令需要由服务器控制台或拥有管理员权限的玩家执行。编辑器指令只能由游戏内玩家使用,并且需要编辑权限。

查看指令帮助

直接输入:

text
/chaui

游戏会列出当前可用的子指令和参数提示。

打开页面编辑器

text
/chaui editor <页面ID>

页面已经存在时会打开对应页面;页面不存在时,会以这个 ID 创建一个空白页面并进入编辑器。

例如:

text
/chaui editor welcome

页面 ID 会同时作为页面文件名使用。建议选择简短、容易识别的名称。

打开普通页面或 HUD

text
/chaui open <玩家> <页面ID>

这个指令用于打开 screen 普通页面和 hud 页面。世界页面需要使用专门的世界页面指令。

打开世界页面

使用页面中已经保存的位置、缩放和朝向:

text
/chaui openworld <玩家> <页面ID> <实例ID>

临时覆盖页面位置和朝向:

text
/chaui openworld <玩家> <页面ID> <实例ID> <x> <y> <z> <yaw>

yaw 可以填写有限数字,也可以填写 follow_player,让页面始终水平朝向当前玩家。实例 ID 是当前玩家全部世界页面共用的实例名称,可以使用纯数字、中文或常用符号,例如 111大厅提示宝箱-1

实例 ID 按玩家全局唯一

只要实例 ID 不同,同一个世界页面就能在多个位置同时打开。使用已经存在的实例 ID 打开任意世界页面时,旧实例会先正常关闭,再由新页面替换。不同玩家可以各自使用相同的实例 ID。

关闭页面

在玩家当前普通 GUI 或容器替换 GUI 上方打开一层 screen 子页面:

text
/chaui opensub <玩家> <页面ID>

只关闭当前最上层子页面:

text
/chaui closesub <玩家>

子页面最多叠加 8 层,不能把当前父子链里已经存在的页面再次打开。父页面和子页面默认都可以点击;模态遮罩由子页面自己的 pointerEvents: block 组件控制。完整示例见在 GUI 上打开子页面

关闭普通页面、HUD 或世界实例

关闭普通页面或 HUD:

text
/chaui close <玩家> <页面ID>

关闭指定世界页面实例:

text
/chaui closeworld <玩家> <实例ID>

世界实例 ID 在同一玩家当前打开的全部世界页面中全局唯一。关闭时只需填写打开时使用的实例 ID,不需要再填写页面 ID。

世界页面中的按钮同样支持准星悬浮和左、右、中键事件。按钮脚本使用无参数 关闭() / close() 时,会关闭当前被点击的世界实例。

播放页面音效

text
/chaui sound <玩家> <页面ID> <音效路径>

音效路径相对于客户端的 resourcepacks/ChaUI/ 目录,例如 sounds/click.ogg。目标客户端必须已经拥有对应的 OGG 文件。

重置玩家的组件位置

当玩家希望恢复页面作者设置的默认位置时,可以重置这个玩家在当前服务器下记住的全部组件位置:

text
/chaui resetpositions <玩家>

目标玩家必须在线,并且客户端已经完成 ChaUI 就绪握手。成功后,当前打开页面中的对应组件会立即回到原始布局位置;以后再次打开页面也不会继续使用旧记忆。这个操作不会修改页面 yml,不会重置其他玩家,也不会删除该玩家在其他服务器中的位置记录。

如果只想重置当前页面中的某一个组件,可以在按钮脚本中使用 component("组件ID").resetPosition()。完整用法见组件对象、布局公式与临时组件

重新载入 ChaUI

text
/chaui reload

重新载入页面与插件配置。当前已经打开的普通页面、HUD 和世界页面会按完整关闭后重新打开的方式刷新,因此页面生命周期事件也会正常执行。

常见问题

提示玩家不在线

检查玩家名是否完全一致,并确认目标玩家已经进入服务器。

提示页面不存在

先在 plugins/ChaUI/pages/ 中确认页面文件存在,或使用编辑器创建并保存页面,然后重新载入 ChaUI。

普通打开指令不能打开世界页面

这是正常的。世界页面支持位置、朝向和多实例,需要使用 openworld

世界页面实例 ID 提示不合法

实例 ID 不能为空,最多 64 个 Unicode 字符,并且不能包含换行等控制字符。纯数字 ID 可以直接使用。

页面打开了但图片缺失

指令只负责打开页面,不会分发客户端素材。请按照客户端安装中的目录说明检查素材。