Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

GameKitMBS.acceptInviteCompleted(match as GKTurnBasedMatchMBS, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: The event to be called after the match is successfully created.
Notes:
match: A newly initialized match object that contains a list of players for 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.

Called by GKTurnBasedMatchMBS.acceptInvite.
Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.achievementViewControllerDidFinish(viewController as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called when the user dismisses the achievements screen. (required)
Notes:
viewController: The achievement view controller whose interface was dismissed by the player. (GKAchievementViewControllerMBS)

Your should dismiss the view controller. If your game paused any gameplay or other activities, it can restart those services in this method.

Feedback, Comments & Corrections

GameKitMBS.addPlayersToMatchCompleted(MatchMaker as GKMatchmakerMBS, match as GKMatchMBS, matchRequest as GKMatchRequestMBS, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called by GKMatchmakerMBS.addPlayersToMatch when matchmaking completes.
Notes: error: If matchmaking was successful, this parameter contains nil. Otherwise, this parameter holds an error object that describes the error that occurred.

Feedback, Comments & Corrections

GameKitMBS.authenticateCompleted(localPlayer as GKLocalPlayerMBS, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called by GKLocalPlayerMBS.authenticate when the player has authenticated or when an error occurs.
Notes: error: This parameter is nil if the player successfully authenticated. Otherwise, it contains an error object that describes the error that occurred.

Feedback, Comments & Corrections

GameKitMBS.authenticateHandler(LocalPlayer as GKLocalPlayerMBS, viewController as NSViewControllerMBS, error as NSErrorMBS, tag as Variant, viewControllerHandle as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: The event called when game center needs authentication.
Notes:
viewController: This parameter is nil if the authentication process is complete. Otherwise, it contains a view controller that your game should display to the player.
error: This parameter contains an error object that describes any error that occurred.

Your game should authenticate the player as early as possible after launching, ideally as soon as you can present a user interface to the player. For example, your game may be launched because the player accepted an invitation to join a match or to take a turn in a turn-based match, so you want your game to authenticate the player and process the match invitation as quickly as possible. After you set a handler, authentication begins automatically and is repeated when your game moves to the background and then back to the foreground.

During the authentication process, Game Kit calls your handler one or more times to handle specific authentication events. Your handler must handle three kinds of events:

  • If the device does not have an authenticated player, Game Kit passes a view controller to your authenticate handler. When presented, this view controller displays the authentication user interface. Your game should pause other activities that require user interaction (such as your game loop), present this view controller and then return. When the player finishes interacting with it, the view controller is dismissed automatically.
  • If the authentication process succeeded, theGKLocalPlayer singleton object's authenticated property is set to true and the object's other properties are set to match those of the connected player.
  • If the authentication process failed, the GKLocalPlayer singleton object's authenticated property is set to false and the object's other properties are cleared.
Each time the authentication handler is called, the data stored in the local player singleton object may have changed. A new player may have logged into the device or the player may have simply logged out from Game Center. Because of both of these possibilities, your authentication handler must be prepared to update any other objects that assume that a particular player is logged in. For more information, see "Authenticating the Local Player in a Multitasking Application" in Game Center Programming Guide.

Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.challengesViewControllerDidFinish(viewController as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: The challengesViewController did finish.
Notes:
Called by GKChallengesViewControllerMBS if needed.
Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.chooseBestHostPlayerCompleted(match as GKMatchMBS, playerID as string, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: Called when GKMatchMBS.chooseBestHostPlayer completes.
Notes:
playerID: The player identifier for the player with the best estimated network performance, or nil if a player could not currently be determined.

Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.declineInviteCompleted(match as GKTurnBasedMatchMBS, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: The event to be called after the match is successfully created.
Notes:
error: If an error occurred, this error object describes the error. If the operation was completed successfully, the value is nil.

Called by GKTurnBasedMatchMBS.declineInvite.
Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.didRequestMatchWithOtherPlayers(players() as GKPlayerMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 15.0 Yes No No No No
Function: Initiates a match from Game Center with the requested players. (required)
Notes:
player: The GKPlayer object containing the current player’s information.
playersToInvite: An array of GKPlayer objects containing the player identifiers to invite to the match.

When this method is called, you should create a new match using the player identifiers provided and present a GKTurnBasedMatchmakerViewController.

Available in OS X v10.10 and later.

Feedback, Comments & Corrections

GameKitMBS.endMatchInTurnWithMatchDataCompleted(match as GKTurnBasedMatchMBS, matchData as Dictionary, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called by GKTurnBasedMatchMBS.endMatchInTurnWithMatchData after the match is successfully ended.
Notes: If an error occurred, this error object describes the error. If the operation was completed successfully, the value is nil.

Feedback, Comments & Corrections

GameKitMBS.endTurnWithNextParticipant(match as GKTurnBasedMatchMBS, nextParticipant as GKTurnBasedParticipantMBS, matchData as Dictionary, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called by GKTurnBasedMatchMBS.endTurnWithNextParticipant after the data is uploaded to Game Center.
Notes: If an error occurred, this error object describes the error. If the operation was completed successfully, the value is nil.

Feedback, Comments & Corrections

GameKitMBS.endTurnWithNextParticipantsCompleted(match as GKTurnBasedMatchMBS, nextParticipants() as GKTurnBasedParticipantMBS, timeout as Double, matchData as Dictionary, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: The event to be called after the data is uploaded to the server.
Notes:
Called by GKTurnBasedMatchMBS.participantQuitInTurnWithOutcome.

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.

Feedback, Comments & Corrections

GameKitMBS.findMatchForRequestCompleted(MatchMaker as GKMatchmakerMBS, request as GKMatchRequestMBS, match as GKMatchMBS, TurnBasedMatch as GKTurnBasedMatchMBS, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called when the match has been created.
Notes:
This is either called by GKMatchmakerMBS.findMatchForRequest or GKTurnBasedMatchMBS.findMatchForRequest.

match: If matchmaking was successful, this parameter contains the created match. Otherwise, this parameter is nil.
error: If matchmaking was successful, this parameter contains nil. Otherwise, this parameter holds an error object that describes the error that occurred.

Feedback, Comments & Corrections

GameKitMBS.findPlayersForHostedMatchRequestCompleted(MatchMaker as GKMatchmakerMBS, request as GKMatchRequestMBS, playerIDs() as string, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called by GKMatchmakerMBS.findPlayersForHostedMatchRequest when the match has been created.
Notes:
players: If matchmaking was successful, this parameter contains an array of players to connect into the match. Otherwise, this parameter is nil.
error: If matchmaking was successful, this parameter contains nil. Otherwise, this parameter holds an error object that describes the error that occurred.

Feedback, Comments & Corrections

GameKitMBS.friendRequestComposeViewControllerDidFinish(viewController as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: The compose view has finished.
Notes: viewController: The GKFriendRequestComposeViewControllerMBS object.

Feedback, Comments & Corrections

GameKitMBS.gameCenterViewControllerDidFinish(gameCenterViewController as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: Called when gameCenterViewController did finish.
Notes: Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.handleInviteFromGameCenter(playersToInvite() as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Sent when the local player receives an invitation to join a new turn-based match.
Notes:
playersToInvite: An array of player identifiers for the players to initially invite to the game.

When you receive this message, your game should create a new GKMatchRequestMBS object and assign the playersToInvite parameter to the match request's playersToInvite property. Then, your game can either call the GKTurnBasedMatchMBS class method findMatchForRequest to find a match programmatically or it can use the request to instantiate a new GKTurnBasedMatchmakerViewControllerMBS object to show a user interface to the player.

Feedback, Comments & Corrections

GameKitMBS.handleMatchEnded(match as GKTurnBasedMatchMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Sent when a match the local player is participating in has ended.
Notes:
match: The match that just ended.

When you receive this message, it should display the match's final results to the player and allow the player the option of saving or removing the match data from Game Center.

Feedback, Comments & Corrections

GameKitMBS.handleTurnEventForMatch(match as GKTurnBasedMatchMBS, didBecomeActive as boolean)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Sent when it is the local player's turn to act in a turn-based match.
Notes:
match: A match object containing the current state of the match.

When you receive this message, the player has accepted a push notification for a match already in progress. Your game should end whatever task it was performing and switch to the match information provided by the match object. For more information on handling player actions in a turn-based match, see GKTurnBasedMatch Class Reference.

didBecomeActive: New parameter valid on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.Invited(MatchMaker as GKMatchmakerMBS, acceptedInvite as GKInviteMBS, playersToInvite() as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called by GKMatchmakerMBS when an invitation is received from another player.
Notes:
acceptedInvite: The invitation accepted by the player.
playersToInvite: A list of player identifiers for additional players to invite into the game.

An game responds to an invitation by allocating and initializing a GKMatchmakerViewControllerMBS object, passing the invitation object and the list of player identifiers as parameters. For more information, see Game Kit Programming Guide.

If your game receives an invitation while your game is running, it should clean up any existing gameplay (including disconnecting from any current matches) and then process the invitation.

Feedback, Comments & Corrections

GameKitMBS.inviteeResponseHandler(MatchRequest as GKMatchRequestMBS, PlayerID as string, response as Integer, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: The event called when an response from an invited player is returned to your game.
Notes:
playerID: The identifier for the player.
response: The nature of the response. See GKInviteeResponse* constants.

Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.leaderboardViewControllerDidFinish(viewController as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: The leaderboard view has finished.
Notes: viewController: The GKLeaderboardViewControllerMBS object.

Feedback, Comments & Corrections

GameKitMBS.loadAchievementDescriptionsCompleted(achievements() as GKAchievementDescriptionMBS, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called by GKAchievementDescriptionMBS.loadAchievementDescriptions when the download is completed.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadAchievementsCompleted(achievements() as GKAchievementMBS, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called by GKAchievementMBS.loadAchievements when the download is completed.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadCategoriesCompleted(categories() as string, titles() as string, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called by GKLeaderboardMBS.loadCategories when the categories have been retrieved from the server.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadDefaultLeaderboardCategoryIDCompleted(LocalPlayer as GKLocalPlayerMBS, categoryID as string, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: The loadDefaultLeaderboardCategoryID method completed.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadFriendPlayersCompleted(localPlayer as GKLocalPlayerMBS, friendPlayers() as GKPlayerMBS, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 15.0 Yes No No No No
Function: The event called by GKLocalPlayerMBS.loadFriendPlayers.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadFriendsCompleted(localPlayer as GKLocalPlayerMBS, friends() as string, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called by GKLocalPlayerMBS.loadFriends when the request completes.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadImageCompleted(description as GKAchievementDescriptionMBS, image as NSImageMBS, error as NSErrorMBS, tag as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Called by GKAchievementDescriptionMBS.loadImage when the download is completed.
Notes:
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.

Feedback, Comments & Corrections

Next items

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




Links
MBS Xojo Plugins