Placeholders

The plugin contains two type of placeholders. Custom placeholders that work just in specific places inside the configuration and general placeholders available through PlaceholderAPI.

General Placeholders

Interest

Placeholder	Description
%royalebanks_personal_interest_amount%	Displays the calculated interest amount relative to the player's current bank balance, formatted according to the used currency's money format. If no bank is present, the no-bank-placeholder config setting is displayed.
%royalebanks_personal_interest_amount_raw%	Displays the calculated interest amount relative to the player's current bank balance as a simple unformatted number. If no bank is present, the no-bank-placeholder config setting is displayed.
%royalebanks_interest_cooldown%	Time left until the next interest trigger, formatted using the normal time format from RoyaleCore's configuration.
%royalebanks_interest_cooldown_short% %royalebanks_interest_cooldown_normal%	It overrides the default time format used from RoyaleCore's configuration
%royalebanks_interest_cooldown_spaces% %royalebanks_interest_cooldown_no_spaces%	It overrides the use-spaces setting from RoyaleCore's configuration
%royalebanks_interest_cooldown_short_spaces%	Possible combinations of overriding the format and use-spaces settings. The format should be specified before the spaces setting, as in the example on the left.

Personal Bank Balance

Placeholder	Description
%royalebanks_personal_bank_balance%	Outputs the player's bank balance formatted according to the used currency's money format. If no bank is present, the no-bank-placeholder config setting is displayed.
%royalebanks_personal_bank_balance_raw%	Outputs the player's bank balance as a simple unformatted number. If no bank is present, the no-bank-placeholder config setting is displayed.

Personal Bank Currency

Avoid using hardcoded values like &6coins. Banks can be multi currency and is better to keep an abstract overview.

Placeholder	Description
%royalebanks_personal_bank_currency_name_singular%	The singular name of the currency used by the bank. If no bank is present, the no-bank-placeholder config setting is displayed.
%royalebanks_personal_bank_currency_name_plural%	The plural name of the currency used by the bank. If no bank is present, the no-bank-placeholder config setting is displayed.
%royalebanks_personal_bank_currency_color%	The color of the currency used by the bank.

For the default Vault currency, you can override the names and color inside the config of RoyaleCore.

Personal Bank Upgrades

For all the placeholders below, if the player doesn't have a bank, the no-bank-placeholder config setting is displayed.

Placeholder	Description
%royalebanks_personal_bank_upgrade_{name}_name%	The {name} upgrade's name as specified in the bank-upgrades configuration.
%royalebanks_personal_bank_upgrade_{name}_description%	The {name} upgrade's description as specified in the bank-upgrades configuration.
%royalebanks_personal_bank_upgrade_{name}_balance_limit%	The {name} upgrade's maximum bank balance, formatted using the bank's currency money format.
%royalebanks_personal_bank_upgrade_{name}_balance_limit_raw%	The {name} upgrade's maximum bank balance, formatted as a simple number.
%royalebanks_personal_bank_upgrade_{name}_cost%	The {name} upgrade's cost, formatted using the bank's currency money format.
%royalebanks_personal_bank_upgrade_{name}_cost_raw%	The {name} upgrade's cost, formatted as a simple number.
%royalebanks_personal_bank_upgrade_{name}_permission%	The {name} upgrade's permission required to own it.

In the above placeholders {name} refers to the setting name of the upgrade configuration section. Two special names exist as well, such as current and next, that you can use to dynamically get the current bank upgrade or the next one in the list.

Examples:

%royalebanks_personal_bank_upgrade_current_name% - Fetches the name of the current bank upgrade.

%royalebanks_personal_bank_upgrade_next_name% - Fetches the name of the next bank upgrade. If one does not exist, the no-next-upgrade-bank-placeholder setting will be returned instead.

Personal Bank Balance Top

Placeholder	Description
%royalebanks_personal_bank_balance_top_name_{position}%	Gets the owner of the bank that is the {position}th place in the top.
%royalebanks_personal_bank_balance_top_amount_{position}%	Gets the held amount in the bank for the {position}th place in the top, formatted using the bank's currency's money format.
%royalebanks_personal_bank_balance_top_amount_raw_{position}%	Gets the held amount in the bank for the {position}th place in the top, as a simple number.
%royalebanks_personal_bank_balance_top_last_refresh_{position}%	Returns the time elapsed from the last refresh of the page the {position} belongs to. Since pages are fetched dynamically, different pages will have different refresh times. You can also use _short/_normal/_no_spaces/_spaces suffix extensions to overwrite the time format settings, as specified in the interest cooldown placeholder. Eg. %royalebanks_personal_bank_balance_top_last_refresh_short_no_spaces_{position}%

Custom Placeholders

The custom placeholders should be documented directly in the sections they can be used in.