Leaderboards API Reference
This section documents all Steam Leaderboards Blueprint nodes provided by the plugin. These nodes allow you to find leaderboards, upload and download scores, and query leaderboard metadata and entries.
All functions operate on the currently logged-in Steam user and require Steam to be running and initialized.
Leaderboard Discovery
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Find Leaderboard | LeaderboardName (string) |
On Success (LeaderboardID): Returns FSteamLeaderboardID.On Failure (Error Message) |
Finds an existing Steam leaderboard by name and returns its identifier. The leaderboard must already exist in Steamworks. |
Score Upload
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Upload Score To Leaderboard | LeaderboardID (FSteamLeaderboardID), Score (int32), UploadMethod (ESteamLeaderboardUploadMethod), Details (int32[]) |
On Success (Result): Returns FSteamUploadScoreResult.On Failure (Error Message) |
Uploads a score to the specified leaderboard for the current user. Supports keeping the best score or forcing an update. |
Score Download
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Download Leaderboard Scores | LeaderboardID (FSteamLeaderboardID), DataRequest (ESteamLeaderboardDataRequest), RangeStart (int32), RangeEnd (int32) |
On Success (Result): Returns FSteamDownloadScoresResult.On Failure (Error Message) |
Downloads leaderboard entries based on the selected data request type (Global, Friends, or Around User) and score range. |
Leaderboard Entries
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Get Current User Leaderboard Entry | LeaderboardID (FSteamLeaderboardID) |
On Success (Entry): Returns FSteamLeaderboardEntry.On Failure (Error Message) |
Retrieves the leaderboard entry for the current Steam user, including score, rank, and details. |
| Get Leaderboard Entry For User | LeaderboardID (FSteamLeaderboardID), UserID (FSteamUserID) |
On Success (Entry): Returns FSteamLeaderboardEntry.On Failure (Error Message) |
Retrieves the leaderboard entry for a specific Steam user by their Steam ID. |
Leaderboard Getters
These nodes are synchronous getters and do not provide callbacks.
| Node | Parameters | Return | Description |
|---|---|---|---|
| Get Leaderboard Entry Count | LeaderboardID (FSteamLeaderboardID) |
int32 |
Returns the total number of entries in the specified leaderboard. |
| Get Leaderboard Sort Method | LeaderboardID (FSteamLeaderboardID) |
ESteamLeaderboardSortMethod |
Returns the sort method used by the leaderboard (Ascending or Descending). |
| Get Leaderboard Display Type | LeaderboardID (FSteamLeaderboardID) |
ESteamLeaderboardDisplayType |
Returns how leaderboard scores are displayed (Numeric, Time in Seconds, or Time in Milliseconds). |
| Get Leaderboard Name | LeaderboardID (FSteamLeaderboardID) |
string |
Returns the name of the specified leaderboard as defined in Steamworks. |