API reference

AchievementProgress Interface

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

Signature

interface AchievementProgress

Properties

bitfield : String?
[Get]
If the type of the achievement is AchievementType.Bitfield it represents the current bitfield state that the achievement has reached.
Signature 
abstract val bitfield: String?
count : ULong
[Get]
If the type of the achievement is AchievementType.Count, it represents the current counter state that the achievement has reached.
Signature 
abstract val count: ULong
isUnlocked : Boolean
[Get]
If the user has already unlocked this achievement.
Signature 
abstract val isUnlocked: Boolean
name : String
[Get]
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.
Signature 
abstract val name: String
unlockTime : LocalDateTime
[Get]
If the achievement is unlocked, the time when it was unlocked.
Signature 
abstract val unlockTime: LocalDateTime
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta