# 🥉Display Item Add Lore

{% hint style="info" %}
This page showing you the rematered display item add lore feature stating from plugin version 4.0.0.
{% endhint %}

## General Setting

You can set it at `config.yml` file.

Default example:

```yaml
  add-lore:
    - '@n '
    - '@a&ePurchase: {buy-price}'
    - '@b&eSell: {sell-price}'
    - '@c&#FF7777Player Buy Stock: {buy-times-player}/{buy-limit-player}'
    - '@d&#FF7777Server Buy Stock: {buy-times-server}/{buy-limit-server}'
    - '@e&#FF7777Player Sell Limit: {sell-times-player}/{sell-limit-player}'
    - '@f&#FF7777Server Sell Limit: {sell-times-server}/{sell-limit-server}'
    - '@g '
    - '@g&#ff3300cCan not buy more!'
    - '@g&8Refresh Time: {buy-refresh-player}'
    - '@i '
    - '@i&#ff3300Sold Out!'
    - '@i&8Refresh Time: {buy-refresh-server}'
    - '@h '
    - '@h&#ff3300Can not sell more!'
    - '@h&8Refresh Time: {sell-refresh-player}'
    - '@j'
    - '@j&#ff3300Can not sell more for server!'
    - '@j&8Refresh Time: {sell-refresh-server}'
    - '@n '
    - '@a@u@y{buy-click}'
    - '@b@v@y{sell-click}'
    - '@k@q@y&#FFFACDRight-Shift click to pick amount!'
    - '@m@v@y&#FFFACDDrop (Q key) to sell all!'
    - '(@n)&c&l:( Can not do this'
    - '(@a)@u@p&cThis item can not be purchased'
    - '(@b)@v@p&cThis item can not be sold'
```

## Per Product Setting

You can set different add lore format for each product, add the `add-lore` option in the product config. Check [shops](/shops/shops.md) page product **B** to find the example.

```yaml
items:
  B:
    display-item:
      material: BREAD
      name: '&cSuper Bread'
    display-name: "Bread"
    add-lore: # <--- Custom Add Lore for this product
      - '@a&ePurchase: {buy-price}'
      - '@b&eSell: {sell-price}'
      - '&eDrop to buy, right to sell'
```

## Hide

You can use `display-item.modify-lore` option to hide the display item add lore.

```yaml
A:
  display-item:
    material: APPLE
    modify-lore: false # This line
  buy-prices:
    # The section of buy price
  sell-prices:
    # The section of sell price
```

## Prefix - Conditional Symbol

Each line start with `@+lower case` will be consider as conditional line. We will only display this line when this condition is meet. Starting from version **4.0.0**, multiple conditional symbols can be set for each line.

@a - This product has buy price. (Means has `buy-prices` section)

@b - This product has sell price. (Means has `sell-prices` section)

@c - This product has player buy limit. (Means has `buy-limits.player` option)

@d - This product has server buy limit. (Means has `buy-limits.global` option)

@e - This product has player sell limit. (Means has `sell-limits.player` option)

@f - This product has server sell limit. (Means has `sell-limits.global` option)

@g - This product has reached player buy limit.

@h - This product has reached player sell limit.

@i - This product has reached server buy limit.

@j - This product has reached server sell limit.

@k - This product has enabled buy more feature.

@l - This product can use favourite feature.

@m - This product can use sell all feature.

@n - Buy/sell price (corresponding to the Click type) is valid. For example, buy click type require buy price is valid.

@o - Player is opening favourite menu.

@p - Player is opening buy more menu.

@q - Player is **not** opening buy more menu.

@x - Player is from bedrock version. Require using [Bedrock Menus](/menus/bedrock-menus-premium.md) feature.

@y - Player is **not** from bedrock version. Require using [Bedrock Menus](/menus/bedrock-menus-premium.md) feature.

@u - This button can buy product.&#x20;

@v - This button can sell product.&#x20;

@z\[vip] - Only show when [multiplier](/shops/sell-multiplier-premium.md) id `vip` is active.

(@z\[vip]) - Only show when [multiplier](/shops/sell-multiplier-premium.md) id `vip` is not active.

## Negation

You can reverse the conditional symbol by adding English parentheses before and after it. For example: `(@a)` represents the reversal of `@a`. (means this product does not has buy price)

{% hint style="danger" %}
Suffix has been removed in display item add lore from 4.0.0.
{% endhint %}

## Multi Line Price&#x20;

Use `;;` symbol if you want to display price in multi lines.

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

You need also update your `add-lore` settings:

```yaml
  add-lore:
    - '@n '
    - '@a&ePurchase: '
    - '@a   &7[-] &f{buy-price}'
    - '@b&eSell:'
    - '@a   &7[-] &f {sell-price}'
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ultimateshop.superiormc.cn/menus/display-item-add-lore.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
