Leaderboards

Enhance competitiveness by integrating leaderboards, allowing players to compare their scores and achievements.

Support

Use this to determine if you can implement leaderboards for your game on the current platform.

Check if the leaderboard feature is supported on the platform.

playgama_bridge_leaderboard_is_supported()

Check if built-in popup is supported.

playgama_bridge_leaderboard_is_native_popup_supported()

Check if multiple boards are supported.

playgama_bridge_leaderboard_is_multiple_boards_supported()

Check if user can set score to leaderboard.

playgama_bridge_leaderboard_is_set_score_supported()

Check if user can retrieve their score.

playgama_bridge_leaderboard_is_get_score_supported()

Check if user can access leaderboard entries including other players' scores.

playgama_bridge_leaderboard_is_get_entries_supported()

Player Scores. Set

Submit the player's score to the leaderboard to update their rank and position.

var options
switch playgama_bridge_platform_id() {
    case "yandex":
	options = {
    	    "leaderboardName": "YOUR_LEADERBOARD_NAME",
            "score": 42
        }
        break
    case "facebook":
        options = {
            "leaderboardName": "YOUR_LEADERBOARD_NAME",
            "score": 42
        }
        break
    case "lagged":
        options = {
            "boardId": "YOUR_LEADERBOARD_ID",
            "score": 42
        }
        break
    case "y8":
        options = {
            "table": "YOUR_LEADERBOARD_NAME",
            "points": 42
        }
        break
}

playgama_bridge_leaderboard_set_score(json_stringify(options))

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_leaderboard_set_score_callback" {
	if async_load[? "success"] {
		// your logic
	}
}

// callback via script
function playgama_bridge_leaderboard_set_score_callback(success) {
	if success {
		// your logic
	}
}

Player Scores. Get

Retrieve the player's score from the leaderboard to display their current standing.

var options
switch playgama_bridge_platform_id() {
    case "yandex":
        options = {
            "leaderboardName": "YOUR_LEADERBOARD_NAME",
        }
        break
    case "facebook":
        options = {
            "leaderboardName": "YOUR_LEADERBOARD_NAME",
        }
        break
    case "y8":
        options = {
            "table": "YOUR_LEADERBOARD_NAME",
        }
        break
}

playgama_bridge_leaderboard_get_score(json_stringify(options))

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_leaderboard_get_score_callback" {
    if async_load[? "success"] {
        var score_value = async_load[? "data"]
    }
}

// callback via script
function playgama_bridge_leaderboard_get_score_callback(success, data) {
    if success {
        var score_value = data
    }
}

Get Full Leaderboard

Retrieve entries from the leaderboard, including the player's rank and score, to display a comprehensive leaderboard.

var options
switch playgama_bridge_platform_id() {
    case "yandex":
        options = {
            "leaderboardName": "YOUR_LEADERBOARD_NAME",
            "includeUser": true, // default = false
            "quantityAround": 10, // default = 5
            "quantityTop": 10 // default = 5
        }
        break
    case "facebook":
        options = {
            "leaderboardName": "YOUR_LEADERBOARD_NAME",
            "count": 10, // default = 5
            "offset": 10 // default = 0
        }
        break
    case "y8":
        options = {
            "table": "YOUR_LEADERBOARD_NAME",
            "perPage": 5, // optional, default = 20, max = 100
            "page": 1, // optional, default = 1
            "mode": "alltime", // optional, "alltime" | "last30days" |  "last7days" |  "today" | "newest"
        }
        break
}

playgama_bridge_leaderboard_get_entries(json_stringify(options))

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_leaderboard_get_entries_callback" {
    if async_load[? "success"] {
        var entries = json_parse(async_load[? "data"])
    }
}

// callback via script
function playgama_bridge_leaderboard_get_entries_callback(success, data) {
    if success {
        var entries = json_parse(data)
    }
}

Show Native Popup

Shows leaderboard entries built-in popup

var options
switch playgama_bridge_platform_id() {
    case "y8":
        options = {
            "table": "YOUR_LEADERBOARD_NAME"
        }
        break
}

playgama_bridge_leaderboard_show_native_popup(json_stringify(options))

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_leaderboard_show_native_popup_callback" {
    if async_load[? "success"] {
        // your logic here
    }
}

// callback via script
function playgama_bridge_leaderboard_show_native_popup_callback(success, data) {
    if success {
        // your logic here
    }
}