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

LeaderboardFilterType Enum

An enum that defines the different types of filters that can be applied to a leaderboard. It can be used in Leaderboards.getEntries to filter the leaderboard entries, such as only friends or specific user IDs.

Signature

enum LeaderboardFilterType : Enum<LeaderboardFilterType> 

Enumeration Constants

MemberDescription
None
No filter enabled on the leaderboard.
Friends
This value indicates that the leaderboard should be filtered to include only friends (bidirectional followers) of the current user.
Unknown
Represents that the LeaderboardFilterType is unknown.
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

value : Int
[Get]
Signature
val value: Int