插件变量
LyWarehouse 提供 PlaceholderAPI 变量，可用于菜单、计分板、聊天格式等支持 PlaceholderAPI 的插件。
使用本页变量需要安装 PlaceholderAPI。变量标识符为 lyck，无需另外下载变量扩展。玩家数据尚未加载时，大部分变量会返回空文本。
变量列表
| 变量 | 返回内容 | 返回示例 |
|---|---|---|
%lyck_now_warehouse% | 玩家当前打开的仓库 ID。未处于仓库界面时返回空文本 | 仓库1 |
%lyck_now_warehouse_mode% | 玩家当前打开的仓库界面模式 | 存储、分解、出售、删除、总览 |
%lyck_unlock:仓库ID% | 指定仓库是否已经解锁 | true、false |
%lyck_empty_slot_all% | 玩家全部已解锁仓库的剩余空槽位总数 | 数字 |
%lyck_empty_slot:仓库ID% | 指定仓库的剩余空槽位数量 | 数字 |
%lyck_amount:物品名% | 玩家全部仓库内指定物品的总数量 | 数字 |
%lyck_slot_amount:仓库ID:槽位ID% | 指定仓库、指定槽位内保存的物品数量 | 数字或配置的默认值 |
%lyck_autopick% | 玩家是否开启拾取物品自动入库 | §a启用中、§7未启用 |
%lyck_autofj_分解组ID% | 指定自动分解组是否开启 | true、false |
%lyck_autosell_出售组ID% | 指定自动出售组是否开启 | true、false |
当前仓库与模式
当前仓库 ID
text
%lyck_now_warehouse%该变量读取玩家当前打开的 LyWarehouse 仓库界面，并返回对应的仓库 ID，例如 仓库1。
玩家未打开 LyWarehouse 仓库界面时返回空文本。该变量适合放在具体仓库界面中，不应依赖它读取仓库总览界面的仓库 ID。
当前仓库模式
text
%lyck_now_warehouse_mode%变量会根据玩家当前打开的界面返回以下中文文本：
| 界面 | 返回值 |
|---|---|
| 普通仓库界面 | 存储 |
| 分解模式界面 | 分解 |
| 出售模式界面 | 出售 |
| 删除模式界面 | 删除 |
| 仓库总览界面 | 总览 |
| 未打开受支持的 LyWarehouse 界面 | 空文本 |
返回值是固定的简体中文文本，可直接用于菜单状态显示或条件判断。
解锁状态
text
%lyck_unlock:仓库ID%将 仓库ID 替换为 config.yml 中 warehouse 节点下的仓库 ID。
| 示例 | 说明 |
|---|---|
%lyck_unlock:仓库1% | 判断玩家是否已经解锁 仓库1 |
%lyck_unlock:材料仓库% | 判断玩家是否已经解锁 材料仓库 |
已经解锁时返回 true，未解锁时返回 false。仓库 ID 必须与配置中的名称完全一致。
剩余槽位
全部仓库空槽位
text
%lyck_empty_slot_all%返回玩家全部已解锁仓库的剩余空槽位总数。物品数量不会影响槽位统计，一个已经保存物品的槽位会被视为已占用槽位。
指定仓库空槽位
text
%lyck_empty_slot:仓库ID%返回指定仓库的剩余空槽位数量。
| 示例 | 说明 |
|---|---|
%lyck_empty_slot:仓库1% | 返回 仓库1 的剩余空槽位数量 |
%lyck_empty_slot:装备仓库% | 返回 装备仓库 的剩余空槽位数量 |
仓库 ID 必须与配置中的仓库 ID 完全一致。
物品数量
按物品名称统计
text
%lyck_amount:物品名%返回玩家全部已解锁仓库内匹配物品的数量总和，不限制具体仓库和槽位。
匹配规则如下：
- 参数与物品的 Bukkit 材质名称一致时，统计该材质的数量。
- 物品存在自定义名称时，也会按完整显示名称进行匹配。
- 参数中的
&颜色代码会转换为 Minecraft 颜色字符后再进行比较。 - 自定义名称采用完整相等匹配，不是关键词包含匹配。
| 示例 | 说明 |
|---|---|
%lyck_amount:DIAMOND% | 统计材质名称为 DIAMOND 的物品数量 |
%lyck_amount:&6金币% | 统计完整显示名称为 &6金币 的物品数量 |
该变量统计的是仓库内部记录的真实数量。即使界面通过配置隐藏物品数量，也不会影响变量结果。
按仓库槽位统计
text
%lyck_slot_amount:仓库ID:槽位ID%返回指定仓库指定槽位内物品的数量。
| 示例 | 说明 |
|---|---|
%lyck_slot_amount:仓库1:0% | 返回 仓库1 第 0 槽位的物品数量 |
%lyck_slot_amount:材料仓库:8% | 返回 材料仓库 第 8 槽位的物品数量 |
槽位 ID 使用程序内部槽位编号，从 0 开始计算。若仓库不存在、槽位为空或无法读取数量，则返回 config.yml 中 papi-slot-amount-default-value 的内容；该配置默认值为 0。
yaml
papi-slot-amount-default-value: '0'可以将默认值改为其他文本，例如：
yaml
papi-slot-amount-default-value: '无物品'自动拾取状态
text
%lyck_autopick%该变量对应玩家通过 /lyck autopick 切换的拾取自动入库状态。
| 状态 | 返回值 |
|---|---|
| 已开启 | §a启用中 |
| 未开启 | §7未启用 |
此变量不会返回 true 或 false，而是返回带颜色的中文状态文本。若目标菜单插件不识别 § 颜色字符，需要由目标插件自行处理颜色显示。
自动拾取功能还受到 config.yml 中 pickup-to-warehouse-enable 配置控制。该配置用于控制插件是否启用拾取物品自动入库机制，玩家变量则表示玩家个人保存的开关状态。
自动分解状态
text
%lyck_autofj_分解组ID%将 分解组ID 替换为 config.yml 中 auto-decompose-item 节点下的分解组名称。
| 示例 | 说明 |
|---|---|
%lyck_autofj_垃圾分解% | 判断玩家是否开启 垃圾分解 自动分解组 |
%lyck_autofj_装备分解% | 判断玩家是否开启 装备分解 自动分解组 |
玩家已开启指定分解组时返回 true，否则返回 false。
自动分解组通过以下指令切换：
text
/lyck autofj 分解组ID玩家需要拥有对应权限：
text
lyck.autofj.分解组ID变量只反映玩家是否启用了对应组。物品实际进入仓库后，还需要满足分解组的 Lore 匹配规则，并且存在可用的分解配置，才会执行自动分解。
自动出售状态
text
%lyck_autosell_出售组ID%将 出售组ID 替换为 config.yml 中 auto-sell-item 节点下的出售组名称。
| 示例 | 说明 |
|---|---|
%lyck_autosell_垃圾出售% | 判断玩家是否开启 垃圾出售 自动出售组 |
%lyck_autosell_材料出售% | 判断玩家是否开启 材料出售 自动出售组 |
玩家已开启指定出售组时返回 true，否则返回 false。
自动出售组通过以下指令切换：
text
/lyck autosell 出售组ID玩家需要拥有对应权限：
text
lyck.autosell.出售组ID变量只反映玩家是否启用了对应组。物品实际进入仓库后，还需要满足出售组的 Lore 匹配规则，并且出售插件能够成功处理该物品，才会执行自动出售。
返回值说明
| 情况 | 返回结果 |
|---|---|
| 玩家对象不存在 | 空文本 |
| 玩家仓库数据尚未加载 | 空文本 |
| 当前未打开受支持的仓库界面 | 当前界面类变量返回空文本 |
| 自动分解组未开启 | false |
| 自动出售组未开启 | false |
| 未识别的 LyWarehouse 变量参数 | §c错误 |
在登录流程、跨服菜单或异步加载较慢的环境中，变量可能在玩家数据加载完成前短暂返回空文本。菜单条件应允许空文本出现，避免将其直接视为已解锁或已启用。