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

LeaderboardStartAt

Updated: Oct 30, 2025

LeaderboardStartAt

@Serializable
enum LeaderboardStartAt : Enum<LeaderboardStartAt>
An enum that allows you to specify the starting point for the leaderboard entries. It can be used as a params in horizon.platform.leaderboards.Leaderboards.getEntries to the starting point for the leaderboard entries that are returned in the response.

Entries

NameSummary
@SerialName(value = "TOP")
Top
This value indicates that the leaderboard entries should start at the top of the leaderboard.
@SerialName(value = "CENTERED_ON_VIEWER")
CenteredOnViewer
This value indicates that the leaderboard entries should start at the viewer’s position on the leaderboard
@SerialName(value = "CENTERED_ON_VIEWER_OR_TOP")
CenteredOnViewerOrTop
This value indicates that the leaderboard entries should start at the viewer’s position on the leaderboard, or at the top of the leaderboard if the viewer is not present.
@SerialName(value = "UNKNOWN")
Unknown
Represents that the LeaderboardStartAt is unknown.

Properties

NameSummary
name
val name: String
ordinal
val ordinal: Int
value
val value: Int

Functions

NameSummary
valueOf
fun valueOf(value: String): LeaderboardStartAt
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
values
fun values(): Array<LeaderboardStartAt>
Returns an array containing the constants of this enum type, in the order they’re declared.