Leaderboards API Reference
This section documents all Google Play Games Services Leaderboards Blueprint nodes provided by the plugin. These nodes allow you to display leaderboard UI, submit scores, and retrieve leaderboard metadata and score data.
Before using any Leaderboards API functions, the player must be successfully signed in to Google Play Games Services. If the user is not signed in, these functions will fail or return no data.
Leaderboards UI
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Show All Leaderboards UI | – | On Opened: Called when the leaderboards UI is opened. On Closed: Called when the UI is closed by the user. On Failure (Error Message): Called if the UI fails to open. |
Displays the native Google Play Games UI with all available leaderboards. |
| Show Leaderboard UI | LeaderboardID (string), TimeSpan (EGooglePlayLeaderboardTimeSpan), Collection (EGooglePlayLeaderboardCollection) |
On Opened: Called when the leaderboard UI is opened. On Closed: Called when the UI is closed by the user. On Failure (Error Message): Called if the UI fails to open. |
Displays the native Google Play Games UI for a specific leaderboard. |
Score Submission
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Submit Score | LeaderboardID (string), Score (int64) |
– | Submits a score to the specified leaderboard. This is a fire-and-forget operation and does not return a result. |
| Submit Score Immediate | LeaderboardID (string), Score (int64) |
On Success (Data): Returns FGooglePlayLeaderboardScoreSubmissionData.On Failure (Error Message): Called if score submission fails. |
Submits a score and immediately returns detailed submission results. |
Leaderboard Metadata
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Get All Leaderboards | bForceReload (bool) |
On Success (Leaderboards): Returns an array of FGooglePlayLeaderboard.On Failure (Error Message): Called if loading fails. |
Loads metadata for all available leaderboards. |
| Get Leaderboard | LeaderboardID (string), bForceReload (bool) |
On Success (Leaderboard): Returns a FGooglePlayLeaderboard.On Failure (Error Message): Called if loading fails. |
Loads metadata for a specific leaderboard. |
Leaderboard Scores
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Get Top Scores | LeaderboardID (string), TimeSpan (EGooglePlayLeaderboardTimeSpan), Collection (EGooglePlayLeaderboardCollection), MaxResults (int32), bForceReload (bool) |
On Success (Scores): Returns an array of FGooglePlayLeaderboardScore.On Failure (Error Message): Called if loading fails. |
Loads the top scores for a leaderboard. |
| Get Player Centered Scores | LeaderboardID (string), TimeSpan (EGooglePlayLeaderboardTimeSpan), Collection (EGooglePlayLeaderboardCollection), MaxResults (int32), bForceReload (bool) |
On Success (Scores): Returns an array of FGooglePlayLeaderboardScore.On Failure (Error Message): Called if loading fails. |
Loads leaderboard scores centered around the current player. |
| Get Current Player Score | LeaderboardID (string), TimeSpan (EGooglePlayLeaderboardTimeSpan), Collection (EGooglePlayLeaderboardCollection) |
On Success: Returns bHasScore (bool) and FGooglePlayLeaderboardScore.On Failure (Error Message): Called if loading fails. |
Loads the current player's score for the specified leaderboard. |