Instance Property

leaderboardIdentifier

The named leaderboard that is displayed by the view controller.

Declaration

var leaderboardIdentifier: String? { get set }

Discussion

The leaderboardIdentifier property must either be nil or it must match a leaderboard identifier you defined when you created your leaderboards in App Store Connect. If nil, the view displays scores for the aggregate leaderboard. Default is nil.

When the leaderboard is presented, the value of this property determines which leaderboard content is displayed to the player. As the player changes which leaderboard content they view, the leaderboardIdentifier property is automatically updated. For example, to preserve the player’s selections, you can read the leaderboardIdentifier property after the screen is dismissed, and set that value the next time you initialize the view controller.

See Also

Configuring the Game Center Controller’s Content

var viewState: GKGameCenterViewControllerState

The content displayed by the Game Center controller.

enum GKGameCenterViewControllerState

Possible values for the viewState property.

var leaderboardCategory: String?

The named leaderboard that is displayed by the view controller.

Deprecated
var leaderboardTimeScope: GKLeaderboard.TimeScope

A time filter used to restrict which scores are displayed to the player.