The named leaderboard that is displayed by the view controller.
SDKs
- iOS 4.1–7.0Deprecated
- macOS 10.8–10.10Deprecated
- Mac Catalyst 13.0–13.0Deprecated
Framework
- Game
Kit
Declaration
var leaderboardCategory: String? { get set }
Discussion
The category property must either be nil
or it must match a category 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 leaderboard
property is automatically updated. For example, to preserve the player’s selections, you can read the leaderboard
property after the screen is dismissed, and set that value the next time you initialize the view controller.