Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items

GameKitMBS.queryPlayerGroupActivityCompleted(MatchMaker as GKMatchmakerMBS, playerGroup as Integer, activity as Integer, 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.queryPlayerGroupActivity when the search completes.
Notes:
activity: The amount of activity in the player group.
error: If the search completed successfully, this parameter is nil; otherwise, this parameter holds an error object that describes the error that occurred.

Feedback, Comments & Corrections

GameKitMBS.receivedTurnEventForMatch(player as GKPlayerMBS, match as GKTurnBasedMatchMBS, didBecomeActive as boolean)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 15.0 Yes No No No No
Function: Activates the player’s turn. (required)
Notes:
This method is called when the it becomes the player’s turn. It is also called when any of the following events happen:

  • The current turn has a time-out associated with it and the turn is about to expire.
  • Player accepts an invite from another player.
  • Turn was passed to another player. In this case, didBecomeActive is false.
  • Match data is saved by another player.
  • Player receives a reminder.

Available in OS X v10.10 and later.

Feedback, Comments & Corrections

GameKitMBS.recipientResponseHandler(MatchRequest as GKMatchRequestMBS, Player as GKPlayerMBS, response as Integer, 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: This event is called whenever you programmatically invite specific players to join a match.
Notes:
It is called once for each player invited to the match. Typically, your game uses the responses to update the custom user interface. For example, you want the player to be able to perform any of the following tasks:

  • Start the match.
  • Invite an additional set of specific players.
  • Use matchmaking to fill the remaining match slots.

Available in OS X v10.10 and later.

Feedback, Comments & Corrections

GameKitMBS.rematchCompleted(TurnMatch as GKTurnBasedMatchMBS, match as GKMatchMBS, 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: Called when GKMatchMBS.rematch completes.
Notes:
match: The new match. If an error occurred, this parameter's value is nil.
error: If an error occurred, this parameter holds an error object that describes the problem. If the match was successfully recreated, this parameter's value is nil.

Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.remotePlayerDidCompleteChallenge(challenge as GKChallengeMBS)
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 a non-local player has completed a challenge issued by the local player.
Notes:
Triggered by a push notification from the server. Received when a challenge notification banner is clicked, or while the game is running.
Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.removeCompleted(match 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 by GKTurnBasedMatchMBS.remove on completion.
Notes:
If an error occurred, this error object describes the error. If the operation was completed successfully, the value is nil.
Tag is the parameter you passed to remove method.

Feedback, Comments & Corrections

GameKitMBS.reportAchievementCompleted(score 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.reportAchievement after the operation completes.
Notes: error: If the operation was successful, this value is nil; otherwise, this parameter holds an object that describes the problem that occurred.

Feedback, Comments & Corrections

GameKitMBS.reportAchievementsCompleted(achievements() as GKAchievementMBS, 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: Called when GKAchievementMBS.reportAchievements completes.
Notes: Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.reportScoreCompleted(score as GKScoreMBS, 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 GKScoreMBS.reportScore after the score is reported.
Notes: error: If an error occurred, this parameter holds an error object that describes the problem. If the score was successfully reported, this parameter's value is nil.

Feedback, Comments & Corrections

GameKitMBS.reportScoresCompleted(Scores() as GKScoreMBS, 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: Reporting scores completed.
Notes:
scores: An array of score objects to report to Game Center.
error: If an error occurred, this parameter holds an error object that describes the problem. If the score was successfully reported, this parameter's value is nil.

Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.resetAchievementsCompleted(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.resetAchievements when the reset action is completed.
Notes: error: If the operation was successful, this value is nil; otherwise, this parameter holds an object that describes the problem that occurred.

Feedback, Comments & Corrections

GameKitMBS.saveCurrentTurnWithMatchDataCompleted(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 13.0 Yes No No No No
Function: The event to be called after the data is uploaded to Game Center.
Notes:
error: If an error occurred, this error object describes the error. If the operation was completed successfully, the value is nil.
matchData: The game-specific state for the match.

Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.selectChallengeablePlayerIDsCompleted(Achievement as GKAchievementMBS, playerIDs() as string, challengeablePlayerIDs() 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: Called by GKAchievementMBS.selectChallengeablePlayerIDs on completion
Notes: Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.setDefaultLeaderboardCategoryIDCompleted(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: Called by GKLocalPlayerMBS.setDefaultLeaderboardCategoryID when completed.
Notes: Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.setDefaultLeaderboardCompleted(categoryID 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.setDefaultLeaderboard after the scores are retrieved from the server.
Notes: error: If an error occurred, this error object describes the error. If the operation was completed successfully, the value is nil.

Feedback, Comments & Corrections

GameKitMBS.shouldShowBannerForLocallyCompletedChallenge(challenge as GKChallengeMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: Whether to show banner for locally completed challenge.
Notes:
If the method returns true, a challenge banner (like an achievement or welcome banner -- not a notification center banner) is displayed. If false, then no banner is displayed. Default behavior for non-implementing apps is true.
Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.shouldShowBannerForLocallyReceivedChallenge(challenge as GKChallengeMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: Whether to show banner for locally received challenge.
Notes:
If the method returns true, a challenge banner (like an achievement or welcome banner -- not a notification center banner) is displayed when a challenge is received in-game for the local player. If false, then no banner is displayed, and localPlayerDidSelectChallenge will not be called for that challenge. Default behavior for non-implementing apps is true.

Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.shouldShowBannerForRemotelyCompletedChallenge(challenge as GKChallengeMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 13.0 Yes No No No No
Function: Whether to show banner for remotely completed challenge.
Notes:
If the method returns true, a challenge banner (like an achievement or welcome banner -- not a notification center banner) is displayed. If false, then no banner is displayed. Default behavior for non-implementing apps is true.
Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.startBrowsingForNearbyPlayersCompleted(Matchmaker as GKMatchmakerMBS, playerID as string, reachable as boolean, 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 startBrowsingForNearbyPlayers method found a player.
Notes: Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.turnBasedMatchmakerViewControllerDidFailWithError(viewController as Variant, error as NSErrorMBS)
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 an error occurs. (required)
Notes:
viewController: The view controller that received an error. (GKTurnBasedMatchmakerViewControllerMBS)
error: An error object that describes the error.

Your game should dismiss the view controller.

Feedback, Comments & Corrections

GameKitMBS.turnBasedMatchmakerViewControllerDidFindMatch(viewController as Variant, 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: Called when the player selected a match to view. (required)
Notes:
viewController: The view controller that found a match. (GKTurnBasedMatchmakerViewControllerMBS)
match: The match that the player selected.

Your game should dismiss the view controller and use the match object to show the current state of the match to the player.

Feedback, Comments & Corrections

GameKitMBS.turnBasedMatchmakerViewControllerPlayerQuitForMatch(viewController as Variant, 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: Called when a player chooses to quit the match. (required)
Notes:
viewController: The view controller that the player interacted with. (GKTurnBasedMatchmakerViewControllerMBS)
match: The match the player has chosen to quit.

When this method is called, the player is the current participant in the match, but that player has chosen to resign the match instead of taking a turn. Your game should dismiss the view controller, set an outcome for the player, and then call the match's participantQuitInTurnWithOutcome method.

Feedback, Comments & Corrections

GameKitMBS.turnBasedMatchmakerViewControllerWasCancelled(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 player cancels matchmaking. (required)
Notes:
viewController: The view controller that the player canceled. (GKTurnBasedMatchmakerViewControllerMBS)

Your game should dismiss the view controller.

Feedback, Comments & Corrections

Previous items

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




Links
MBS Xojo Plugins