GKLeaderboardMBS.category as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The named leaderboard to retrieve information from.

If non-empty, Game Center only returns scores with a matching category value. If empty, this property is ignored. Default is empty.
(Read and Write computed property)

GKLeaderboardMBS.Constructor

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Initializes a default leaderboard request.

A leaderboard object initialized with this method uses the playerScope, timeScope, and range properties to search Game Center for scores.

See also:

• Constructor(playerIDs() as string)

GKLeaderboardMBS.Constructor(playerIDs() as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Initializes a leaderboard request to retrieve the scores of a specific group of players.

playerIDs: An array of strings that holds the player identifier strings of the players to retrieve.

A leaderboard object initialized with this method ignores the playerScope and range properties. Instead, it retrieves scores for the specific list of players whose IDs are included in the playerIDs parameter.

See also:

• Constructor

GKLeaderboardMBS.groupIdentifier as string

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

Set when leaderboards have been designated a game group; set when loadLeaderboards has been called for leaderboards that support game groups.

Available on Mac OS X 10.8.2 and newer.

GKLeaderboardMBS.isLoading as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

A Boolean value that indicates whether the leaderboard object is retrieving scores. (read-only)

The value of the loading property is true if the leaderboard object has any pending requests for scores.

GKLeaderboardMBS.loadScores(tag as Variant = nil)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Retrieves a set of scores from Game Center.

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.loadScoresCompleted event.

You can call this method multiple times; each call represents a different query against the scores stored on Game Center. If you post multiple load operations using the same leaderboard object, any properties that are updated by loading scores reflect the last query that completed. The order that achievement queries are processed is arbitrary.

GKLeaderboardMBS.localPlayerScore as GKScoreMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The score earned by the local player. (read-only)

This property is invalid until a call to loadScores is completed. Afterward, it contains a score object representing the local player's score on the leaderboard.

GKLeaderboardMBS.maxRange as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The size of the leaderboard. (read-only)

This property is invalid until a call to loadScores is completed. Afterward, it contains the total number of entries available to return to your game given the filters you applied to the query.

GKLeaderboardMBS.playerScope as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

A filter used to restrict the search to a subset of the players on Game Center.

The playerScope property is ignored if the leaderboard request was initialized using the Constructor method. Otherwise, the playerScope property determines which players are included in the request for high scores. The default is GKLeaderboardPlayerScopeGlobal. See Leaderboard Player Scope constants for more information.
(Read and Write computed property)

GKLeaderboardMBS.range as NSRangeMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The numerical score rankings to return from the search.

The range property is ignored if the leaderboard request was initialized using the Constructor method. Otherwise, the range property is used to filter which scores are returned to your game. For example, if you specified a range of [1,10], after the search is complete, your game receives the top ten scores. The default range is [1,25].

The minimum index is 1. The maximum length is 100.
(Read and Write computed property)

GKLeaderboardMBS.scores as GKScoreMBS()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The list of scores returned by the search. (read-only)

This property is invalid until a call to loadScores is complete. Afterward, it contains the same score objects that were returned to the completion handler.

GKLeaderboardMBS.timeScope as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

A filter used to restrict the search to scores that were posted within a specific period of time.

This property determines how far back in time the search looks for scores. The default value is GKLeaderboardTimeScopeAllTime. See Leaderboard Time Scope for more information.
(Read and Write computed property)

GKLeaderboardMBS.title as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The localized title for the leaderboard. (read-only)

This property is invalid until a call to loadScores is complete. Afterward, it contains the localized title that matches the category property of the leaderboard object.