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

LeaderboardFilterType

Updated: Oct 30, 2025

LeaderboardFilterType

@Serializable
enum LeaderboardFilterType : Enum<LeaderboardFilterType>
An enum that defines the different types of filters that can be applied to a leaderboard. It can be used in horizon.platform.leaderboards.Leaderboards.getEntries to filter the leaderboard entries, such as only friends or specific user IDs.

Entries

NameSummary
@SerialName(value = "NONE")
None
No filter enabled on the leaderboard.
@SerialName(value = "FRIENDS")
Friends
This value indicates that the leaderboard should be filtered to include only friends (bidirectional followers) of the current user.
@SerialName(value = "UNKNOWN")
Unknown
Represents that the LeaderboardFilterType is unknown.
@SerialName(value = "USER_IDS")
UserIds
Filter the leaderboard to include specific user IDs. Use this filter to get rankings for users that are competing against each other. You specify the leaderboard name and whether to start at the top, or for the results to center on the (client) user. Note that if you specify the results to center on the client user, their leaderboard entry will be included in the returned array, regardless of whether their ID is explicitly specified in the list of IDs.

Properties

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

Functions

NameSummary
valueOf
fun valueOf(value: String): LeaderboardFilterType
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<LeaderboardFilterType>
Returns an array containing the constants of this enum type, in the order they’re declared.