Leaderboards

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

Leaderboards Type

Type of leaderboards on the current platform.

playgama_bridge_leaderboards_type()

Type	Game Logic
not_available	Leaderboards are not available. Any leaderboard functionality must be disabled in the game.
in_game	Leaderboards are available. The game must use the set_score method to set the player's score. The game should display custom in-game leaderboards using the data from the get_entries method.
native	Leaderboards are available. The game must use the set_score method to set the player's score. The game should not display custom in-game leaderboards because leaderboards are displayed in the platform interface and the get_entries method does not work.
native_popup	Leaderboards are available. The game must use the set_score method to set the player's score. The game should call show_native_popup to display leaderboards overlay and the get_entries method does not work.

Setup

Setup leaderboards in the config file. For each leaderboard add an id. You can override which id is sent to the platform's native SDK.

{
    ...    
    "leaderboards": [
        {
            "id": "test_leaderboard", // use this id in game logic
            "<ANY_PLATFORM_ID_HERE>": "<OVERRIDED_ID_FOR_PLATFORM_HERE>"
        }
    ]
}

Set Score

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

var leaderboardId = "YOUR_LEADERBOARD_ID" // id that you specified in the config file
var score = 42

playgama_bridge_leaderboards_set_score(leaderboardId, score)

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

Get Entries

Works only when playgama_bridge_leaderboards_type = in_game

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

var leaderboardId = "YOUR_LEADERBOARD_ID" // id that you specified in the config file

playgama_bridge_leaderboards_get_entries(leaderboardId)

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

Show Native Popup

Works only when playgama_bridge_leaderboards_type = native_popup

Displays the leaderboard overlay, including the player's rank and score.

var leaderboardId = "YOUR_LEADERBOARD_ID" // id that you specified in the config file

playgama_bridge_leaderboards_show_native_popup(leaderboardId)

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