Placeholders
All placeholders require PlaceholderAPI and use the %battlepass_ prefix.
Progress
| Placeholder | Description |
|---|---|
%battlepass_tier% | The player's current tier |
%battlepass_max_tier% | The highest tier configured |
%battlepass_xp% | XP earned toward the next tier |
%battlepass_xp_required% | XP the next tier needs |
%battlepass_progress% | Progress toward the next tier, as a percentage |
%battlepass_pass% | The player's pass, as a display name |
%battlepass_pass_id% | The player's pass, as an id for comparisons |
%battlepass_playtime% | Tracked playtime, in raw form |
%battlepass_playtime_formatted% | Tracked playtime, formatted for display |
%battlepass_boost% | The passive farming-XP boost the player's pets grant right now, in percentage points at one decimal (48.0 for x1.48, 0.4 for a level-1 pet, 0.0 with nothing equipped). Since 2.4.0 |
%battlepass_boost_factor% | The same boost as the raw multiplier (1.48, 1.004, 1). Since 2.4.0 |
The two boost placeholders read the live pet integrations - the exact value the farming drain pays with - and are not tied to the player's pass data, so they answer from the first tick after a join. A player with no matching pet equipped is not an error: their boost is simply 0.0.
Challenge slots
| Placeholder | Description |
|---|---|
%battlepass_challenges_ready% | How many challenge slots the player can roll right now - the same count the unrolled-challenge reminder nudges them with, so a scoreboard line and the chat line can never disagree. Only slots inside challenges.slots count. Since 2.5.0 |
%battlepass_challenge_<n>_<field>% reads one challenge slot, where <n> is the slot number starting at 1. Note the singular challenge_ here against the plural challenges_ready above.
| Field | Description |
|---|---|
state | Whether the slot is empty, running, finished or cooling down |
type | The challenge type in the slot |
name | The challenge display name |
progress | How far the player has come |
target | What the challenge asks for |
reward | The XP the challenge pays |
percent | Progress as a percentage |
expires | Time left before the challenge expires |
cooldown | Time left on the slot's cooldown |
For example, %battlepass_challenge_1_percent% gives the completion percentage of the first slot.
Field names are not case sensitive, so %battlepass_challenge_1_STATE% and %battlepass_challenge_1_state% resolve the same way.