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

OVR_LeaderboardFilterType.h File

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

Enumeration Types

Enumeration ovrLeaderboardFilterType_

A custom data structure that defines a set of enumerated values, where each value represents a specific type or category for that enumeration. See our index for a full list of our enums and APIs.
ovrLeaderboard_FilterNone
No filter enabled on the leaderboard.
ovrLeaderboard_FilterFriends
This value indicates that the leaderboard should be filtered to include only friends (bidirectional followers) of the current user.
ovrLeaderboard_FilterUnknown
No description available
ovrLeaderboard_FilterUserIds
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.

Typedefs

A custom data structure that defines a set of enumerated values, where each value represents a specific type or category for that enumeration. See our index for a full list of our enums and APIs.

Functions

Converts an ovrLeaderboardFilterType enum value to a string The returned string does not need to be freed
Converts a string representing an ovrLeaderboardFilterType to the actual enum value and returns the value.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon