Skip to content

PlaceholderAPI

alexisleder edited this page Sep 27, 2026 · 3 revisions

PlaceholderAPI

LederProtections includes an internal, persistent PlaceholderAPI expansion. No eCloud download is required. Enable it with:

compatibility:
  hooks:
    placeholderapi:
      enabled: true
      register-expansion: true
      cache-duration-ms: 1000
      async-timeout-ms: 100

Apply changes with /lep reload. Placeholders use the prefix %lederprotections_...% and return unformatted values suitable for scoreboards, TAB lists, menus and chat plugins.

Global placeholders

Placeholder Value
%lederprotections_version% Installed plugin version.
%lederprotections_api_version% Public API contract version.
%lederprotections_protections_total% Total protections (total is an alias).
%lederprotections_public_protections_total% Listed public protections (protections_public_total is an alias).
%lederprotections_types_total% Loaded stone types (stone_types_total is an alias).
%lederprotections_directory_enabled% yes or no.
%lederprotections_holograms_enabled% Global hologram switch: yes or no.
%lederprotections_rules_enabled% Rule-engine state: yes or no.
%lederprotections_vault_available% Vault economy availability (economy_available is an alias).
%lederprotections_worldguard_available% WorldGuard hook availability.
%lederprotections_placeholderapi_available% PlaceholderAPI hook availability.

Player placeholders

Placeholder Value
%lederprotections_player_uuid% Player UUID.
%lederprotections_player_name% Player name, or none.
%lederprotections_player_owned_total% Protections owned by the player. player_total and player_protections_total are aliases.
%lederprotections_player_coowned_total% Protections where the player is co-owner.
%lederprotections_player_member_total% Protections where the player is a member.
%lederprotections_player_accessible_total% Owned, co-owned or member protections, excluding blocked entries.
%lederprotections_player_blocked_total% Protections that block the player.
%lederprotections_player_is_admin% yes or no; permission checks require an online player.
%lederprotections_player_limit% Effective global ownership limit; -1 means unlimited.
%lederprotections_player_remaining% Remaining global slots; -1 means unlimited.
%lederprotections_player_remaining_formatted% Remaining slots using the localized unlimited label.
%lederprotections_inside_protection% yes or no; requires an online player.

The long forms player_protections_limit, player_protections_remaining, player_protections_remaining_formatted and player_is_inside_protection are also supported.

Per-type placeholders

Replace <type> with the stone ID from stones.yml, for example 4, 8 or premium:

Pattern Value
%lederprotections_player_type_<type>_count% Owned count (total is an alias).
%lederprotections_player_type_<type>_limit% Effective type limit.
%lederprotections_player_type_<type>_remaining% Remaining type slots.
%lederprotections_player_type_<type>_remaining_formatted% Localized remaining value.

Unknown type IDs return 0.

Current-protection placeholders

These require an online player. When the player is outside a protection, text values return none, numeric values return 0, and booleans return no.

Suffix after current_ Value
id Persistent protection ID.
name, display_name Display name.
type, type_id Stone type ID.
owner, owner_uuid Owner name or UUID.
role owner, coowner, member, visitor or blocked.
world World name.
members, coowners, blocked Stored role counts.
stone_x, stone_y, stone_z Protection-stone coordinates.
min_x, min_y, min_z Minimum bounds.
max_x, max_y, max_z Maximum bounds.
size_x, size_y, size_z Inclusive dimensions.
area, volume Horizontal area or total volume.
is_owner, is_coowner, is_member, is_blocked yes or no.
description Public profile description.
category, icon Public category ID or icon material.
visibility private, public_open or public_closed.
is_public, is_visitable yes or no.
visits, featured, published_at Public-directory metadata.
has_visit_point yes or no.
hologram_state default, enabled or disabled.
hologram_enabled Effective hologram state after the global/default switches.

Example:

%lederprotections_current_display_name%
%lederprotections_current_owner%
%lederprotections_current_role%
%lederprotections_current_hologram_enabled%

Native hologram variables

The strings under holograms.lines use lightweight {...} variables, not PlaceholderAPI syntax: {title}, {owner}, {id}, {size_x}, {size_y}, {size_z}, {description} and {visibility}.

Testing and troubleshooting

/papi parse me %lederprotections_version%
/papi parse me %lederprotections_current_role%
/lep hooks
/lep reload

If the original placeholder is returned, confirm PlaceholderAPI is installed, the hook and expansion are enabled, the consuming plugin supports PlaceholderAPI, and LederProtections registered the expansion. Unknown placeholder names are left unresolved intentionally.

Clone this wiki locally