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

ovr_Leaderboard_GetEntries Function

Retrieves a list of leaderboard entries for a specified leaderboardName, with options to filter and limit the number of results returned. Error codes
  • 100: Parameter {parameter}: invalid user id: {user_id}
  • 100: Something went wrong.
  • 12074: You're not yet ranked on this leaderboard.
A message with type ovrMessage_Leaderboard_GetEntries will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrLeaderboardEntryArrayHandle. Extract the payload from the message handle with ovr_Message_GetLeaderboardEntryArray().

Signature

ovrRequest ovr_Leaderboard_GetEntries(const char *leaderboardName, int limit, ovrLeaderboardFilterType filter, ovrLeaderboardStartAt startAt)

Parameters

leaderboardName: const char * The name of the leaderboard from which to retrieve entries.
limit: int Specifies the maximum number of entries to be returned.
filter: ovrLeaderboardFilterType By using ovrLeaderboard_FilterFriends, this allows you to filter the returned values to bidirectional followers.
startAt: ovrLeaderboardStartAt Defines whether to center the query on the user or start at the top of the leaderboard.

Returns