Placeholders
Every placeholder the plugin answers, about the player and about the protection they stand in, in the PlaceholderAPI form and the short form Exylia files read.
Every placeholder below is written in full, and clicking one copies it.
How the name is written#
The plugin registers its placeholders through ExyliaLib as one group, protections. PlaceholderAPI reaches
them with the plugin's name in front, so a scoreboard, a hologram or a tab plugin asks for:
%exyliaprotections_protections_name%That is the form this page documents. Inside an Exylia plugin's own files — menus, messages, another Exylia
plugin's scoreboard — the registered name also stands on its own: %protections_name%.
No expansion needs downloading. Without PlaceholderAPI installed only the Exylia form works.
%exyliasurvivalcore_protections_…% belonged to the old protections module. Replace
exyliasurvivalcore_ with exyliaprotections_; the rest of each name is the same.
Every placeholder answers for a player. Read without one — from the console, or a global line of another plugin — it is empty, and the console reports it once.
About the player#
| Placeholder | Shows | Example |
|---|---|---|
%exyliaprotections_protections_count% | Protections the player owns. | 0 |
%exyliaprotections_protections_max% | How many the player may own: the highest limit they hold. | 5 |
%exyliaprotections_protections_effects_active% | The member perks active on the player, comma separated. | Haste, Speed |
About the protection they stand in#
Everything here is about the protection at the player's position, and empty outside one.
| Placeholder | Shows | Example |
|---|---|---|
%exyliaprotections_protections_name% | Name of the protection the player stands in. | Spawn Base |
%exyliaprotections_protections_owner% | Owner of the protection the player stands in. | Steve |
%exyliaprotections_protections_role% | The player's role in the protection they stand in: owner, the id of their role, or visitor. | trusted |
%exyliaprotections_protections_level% | Upgrade level of the protection here. | 2 |
%exyliaprotections_protections_lives% | Raid lives left. Empty when raids are off. | 3 |
%exyliaprotections_protections_max_lives% | Most raid lives this protection can hold. Empty when raids are off. | 5 |
%exyliaprotections_protections_raid_state% | The raid state of the protection here. Empty when raids are off. | Safe |
%exyliaprotections_protections_bank% | What the protection's bank holds. Empty when the bank is off. | 1,200 |
%exyliaprotections_protections_upkeep_cost% | The upkeep cost per period. Empty when upkeep is off. | 50 |
%exyliaprotections_protections_upkeep_due% | Time until the next upkeep payment. Empty when upkeep is off. | 2d 4h |
%exyliaprotections_protections_sale_price% | The asking price when the protection is for sale, empty otherwise. | 10,000 |
%exyliaprotections_protections_subregion% | Name of the plot the player stands in. | shop |
%exyliaprotections_protections_rent_tenant% | Who is renting the plot or protection here. | Alex |
%exyliaprotections_protections_rent_expiry% | Time left on the rent here. | 3d |
%exyliaprotections_protections_warp_rating% | Average rating of the public warp of this protection. | 4.5 |
%exyliaprotections_protections_warp_visits% | Visits the public warp of this protection has had. | 37 |
role reads the player's own role first and then their clan's. A staff member managing somebody else's
land through exyliaprotections.admin is still a visitor there.
The names of perks and of raid states come from messages.yml, so they follow the server's language. See
Configuration.
Examples#
A scoreboard block that only fills in inside a protection:
Land: %exyliaprotections_protections_name%
Owner: %exyliaprotections_protections_owner%
Role: %exyliaprotections_protections_role%Raid status for a server with raids on:
Lives: %exyliaprotections_protections_lives%/%exyliaprotections_protections_max_lives% (%exyliaprotections_protections_raid_state%)The player's allowance:
Protections: %exyliaprotections_protections_count%/%exyliaprotections_protections_max%Something missing on this page? Tell us on Discord