Class Leaderboard

Example

//@input Asset.LeaderboardModule leaderboardModule

const createOptions = getCreateOptions();
script.leaderboardModule.getLeaderboard(createOptions, getLeaderboardSuccessCallback, getLeaderboardFailureCallback);

function getCreateOptions() {
    const options = Leaderboard.CreateOptions.create();
    options.name = "leaderboardName";
    options.ttlSeconds = 64000;
    options.orderingType = Leaderboard.OrderingType.Descending;

    return options;
}

function getRetrievalOptions() {
    const retrievalOptions = Leaderboard.RetrievalOptions.create();
    retrievalOptions.usersType = Leaderboard.UsersType.Friends;
    retrievalOptions.usersLimit = 3;

    return retrievalOptions;
}

function getLeaderboardSuccessCallback(leaderboard) {
    print("[Leaderboard] getLeaderbaord success callback");
    print("[Leaderboard] Leaderboard Name = " + leaderboard.name);
    print("[Leaderboard] Ordering Type = " + leaderboard.orderingType);

    const retrievalOptions = getRetrievalOptions();
    leaderboard.getLeaderboardInfo(retrievalOptions, getInfoSuccessCallback, getInfoFailureCallback);
    leaderboard.submitScore(100, submitScoreSuccessCallback, submitScoreFailureCallback);
}

function getLeaderboardFailureCallback(message) {
    print("[Leaderboard] getLeaderboard failure callback with message " + message);
}

function getInfoSuccessCallback(othersInfo, currentUserInfo) {
    print("[Leaderboard] getLeaderboardInfo success callback");

    if (!isNull(currentUserInfo)) {
        print(`[Leaderboard] Current User info: ${currentUserInfo.snapchatUser.displayName ? currentUserInfo.snapchatUser.displayName : ''} score: ${currentUserInfo.score}`);
    }
    othersInfo.forEach((userRecord, idx) => {
        print(`[Leaderboard] ${idx + 1}. ${userRecord.snapchatUser.displayName ? userRecord.snapchatUser.displayName : ''} score: ${userRecord.score}`);
    });
}

function getInfoFailureCallback(message) {
    print("[Leaderboard] getLeaderboardInfo failure callback with message " + message);
}

function submitScoreSuccessCallback(currentUserInfo) {
    print("[Leaderboard] submitScore success callback");
    if (!isNull(currentUserInfo)) {
        print(`[Leaderboard] Current User info: ${currentUserInfo.snapchatUser.displayName ? currentUserInfo.snapchatUser.displayName : ''} score: ${currentUserInfo.score}`);
    }
}

function submitScoreFailureCallback(message) {
    print("[Leaderboard] submitScore failure callback with message " + message);
}
Copy