gamecircle.Leaderboard.LocalPlayerScoreReturn

Type Table

Library gamecircle.*

Revision Release 2025.3714

Keywords achievement, return, value, table

Overview

Table that encapulates the error values and return value from the GetLocalPlayerScore function.

Properties

isError - Boolean
If the GameCircle SDK encountered an error, this value will be true.
errorMessage - String
If the GameCircle SDK encountered an error, this string will be populated with an error message.
rank - Number
The local player’s rank on the leaderboard, base on the filter given in the originating request function.
score - Number
The highest score recorded for the local player on a leaderboard given the filter provided in the originating request function.

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("Score information recieved for Leaderboard!")  
        print("The local player is rank " .. returnValue.rank .. " with a score of " .. returnValue.score .. ".")  
    end 
end 
gamecircle.Leaderboard.GetLocalPlayerScore(leaderboardId, "GLOBAL_WEEK", LeaderboardCallback)

Type	Table
Library	gamecircle.*
Revision	Release 2025.3714
Keywords	achievement, return, value, table