Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt

Use this file to discover all available pages before exploring further.

The Give Reward Action adds a defined reward to the player’s pending queue.

​
Configuration

​
reward
Ref<RewardDefinition>
required
The template of the reward to give.
​
artifact
Ref<Artifact>
required
The storage artifact where the queue is saved.
​
customData
String
default:"{}"
Optional JSON string attached to this specific instance. Useful for passing dynamic data to the claim event.

​
Scheduling (Cron)

​
useCron
Boolean
default:"false"
Enable time-based checks.
​
cronExpression
String
Cron expression (e.g. 0 0 0 * * * for daily).
Behavior: If enabled, the action checks if the player has already received this reward within the current cron window. If so, it does nothing. Useful for “Daily Rewards”. 
action:
  type: btc_give_reward
  reward: "daily_bonus"
  useCron: true
  cronExpression: "0 0 0 * * *"