All Towny placeholders

Introduction

This page documents all Towny placeholders. Placeholders are used to dynamically display Towny data, such as resident, town and nation information. Placeholders can be displayed in chat, scoreboards, TAB lists, holograms, and in any other plugin with PlaceholderAPI support.

Resident

Placeholder	Description
%townyadvanced_player_jailed%	Display true is the player is jailed, otherwise false.
%townyadvanced_player_location_formattedtown_or_wildname%	Displays either the formatted townname at the location or the wilderness name.
%townyadvanced_player_location_nation_board%	Displays the board message of the nation where the player is stood.
%townyadvanced_player_location_plot_forsale%	Shows For Sale lang string when a plot is for sale.
%townyadvanced_player_location_plot_name%	Displays a plot's name if it has one.
%townyadvanced_player_location_plot_owner_name%	Displays the name of the resident who owns the plot, or blank if no one personally owns it.
%townyadvanced_player_location_plotgroup_name%	Shows the PlotGroup name if the player location has a PlotGroup.
%townyadvanced_player_location_pvp%	Displays (PVP) or blank, depending on pvp status of the location.
%townyadvanced_player_location_pvp%	Displays (PVP) or (No PVP), depending on pvp status of the location.
%townyadvanced_player_location_town_board%	Displays the board message of the town where the player is stood.
%townyadvanced_player_location_town_forsale_cost%	Displays the cost of the town at the player's location, or "Not for sale." if it is not for sale.
%townyadvanced_player_location_town_mayor_name%	If there is a town present where the player stands, it will return the name of that town's mayor.
%townyadvanced_player_location_town_nation_name%	If there is a town present where the player stands, it will return the name of the nation, if the town has one.
%townyadvanced_player_location_town_or_wildname%	Displays either the townname at the location or the wilderness name.
%townyadvanced_player_location_town_postfix%	Displays the town's postfix or blank.
%townyadvanced_player_location_town_prefix%	Displays the town's prefix or blank.
%townyadvanced_player_location_town_resident_count%	If there is a town present where the player stands, it will return the number representing the number of residents that town has.
%townyadvanced_player_plot_is_trusted%	returns True or False based on whether the player is in a town, and is trusted in the plot.
%townyadvanced_player_plot_owner%	Display true if the resident is owning the townblock at his location.
%townyadvanced_player_plot_type%	Display the townblock's type at the resident's location (ex: shop), or "" if none.
%townyadvanced_player_status%	Displays Nomad, Resident, Mayor or King, depending on what position the player is in.
%townyadvanced_player_town_is_trusted%	returns True or False based on whether the player is in a town, and is trusted in the town.
%townyadvanced_resident_friends_amount%	Number of friends a resident has.
%townyadvanced_resident_join_date_formatted%	Returns a human-readable date and time at which the player joined the server.
%townyadvanced_resident_join_date_unformatted%	Returns the long value of the time in epoch milliseconds that a player joined the server.
%townyadvanced_resident_primary_rank%	Displays a prefix associated with a player's highest-priority nation or town rank.
%townyadvanced_resident_primary_rank_spaced%	Displays a resident's primary rank with a space afterwards.

Town

