Skip to main content

UgsLeaderboards

14 tools in this family (folder Editor/Tools/UgsLeaderboards/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.

ToolEffectDescription
ugs_leaderboards_export_setupread-onlyExport the complete dashboard configuration (leaderboards + sort order + score type + reset
ugs_leaderboards_get_friends_leaderboardread-onlyConvenience wrapper for friends-only filtering. Bridges into the ugs_friends_* family to fetch
ugs_leaderboards_get_my_tierread-onlyReturn the tier the signed-in player currently sits in on a given leaderboard. Tier is derived
ugs_leaderboards_get_player_scoreread-onlyFetch the signed-in player's single entry on a leaderboard. Returns rank, score, tier,
ugs_leaderboards_get_scoresread-onlyPage through a leaderboard. Returns up to limit entries starting at offset. Set
ugs_leaderboards_get_scores_around_playerread-onlyReturn the entries immediately above and below the signed-in player. With range_limit=5, the
ugs_leaderboards_get_scores_by_playersread-onlyFetch entries for a specific list of player ids. Useful for displaying a clan / party list, or
ugs_leaderboards_get_tiersread-onlyReturn every configured tier on a leaderboard. Each tier carries name, min_score, max_score and
ugs_leaderboards_get_version_scoresread-onlyPage through the scores of a SPECIFIC archived version of a leaderboard. Pair with
ugs_leaderboards_get_versionsread-onlyReturn the full version history for a leaderboard: every archived window plus the current one.
ugs_leaderboards_initwritesInitialize UGS Leaderboards. Verifies UGS Authentication is initialized and the player is signed in
ugs_leaderboards_post_cross_platformwritesMirror a single score to BOTH the cross-platform UGS leaderboard AND a Steam-side board in one
ugs_leaderboards_post_scorewritesAtomically post a score for the signed-in player. The server applies the leaderboard's configured
ugs_leaderboards_setup_auto_postwritesGenerate ready-to-drop C# files for a project: a paginated leaderboard panel, a friends-only