Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

GameKitMBS.loadLeaderboardsCompleted(Leaderboards() as GKLeaderboardMBS, 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: Leaderboards have been loaded.
Notes: Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.loadMatchDataCompleted(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.loadMatchData after the match data has been retrieved from the server.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadMatchesCompleted(matches() 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.loadMatches after the matches are retrieved from the server.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadMatchWithIDCompleted(TurnBasedMatch as GKTurnBasedMatchMBS, matchID 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 event to be called after the match is retrieved from the server.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadPhotoForSizeCompleted(player as GKPlayerMBS, size as Integer, photo 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 GKPlayerMBS.loadPhotoForSize when the player data is retrieved from Game Center.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadPlayersForIdentifiersCompleted(identifiers() as string, players() as GKPlayerMBS, 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 GKPlayerMBS.loadPlayersForIdentifiers when the player data is retrieved from Game Center.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadReceivedChallengesCompleted(challenges() as GKChallengeMBS, 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 loadReceivedChallenges finished.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.loadScoresCompleted(Leaderboard as GKLeaderboardMBS, scores() 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 GKLeaderboardMBS.loadScores after the scores are retrieved from the server.
Notes:
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.

Feedback, Comments & Corrections

GameKitMBS.localPlayerDidCompleteChallenge(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 the local player has completed one of their challenges, triggered by a push notification from the server.
Notes:
Received only while the game is running.
Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.localPlayerDidReceiveChallenge(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 the local player has received a challenge, triggered by a push notification from the server.
Notes:
Received only while the game is running.
Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.localPlayerDidSelectChallenge(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 the user clicks a challenge notification banner or the "Play Now" button for a challenge inside Game Center, causing the game to launch.
Notes:
Also called when the user clicks a challenge banner inside the game.
Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.matchConnectionWithPlayerFailed(match as GKMatchMBS, playerID as string, 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 the match fails to connect to a player.
Notes:
match: The match that received the error.
player: The identifier for the player whose connection failed.
error: The error that occurred.

This method is called if the match was unable to send a transmission to another player in the match.

Feedback, Comments & Corrections

GameKitMBS.matchDidChangeState(match as GKMatchMBS, playerID as string, state as Integer)
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 connects to or disconnects from the match.
Notes:
match: The match that the player is connected to.
player: The identifier for the player whose state changed.
state: The state the player moved to. (see constants in GKMatchMBS)

Your game implements this method to be notified when players connect to or disconnect from the match.one

Feedback, Comments & Corrections

GameKitMBS.matchDidFailWithError(match as GKMatchMBS, 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 the match cannot connect to any other players.
Notes:
match: The match that received the error.
error: The error that occurred.

This method is called if the match cannot connect to any other players associated with the match. It usually means a serious networking error has occurred.

Feedback, Comments & Corrections

GameKitMBS.matchDidReceiveData(match as GKMatchMBS, data as Dictionary, playerID 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 when data is received from a player. (required)
Notes:
match: The match that received the data.
data: The data sent by the player.
player: The string identifier for the player that sent the data.

Important: Data received from other players should be treated as untrusted data. Be sure to validate the data you receive from the match and write your code carefully to avoid security vulnerabilities. See the Secure Coding Guide for more information.

Feedback, Comments & Corrections

GameKitMBS.matchEnded(player as GKPlayerMBS, match as GKTurnBasedMatchMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 15.0 Yes No No No No
Function: Called when the match has ended. (required)
Notes:
player: The GKPlayer object containing the current player’s information.
match: The GKTurnBasedMatch object containing the current game data.

Available in OS X v10.10 and later.

Feedback, Comments & Corrections

GameKitMBS.matchForInviteCompleted(Matchmaker as GKMatchmakerMBS, invite as GKInviteMBS, 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 by matchForInvite on completion.
Notes:
Match provides the new match object on success.

Possible reasons for error:
1. Communications failure.
2. Invite cancelled.
Available on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.matchmakerViewControllerDidFailWithError(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 the view controller encounters an unrecoverable error. (required)
Notes:
viewController: The view controller that received the error. (GKMatchmakerViewControllerMBS)
error: An error object that describes the error.

Feedback, Comments & Corrections

GameKitMBS.matchmakerViewControllerDidFindMatch(viewController as Variant, match as GKMatchMBS)
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 peer-to-peer match is found.
Notes:
viewController: The view controller that performed the matchmaking. (GKMatchmakerViewControllerMBS)
match: A completed match.

This method is called when the view controller's hosted property is false. Although optional in the protocol, if your game attaches a delegate to the view controller for a peer-to-peer match, the view controller expects your game to provide an implementation of this method.

Feedback, Comments & Corrections

GameKitMBS.matchmakerViewControllerDidFindPlayers(viewController as Variant, playerIDs() 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 when a hosted match is found.
Notes:
viewController: The view controller that performed the matchmaking. (GKMatchmakerViewControllerMBS)
players: An array of identifier strings for the matched players.

This method is called when the view controller's hosted property is true. Although optional in the protocol, if your game attaches a delegate to the view controller for a hosted match, the view controller expects your game to provide an implementation of this method.

The view controller returns the list of players to your game by calling this method. Your game is responsible for connecting these players to your own server and then using that server to relay messages between the players.

Feedback, Comments & Corrections

GameKitMBS.matchmakerViewControllerDidReceiveAcceptFromHostedPlayer(viewController as Variant, playerID 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 when a player in a hosted match accepts the invitation.
Notes:
viewController: The view controller that accepted the invitation. (GKMatchmakerViewControllerMBS)
playerID: The identifier of the accepting player.

After a player accepts an invitation, that player's device should connect to your server. Once the connection is established, your game should call the view controller's setHostedPlayer method to update the player's connection status.

Feedback, Comments & Corrections

GameKitMBS.matchmakerViewControllerWasCancelled(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 cancels the matchmaking request (required)
Notes: viewController: The view controller that received the cancellation. (GKMatchmakerViewControllerMBS)

Feedback, Comments & Corrections

GameKitMBS.matchShouldReinvitePlayer(match as GKMatchMBS, playerID as string) 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: Called when a player in a two-player match was disconnected.
Notes:
match: The match that lost the player.
playerID: The identifier for the player whose connection failed.

Your game should return true if it wants Game Kit to attempt to reconnect the player, false if it wants to terminate the match.

Occasionally, players may get disconnected from a match. If your game implements this method in the match delegate and the match only contains two players, Game Kit calls this method after a player gets disconnected. If your delegate allows Game Kit to reconnect to the other player, it reconnects the other player. Your matchDidChangeState event is called when the other player is reconnected.

Feedback, Comments & Corrections

GameKitMBS.NotificationBannerCompleted(title as string, message as string, duration as Double, 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 GameKitMBS.showBannerWithTitle after the banner is reported.
Notes: Duration is only passed if it was sent with the newer method on Mac OS X 10.8.2 and newer.

Feedback, Comments & Corrections

GameKitMBS.participantQuitInTurnWithOutcomeCompleted(match as GKTurnBasedMatchMBS, matchOutcome as Integer, nextParticipant as GKTurnBasedParticipantMBS, 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.participantQuitOutOfTurnWithOutcomeCompleted(match as GKTurnBasedMatchMBS, matchOutcome 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 GKTurnBasedMatchMBS.participantQuitOutOfTurnWithOutcome called after the data is uploaded to the server.
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.PlayerAuthenticationDidChange(player as GKPlayerMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: Player's authentication changed.

Feedback, Comments & Corrections

GameKitMBS.playerChanged(player as GKPlayerMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event GameKit MBS MacFrameworks Plugin 12.3 Yes No No No No
Function: The player changed.

Feedback, Comments & Corrections

GameKitMBS.playerStateUpdate(playerID as string, state as Integer, 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 state of any participant in the chat changes (including the local player).
Notes:
player: The player identifier for the player whose status changed.
state: The new state of the player.
You need to call enablePlayerStateUpdate to receive events.

Feedback, Comments & Corrections

GameKitMBS.queryActivityCompleted(MatchMaker as GKMatchmakerMBS, 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.queryActivity when query is done.
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

Previous items Next items

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




Links
MBS Xojo Plugins