Placeholders
With PlaceholderAPI installed, AtlasRealms registers the atlasrealms expansion.
The placeholders were added in 2.5.0. Every one is read from memory and
answers for a player who is offline, so a leaderboard, a hologram or a web
panel can use them; only the last three need the player on the server.
| Placeholder | Answers |
|---|---|
%atlasrealms_has_realm% |
true or false |
%atlasrealms_realm_name% |
the realm’s id, which is also its world name |
%atlasrealms_realm_owner% |
the owner’s name |
%atlasrealms_realm_theme% |
the theme id |
%atlasrealms_realm_status% |
open, members or closed |
%atlasrealms_realm_size% |
how wide the border is, in blocks |
%atlasrealms_realm_level% |
how many rings of the border ladder it has bought, counting the one it started with |
%atlasrealms_realm_members% |
members, not counting the owner |
%atlasrealms_realm_members_online% |
how many of those are on the server |
%atlasrealms_in_realm% |
whether the player is standing in a realm |
%atlasrealms_current_realm% |
the id of the realm they are standing in |
%atlasrealms_role% |
owner, trusted_member, resident_member or visitor, where they stand |
Two realms, not one
Section titled “Two realms, not one”realm_* is the realm the player owns. in_realm, current_realm and
role are the realm the player is standing in. These are different realms,
and often only one of them exists — a visitor standing in someone else’s realm
owns none of their own.
Raw keys, not display text
Section titled “Raw keys, not display text”A status and a role are the raw key (open, visitor), not the display text.
The plugin’s own text is MiniMessage, which does not belong in a scoreboard. Wrap
the key in your own words.
A realm has no display name in AtlasRealms, so realm_name is its id — the value
a web panel or a script wants. Use realm_owner for a scoreboard.
When a player has no realm
Section titled “When a player has no realm”A player with no realm gets an empty string, a 0 or false rather than a word,
so you can put your own text around it.