菜单配置
1303 字约 4 分钟
MyCompany 将菜单布局与菜单文本分开存放在两个地方:
plugins/MyCompany/menu/<菜单 id>.yml—— 背包大小、物品图标与槽位plugins/MyCompany/lang/<语言>.yml—— 所有标题、物品名称与 lore
所有菜单文件都遵循两条规则:
- 菜单文本只在语言文件中配置,菜单文件里不写文本。 菜单文件只负责“显示哪个物品”和“显示在哪个位置”。
- 菜单文件没有固定的物品清单。
items下的每个 key 就是一个物品;添加任意物品时,只要给它material和槽位,再到语言文件补上文本即可。额外物品不需要任何功能,可以用来做装饰或说明。
文件结构
menu/main.yml
size: 45
items:
# 特殊填充物品,下文会说明
default:
material: BLACK_STAINED_GLASS_PANE
user_info:
material: PLAYER_HEAD;%player%
slot: 3
company_info:
material: DIAMOND
slot: 4
balance:
material: GOLD_INGOT
slot: 5| 键 | 说明 |
|---|---|
size | 背包大小。必须是 9 的倍数,范围 9 到 54。 |
items | 必需。下面的每个 key 都会成为一个菜单物品。 |
default | 特殊物品:绘制菜单时会跳过它,只用它填充所有空槽。它的文本不会从语言文件读取。 |
material | 每个物品必需。Bukkit 材料名称。名称无效时会变成 AIR,物品不可见。 |
slot | 单个槽位编号。 |
slots | 槽位列表。没有设置 slot 时使用,例如给多个槽位画边框。 |
options | 可选,用于菜单自己的数字选项,例如每页数量。 |
物品必须至少有一个槽位才会被绘制。只有 material、没有 slot 或 slots 的 key 会被加载,但不会显示。
文本路径
语言路径由菜单 id 和物品 id 拼成:
| 文本 | 语言路径 |
|---|---|
| 菜单标题 | menu.<菜单 id>.title |
| 物品名称 | menu.<菜单 id>.items.<物品 id>.display_name |
| 物品 lore | menu.<菜单 id>.items.<物品 id>.lore |
| 点击提示(可选) | menu.<菜单 id>.actions.<action>.<click> |
例如,menu/main.yml 中的 balance 物品对应:
lang/zh_CN.yml
menu:
main:
title: '&b%company% &a公司菜单'
items:
balance:
display_name: '&a财产'
lore:
- ''
- '&7公司目前拥有 &e$%cash%'
- ''注意:
- 颜色代码使用
&,例如&a、&c、&7;十六进制颜色使用&#RRGGBB。 - 菜单 id 与物品 id 区分大小写,语言路径必须与它们完全一致。
- 菜单代码会传入
%company%、%player%、%cash%、%position%等占位符;编辑已有文本时请保留这些占位符。 - 包含
#remove#的 lore 行会被隐藏,用于只在某些情况下显示的点击提示。 - 物品名称的键是
display_name(下划线),不是display-name。
添加装饰物品
添加一个没有功能的物品只需要改两处。
菜单文件:
menu/main.yml
items:
info_note:
material: PAPER
slot: 40语言文件:
lang/zh_CN.yml
menu:
main:
items:
info_note:
display_name: '&e如何赚取收入'
lore:
- '&7完成员工订单,并'
- '&7创建箱子商店。'这样物品就会带着文本出现在第 40 格。它的 id(info_note)没有对应任何菜单动作,因此点击它不会有配置好的效果。 这是添加装饰、分隔线或一段说明文字最简单的方式,不需要改动任何代码。
如果想让一个物品覆盖多个槽位,使用 slots:
items:
border:
material: GRAY_STAINED_GLASS_PANE
slots: [0, 1, 2, 3, 4, 5, 6, 7, 8]玩家头颅可以使用 PLAYER_HEAD;<玩家名> 形式:
items:
head:
material: PLAYER_HEAD;%player%
slot: 10每页数量
列表类菜单从 options 读取每页数量:
| 菜单 | 选项 |
|---|---|
position、position_list | position-per-page |
focus | expertise-per-page |
focus_list | focus-per-page |
personnel | personnel-per-page |
player_list | player-per-page |
orders | order-per-page |
area_list、area_rent_market、area_sale_market | area-per-page |
position_permission_list | permission-per-page |
数值不要超过按钮之外剩余槽位的数量。
菜单文件清单
插件只加载固定列表中的菜单文件。新增一个 .yml 文件不会变成新菜单;请使用以下 id:
| 文件 | 内容 |
|---|---|
main | 公司主菜单 |
found | 创建公司界面 |
confirmation | 确认对话框 |
personnel | 公司员工列表 |
player_list | 用于招聘的在线玩家列表 |
position、position_list、position_permission_list | 职位管理 |
chestshop | 箱子商店菜单 |
internal_store | 内部商店 |
orders | 员工订单 |
focus、focus_list | Focus 与专精菜单 |
areas、area_list | 公司领地面板 |
area_trade_market、area_rent_market、area_sale_market | 领地市场 |
应用修改
/myc reload会重新读取语言文件和菜单文件,包括新增物品和修改后的槽位。menus.yml不同:它只保存全局无权限图标(global.no-perm),只在启动时读取。修改后需要重启服务器。- 缺失的菜单文件会从插件 jar 重新生成;已有文件不会被更新覆盖。
常见问题
| 现象 | 原因 |
|---|---|
| 菜单打不开,或控制台报错 | size 缺失,或不是 9 到 54 之间、9 的倍数;也可能是某个物品的槽位超出了 size。 |
| 物品没有出现 | 物品没有 slot 或 slots,或者材料无效变成了 AIR。 |
| 物品没有文本 | 语言路径与菜单 id、物品 id 不匹配,或 key 拼写不同。 |
标题显示 Please update the language file. | 缺少 menu.<菜单 id>.title。 |
| 新增的菜单文件没有生效 | 只加载内置的菜单 id;请把物品加到已有菜单文件里。 |
| 修改没有生效 | 执行 /myc reload;menus.yml 则需要重启服务器。 |