Platforms to show: All Mac Windows Linux Cross-Platform

Back to GKTurnBasedMatchMBS class.

GKTurnBasedMatchMBS.Available as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
True if the class is available.

Should always be true on Mac OS X 10.8 and newer.

GKTurnBasedMatchMBS.findMatchForRequest(request as GKMatchRequestMBS, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Programmatically searches for a new match to join.

request: A match request that specifies the properties that the new match must fulfill.

When this method is called, it creates a background task to handle the request. The method then returns control to your game. Later, when the task is complete, Game Kit calls your GameKitMBS.findMatchForRequest2Completed event.

This method may either create a new match or it may place the player into an existing match that does not yet have its full complement of players and needs a new player to advance the match further. Regardless of how the player is placed in the match, the local player is always the current participant in the returned match. Your game should immediately display the match in its user interface and allow the player to take a turn.

GKTurnBasedMatchMBS.loadMatches(tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method GameKit MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Loads the set of turn-based matches involving the local player and creates a match object for each match.

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

GKTurnBasedMatchMBS.loadMatchWithID(matchID as string, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Loads a specific match.

matchID: The identifier for the turn-based match.

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 your GameKitMBS.loadMatchWithIDCompleted event.

Available on Mac OS X 10.8.2 and newer.

GKTurnBasedMatchMBS.TimeoutDefault as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Indicates that the player has one week to take a turn.
Example
MsgBox str(GKTurnBasedMatchMBS.TimeoutDefault)

One of the common values for turn timeouts.
Available on Mac OS X 10.8.2 and newer.
Currently this function returns 604800 seconds (7 weeks), but this may change in the future.

GKTurnBasedMatchMBS.TimeoutNone as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method GameKit MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Indicates that the player's turn never times out.
Example
MsgBox str(GKTurnBasedMatchMBS.TimeoutNone)

One of the common values for turn timeouts.
Available on Mac OS X 10.8.2 and newer.
Currently this function returns 0 seconds, but this may change in the future.

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


The biggest plugin in space...