Type function Library gamecircle.* Return value None Revision Release 2024.3703 Keywords Leaderboard, Overlay
This function will make the GameCircle SDK open it's own Leaderboard overlay on top of the current application. This will allow users to see their position on a leaderboard or all available leaderboards.
gamecircle.Leaderboard.OpenOverlay() gamecircle.Leaderboard.OpenOverlay(id)
String. The Gamecircle ID of the leaderboard that is to be displayed in the overlay. If the parameter is not given, the GameCircle system will open an overlay displaying all of the game's available leaderbaords.
local leaderboardId = "myFirstLeaderboard"
local gamecircle = require("plugin.gamecircle")
gamecircle.Init(false, true, false)
gamecircle.Leaderboard.OpenOverlay(leaderboardId)