Platforms to show: All Mac Windows Linux Cross-Platform

Back to GKLeaderboardMBS class.

GKLeaderboardMBS.Available as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
True if the class is available.

Should always be true on Mac OS X 10.8 and newer.

GKLeaderboardMBS.loadCategories(tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Loads the list of leaderboard categories along with their corresponding localized titles.

You use this class method to retrieve the category identifiers and titles you configured for your leaderboards on iTunes Connect. To create a leaderboard query that targets a particular category, set the category property to one of the strings returned by this method.

When this method is called, it creates a new background task to handle the request. The method then returns control to your game. Later, when the task is complete, Game Kit calls GameKitMBS.loadCategoriesCompleted event.

GKLeaderboardMBS.loadLeaderboards(tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Loads the leaderboards.

Calls GameKitMBS.loadLeaderboardsCompleted later when completed.
Available on Mac OS X 10.8.2 and newer.

GKLeaderboardMBS.setDefaultLeaderboard(categoryID as string, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Sets the default leaderboard for the local player.

categoryID: The named leaderboard that should be the new default leaderboard for the local player.

The default leaderboard is used whenever your game uses a GKScore object to report a score to Game Center without explicitly setting the score object's category property. The default leaderboard is normally set in iTunes Connect when you configure your game. However, your game can use this class method to override the default leaderboard that appears for the local player.

When this method is called, it creates a new background task to handle the request. The method then returns control to your game. Later, when the task is complete, Game Kit calls GameKitMBS.setDefaultLeaderboardCompleted event.

If an error occurs and was a network error, your game should periodically resend the request until it completes.

The items on this page are in the following plugins: MBS MacFrameworks Plugin.


The biggest plugin in space...