Streaks #
The Hiro Streaks System is a versatile feature designed to enhance player engagement and competitiveness by rewarding consecutive wins. These wins can be tracked, and rewards can be configured to motivate players to reach certain streak thresholds by maintaining momentum. This feature enhances player engagement by adding an extra layer of challenge, encouraging skill mastery, and creating competitive tension.
Customization parameters #
The following JSON represents the customization parameters you can use to configure the default user experience for the Streaks system.
|
|
Streak #
Property | Type | Description |
---|---|---|
name | string | The display-friendly name for this streak. |
description | string | The description text for this streak. |
count | int64 | The initial progress for this streak. |
max_count | int64 | The maximum progress that this streak can achieve. |
max_count_current_reset | int64 | The maximum count that can be submitted within the same reset interval. |
idle_count_decay_reset | int64 | The amount of count that will be decreased if no count is submitted within the reset interval. |
max_idle_count_decay | int64 | The maximum amount of count that can be decreased if no count is submitted over consecutive reset intervals. |
reset_cronexpr | string | The reset schedule expressed in CRON format. |
rewards | StreakReward | The rewards that a user should receive once they complete certain streak checkpoints. |
start_time_sec | int64 | The start time (expressed as a UNIX timestamp) for this streak. |
end_time_sec | int64 | The end time (expressed as a UNIX timestamp) for this streak. |
disabled | bool | Used to disable this streak without removing it from the data definition. |
Streak Reward #
Property | Type | Description |
---|---|---|
count_min | int64 | The minimum count required to receive this reward. |
count_max | int64 | The maximum count required to receive this reward. |
reward | Reward | The rewards that a user should receive at each count between count_min and count_max . |