BTC Open Rewards Menu
Opens the rewards queue menu for a player
フィールド
| フィールド | 型 | デフォルト | 説明 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
artifact | Ref<RewardsArtifactEntry> | — | Artifact for reward storage | ||||||||||||||||||||||||
config | Ref<RewardsConfigManifestEntry> | — | Rewards config manifest entry (for sounds, messages) | ||||||||||||||||||||||||
title | String | <gold>Your Rewards | Menu title (supports MiniMessage)プレースホルダー | ||||||||||||||||||||||||
rows | Int | 6 | Number of rows (1-6) | ||||||||||||||||||||||||
backgroundItem | Item | — | Background item for empty slots | ||||||||||||||||||||||||
rewardSlotsConfig | RewardSlotsConfig | — | Reward slots configuration
|
| フィールド | 型 | デフォルト | 説明 |
|---|---|---|---|
useRange | Boolean | true | Use range mode (true) or explicit slot list (false) |
rangeFrom | Int | 0 | Starting slot for range mode (inclusive) |
rangeTo | Int | 44 | Ending slot for range mode (inclusive) |
explicitSlots | List<Int> | empty | Explicit list of slots when useRange is false |
infoSlotInfoSlotConfig?InfoSlotConfig(4)
| フィールド | 型 | デフォルト | 説明 |
|---|---|---|---|
slots | List<Int> | — | Slot position in the menu |
item | Item | — | Info display item |
displayName | String | — | Info display name (supports MiniMessage) |
lore | List<String> | empty | Info lore lines (supports MiniMessage) |
previousPageButtonMenuButtonConfig?MenuButtonConfig(4)
| フィールド | 型 | デフォルト | 説明 |
|---|---|---|---|
slots | List<Int> | — | Slot position in the menu |
item | Item | — | Button display item |
displayName | String | — | Button display name (supports MiniMessage) |
lore | List<String> | empty | Button lore lines (supports MiniMessage) |
nextPageButtonMenuButtonConfig?MenuButtonConfig(4)
| フィールド | 型 | デフォルト | 説明 |
|---|---|---|---|
slots | List<Int> | — | Slot position in the menu |
item | Item | — | Button display item |
displayName | String | — | Button display name (supports MiniMessage) |
lore | List<String> | empty | Button lore lines (supports MiniMessage) |
bulkClaimButtonMenuButtonConfig?MenuButtonConfig(4)
| フィールド | 型 | デフォルト | 説明 |
|---|---|---|---|
slots | List<Int> | — | Slot position in the menu |
item | Item | — | Button display item |
displayName | String | — | Button display name (supports MiniMessage) |
lore | List<String> | empty | Button lore lines (supports MiniMessage) |
backButtonBackButtonConfig?BackButtonConfig(5)
| フィールド | 型 | デフォルト | 説明 |
|---|---|---|---|
slots | List<Int> | — | Slot position in the menu |
item | Item | — | Button display item |
displayName | String | <red>Back | Button display name (supports MiniMessage) |
lore | List<String> | empty | Button lore lines (supports MiniMessage) |
command | String | — | Command to execute when clicked (without leading /). Leave empty to just close the menu. |
inventoryFullMessageString<red>Your inventory is full!TypeWriter 共通フィールド(criteria, modifiers, triggers)
| フィールド | 型 | デフォルト | 説明 |
|---|---|---|---|
criteria | List<Criteria> | empty | — |
modifiers | List<Modifier> | empty | — |
triggers | List<Ref<TriggerableEntry>> | empty | — |
How to use it
Set artifact to your single Rewards Artifact; config selects the Rewards Config whose messages and lore layout are used.
Slots are numbered from 0, nine per row. With rows set to 6 and the default rewardSlotsConfig (range 0 to 44), the last row is free for previousPageButton, infoSlot, bulkClaimButton, nextPageButton and backButton (defaults suggest slot 4 for the info and slot 45 for the back button; the other buttons default to slot 0, so set them). When more rewards are pending than there are reward slots, the menu is paginated.
Reward slots must not overlap the button slots. Slots not used by any element receive backgroundItem.