# Placeholders

EdTools integrates deeply with [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) to provide a vast array of dynamic placeholders that you can use in any other plugin that supports PAPI, as well as within EdTools' own configuration files (like GUIs and lore).

> **Number Formatting:**
>
> * Append `_formatted` to a number-based placeholder to format it using the `default-type` from `config.yml`.
> * Append `_formatted_single` to always format it with separators (e.g., `1,000,000`).

### Enchant Placeholders

* `%edtools_enchant_level_<enchant>%`: The player's current level of the specified enchant.
* `%edtools_enchant_chance_<enchant>%`: The calculated activation chance of the enchant for the player.
* `%edtools_enchant_maxlevel_<enchant>%`: The maximum level configured for the enchant.
* `%edtools_enchant_cost_<enchant>_<levels>%`: The cost to upgrade an enchant by a specific number of levels.
* `%edtools_enchant_maxcost_<enchant>%`: The total cost to upgrade by the maximum number of levels the player can currently afford.
* `%edtools_enchant_maxlevels_<enchant>%`: The maximum number of levels of an enchant the player can afford to buy at once.
* `%edtools_enchant_material_<enchant>%`: The material name defined in the enchant's configuration file.
* `%edtools_enchant_status_<enchant>%`: The enchant's toggle state for the player. Returns `enabled` or `disabled`.

### Leveling Placeholders

* `%edtools_leveling_level_<level>%`: The player's current level in the specified leveling system.
* `%edtools_leveling_bar_<level>%`: The text-based progress bar, as configured in the leveling file.
* `%edtools_leveling_progress_<level>%`: The numerical percentage progress to the next level (e.g., `85.42`).
* `%edtools_leveling_currencyrequired_<level>%` The total required currency to level up.

### Currency Placeholders

* `%edtools_currency_balance_<currency>%`: The player's balance of the specified currency.
* `%edtools_currency_name_<currency>%`: The `display-name` of the currency.

### Booster Placeholders

* `%edtools_boosters_global_enchants%`: The total multiplier from all of a player's active global enchant boosters.
* `%edtools_boosters_global_<currency>%`: The total multiplier from all of a player's active boosters for a specific currency.
* `%edtools_boosters_names_enchants%`: A list of names of active global enchant boosters.
* `%edtools_boosters_names_<currency>%`: A list of names of active boosters for a specific currency.

### Utility Placeholders

* `%edtools_calc_<expression>%`: Calculates a mathematical expression. You can embed other placeholders inside it. Example: `%edtools_calc_10*{edtools_enchant_level_crop-coingreed}%`.
* `%edtools_random_<min>|<max>%`: Returns a random whole number between the min and max values.
* `%edtools_notation_<number>%`: Formats a raw number using the default notation from `config.yml`.
* `%edtools_summary_<currency>%`: The total amount of a currency a player has earned in the current sell summary period (from `item-prices.yml`).
* `%edtools_zone_crop_selected_<zoneId>%`: The ID of the block type a player has selected for a given Regen Zone.
* `%edtools_zone_in%`: The ID of the zone where the player is. Will return the raw placeholder if the player isn't in any zone.