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

AchievementDefinition

Updated: Oct 30, 2025

AchievementDefinition

interface AchievementDefinition
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 horizon.platform.achievements.Achievements.getAllDefinitions.

Properties

NameSummary
bitfieldLength
abstract val bitfieldLength: Long
It is required for bitfield achievements: horizon.platform.achievements.enums.AchievementType.bitfield. This represents the size of the bitfield for this achievement.
json
open val json: String
name
abstract val name: String
A string of the api name of the achievement. It can be used to get the achievement progress by name by the function horizon.platform.achievements.Achievements.getProgressByName.
target
abstract val target: Long
FIXME: Add doc comment for this field!
type
abstract val type: AchievementType
This is the type of achievement. There are three types of achievement: horizon.platform.achievements.enums.AchievementType.simple - unlocked by completion of a single event or objective, horizon.platform.achievements.enums.AchievementType.bitfield - unlocked when a number of bits in a bitfield are set, and horizon.platform.achievements.enums.AchievementType.count - unlocked when a counter reaches a defined target.