gamecircle.Leaderboard.Leaderboard

Overview

A representation of the leaderboard data returned by GameCircle SDK for some functions.

Properties

• id - String The GameCircle ID of the leaderboard.
• name - String The name of the leaderboard.
• displayText - String The informative display text for the leaderboard.
• imageURL - String The URL to the leaderboard’s image as stored on Amazon’s servers.
• scoreFormat - String A string giving details of how the leaderboard’s scores are formated.

Example

local leaderboardId = "myFirstLeaderboard"  
local gamecircle = require("plugin.gamecircle")  
gamecircle.Init(false, true, false)  
function LeaderboardCallback(returnValue)  
    if returnValue.isError == true then  
        print("Get Scores request returned with error message: " .. returnValue.errorMessage)  
    else  
        print("Leaderboard information recieved!")  
        print("-num" .. returnValue.num)  
        for i, leaderboard in ipairs(returnValue) do   
            print("-Leaderboard ID" .. leaderboard.id)  
            print("--name" .. leaderboard.name)  
            print("--displayText" .. leaderboard.displayText)  
            print("--scoreFormat" .. leaderboard.scoreFormat)  
            print("--imageURL" .. leaderboard.imageURL)  
            print("--imageURL may be blank, as warned by Amazon's SDK documentation, when propegated outside basic GetLeaderboard function")  
        end  
    end  
end  
gamecircle.Leaderboard.GetLeaderboards(LeaderboardCallback)