Placeholder	Description
%townyadvanced_daily_town_overclaimed_per_plot_upkeep_penalty%	Shows the penalty paid per-plot by a Town.
%townyadvanced_daily_town_per_plot_upkeep%	Shows the amount of upkeep paid per-plot by a Town.
%townyadvanced_daily_town_tax%	Displays the daily tax charged by the town on the residents.
%townyadvanced_daily_town_upkeep%	Shows town's upkeep cost.
%townyadvanced_daily_town_upkeep_reduction_from_town_level%	Shows the percentage that a Town's upkeep is reduced by the TownLevel's upkeepModifier, or if the player has no Town what a 1 player town would receive.
%townyadvanced_daily_town_upkeep_unformatted%	An unformatted town upkeep amount.
%townyadvanced_has_town%	Returns true or false whether the resident has a town.
%townyadvanced_is_town_open%	Shows (Open) lang string when the player's town is open.
%townyadvanced_is_town_peaceful%	If the player has a town which is peaceful the language string "status_town_title_peaceful" will be shown: "&b(Peaceful)".
%townyadvanced_is_town_public%	Shows (Public) lang string when the player's town is public.
%townyadvanced_town%	Displays town name (if they have one.)
%townyadvanced_town_balance%	Displays town bank value.
%townyadvanced_town_balance_unformatted%	Shows the town's raw cached bank balance.
%townyadvanced_town_board%	Displays a player's town's board message.
%townyadvanced_town_creation_cost%	Shows the cost of a town.
%townyadvanced_town_formatted%	Displays long-form town name (if they have one.)
%townyadvanced_town_formatted_with_town_minimessage_colour%	A placeholder that uses the towny config's town placeholder formatting, but inserts the town's colour code (in minimessage format) before the town name.
%townyadvanced_town_map_color_hex%	Returns the colour set by the town.
%townyadvanced_town_map_color_minimessage_hex%	Shows the town colour formatted for MiniMessage, (TownyChat-friendly.)
%townyadvanced_town_mayor%	A resident's town's mayor's name.
%townyadvanced_town_merge_cost%	Shows the base cost to merge a town.
%townyadvanced_town_merge_per_plot_percentage%	Shows the percentage of the TownBlock claim price that the merging Town will have to pay in order to do a merge.
%townyadvanced_town_postfix%	Display the config-defined postfix of the player's nation (ex: ruins, settlement, ...)
%townyadvanced_town_prefix%	Display the config-defined prefix of the player's town (ex: ruins, settlement, ...)
%townyadvanced_town_ranks%	Displays either Mayor, or the various town ranks a player has or nothing if they have none.
%townyadvanced_town_reclaim_cost%	Shows the cost to reclaim a town.
%townyadvanced_town_reclaim_max_duration_hours%	Shows the maximum number of hours a town can be ruined before it is deleted.
%townyadvanced_town_reclaim_min_duration_hours%	Shows the minimum number of hours a town can be ruined before it can be reclaimed.
%townyadvanced_town_residents_amount%	Number of residents in a town.
%townyadvanced_town_residents_online%	Number of residents in a town that are currently online.
%townyadvanced_town_tag%	Displays town tag (if they have one.)
%townyadvanced_town_tag_override%	Displays town tag (if they have one,) or the full town name.
%townyadvanced_town_tag_override_unformatted%	The town tag (or town name if no tag is set,) without any formatting from the Towny config.yml.
%townyadvanced_town_tag_unformatted%	The town tag without any formatting from the Towny config.yml.
%townyadvanced_town_townblocks_bonus%	Number of bonus blocks given to a resident's town.
%townyadvanced_town_townblocks_bought%	Number of townblocks bought by a resident's town.
%townyadvanced_town_townblocks_maximum%	Number of townblocks a town has available to claim.
%townyadvanced_town_townblocks_natural_maximum%	Number of townblocks a town has available to claim, not counting bonus/bought townblocks.
%townyadvanced_town_townblocks_used%	Number of townblocks claimed by a resident's town.
%townyadvanced_town_unformatted%	Shows the player's townname, if they have one.
%townyadvanced_towny_colour%	Used to show colours before nomads, residents, mayors and kings. (Set in the config.yml.)
%townyadvanced_towny_name_postfix%	Displays mayor and king postfix.
%townyadvanced_towny_name_prefix%	Displays mayor and king prefix.
%townyadvanced_towny_postfix%	Displays surname if it exists, falls back to mayor and king postfixes.
%townyadvanced_towny_prefix%	Displays title if it exists, falls back to mayor and king prefixes.
%townyadvanced_towny_tag%	Displays town and nation tags.
%townyadvanced_towny_tag_formatted%	Displays town and nation tags if they exist, falling back to long-form names if they don't.
%townyadvanced_towny_tag_override%	Displays town and nation tags if they exist, falling back to names if they don't.
%townyadvanced_towny_tag_override_with_minimessage_colour%	A placeholder that uses the towny config's "both" placeholder formatting, but inserts the town or nation's colour code (in minimessage format) before the town or nation name (or tag if they have one set.)
%townyadvanced_daily_resident_tax_unformatted%	A placeholder that shows how much a resident will pay daily in taxes, but unformatted, just a raw number.
%townyadvanced_daily_resident_tax%	A placeholder that shows how much a resident will pay daily in taxes. This number is the total of any town tax as well as any plot taxes they owe. Taxes owed are cached for a period of time using the config's economy.bank_account_cache_timeout setting.

Nation

