插件变量
LyOptimize 提供 PlaceholderAPI 变量,用于读取玩家当前的显示与屏蔽设置。变量可用于菜单按钮、计分板、HUD 或其他支持 PlaceholderAPI 的界面。
使用条件
- 服务器需要安装 PlaceholderAPI。
- PlaceholderAPI 在
plugin.yml中属于软依赖;未安装时,LyOptimize 的基础功能仍可运行,但本页变量无法使用。 - 变量标识符为
lo。 - 变量需要在具有玩家上下文的位置使用,用于读取对应玩家自己的设置。
- 如果传入的玩家对象为空,或玩家数据尚未载入,变量返回空字符串。
- 如果启用 MySQL 数据存储,必须安装 LyMySQLCore,并确保数据库连接成功;否则依赖玩家数据的相关功能不会生效。
变量列表
| 变量 | 对应设置 | 屏蔽时返回 | 显示时返回 |
|---|---|---|---|
%lo_player% | 其他玩家显示 | §7屏蔽 | §a显示 |
%lo_obp% | 其他暴雪粒子 | §7屏蔽 | §a显示 |
%lo_sbp% | 自身暴雪粒子 | §7屏蔽 | §a显示 |
%lo_mbp% | 怪物暴雪粒子 | §7屏蔽 | §a显示 |
%lo_par% | Minecraft 原版粒子效果 | §7屏蔽 | §a显示 |
%lo_model% | 模型显示 | §7屏蔽 | §a显示 |
%lo_message% | 自定义消息显示 | §7屏蔽 | §a显示 |
返回值说明
所有已登记变量使用相同的状态格式:
| 返回值 | 含义 |
|---|---|
§7屏蔽 | 玩家已经关闭或屏蔽对应内容 |
§a显示 | 玩家允许显示或接收对应内容 |
| 空字符串 | 没有玩家上下文,或该玩家的数据尚未载入 |
§c错误 | 使用了 lo 标识符下未登记的变量参数 |
返回值包含 Minecraft 原生颜色符号 §。变量展示位置是否解析颜色,由调用变量的插件或界面决定。
变量对应关系
玩家与模型
%lo_player%:对应其他玩家显示开关。%lo_model%:对应模型显示开关。
粒子效果
%lo_obp%:对应其他暴雪粒子开关。%lo_sbp%:对应自身暴雪粒子开关。%lo_mbp%:对应怪物暴雪粒子开关。%lo_par%:对应 Minecraft 原版粒子效果开关。
自定义消息
%lo_message%:对应自定义消息显示开关。- 该开关用于玩家可控的自定义消息屏蔽功能。
- 服务器强制屏蔽的自定义消息不由该玩家开关控制。
使用格式
变量统一使用以下格式:
text
%lo_<变量参数>%可用的变量参数为:
| 参数 | 完整变量 |
|---|---|
player | %lo_player% |
obp | %lo_obp% |
sbp | %lo_sbp% |
mbp | %lo_mbp% |
par | %lo_par% |
model | %lo_model% |
message | %lo_message% |
变量参数必须使用表格中的登记名称。未登记的参数不会读取其他设置,而是返回 §c错误。
注意事项
- 变量只读取当前状态,不会修改玩家设置。
- 变量读取的是调用时玩家上下文对应的玩家数据,不是固定读取服务器或控制台状态。
- 控制台、静态文本或其他不支持玩家上下文的场景,可能返回空字符串。
- 玩家数据尚未载入时,所有变量都会返回空字符串。
%lo_par%表示 Minecraft 原版粒子效果状态。配置文件注释中的“原版粒子粒子”是重复表述,不代表另一个独立变量。- 启用 MySQL 存储时,必须安装 LyMySQLCore 并成功连接数据库,依赖数据库中玩家数据的相关功能才会生效。