Google Play Leaderboards
The Google Play Leaderboards is a service which allows you to create multiple different types of leaderboards for users of your application to compete in. This adds a flavour of competitiveness to your application.
Leaderboards can be categorised in the PUBLIC or FRIENDS domain, defaulting to PUBLIC. In addition to this, you can fetch leaderboards at different time spans and positions within larger leaderboards.
You setup your leaderboards in the Google Play Console.
Available Blueprint Nodes
The below blueprint nodes allow you to display your leaderboards through Google's external user interface (UI) or generate your own by fetching the raw data. They also allow you to record scores for the currently signed in player to be represented on the leaderboard.
Google Play Launch All Leaderboards Display
This blueprint node will show the list of leaderboards for a game through an external Google user interface.
On Success
A delegate which produces no paramaters and is called once the external UI has been displayed.
You can simply click and drag off this pin to create a custom event.
On Failure
A delegate producing a message describing the failure.
You can simply click and drag off this pin to create a custom event.
Google Play Launch Leaderboard Display
This blueprint node will show a specific leaderboard for a game through an external Google user interface.
Leaderboard ID
The Leaderboard ID from the Google Play Console for the leaderboard.
Time Span
The Time Span enumeration indicating which period of time to show the scores for.
Collection
The Collection enumeration which indicates which group of people to include in the scores.
On Success
A delegate which produces no paramaters and is called once the external UI has been displayed.
You can simply click and drag off this pin to create a custom event.
On Failure
A delegate producing a message describing the failure.
You can simply click and drag off this pin to create a custom event.
Google Play Submit Leaderboard Score
A blueprint node which submits a score to a leaderboard for the currently signed-in player. The score is ignored if it is worse (as defined by the leaderboard configuration) than a previously submitted score for the same player.
Leaderboard ID
The Leaderboard ID from the Google Play Console to submit the score to.
Score
An integer representing the raw score value.
Google Play Submit Leaderboard Score Immediate
A blueprint node which submits a score to a leaderboard for the currently signed-in player immediatly providing feedback whether it is successful or not. The score is ignored if it is worse (as defined by the leaderboard configuration) than a previously submitted score for the same player.
Leaderboard ID
The Leaderboard ID from the Google Play Console to submit the score to.
Score
An integer representing the raw score value.
OnSuccess
A delegate which produces a FGooglePlayLeaderboardScoreSubmissionData object representing the submission result.
You can simply click and drag off this pin to create a custom event.
OnFailure
A delegate producing a message describing the failure.
You can simply click and drag off this pin to create a custom event.
Google Play Get All Leaderboards
This blueprint node fetches an array of all leaderboard metadata for every leaderboard registered to the application.
Clear Cache
A boolean indicating whether or not to clear locally cached data and attempt to fetch the latest data from the server.
On Success
A delegate which produces an array of FGooglePlayLeaderboard metadata representing all leaderboards.
You can simply click and drag off this pin to create a custom event.
On Failure
A delegate producing a message describing the failure.
You can simply click and drag off this pin to create a custom event.
Google Play Get Leaderboard
This blueprint node fetches the leaderboard metadata for a leaderboard.
Leaderboard ID
The Leaderboard ID from the Google Play Console for the leaderboard.
Clear Cache
A boolean indicating whether or not to clear locally cached data and attempt to fetch the latest data from the server.
On Success
A delegate which produces the FGooglePlayLeaderboard metadata for the leaderboard.
You can simply click and drag off this pin to create a custom event.
On Failure
A delegate producing a message describing the failure.
You can simply click and drag off this pin to create a custom event.
Google Play Get Current Player Leaderboard Score
This blueprint node fetches the GooglePlayLeaderboardScore that represents the signed-in player's score for the leaderboard.
Leaderboard ID
The Leaderboard ID from the Google Play Console for the leaderboard.
Time Span
The Time Span enumeration indicating which period of time to show the scores for.
Collection
The Collection enumeration which indicates which group of people to include in the scores.
On Success
A delegate which produces the currently signed-in player's GooglePlayLeaderboardScore for the leaderboard.
You can simply click and drag off this pin to create a custom event.
On Failure
A delegate producing a message describing the failure.
You can simply click and drag off this pin to create a custom event.
Google Play Get Player Centered Scores
This blueprint node fetches an array of FGooglePlayLeaderboardScore that represents the player-centered page of scores for the leaderboard.
Leaderboard ID
The Leaderboard ID from the Google Play Console for the leaderboard.
Time Span
The Time Span enumeration indicating which period of time to show the scores for.
Collection
The Collection enumeration which indicates which group of people to include in the scores.
Max Results
An integer representing the maximum number of scores to fetch per page. Must be between 1 and 25.
NOTE: This value must be between 1 and 25. If it is not, it will be clamped for you.
Clear Cache
A boolean indicating whether or not to clear locally cached data and attempt to fetch the latest data from the server.
On Success
A delegate which produces the currently signed-in player's GooglePlayLeaderboardScore for the leaderboard.
You can simply click and drag off this pin to create a custom event.
On Failure
A delegate producing a message describing the failure.
You can simply click and drag off this pin to create a custom event.
Google Play Get Top Scores
This blueprint node fetches an array of FGooglePlayLeaderboardScore that represents the top page of scores for the leaderboard.
Leaderboard ID
The Leaderboard ID from the Google Play Console for the leaderboard.
Time Span
The Time Span enumeration indicating which period of time to show the scores for.
Collection
The Collection enumeration which indicates which group of people to include in the scores.
Max Results
An integer representing the maximum number of scores to fetch per page. Must be between 1 and 25.
NOTE: This value must be between 1 and 25. If it is not, it will be clamped for you.
Clear Cache
A boolean indicating whether or not to clear locally cached data and attempt to fetch the latest data from the server.
On Success
A delegate which produces an array of GooglePlayLeaderboardScore representing the top scores for a leadeboard.
You can simply click and drag off this pin to create a custom event.
On Failure
A delegate producing a message describing the failure.
You can simply click and drag off this pin to create a custom event.
Google Play Get More Scores
This blueprint node fetches more GooglePlayLeaderboardScores for the previously loaded leaderboard.
NOTE: This will fail if you have not loaded the leaderboard using the above nodes first, as this defines the starting point to get more scores from.
Leaderboard ID
The Leaderboard ID from the Google Play Console for the leaderboard.
Max Results
An integer representing the maximum number of scores to fetch per page. Must be between 1 and 25.
NOTE: This value must be between 1 and 25. If it is not, it will be clamped for you.
Page Direction
The GooglePlayLeaderboardPageDirection enumeration indicating whether to get scores from before or after the current set.
NOTE: If the default Page Direction is chosen, no pagination will occur.
On Success
A delegate which produces an array of GooglePlayLeaderboardScore representing the scores for a leadeboard.
You can simply click and drag off this pin to create a custom event.
On Failure
A delegate producing a message describing the failure.
You can simply click and drag off this pin to create a custom event.