蓝钦的文档

深浅模式

CooPay PlaceholderAPI 变量参考 ​

更新: 2026/8/14 字数: 0 字 时长: 0 分钟

使用前提 ​

  • 安装 PlaceholderAPI 插件。
  • 所有变量均以 %CooPay_ 开头。
  • 表格中的 <礼包ID> 需要替换为 rewards.yml 中的实际礼包 ID。
  • 表格中的 <奖励ID> 需要替换为 total_pay_rewards 下的实际档位 ID。

充值与排行榜变量 ​

变量返回内容
%CooPay_player_pay%当前玩家的累计充值金额
%CooPay_top_name_<n>%全服赞助榜第 n 名玩家名，n 支持 1 至 10
%CooPay_top_pay_<n>%全服赞助榜第 n 名累计充值金额，n 支持 1 至 10

礼包变量 ​

变量返回内容
%CooPay_kit_cooldown_text_<礼包ID>%当前玩家的剩余冷却，格式为 XdXhXm；无冷却或已到期时为空
%CooPay_kit_cooldown_seconds_<礼包ID>%当前玩家的剩余冷却秒数，正数向上取整；无冷却或已到期时为 0
%CooPay_kit_price_<礼包ID>%礼包价格
%CooPay_kit_player_bought_<礼包ID>%当前玩家已购买该礼包的累计次数
%CooPay_kit_global_bought_<礼包ID>%全服已购买该礼包的累计次数
%CooPay_kit_player_limit_<礼包ID>%个人累计购买上限；不限购时为 -1
%CooPay_kit_global_limit_<礼包ID>%全服累计购买上限；不限购时为 -1
%CooPay_kit_player_remaining_<礼包ID>%当前玩家剩余可购次数；不限购时为 -1，已用尽时为 0
%CooPay_kit_global_remaining_<礼包ID>%全服剩余可购次数；不限购时为 -1，已用尽时为 0
%CooPay_kit_has_permission_<礼包ID>%在线玩家是否同时拥有 coopay.buy 和礼包配置的额外权限，返回 true 或 false

旧变量 %CooPay_refresh_time_<礼包ID>% 继续兼容，返回值与 %CooPay_kit_cooldown_text_<礼包ID>% 相同。新配置建议使用语义更明确的 kit_cooldown_text 变量。

累充奖励变量 ​

变量返回内容
%CooPay_totalpay_grant_mode%当前发放模式：auto 或 claim
%CooPay_totalpay_unclaimed_count%当前玩家可领取的档位数量；auto 模式下恒为 0
%CooPay_totalpay_next_id%当前玩家下一个未达到的档位 ID；全部达到时为空
%CooPay_totalpay_next_amount%当前玩家下一个未达到的档位金额；全部达到时为空
%CooPay_totalpay_reward_amount_<奖励ID>%指定档位要求的累计充值金额
%CooPay_totalpay_reward_claimed_<奖励ID>%当前玩家是否已领取该档位，返回 true 或 false
%CooPay_totalpay_reward_unlocked_<奖励ID>%当前玩家是否已达到该档位，返回 true 或 false
%CooPay_totalpay_reward_can_claim_<奖励ID>%当前玩家是否可手动领取该档位，返回 true 或 false；仅 claim 模式可能为 true
%CooPay_totalpay_reward_status_<奖励ID>%档位状态：locked、claimable 或 claimed

返回规则 ​

限购不会随冷却重置

limit 和 global_limit 记录的是累计购买次数。refresh_time 只控制玩家两次成功购买之间的个人冷却，不会重置已购买次数。

  • 礼包 ID 支持下划线，变量匹配时忽略大小写。
  • rewards.yml 中的礼包 ID 必须唯一，不能同时存在 VIP 和 vip 这类仅大小写不同的 ID。
  • %CooPay_player_pay%、player_bought、player_remaining、冷却变量和权限变量需要玩家上下文。
  • kit_has_permission 对离线目标玩家或无效礼包返回 false。
  • 购买数据首次从数据库异步载入时，相关变量可能短暂返回空字符串；后续解析会返回实际值。
  • 无效礼包除权限变量外返回空字符串。
  • 累充奖励 ID 支持字母、数字、下划线和横线，变量匹配时忽略大小写。
  • totalpay_grant_mode 和档位金额不需要玩家上下文；其余累充奖励变量需要玩家上下文。
  • 累充金额或领取记录首次异步载入时，玩家相关的累充奖励变量可能短暂返回空字符串。
  • 无效奖励 ID 的档位金额和状态返回空字符串，三个布尔变量返回 false。