Skip to content

插件变量

LyMailReload 提供 PlaceholderAPI 变量,用于读取玩家当前的邮箱数据与界面状态。

使用条件

  • 服务器必须安装并启用 PlaceholderAPI。
  • LyMailReload 会在启动时检测 PlaceholderAPI;未启用时不会注册变量扩展。
  • 变量标识符为 lmail
  • 变量必须在存在玩家上下文的位置使用,无法取得玩家时返回空字符串。

变量列表

变量返回内容无数据时
%lmail_amount%玩家邮箱内当前保存的邮件数量0
%lmail_has_模板ID%玩家是否曾收到过指定模板邮件未收到返回 0
%lmail_now_mail%玩家在邮箱界面中当前选中邮件的索引-1

邮箱数量

%lmail_amount% 返回玩家邮箱内当前存在的邮件总数。

邮件被领取或过期删除后,数量会随之减少。玩家数据尚未加载或不存在时返回 0

收件记录

变量格式:

text
%lmail_has_模板ID%

模板ID 替换为邮件模板中的 id。例如模板配置为:

yaml
id: 'test'

对应变量为 %lmail_has_test%

返回值含义
1玩家曾经收到过该模板邮件
0玩家从未收到过该模板邮件,或玩家数据尚未加载

该变量读取的是玩家的历史收件记录,不是检查邮箱内是否仍然存在这封邮件。邮件已经领取或过期删除后,只要历史收件记录仍然存在,变量仍返回 1

模板邮件成功发送到玩家邮箱时,插件会立即增加对应模板的收件次数。因此,玩家不需要先领取附件,变量也会返回 1

当前选中邮件

%lmail_now_mail% 返回玩家在邮箱 GUI 中当前选中邮件的索引。

返回值含义
0 或更大的整数当前选中邮件在完整邮箱列表中的索引
-1当前没有选中邮件

索引从 0 开始计算,不是从 1 开始。邮箱每页显示 27 封邮件,但该变量记录的是完整邮件列表中的索引,不是当前页面内的槽位编号。

以下情况会返回 -1

  • 玩家尚未点击选择邮件。
  • 玩家关闭了邮箱界面。
  • 玩家领取了当前邮件,选中状态被清除。
  • 邮箱界面刷新时取消了当前选择。

邮件列表按照到期时间从早到晚排列,因此邮件被领取、删除或重新排序后,索引可能发生变化。

返回异常

当使用了已注册但无法识别的 lmail 参数时,插件返回红色的“错误”文本。请检查变量名称、下划线和模板 ID 是否正确。