TNE Docs
  • Getting Started
    • Welcome
    • Currencies Key Concepts
    • Creating a Currency
    • Breakdown of Main Currency Configuration File
    • Breakdown of Denomination Configuration File
    • Commands & Permissions
    • PlaceholderAPI Placeholders
  • FAQ HOWTO
    • HOW TO: Limit Access to Currencies
    • HOWTO: Contribute Translation
    • HOWTO: Share Balances Across Servers
  • Developers
    • Welcome Developers
    • Contributing
    • API Usage
    • Callbacks
    • Platform Implementations
    • Creating Custom Account Type
    • Creating Custom Balance Handlers
    • Creating Custom Account Statuses
    • Creating Custom Balance Format Rule
    • Creating Custom Currency Loader & Saver
    • Creating Custom Currency Type
    • Creating Custom Transaction Checks
    • Creating Custom TaxType
    • Creating Custom Transaction Type
Powered by GitBook
On this page
  • General Placeholders
  • World-Specific Placeholders
  • Combined World and Currency Placeholders
  • Leaderboard Placeholders
  • Usage Examples
  • Notes
  1. Getting Started

PlaceholderAPI Placeholders

TheNewEconomy integrates with PlaceholderAPI (PAPI) to provide a variety of placeholders for displaying economy-related information. Below is a list of supported placeholders and their descriptions.


General Placeholders

Player-Specific Balance

Placeholder
Description

%tne_balance%

Displays the player's total balance in the default currency and region.

%tne_balance_formatted%

Displays the player's total balance in a formatted manner (e.g., including currency symbols).

%tne_balance:inventory%

Displays the player's inventory balance.

%tne_balance:virtual%

Displays the player's virtual balance.

%tne_balance:ender%

Displays the player's balance stored in an Ender chest.


World-Specific Placeholders

World and Currency Balance

Placeholder
Description

%tne_world_<world_name>%

Displays the player's total balance for the specified world.

%tne_world_<world_name>_formatted%

Displays the player's total balance for the specified world in a formatted manner.

%tne_currency_<currency_name>%

Displays the player's total balance for the specified currency.

%tne_currency_<currency_name>_formatted%

Displays the player's total balance for the specified currency in a formatted manner.


Combined World and Currency Placeholders

Placeholder
Description

%tne_wcur_<world_name>_<currency_name>%

Displays the player's total balance for the specified world and currency.

%tne_wcur_<world_name>_<currency_name>_formatted%

Displays the player's balance for the specified world and currency in a formatted manner.


Leaderboard Placeholders

Top Positions

Placeholder
Description

%tne_toppos_<currency_name>%

Displays the player's rank position for the specified currency.

%tne_toppos_<currency_name>_position_<pos>%

Displays the player at the specified leaderboard position for the given currency.


Usage Examples

  1. Display Total Balance: %tne_balance%

  2. Show World-Specific Balance in World "MyWorld": %tne_world_MyWorld%

  3. Show Formatted Currency Balance for USD: %tne_currency_usd_formatted%

  4. Display the Player at Position 1 on the Leaderboard for Euro: %tne_toppos_euro_position_1%


Notes

  • Some placeholders support the _formatted suffix to display balances with currency formatting.

  • Placeholders like balance:inventory, balance:virtual, and balance:ender specify the storage type for the balance being displayed.

  • Ensure PlaceholderAPI is installed on your server for these placeholders to work.

  • Placeholders are dynamically calculated and depend on the player’s account, regions, and available currencies.

For further customization and details, refer to the PAPI and TheNewEconomy documentation.

PreviousCommands & PermissionsNextHOW TO: Limit Access to Currencies

Last updated 5 months ago