API reference

AchievementDefinition Interface

An AchievementDefinition defines an achievement; this includes its name and how it is unlocked. For an individual user's progress in unlocking an achievement, see AchievementProgress. It can be retrieved using Achievements.getAllDefinitions.

Signature

interface AchievementDefinition

Properties

bitfieldLength : Long
[Get]
It is required for bitfield achievements: AchievementType.Bitfield. This represents the size of the bitfield for this achievement.
Signature 
abstract val bitfieldLength: Long
name : String
[Get]
A string of the api name of the achievement. It can be used to get the achievement progress by name by the function Achievements.getProgressByName.
Signature 
abstract val name: String
target : ULong
[Get]
FIXME: Add doc comment for this field!
Signature 
abstract val target: ULong
type : AchievementType
[Get]
This is the type of achievement. There are three types of achievement: AchievementType.Simple - unlocked by completion of a single event or objective, AchievementType.Bitfield - unlocked when a number of bits in a bitfield are set, and AchievementType.Count - unlocked when a counter reaches a defined target.
Signature 
abstract val type: AchievementType
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta