Sub Achievements #
Sub achievements can be used to enhance the player experience by creating a reward ladder, with each sub achievement granting an increasingly valuable reward as the player progresses.
Sub achievements belong to a parent achievement and can have their own associated reward, and a “total completion” reward for when all sub achievements have been completed. For example, the parent achievement could be “Complete this level” and the sub achievements could be “Complete this level with 3 stars”, “Complete this level with 4 stars”, and “Complete this level with 5 stars”.
Customization Parameters #
|
|
Each individual sub-achievement is keyed by id and may define the following:
Sub Achievement #
Property | Type | Description |
---|---|---|
auto_claim | bool | Whether the achievement’s reward should be given automatically upon completion. |
auto_reset | bool | Whether the achievement should reset after completion. |
category | string | The category that this achievement belongs to. |
count | int64 | The initial progress towards completion. |
description | string | The description text for this achievement. |
reset_cronexpr | string | The reset schedule expressed in CRON format. |
duration_sec | int64 | How long (in seconds) this achievement is available for progression after creation. Used for limited time achievements. |
max_count | int64 | The number of times this achievement must be progressed before it can be claimed. Set this to 0 (zero) to allow for immediate claiming, so long as all preconditions are met. |
name | string | The display friendly name for this achievement. |
precondition_ids | []string | Achievement IDs the user must have completed to be able to start this achievement. |
reward | Reward | The rewards that a user should be able to claim once they complete this achievement. |
additional_properties | string:string | A map of key value pairs that can contain additional context. |