Skip to content

Leaderboards

Functions

Function Name Usage Description Notes
GetNearbyValues Leaderboards.GetNearbyValues(string leaderboardId, number numValues, User user, callback callback) Gets nearby leaderboard values on the specified leaderboard for the specified user, centered on the user where possible. Results are returned as a parameter to the callback function. Callback function parameter is a table of results, each result contains name, score, rank & icon. May return cached results if used frequently.
GetTopValues Leaderboards.GetTopValues(string leaderboardId, number numValues, callback callback) Gets the top ranking values from the specified leaderboard. Results are returned as a parameter to the callback function. Callback function parameter is a table of results, each result contains name, score, rank & icon. May return cached results if used frequently.
GetMetadata Leaderboards.GetMetadata(callback callback) See Leaderboards.GetAllMetadata Gets the metadata of every leaderboard associated with this game. Results are as a parameter to the callback function. Callback function parameter is a table of results, each result contains id, displayName, displayIndex, resetTime, isPeriodic, isAscending & scoreType. Deprecated
GetMetadata Leaderboards.GetMetadata(string leaderboardId, callback callback) Gets the metadata of a single named leaderboard for this game. Results are as a parameter to the callback function. Callback function parameter is a table containing id, displayName, displayIndex, resetTime, isPeriodic, isAscending & scoreType.
GetAllMetadata Leaderboards.GetAllMetadata(callback callback)
GetNearbyValuesForGame Leaderboards.GetNearbyValuesForGame(string gameId, string leaderboardId, number numValues, User user, callback callback) Gets nearby leaderboard values for the specified GameId. Results are returned as a parameter to the callback function. Callback function parameter is a table of results, each result contains name, score, rank & icon. May return cached results if used frequently.
GetTopValuesForGame Leaderboards.GetTopValuesForGame(string gameId, string leaderboardId, number numValues, callback callback) Gets the top ranking values for the specified GameId Results are returned as a parameter to the callback function. Callback function parameter is a table of results, each result contains name, score, rank & icon. May return cached results if used frequently.
GetMetadataForGame Leaderboards.GetMetadataForGame(string gameId, callback callback) See Leaderboards.GetAllMetadataForGame Gets the metadata of every leaderboard associated with the specified GameId. Results are as a parameter to the callback function. Callback function parameter is a table of results, each result contains id, displayName, displayIndex, resetTime, isPeriodic, isAscending & scoreType. Deprecated
GetMetadataForGame Leaderboards.GetMetadataForGame(string gameId, string leaderboardId, callback callback) Gets the metadata of a single named leaderboard associated with the specified GameId. Results are as a parameter to the callback function. Callback function parameter is a table containing id, displayName, displayIndex, resetTime, isPeriodic, isAscending & scoreType.
GetAllMetadataForGame Leaderboards.GetAllMetadataForGame(string gameId, callback callback) Gets the metadata of every leaderboard associated with the specified GameId. Results are as a parameter to the callback function. Callback function parameter is a table of results, each result contains id, displayName, displayIndex, resetTime, isPeriodic, isAscending & scoreType.