Placeholders
With PlaceholderAPI installed, ProtonAuctions adds its own placeholders, so scoreboards, tab lists, menus and holograms can show a player's auction activity, the state of the market and what items are worth. They all start with %protonauctions_ and need no setup beyond PlaceholderAPI itself.
Player
These show figures for the player viewing them.
| Placeholder | Shows |
|---|---|
%protonauctions_listings% | Their active listings. |
%protonauctions_listings_limit% | How many listings they may have at once. For a player who is offline, this shows the limit from config.yml. |
%protonauctions_sold% | How many sales they have made. |
%protonauctions_bought% | How many purchases they have made. |
%protonauctions_claims% | How many items and payouts are waiting for them in /ah claim. |
%protonauctions_claims_items% | How many items are waiting in /ah claim. |
%protonauctions_claims_money% | How many payouts are waiting in /ah claim. |
%protonauctions_earned% | What they have earned from sales, after tax, in your default currency. |
%protonauctions_spent% | What they have spent on purchases, in your default currency. |
For another currency, add its id, for example %protonauctions_earned_playerpoints%.
Market
| Placeholder | Shows |
|---|---|
%protonauctions_market_listings% | The active listings on the server. |
%protonauctions_market_sales_today% | Sales since midnight, server time. |
%protonauctions_market_volume_today% | What those sales came to, in your default currency. Add a currency id for another one, for example %protonauctions_market_volume_today_playerpoints%. |
Item values
These take a vanilla item name, such as diamond or netherite_ingot, and show the economy engine's view of the plain item in your default currency.
| Placeholder | Shows |
|---|---|
%protonauctions_value_<item>% | Its market value, for example %protonauctions_value_diamond%. |
%protonauctions_trend_<item>% | Rising fast, rising, stable, falling or falling fast. |
%protonauctions_confidence_<item>% | How sure the engine is, as a percentage. |
Custom items, and items with a name, lore or enchantments, are not covered. An item the engine has no value for yet shows -.
Top lists
Ranks run from 1 to 10 and cover all time, in your default currency.
| Placeholder | Shows |
|---|---|
%protonauctions_top_earners_<rank>_name% and %protonauctions_top_earners_<rank>_amount% | The players who earned the most from sales, after tax. |
%protonauctions_top_sellers_<rank>_name% and %protonauctions_top_sellers_<rank>_count% | The players with the most sales. |
%protonauctions_biggest_sale_<rank>_item%, _price%, _seller% and _buyer% | The biggest single sales. |
For example, %protonauctions_top_earners_1_name% shows the top earner's name.
Plain numbers
Put raw_ in front of a placeholder to get a plain number without currency formatting, for example %protonauctions_raw_earned% or %protonauctions_raw_value_diamond%. This helps plugins that compare or sort numbers.
How fresh the values are
Placeholders never wait on the database. Values load in the background and are kept for a short time, so the very first read can show 0 or - for a moment.
| Values | Refreshed |
|---|---|
| A player's own figures | Every 30 seconds, and shortly after they list, sell or buy, or a listing of theirs ends |
| Market figures | Every minute, and shortly after a listing is made, sold or ends |
| Item values | Every 5 minutes, or every minute while an item has no value yet |
| Top lists | Every 3 minutes |
PlaceholderAPI has to be running when ProtonAuctions starts. If another expansion already uses the name protonauctions, the placeholders are not added and the console says so.