Placeholders

Built-in Placeholders List

PlaceholderDisplay InfoWhere can use

{shop}

Display Shop ID (filename).

Message File Actions

{shop-name}

Display Shop Display Name.

Shop Menu Actions

{shop-menu}

Display Shop Menu ID.

Actions

{product}

Display Product ID.

Message File

{amount}

Display shop or sell amount.

Message File Actions Price placeholder option

{status}

Show whether now price is greatter or less than base price. Only use for dynamic price.

Price placeholder option

{item}

Display Purchased Items Name.

Message File

{menu}

Display Menu ID.

Message File

{price}

Display Buy/Sell price.

Message File

{limit}

Display Buy/Sell limits.

Message File

{times}

Display Buy/Sell times.

Message File

{refresh}

Display Product Reset Refresh Time or Cooldown Refresh Time.

Message File

{buy-price}

See above.

Display Item Add Lore PlaceholderAPI Support

{sell-price}

See above.

Display Item Add Lore PlaceholderAPI Support

{buy-times-player}

See above.

Display Item Add Lore PlaceholderAPI Support amount option

{buy-limit-player}

See above.

Display Item Add Lore PlaceholderAPI Support

{buy-refresh-player}

See above.

Display Item Add Lore PlaceholderAPI Support

{buy-cooldown-player}

See above.

Display Item Add Lore PlaceholderAPI Support

{sell-xxx}

See above. xxx is same as buy, like {sell-limit-playe}

See above.

{xxx-server}

See above. xxx is same as player, like {buy-limit-server}

See above.

{buy-click}

View Buy Price Status

Display Item Add Lore

{sell-click}

View Sell Price Status

Display Item Add Lore

{item-name}

Display product display name

Display Item Add Lore PlaceholderAPI Support

{random_<ID>}

Use random placeholder. For more info, please view Random page.

Anywhere in plugin PREMIUM

{random-times_<ID>}

View random placeholder refresh time.

Anywhere in plugin PREMIUM

{discount_<ID>}

Use discount placeholder. For more info, please view Discount page.

Anywhere in plugin PREMIUM

{compare_<number1>_<number2}

Compare 2 numbers. Result format can be changed in config.yml file.

Anywhere in plugin PREMIUM

{math_<mathStr>}

Calculate the math string you put. Like {math_10+50} will print 60. Require you enable math.enabled option in config.yml file. You can set result scale at placeholder.math.scale option.

Anywhere in plugin

PlaceholderAPI Support

All built-in placeholders above that has PlaceholderAPI Support tag can be used in PlaceholderAPI expansion:

Use %ultimateshop_<shopID>_<productID>_<builtInPlaceholder>% to display built-in placeholder outsite of the plugin!

For example:

%ultimateshop_example_A_{buy-limit-player}%

For random and discount placeholder, you don't need specife the shop and the product, just put the placeholder after ultimateshop. For example:

%ultimateshop_{random-times_rotate}%

New Line Symbol

Use ;; symbol if you want to start a new line, this is very useful for some people want to display price in multi lines.

placeholder:
  price:
    split-symbol-any: ';;' # <--- Changed this in config.yml
    split-symbol-all: ';;' # <--- Changed this in config.yml
    unknown: "Unknown"

Dynamic Price Status - Premium

Start from 2.3.2, you can use {status} placeholder in price section's amount option, like this:

    buy-prices:
      1:
        economy-plugin: Vault
        amount: '550+{buy-times-server}*0.2-{sell-times-server}*0.1'
        max-amount: 5500
        min-amount: 325
        placeholder: '&6{amount} Coins {status}' # <--- We use {status} here.
        start-apply: 0

Please note that to use this placeholder, you have to make sure in amount option, the first number is base price. Like here, 550 is the base price.

You can also enable add-status-in-dynamic-price-placeholde option in config.yml to let plugin auto add this for you, you don't need have to manually add the placeholder at each price placeholder!

Last updated