Platforms to show: All Mac Windows Linux Cross-Platform

Back to GameKitMBS class.

GameKitMBS.leaderboardViewControllerDidFinish(viewController as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The leaderboard view has finished.

viewController: The GKLeaderboardViewControllerMBS object.

GameKitMBS.loadAchievementDescriptionsCompleted(achievements() as GKAchievementDescriptionMBS, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called by GKAchievementDescriptionMBS.loadAchievementDescriptions when the download is completed.

descriptions: An array of description objects for the achievements in your game. If an error occurred, this value may be non-empty. In this case, the array holds whatever descriptions were downloaded by Game Kit before the error occurred.
error: If an error occurred, this error object describes the error. If the operation completed successfully, this value is nil.

GameKitMBS.loadAchievementsCompleted(achievements() as GKAchievementMBS, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called by GKAchievementMBS.loadAchievements when the download is completed.

achievements: An array of achievement objects that represents all progress reported to Game Center for the local player. If an error occurred, this parameter may be non-empty, in which case the array holds whatever achievement information Game Kit was able to fetch.
error: If an error occurred, this object describes the error. If the operation completed successfully, this value is nil.

GameKitMBS.loadCategoriesCompleted(categories() as string, titles() as string, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called by GKLeaderboardMBS.loadCategories when the categories have been retrieved from the server.

categories: An array of strings that provides the categories to your game. If an error occurred, this value may be non-empty. In this case, the array holds whatever data Game Kit was able to download before the error occurred.
titles: An array of strings that provides localized titles for each category. If an error occurred, this value may be non-empty. In this case, the array holds whatever data Game Kit was able to download before the error occurred.
error: If an error occurred, this error object describes the error. If the operation completed successfully, the value is nil.

GameKitMBS.loadDefaultLeaderboardCategoryIDCompleted(LocalPlayer as GKLocalPlayerMBS, categoryID as string, error as NSErrorMBS, tag as Variant)

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

categoryID: The category ID string for the local player's default leaderboard.
error: If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is nil.

Available on Mac OS X 10.8.2 and newer.

GameKitMBS.loadFriendPlayersCompleted(localPlayer as GKLocalPlayerMBS, friendPlayers() as GKPlayerMBS, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 15.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The event called by GKLocalPlayerMBS.loadFriendPlayers.

friendPlayers: An array of GKPlayer objects containing the player identifiers for the players that are friends of the local player. If an error occurred, this value can be non-nil. In that case, the array contains the data that Game Kit was able to download before the error occurred.
error: If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is nil.

GameKitMBS.loadFriendsCompleted(localPlayer as GKLocalPlayerMBS, friends() as string, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called by GKLocalPlayerMBS.loadFriends when the request completes.

friends: An array of player identifiers for the players that are friends of the local player. If an error occurred, this value can be non-empty. In that case, the array contains the data that Game Kit was able to download before the error occurred.
error: If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter is nil.

GameKitMBS.loadImageCompleted(description as GKAchievementDescriptionMBS, image as NSImageMBS, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called by GKAchievementDescriptionMBS.loadImage when the download is completed.

image: The downloaded image. If an error occurred, this value is nil.
error: If an error occurred, this error object describes the error. If the operation completed successfully, this value is nil.

GameKitMBS.loadLeaderboardsCompleted(Leaderboards() as GKLeaderboardMBS, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Leaderboards have been loaded.

Available on Mac OS X 10.8.2 and newer.

GameKitMBS.loadMatchDataCompleted(match as GKTurnBasedMatchMBS, matchData as Dictionary, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called by GKTurnBasedMatchMBS.loadMatchData after the match data has been retrieved from the server.

matchData: The data stored on Game Center that reflects the current state of the match. If an error occurred, this value is nil.
error: If an error occurred, this error object describes the error. If the operation was completed successfully, the value is nil.

GameKitMBS.loadMatchesCompleted(matches() as GKTurnBasedMatchMBS, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called by GKTurnBasedMatchMBS.loadMatches after the matches are retrieved from the server.

matches: An array of match objects that hold the requested matches. If an error occurred, this value may be non-empty. In this case, the array holds whatever match data could be retrieved from Game Center before the error occurred.
error: If an error occurred, this error object describes the error. If the operation was completed successfully, the value is nil.

GameKitMBS.loadMatchWithIDCompleted(TurnBasedMatch as GKTurnBasedMatchMBS, matchID as string, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The event to be called after the match is retrieved from the server.

Called when GKTurnBasedMatchMBS.loadMatchWithID finishes.

matchID: The identifier for the turn-based match.
match: If the operation completed successfully, this parameter holds the match. If an error occurred, the value is nil.
error: If an error occurred, this error object describes the error. If the operation was completed successfully, the value is nil.

Available on Mac OS X 10.8.2 and newer.

GameKitMBS.loadPhotoForSizeCompleted(player as GKPlayerMBS, size as Integer, photo as NSImageMBS, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called by GKPlayerMBS.loadPhotoForSize when the player data is retrieved from Game Center.

photo: An image for the player. If an error occurred, this may still be non-nil. In this case, the image reflects an image cached by Game Kit on the device.
error: If an error occurred, this error object describes the error. If the operation completed successfully, this is nil.

GameKitMBS.loadPlayersForIdentifiersCompleted(identifiers() as string, players() as GKPlayerMBS, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called by GKPlayerMBS.loadPlayersForIdentifiers when the player data is retrieved from Game Center.

players: An array of GKPlayer objects, one per identifier. If an error occurred, this may be non-empty. In that case, the array holds whatever data Game Kit was able to retrieve for the requested players.
error: If an error occurred, this error object describes the error. If the operation completed successfully, this is nil.

GameKitMBS.loadReceivedChallengesCompleted(challenges() as GKChallengeMBS, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called when loadReceivedChallenges finished.

challenges: An array of challenge objects that represents all challenges made to the local player. If an error occurred, this parameter may be non-nil, in which case the array holds whatever challenge information Game Kit was able to fetch.
error: If an error occurred, this object describes the error. If the operation completed successfully, this value is nil.

Available on Mac OS X 10.8.2 and newer.

GameKitMBS.loadScoresCompleted(Leaderboard as GKLeaderboardMBS, scores() as GKScoreMBS, error as NSErrorMBS, tag as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called by GKLeaderboardMBS.loadScores after the scores are retrieved from the server.

scores: An array of score objects that hold the requested scores. If an error occurred, this value may be non-nil. In this case, the array holds whatever score data could be retrieved from Game Center before the error occurred.
error: If an error occurred, this error object describes the error. If the operation was completed successfully, the value is nil.

GameKitMBS.localPlayerDidCompleteChallenge(challenge as GKChallengeMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called when the local player has completed one of their challenges, triggered by a push notification from the server.

Received only while the game is running.
Available on Mac OS X 10.8.2 and newer.

GameKitMBS.localPlayerDidReceiveChallenge(challenge as GKChallengeMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called when the local player has received a challenge, triggered by a push notification from the server.

Received only while the game is running.
Available on Mac OS X 10.8.2 and newer.

GameKitMBS.localPlayerDidSelectChallenge(challenge as GKChallengeMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called when the user clicks a challenge notification banner or the "Play Now" button for a challenge inside Game Center, causing the game to launch.

Also called when the user clicks a challenge banner inside the game.
Available on Mac OS X 10.8.2 and newer.

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


The biggest plugin in space...