# Rewards Option

## Item Format

Each reward must has item to display. Should use Item Format at [this](https://ultimateshop.superiormc.cn/base/item-format) page.

**Example:**

```yaml
  1:
    material: DIAMOND
    custom-model-data: 0
    name: '&eA Reward'
    lore:
      - '&fLine1'
      - '&fLine2'
    # For command rewards, you should set this option to false.
    # Otherwise, players will get both item you set here and also the commands reward.
    give-item: true
    # Random amount.
    amount: 1~10
    chance: 20
    edge: rare
```

## General Options

Those options can be used in the 2 types of reward. **All of them except rate are optional.**

* amount: The amount of reward items. Like `1`. You can also entry in the form of "`1~5`" which means the amount is random in the interval. 
* times: How many times the commands excute, can be used as random money amount. You can also entry in the form of "`1~5`" which means the times is random in the interval. 
* give-item: Whether give the item to the player. Recommend set false if just want to use commands as reward. Like: `true`.
* actions: The action will active after finish flip (close flip UI). Use **Action Format** here, for more info, please view [Format](https://flipcard.superiormc.cn/info/format) page. 
* flip-actions: The action will active when flip the card. **For safely reason, only recommand use announcement action here.** Use **Action Format** here, for more info, please view [Format](https://flipcard.superiormc.cn/info/format) page. 
* rate: The weight of the reward. Real rate is this `reward rate/all rewards total rate`.

You can also use `rates` option to replace `rate` option to make dynamic rate, like:

```yaml
rates:
  default: 0.1
  one_rates_condition: 0.4
```

This means default players will have 0.1 rate for this reward, players meet `one_rates_condition` condition (view rates-conditions option below) have 0.4 rate.

This rate supports PlaceholderAPI's placeholder and Math string, like this: **(You need enable math.enabled option in config.yml file to use Math string)**

<figure><img src="https://2842354417-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLuSnM0RWEZSpv5WDinSa%2Fuploads%2F1gVz590QgSmHv6nmwFKo%2F%E5%B1%8F%E5%B9%95%E6%88%AA%E5%9B%BE%202023-07-10%20225520.png?alt=media&#x26;token=4218b910-f744-405c-a190-db4ad91c7f5d" alt=""><figcaption></figcaption></figure>

* rates-conditions:&#x20;

```yaml
rates-conditions:
  one_rates_condition:
    1:
      type: world
      world: 'OneWorld'
```

`one_rates_condition` is Condition ID, can write it at rates option like this format. In this example, players who in OneWorld will have 0.4 rate.

Each condition id section should use **Condition Format**, for more info, please view [Format](https://flipcard.superiormc.cn/info/format) page.

* edge: The textures of reward edge. It can express rarity. If not set, card won't have any edge.
* limit: The max limit of the reward in a card flip event. Set 1 means you can only get this reward once in a card flip event.