Leaderboard dialog

Display the player score and allow to submit it to a leaderboard.

Authors and contributors to this experimental extension: D8H.

Display the player score and allow to submit it to a leaderboard.

Tip

Learn how to install new extensions by following a step-by-step guide.

Leaderboard dialog

Displays the player score and allows to submit it to a leaderboard.

Object properties

Default player name (🔤 String).
Leaderboard (🔤 Leaderboard Identifier (String)).
Format (Choice, one of: "Number", "MM:SS.ms", "MM:SS", "SS.ms", "SS", "ms", "HH:MM:SS.ms", "HH:MM:SS"). Default value is Number.
Prefix (🔤 String).
Suffix (🔤 String).
Round to decimal point (🔢 Number). Default value is 3.
Score label (🔤 String). Default value is Score:.
Best score label (🔤 String). Default value is Best:.

See internal technical details

Default player name is stored as DefaultPlayerName (String). Default value is ``.
Leaderboard is stored as LeaderboardId (LeaderboardId). Default value is ``.
Format is stored as Format (Choice). Default value is Number.
Prefix is stored as Prefix (String). Default value is ``.
Suffix is stored as Suffix (String). Default value is ``.
Round to decimal point is stored as NumberDecimalPoint (Number). Default value is 3.
Score label is stored as ScoreLabelText (String). Default value is Score:.
Best score label is stored as BestScoreLabelText (String). Default value is Best:.

Object actions

Best score
Change the best score of the object.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Value

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::SetBestScore.

Default player name
Change the default player name.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Operator
Parameter 2 (🔤 String): Value

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::SetDefaultPlayerName.

Leaderboard
Change the leaderboard of the object.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Operator
Parameter 2 (🔤 Leaderboard Identifier (String)): Value

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::SetLeaderboardId.

Score
Change the score.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Value

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::SetScore.

Title
Change the title of the object.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Operator
Parameter 2 (🔤 String): Value

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::SetTitle.

Object conditions

Best score
Compare the best score of the object.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::BestScore.

Default player name
Compare the default player name.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Relational operator
Parameter 2 (🔤 String): Value to compare

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::DefaultPlayerName.

Back button clicked
Check if the back button of the dialog is clicked.

See parameters & details

Parameter 0: 👾 Object

Technical note: parameter 1 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::IsBackClicked.

Next button clicked
Check if the next button of the dialog is clicked.

See parameters & details

Parameter 0: 👾 Object

Technical note: parameter 1 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::IsNextClicked.

Restart button clicked
Check if the restart button of the dialog is clicked.

See parameters & details

Parameter 0: 👾 Object

Technical note: parameter 1 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::IsRestartClicked.

Score is submitted
Check if the score has been sucessfully submitted by the dialog.

See parameters & details

Parameter 0: 👾 Object

Technical note: parameter 1 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::IsScoreSubmitted.

Leaderboard
Compare the leaderboard of the object.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Relational operator
Parameter 2 (🔤 Leaderboard Identifier (String)): Value to compare

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::LeaderboardId.

Player name
Compare the player name.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Relational operator
Parameter 2 (🔤 String): Value to compare

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::PlayerName.

Score
Compare the score.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is LeaderboardDialog::LeaderboardDialog::Score.

Object expressions

Expression	Description
`Object.BestScore()`	Return the best score of the object.
`Object.DefaultPlayerName()`	Return the default player name.
`Object.LeaderboardId()`	Return the leaderboard of the object.
`Object.PlayerName()`	Return the player name.
`Object.Score()`	Return the score.

This page is an auto-generated reference page about the Leaderboard dialog extension for GDevelop, the open-source, AI-powered, cross-platform game engine designed for everyone. Learn more about all GDevelop extensions here.