Placeholders
AstralLeaderboards registers one root placeholder plus three chainable object namespaces. All-time is the implicit default window: %leaderboards_<id>_entries% and %leaderboards_<id>_playerEntry% read the ALL_TIME bucket directly (kept for backwards compatibility), while _allTime/_weekly/_monthly give an explicit view into any of the three windows.
leaderboards_<id> (root)
%leaderboards_<id>% resolves a configured leaderboard by its id (from config.yml) and returns the leaderboard object below — it must be chained with a sub-key.
leaderboard_* (a configured Entry)
Placeholder | Description |
|---|---|
| The leaderboard id, echoed back. |
| The configured suffix component, or nothing if unset. |
|
|
| Chains into the configured display |
| List of |
| The viewing player's own all-time |
| Chains into a period view scoped to |
| Chains into a period view scoped to |
| Chains into a period view scoped to |
Period-view sub-keys
%leaderboards_<id>_weekly%/_monthly%/_allTime% resolve a LeaderboardViewPlaceholder, which must itself be chained:
Placeholder | Description |
|---|---|
| The period name, e.g. |
| Chains back into the leaderboard object above ( |
| List of |
| The viewing player's |
Substitute _monthly/_allTime for the other windows — same sub-keys.
entry_* (a LeaderboardEntry, one player's standing on one leaderboard/period)
Placeholder | Description |
|---|---|
| The player's UUID. |
| Chains into a |
| The leaderboard id string. |
| The entry's period bucket key, e.g. |
| The raw |
| The score rendered through the leaderboard's |
| The leaderboard's configured suffix, resolved per-entry. |
| 1-based rank within the current top N. |
| Chains into a |