Перейти к основному содержимому

BTC Open Rewards Menu

Opens the rewards queue menu for a player

Поля

ПолеТипПо умолчаниюОписание
artifactRef<RewardsArtifactEntry>—Artifact for reward storage
configRef<RewardsConfigManifestEntry>—Rewards config manifest entry (for sounds, messages)
titleString<gold>Your RewardsMenu title (supports MiniMessage)Плейсхолдеры
rowsInt6Number of rows (1-6)
backgroundItemItem—Background item for empty slots
rewardSlotsConfigRewardSlotsConfig—Reward slots configuration
RewardSlotsConfig (4)
ПолеТипПо умолчаниюОписание
useRangeBooleantrueUse range mode (true) or explicit slot list (false)
rangeFromInt0Starting slot for range mode (inclusive)
rangeToInt44Ending slot for range mode (inclusive)
explicitSlotsList<Int>emptyExplicit list of slots when useRange is false
infoSlotInfoSlotConfig?—Info slot configuration (optional)
InfoSlotConfig (4)
ПолеТипПо умолчаниюОписание
slotsList<Int>—Slot position in the menu
itemItem—Info display item
displayNameString—Info display name (supports MiniMessage)
loreList<String>emptyInfo lore lines (supports MiniMessage)
previousPageButtonMenuButtonConfig?—Previous page button configuration (optional)
MenuButtonConfig (4)
ПолеТипПо умолчаниюОписание
slotsList<Int>—Slot position in the menu
itemItem—Button display item
displayNameString—Button display name (supports MiniMessage)
loreList<String>emptyButton lore lines (supports MiniMessage)
nextPageButtonMenuButtonConfig?—Next page button configuration (optional)
MenuButtonConfig (4)
ПолеТипПо умолчаниюОписание
slotsList<Int>—Slot position in the menu
itemItem—Button display item
displayNameString—Button display name (supports MiniMessage)
loreList<String>emptyButton lore lines (supports MiniMessage)
bulkClaimButtonMenuButtonConfig?—Bulk claim button configuration (optional)
MenuButtonConfig (4)
ПолеТипПо умолчаниюОписание
slotsList<Int>—Slot position in the menu
itemItem—Button display item
displayNameString—Button display name (supports MiniMessage)
loreList<String>emptyButton lore lines (supports MiniMessage)
backButtonBackButtonConfig?—Back button configuration — closes menu and optionally executes a command (optional)
BackButtonConfig (5)
ПолеТипПо умолчаниюОписание
slotsList<Int>—Slot position in the menu
itemItem—Button display item
displayNameString<red>BackButton display name (supports MiniMessage)
loreList<String>emptyButton lore lines (supports MiniMessage)
commandString—Command to execute when clicked (without leading /). Leave empty to just close the menu.
inventoryFullMessageString<red>Your inventory is full!Message when inventory is full (supports MiniMessage)Плейсхолдеры
Общие поля TypeWriter (criteria, modifiers, triggers)
ПолеТипПо умолчаниюОписание
criteriaList<Criteria>empty—
modifiersList<Modifier>empty—
triggersList<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.