Leaderboards API Reference
This section documents all Leaderboards Blueprint nodes provided by PloxTools: Steam Integration.
All functions require Steam to be initialized unless stated otherwise.
Leaderboards
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Find Steam Leaderboard | LeaderboardName (string) |
On Success (Leaderboard ID: FSteamLeaderboardID)On Failure (Error Message: string) |
Finds an existing Steam leaderboard by name and returns its ID. The leaderboard must already exist in Steamworks. |
| Find Or Create Steam Leaderboard | LeaderboardName (string)SortMethod (ESteamLeaderboardSortMethod)DisplayType (ESteamLeaderboardDisplayType) |
On Success (Leaderboard ID: FSteamLeaderboardID)On Failure (Error Message: string) |
Finds a Steam leaderboard by name or creates it if it does not exist. Sort and display settings are used only when a new leaderboard is created. |
| Upload Score To Steam Leaderboard | LeaderboardID (FSteamLeaderboardID)Score (int32)UploadMethod (ESteamLeaderboardUploadMethod)Details (array of int32) |
On Success (Result: FSteamUploadScoreResult)On Failure (Error Message: string) |
Uploads a score to the specified leaderboard for the current user. You can choose whether to keep the best score or force update it. |
| Download Steam Leaderboard Scores | LeaderboardID (FSteamLeaderboardID)DataRequest (ESteamLeaderboardDataRequest)RangeStart (int32)RangeEnd (int32) |
On Success (Result: FSteamDownloadScoresResult)On Failure (Error Message: string) |
Downloads leaderboard entries based on the selected data request type (Global, Friends, or Around User) and range. |
| Get Current User Steam Leaderboard Entry | LeaderboardID (FSteamLeaderboardID) |
On Success (Entry: FSteamLeaderboardEntry)On Failure (Error Message: string) |
Gets the leaderboard entry for the current Steam user, including score, rank, and details. |
| Get Steam Leaderboard Entry For User | LeaderboardID (FSteamLeaderboardID)UserID (FSteamUserID) |
On Success (Entry: FSteamLeaderboardEntry)On Failure (Error Message: string) |
Gets the leaderboard entry for a specific Steam user by their Steam ID. |
Getters
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Get Steam Leaderboard Entry Count | LeaderboardID (FSteamLeaderboardID) |
int32 | Returns the total number of entries in the specified leaderboard. |
| Get Steam Leaderboard Sort Method | LeaderboardID (FSteamLeaderboardID) |
ESteamLeaderboardSortMethod |
Returns the sort method of the leaderboard (Ascending or Descending). |
| Get Steam Leaderboard Display Type | LeaderboardID (FSteamLeaderboardID) |
ESteamLeaderboardDisplayType |
Returns how the leaderboard score is displayed (Numeric, Time in Seconds, or Time in Milliseconds). |
| Get Steam Leaderboard Name | LeaderboardID (FSteamLeaderboardID) |
string | Returns the name of the specified leaderboard as defined in Steamworks. |