# Pickable Reward

The reward is designed in such a way that the player can select from the available options only some rewards whose content is not visible before claiming.

* `picks` \[number] - how many rewards a player can pick (collect)
* `pick-rewards` \[list] - individual rewards from which the player can choose

<figure><img src="/files/LqSqwt2oF2xhyaWFpxtJ" alt=""><figcaption><p>Preview</p></figcaption></figure>

### Example configuration

#### examplePickableReward.yml

{% code fullWidth="true" %}

```yaml
# Decides if rewards will be claimable.
enabled: true
type: pickable_reward
#
# Reward tag
#
tag: Pickable Reward
# How many picks the player has available.
picks: 3
# When will the reward be available again
# after claiming.
cooldown: 24
# Unit used for cooldown
unit: hours # So the cooldown is 24 hours
#
# Format which will be used to show the
# general cooldown of this reward.
#
cooldown-general-format: "%hours% hours"
#
# Format of the cooldown that will be displayed
# when using the %cooldown% placeholder in reward GUIs.
#
cooldown-format: '%hours%:%minutes%:%seconds%'
# Make the reward available for the player
# after their first join on the server.
available-after-first-join: true
# Notifies players that the reward is currently available
live-reminder-enabled: true
# How many free slots should the player have
# to be able to claim this reward.
required-slots: 3
#
# (Optional) Permission which player must have to be
# able to obtain this reward.
#
permission: ultimaterewards.examplePickableReward
#
# NOTE THAT ITEM & SOUND NAMES ARE SLIGHTLY DIFFERENT BETWEEN 1.12 & 1.13 VERSIONS!
# SO MAKE SURE YOU ARE USING VALID ITEM NAMES (DEFAULT ONES ARE USED FROM 1.13+ VERSIONS)
# OTHERWISE, THEY WILL BE REPLACED BY STONE IF AN INVALID NAME IS USED.
#
# When the player has this permission,
# the following properties will be shown...
#
# When the reward is currently claimable:
available-item: LIME_STAINED_GLASS_PANE
available-display-name: '&b&lPICKABLE REWARD'
available-lore:
  - ' '
  - '&7Can contains:'
  - '&a ✓ Diamond'
  - '&a ✓ Iron Ingot'
  - '&a ✓ Coal'
  - '&a ✓ Netherite Ingot'
  - '&5 ✓ Mystery Reward'
  - ' '
  - '&e► Click to pick &8(%picks% pick(s) remain)'
# When the reward is under cooldown:
unavailable-item: RED_STAINED_GLASS_PANE
unavailable-display-name: "&7&lPICKABLE REWARD"
unavailable-lore:
  - '&7Available in:'
  - '&7%cooldown%'
# The claimed reward will be shown as this:
# The preview item will be displayed
claimed-display-name: '&7&lPICKABLE REWARD'
claimed-lore:
  - '&7 Claimed'
#
# On the other hand, when the player doesn't have this permission,
# the following properties will be shown.
#
no-permission-item: BARRIER
no-permission-display-name: "&c&l&mPICKABLE REWARD"
no-permission-lore:
  - "&c ✕ Locked, requires"
  - "&c   %permission% permission"
#
# Rewards that will be randomly placed for individual selection of them
# for individual selection (through menu) of them.
# All available actions and format examples can be found on
# https://revivalo.gitbook.io/ultimaterewards/
#
pick-rewards:
  1:
    preview-item: COAL
    display-name: "&8COAL :("
    lore:
      - "&7Obtained:"
      - "&e 1x Coal"
    actions:
      - "[console] minecraft:give %player% coal 1"
  2:
    preview-item: COAL
    display-name: "&8COAL :("
    lore:
      - "&7Obtained:"
      - "&e 1x Coal"
    actions:
      - "[console] minecraft:give %player% coal 1"
  3:
    preview-item: COAL
    display-name: "&8COAL :("
    lore:
      - "&7Obtained:"
      - "&e 1x Coal"
    actions:
      - "[console] minecraft:give %player% coal 1"
  4:
    preview-item: COAL
    display-name: "&8COAL :("
    lore:
      - "&7Obtained:"
      - "&e 1x Coal"
    actions:
      - "[console] minecraft:give %player% coal 1"
  5:
    preview-item: COAL
    display-name: "&8COAL :("
    lore:
      - "&7Obtained:"
      - "&e 1x Coal"
    actions:
      - "[console] minecraft:give %player% coal 1"
  6:
    preview-item: IRON_INGOT
    display-name: "&7IRONS :/"
    lore:
      - "&7Obtained:"
      - "&e 1x Iron Ingot"
    actions:
      - "[console] minecraft:give %player% iron_ingot 1"
  7:
    preview-item: IRON_INGOT
    display-name: "&7IRONS :/"
    lore:
      - "&7Obtained:"
      - "&e 1x Iron Ingot"
    actions:
      - "[console] minecraft:give %player% iron_ingot 1"
  8:
    preview-item: IRON_INGOT
    display-name: "&7IRONS :/"
    lore:
      - "&7Obtained:"
      - "&e 1x Iron Ingot"
    actions:
      - "[console] minecraft:give %player% iron_ingot 1"
  9:
    preview-item: IRON_INGOT
    display-name: "&7IRONS :/"
    lore:
      - "&7Obtained:"
      - "&e 1x Iron Ingot"
    actions:
      - "[console] minecraft:give %player% iron_ingot 1"
  10:
    preview-item: IRON_INGOT
    display-name: "&7IRONS :/"
    lore:
      - "&7Obtained:"
      - "&e 1x Iron Ingot"
    actions:
      - "[console] minecraft:give %player% iron_ingot 1"
  11:
    preview-item: IRON_INGOT
    display-name: "&7IRONS :/"
    lore:
      - "&7Obtained:"
      - "&e 1x Iron Ingot"
    actions:
      - "[console] minecraft:give %player% iron_ingot 1"
  12:
    preview-item: DIAMOND
    display-name: "&bDIAMONDS!!!"
    lore:
      - "&7Obtained:"
      - "&e 1x Diamond"
    actions:
      - "[console] minecraft:give %player% diamond 1"
  13:
    preview-item: DIAMOND
    display-name: "&bDIAMONDS!!!"
    lore:
      - "&7Obtained:"
      - "&e 1x Diamond"
    actions:
      - "[console] minecraft:give %player% diamond 1"
  14:
    preview-item: DIAMOND
    display-name: "&bDIAMONDS!!!"
    lore:
      - "&7Obtained:"
      - "&e 1x Diamond"
    actions:
      - "[console] minecraft:give %player% diamond 1"
  15:
    preview-item: DIAMOND
    display-name: "&bDIAMONDS!!!"
    lore:
      - "&7Obtained:"
      - "&e 1x Diamond"
    actions:
      - "[console] minecraft:give %player% diamond 1"
  16:
    preview-item: DIAMOND
    display-name: "&bDIAMONDS!!!"
    lore:
      - "&7Obtained:"
      - "&e 1x Diamond"
    actions:
      - "[console] minecraft:give %player% diamond 1"
  17:
    preview-item: DIAMOND
    display-name: "&bDIAMONDS!!!"
    lore:
      - "&7Obtained:"
      - "&e 1x Diamond"
    actions:
      - "[console] minecraft:give %player% diamond 1"
  18:
    preview-item: DIAMOND
    display-name: "&bDIAMONDS!!!"
    lore:
      - "&7Obtained:"
      - "&e 1x Diamond"
    actions:
      - "[console] minecraft:give %player% diamond 1"
  19:
    preview-item: NETHERITE_INGOT
    display-name: "&dNETHERITE INGOTS :O"
    lore:
      - "&7Obtained:"
      - "&e 1x Netherite Ingot"
    actions:
      - "[console] minecraft:give %player% netherite_ingot 1"
  20:
    preview-item: NETHERITE_INGOT
    display-name: "&dNETHERITE INGOTS :O"
    lore:
      - "&7Obtained:"
      - "&e 1x Netherite Ingot"
    actions:
      - "[console] minecraft:give %player% netherite_ingot 1"
  21:
    preview-item: NETHERITE_INGOT
    display-name: "&dNETHERITE INGOTS :O"
    lore:
      - "&7Obtained:"
      - "&e 1x Netherite Ingot"
    actions:
      - "[console] minecraft:give %player% netherite_ingot 1"
  22:
    preview-item: NETHERITE_INGOT
    display-name: "&dNETHERITE INGOTS :O"
    lore:
      - "&7Obtained:"
      - "&e 1x Netherite Ingot"
    actions:
      - "[console] minecraft:give %player% netherite_ingot 1"
  23:
    preview-item: NETHERITE_INGOT
    display-name: "&dNETHERITE INGOTS :O"
    lore:
      - "&7Obtained:"
      - "&e 1x Netherite Ingot"
    actions:
      - "[console] minecraft:give %player% netherite_ingot 1"
  24:
    preview-item: TOTEM_OF_UNDYING
    display-name: "&6TOTEM OF UNDYING"
    lore:
      - "&7Obtained:"
      - "&e 1x Totem of Undying"
    actions:
      - "[console] minecraft:give %player% totem_of_undying 1"
  25:
    preview-item: TOTEM_OF_UNDYING
    display-name: "&6TOTEM OF UNDYING"
    lore:
      - "&7Obtained:"
      - "&e 1x Totem of Undying"
    actions:
      - "[console] minecraft:give %player% totem_of_undying 1"
  26:
    preview-item: TOTEM_OF_UNDYING
    display-name: "&6TOTEM OF UNDYING"
    lore:
      - "&7Obtained:"
      - "&e 1x Totem of Undying"
    actions:
      - "[console] minecraft:give %player% totem_of_undying 1"
  27:
    preview-item: FIREWORK
    display-name: "&5&lMYSTERY REWARD"
    lore:
      - "&7Obtained:"
      - "&d 1x  Spawner"
      - "&d 64x Experience Bottle"
      - "&d 16x Enchanted Golden Apple"
    actions:
      - "[broadcast] &5Player %player% just received &lMystery Reward&5 from Pickable Reward"
      - "[console] minecraft:give %player% spawner 1"
      - "[console] minecraft:give %player% experience_bottle 64"
      - "[console] minecraft:give %player% enchanted_golden_apple 16"
```

