跳到正文

YuPay PlaceholderAPI

YuPay 注册的 PlaceholderAPI 标识为 yupay,占位符格式为 %yupay_<占位符>%。带 <time> 的占位符使用毫秒作为时间窗口,例如 86400000 表示最近 24 小时。

玩家占位符

占位符返回值用法示例
%yupay_is_banned%true / false,玩家是否被禁止赞助。条件菜单隐藏赞助按钮
%yupay_total%玩家累计成功赞助金额,保留两位小数。128.00
%yupay_total_orders%玩家订单总数。个人资料面板
%yupay_success_orders%玩家成功订单数。赞助历史统计
%yupay_rank%玩家赞助排名;未上榜返回语言文件中的未上榜文本。排行榜菜单
%yupay_has_paid_in_<time>%最近一段时间是否有成功赞助。%yupay_has_paid_in_86400000%
%yupay_recent_amount_gt_<time>_<amount>%最近一段时间成功赞助额是否大于阈值。%yupay_recent_amount_gt_604800000_50%
%yupay_orders_in_<time>%最近一段时间订单数。%yupay_orders_in_86400000%
%yupay_success_orders_in_<time>%最近一段时间成功订单数。%yupay_success_orders_in_86400000%
%yupay_amount_in_<time>%最近一段时间成功赞助金额。%yupay_amount_in_2592000000%
%yupay_is_limited%玩家今日累计是否达到 max-daily-amountfalse
%yupay_daily_remaining%今日剩余可赞助金额;未设置日限额时返回 088.00
%yupay_lang%玩家语言。离线玩家默认 zh_cnzh_cn
%yupay_pay_methods_count%当前可用支付方式数量。2
%yupay_pay_methods_list%当前可用支付方式列表。wechat, alipay

服务器占位符

占位符返回值
%yupay_server_total%全服累计成功赞助金额。
%yupay_server_total_orders%全服订单总数。
%yupay_server_success_orders%全服成功订单数。
%yupay_server_orders_in_<time>%最近一段时间全服订单数。
%yupay_server_success_orders_in_<time>%最近一段时间全服成功订单数。
%yupay_server_amount_in_<time>%最近一段时间全服成功赞助金额。

排行榜占位符

占位符返回值
%yupay_top_<rank>_name%rank 名玩家名,支持 1-10。
%yupay_top_<rank>_amount%rank 名累计金额,支持 1-10。
%yupay_top1_name%旧格式兼容,第 1 名玩家名。
%yupay_top1_amount%旧格式兼容,第 1 名累计金额。

卡密占位符

占位符返回值
%yupay_code_total%卡密总数。
%yupay_code_active%启用中的卡密数。
%yupay_code_<code>_status%卡密状态;会动态返回 EXPIREDDEPLETED
%yupay_code_<code>_amount%卡密关联金额。
%yupay_code_<code>_economy_type%卡密经济类型。
%yupay_code_<code>_economy_amount%卡密经济奖励数量。
%yupay_code_<code>_used%已核销次数。
%yupay_code_<code>_max_uses%最大核销次数。
%yupay_code_<code>_expire%过期时间戳;永不过期返回 -1
%yupay_code_<code>_expire_formatted%格式化过期时间。
%yupay_code_<code>_remark%卡密备注。
%yupay_code_<code>_locked%卡密是否处于核销锁定中。
%yupay_code_<code>_redeemed%当前玩家是否已核销该卡密。
%yupay_code_<code>_can_redeem%当前玩家是否可核销该卡密。

展示示例

text
今日赞助:%yupay_amount_in_86400000% 元
赞助榜第一:%yupay_top_1_name% - %yupay_top_1_amount% 元
FREEGIFT 状态:%yupay_code_FREEGIFT_status%
FREEGIFT 是否可核销:%yupay_code_FREEGIFT_can_redeem%

使用建议

  • 菜单和计分板建议使用玩家占位符与服务器占位符,不要频繁刷新卡密动态变量。
  • <time> 统一使用毫秒;1 天是 86400000,7 天是 604800000,30 天可用 2592000000
  • 排行榜页面可组合 %yupay_top_1_name%%yupay_top_10_amount%