API reference
API reference
Select your platform
No SDKs available
No versions available

AchievementProgress

Updated: Oct 30, 2025

AchievementProgress

interface AchievementProgress
The unlock progress of a particular achievement can be retrieved using horizon.platform.achievements.Achievements.getAllProgress. It can be used to display the progress of each achievement in your game. See the following link for more information.

Properties

NameSummary
bitfield
abstract val bitfield: String?
If the type of the achievement is horizon.platform.achievements.enums.AchievementType.bitfield it represents the current bitfield state that the achievement has reached.
count
abstract val count: Long
If the type of the achievement is horizon.platform.achievements.enums.AchievementType.count, it represents the current counter state that the achievement has reached.
isUnlocked
abstract val isUnlocked: Boolean
If the user has already unlocked this achievement.
json
open val json: String
name
abstract val name: String
The unique string that you use to reference the achievement in your app, as specified in the developer dashboard. It can be retrieved using horizon.platform.achievements.models.AchievementDefinition.apiName.
unlockTime
abstract val unlockTime: LocalDateTime
If the achievement is unlocked, the time when it was unlocked.