Skip to main content

Reward Definition

The Reward Definition creates a reusable template for a reward. It defines what the reward looks like in the menu and what happens when it is claimed.

Configuration

rewardIdString

Unique ID referenced by GiveRewardAction.

displayItemItem

The icon shown in the GUI.

requiredInventorySlotsInt

Number of empty inventory slots required to claim.

onClaimActions

"> Actions executed to deliver the reward (e.g. give_item, add_money).

onClaimFailActions

"> Actions executed if claim fails (e.g. inventory full).

manifest:
type: btc_reward_definition
id: "daily_gold"
rewardId: "daily_gold"
requiredInventorySlots: 0
onClaimActions:
- action: add_money
amount: 100