Rewards
A reward is what a contract pays out on completion. A contract needs at
least one. The type field selects which reward it is and which fields it
carries. Each per-type page in this section lists its complete field set, shared
and type-specific alike.
Every reward shares title, description, and an eligiblePermissions list
that gates who can receive it.
When rewards are granted
Section titled “When rewards are granted”A completed contract’s reward is granted when the player claims it. Claiming is deliberate: the player must open the contract’s menu and click the “Claim” button. Otherwise, the reward will be granted automatically when the contract expires (if the player has completed it).
Error handling and reward reversion
Section titled “Error handling and reward reversion”During the reward distribution process, if an error occurs, the plugin will attempt to revert any rewards that were succesfully granted before the error.
If the plugin is able to revert all granted rewards, the player will be notified and the contract will remain completed (unclaimed) so that they can try claiming again later.
However, if the plugin is unable to revert any granted rewards or has granted unrevertible rewards (i.e. a Command reward), the player will be notified, but the contract will be marked as claimed and the reward will be considered lost. In this case, the player should contact an admin for assistance.
Command rewards are impossible to revert, so once a Command reward is granted, if an error occurs later during the reward distribution process, the plugin will not attempt to revert rewards and the contract will be marked as claimed. For this reason, the plugin processes Command rewards last, after all other revertible rewards have been granted.
Not the rewards you’re looking for? Need something custom?
Section titled “Not the rewards you’re looking for? Need something custom?”If the rewards below don’t fit your needs, think again! Most people overlook the the Command Reward type! If you need to reward your players with a feature backed by another plugin, that plugin most likely has a command that you would usually run yourself to give your players that feature (XP, battlepass points, leaderboard score, etc.). The Command Reward allows you to run that command for your players automatically when they complete a contract. You can even use placeholders in the command to customize it for each player!
Reward types
Section titled “Reward types”