Placeholder	Description
%townyadvanced_daily_nation_tax%	Displays the daily tax charged by the nation on the towns.
%townyadvanced_daily_nation_upkeep%	Shows nation's upkeep cost.
%townyadvanced_daily_nation_upkeep_reduction_from_nation_level%	Shows the percentage that a Nation's upkeep is reduced by the NationLevel's upkeepModifier, or if the player has no Nation what a 1 player town would receive if they had a nation.
%townyadvanced_daily_nation_upkeep_unformatted%	An unformatted nation upkeep amount.
%townyadvanced_has_nation%	Returns true or false whether the resident has a nation.
%townyadvanced_is_nation_peaceful%	If the player has a nation which is peaceful the language string "status_town_title_peaceful" will be shown: "&b(Peaceful)".
%townyadvanced_nation%	Displays nation name (if they have one.)
%townyadvanced_nation_balance%	Displays nation bank value.
%townyadvanced_nation_balance_unformatted%	Shows the nation's raw cached bank balance.
%townyadvanced_nation_board%	Displays a player's nation's board message.
%townyadvanced_nation_capital%	Name of a resident's nation's capital.
%townyadvanced_nation_creation_cost%	Shows the cost of a nation.
%townyadvanced_nation_formatted%	Displays long-form nation name (if they have one.)
%townyadvanced_nation_formatted_with_nation_minimessage_colour%	A placeholder that uses the towny config's nation placeholder formatting, but inserts the nation's colour code (in minimessage format) before the nation name.
%townyadvanced_nation_king%	A resident's nation's king's name.
%townyadvanced_nation_map_color_hex%	Returns the hex colour code of the nation's mapcolor set with /t set mapcolor (seen in dynmap-towny.)
%townyadvanced_nation_map_color_minimessage_hex%	Shows the nation colour formatted for MiniMessage, (TownyChat-friendly.)
%townyadvanced_nation_or_town_name%	Displays a player's nation name or, if no nation, their town name or, blank if they have no town.
%townyadvanced_nation_postfix%	Display the config-defined postfix of the player's nation (ex: lands, realms, ...)
%townyadvanced_nation_prefix%	Display the config-defined prefix of the player's town (ex: lands, realms, ...)
%townyadvanced_nation_ranks%	Displays either King, or the various nation ranks a player has or nothing if they have none.
%townyadvanced_nation_residents_amount%	Number of residents in a resident's nation.
%townyadvanced_nation_residents_online%	Number of residents in a resident's nation that are currently online.
%townyadvanced_nation_tag%	Displays nation tag (if they have one.)
%townyadvanced_nation_tag_override%	Displays nation tag (if they have one,) or the full nation name.
%townyadvanced_nation_tag_override_unformatted%	The nation tag (or nation name if no tag is set,) without any formatting from the Towny config.yml.
%townyadvanced_nation_tag_town_formatted%	Shows the nation tag and the full town name. If nation tag is not set, only the town name is shown.
%townyadvanced_nation_tag_town_name%	Displays nation tag (if set, otherwise blank,) followed by the Town name (if the player is part of a town.)
%townyadvanced_nation_tag_unformatted%	The nation tag without any formatting from the Towny config.yml.
%townyadvanced_nation_unformatted%	Shows the player's nationname, if they have one.
%townyadvanced_surname%	Displays king-granted surname.
%townyadvanced_title%	Displays king-granted title.

Town + Nation

Placeholder	Description
%townyadvanced_daily_nation_per_town_upkeep%	Shows the amount of upkeep paid per-town by a Nation.
%townyadvanced_daily_town_upkeep_reduction_from_nation_level%	Shows the percentage that a Town's upkeep is reduced by the NationLevel's nationTownUpkeepModifier, or if the player has no Nation what a 1 player town would receive if they had a nation.

Plot

Placeholder	Description
%townyadvanced_outpost_claim_price%	Shows the price of claiming an outpost using /t claim outpost.
%townyadvanced_townblock_buy_bonus_price%	Shows the base price of buying a TownBlock using /t buy bonus.
%townyadvanced_townblock_claim_price%	Shows the base price of claiming a TownBlocking using /t claim.
%townyadvanced_townblock_next_claim_price%	Displays the cost of the player's town's next claim, taking into account any townblock price increase rules.
%townyadvanced_townblock_unclaim_price%	Shows the base price of claiming a TownBlocking using /t unclaim.

Rankings

Placeholder	Description
%townyadvanced_top_town_balance_n%	(Replace n with a number) Displays the nth Town by money in the town bank.
%townyadvanced_top_town_land_n%	(Replace n with a number) Displays the nth Town by number of townblocks claimed.
%townyadvanced_top_town_residents_n%	(Replace n with a number) Displays the nth Town by number of residents.

Time

Placeholder	Description
%townyadvanced_time_until_new_day_formatted%	Display the amount of time until a new day, formatted and translated.
%townyadvanced_time_until_new_day_hours_formatted%	Display the amount of hours until a new day, formatted and translated.
%townyadvanced_time_until_new_day_hours_raw%	Display the raw number of hours until new day.
%townyadvanced_time_until_new_day_minutes_formatted%	Display the amount of minutes until a new day, formatted and translated.
%townyadvanced_time_until_new_day_minutes_raw%	Display the raw number of minutesuntil new day.
%townyadvanced_time_until_new_day_seconds_formatted%	Display the amount of seconds until a new day, formatted and translated.
%townyadvanced_time_until_new_day_seconds_raw%	Display the raw number of seconds until new day.

World

Placeholder	Description
%townyadvanced_number_of_neutral_towns_in_server%	Shows the number of neutral Towns on the server.
%townyadvanced_number_of_neutral_towns_in_world%	Shows the number of neutral Towns with homeblocks in the same world as the player.
%townyadvanced_number_of_towns_in_server%	Shows the number of Towns on the server.
%townyadvanced_number_of_towns_in_world%	Shows the number of Towns with homeblocks in the same world as the player.

Relational

Placeholder	Description
%rel_townyadvanced_color%	Applies the colour codes set in the config.yml's new papi_relational_formatting section, used in TAB and other plugins which can do Relational placeholders.