{% endcode %}

#### guis.yml

{% code fullWidth="true" %}

```yaml
pickableRewards:
  title: Pickable Rewards
  rows: 4
  content:
    '0': examplePickableReward:1
    '1': examplePickableReward:2
    '2': examplePickableReward:3
    '3': examplePickableReward:4
    '4': examplePickableReward:5
    '5': examplePickableReward:6
    '6': examplePickableReward:7
    '7': examplePickableReward:8
    '8': examplePickableReward:9
    '9': examplePickableReward:10
    '10': examplePickableReward:11
    '11': examplePickableReward:12
    '12': examplePickableReward:13
    '13': examplePickableReward:14
    '14': examplePickableReward:15
    '15': examplePickableReward:16
    '16': examplePickableReward:17
    '17': examplePickableReward:18
    '18': examplePickableReward:19
    '19': examplePickableReward:20
    '20': examplePickableReward:21
    '21': examplePickableReward:22
    '22': examplePickableReward:23
    '23': examplePickableReward:24
    '24': examplePickableReward:25
    '25': examplePickableReward:26
    '26': examplePickableReward:27
    '31':
      item: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNjZkOGVmZjRjNjczZTA2MzY5MDdlYTVjMGI1ZmY0ZjY0ZGMzNWM2YWFkOWI3OTdmMWRmNjYzMzUxYjRjMDgxNCJ9fX0=
      name: "&cBack"
      lore:
        - '&7Return to the main menu'
      action: '[open] main'
```

{% endcode %}


---

# 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://ultimaterewards.athelion.eu/configuration/rewards/reward-types/pickable-reward.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.