Leaderboards
AI Summary
A short gist of this page, generated for you.
Powered by AI. Summaries can miss nuance — when in doubt, read the page.
Leaderboards rank player scores across everyone who plays your game.
Check the feature flag
Leaderboards are currently not enabled (features.leaderboardsEnabled === false). Check the flag from the init() result before showing any leaderboard UI.
javascript
var leaderboardsOn = false;
FunOxSDK.init().then(function (result) {
leaderboardsOn = result.features.leaderboardsEnabled;
});#submitScore(score, leaderboardId?)
Submits a score. leaderboardId defaults to 'main'.
javascript
if (leaderboardsOn) {
FunOxSDK.submitScore(9500).then(function (result) {
console.log('Rank:', result.rank);
});
}score must be a number; anything else is rejected with INVALID_SCORE.
#getLeaderboard(options?)
Fetches leaderboard entries.
javascript
FunOxSDK.getLeaderboard({
leaderboardId: 'main', // default: 'main'
limit: 10, // default: 10
offset: 0, // default: 0
timeframe: 'weekly' // 'alltime' | 'weekly' | 'daily', default: 'alltime'
}).then(function (result) {
displayLeaderboard(result.entries);
});#Result
json
{
"entries": [
{ "rank": 1, "name": "PlayerOne", "score": 99000, "avatar": "..." },
{ "rank": 2, "name": "PlayerTwo", "score": 88000, "avatar": "..." }
],
"playerEntry": { "rank": 45, "score": 9500 }
}