Skip to content

Placeholders

EspiDev edited this page Apr 3, 2021 · 10 revisions

These are the placeholders provided by ProtectionStones for PlaceholderAPI.

Region Placeholders

There are two ways to refer to a region:

%protectionstones_currentregion_...% - current region the player is in
%protectionstones_region_[identifier]_...% - search a region by name or id

Here are all of the possible options (replace the ..., ex. %protectionstones_currentregion_owners%):

Description
owners List of owners, separated by comma and space.
members List of members, separated by comma and space.
name The name of the region, or the id if there isn't one set.
id The id of the region.
type The block type of the region.
alias The region's alias type.
is_hidden Whether or not the protection block is hidden.
home_location The location of the region's home.
is_for_sale Whether or not the region is for sale.
rent_stage The rent stage of the region.
landlord The region's landlord if it is being rented out.
rent_period The period for rent payments.
rent_amount The amount tenants pay per rent period.
sale_price The price as to which the region is on sale for.
tax_owed How much tax is unpaid for this region.
tax_autopayer The region's configured autopayer.
flags The list of flags of the region.
flags_[flag] Where [flag] is the name of the flag you want to get the value of.

Config Placeholders

All of the config options are available to use as placeholders.

I will not be listing them all here, because they are the same names as what they are in the config here.

In order to refer to them, you need to add the section names behind the config option.

For example, to refer to the config setting for the price of a protection block, you add the section name behind: %protectionstones_config_block_[alias]_block_data_price%

Global config placeholders

How to refer: %protectionstones_config_...%

Special formatted placeholders:

%protectionstones_config_economy_max_rent_period_pretty%
%protectionstones_config_economy_min_rent_period_pretty%

Block config placeholders

Ways to refer:

%protectionstones_config_block_[alias]_...%
%protectionstones_currentregion_config_...%
%protectionstones_region_[identifier]_config_...%

Special formatted placeholders (replace the ...):

economy_tax_period_pretty
economy_tax_payment_time_pretty

Player Placeholders

Refer to the current player with: %protectionstones_currentplayer_...%

Replace ... with the following:

Description
global_region_limit The limit of regions the current player can have, or -1 if there is no limit.
region_limit_[alias] The limit for a specific block type (replace [alias] with the alias of the type).
total_tax_owed The total amount of tax money owed by the player.
num_of_owned_regions The number of regions the player owns.
num_of_owned_regions_[world] The number of regions the player owns in a world (replace [world] with the world name).
num_of_accessible_regions The number of regions the player owns or is a member of.
num_of_accessible_regions_[world] The number of regions the player owns or is a member of in a world (replace [world] with the world name).
owned_regions_ids_[world] Lists the IDs of all of the regions the player owns in a world, separated by ", ".
accessible_regions_ids_[world] Lists the IDs of all of the regions the player owns or is a member of in a world, separated by ", ".
Clone this wiki locally