Skip to content

Leaderboards

The Leaderboards feature provides access to Steam leaderboards for competitive scores, rankings, time trials, and other ordered player results.

It can find existing leaderboards, optionally create them, upload scores, download ranking ranges, and retrieve entries for the local user or another Steam user.

Main Capabilities

  • Find a Steam leaderboard by name
  • Find or create a leaderboard
  • Upload scores with configurable replacement behavior
  • Attach optional integer details to score entries
  • Download global, friends, or around-user score ranges
  • Retrieve the current user's entry
  • Retrieve an entry for a specific Steam user
  • Read leaderboard name, entry count, sort method, and display type

Basic Workflow

A typical leaderboard flow is:

  1. Configure the leaderboard in Steamworks.
  2. Call Find Steam Leaderboard using its name.
  3. Store the returned FSteamLeaderboardID.
  4. Use that ID when uploading or downloading scores.
  5. Display downloaded FSteamLeaderboardEntry values in your UI.

For Steamworks configuration, see Steamworks Setup.

For practical Blueprint workflows, see Examples.

Score Upload Behavior

Score replacement is controlled by ESteamLeaderboardUploadMethod.

Use Keep Best when Steam should preserve the better existing score, or Force Update when every submitted value should replace the current one.

The upload callback returns FSteamUploadScoreResult, including whether the score changed and the previous/new global rank.

Downloading Entries

Leaderboard ranges use ESteamLeaderboardDataRequest to select global, around-user, or friends data.

Leaderboard ordering and score presentation are described by ESteamLeaderboardSortMethod and ESteamLeaderboardDisplayType.

Important Notes

  • Leaderboard names must match the Steamworks configuration when finding existing leaderboards.
  • Steam manages ranking and sorting; the plugin does not rank entries locally.
  • Uploads and downloads are asynchronous.
  • Score meaning depends on the leaderboard configuration, especially its sort method and display type.
  • Find Or Create should be used intentionally; production projects commonly preconfigure leaderboards in Steamworks.