GKMatchRequestMBS.Constructor

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The constructor.

GKMatchRequestMBS.defaultNumberOfPlayers as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	GameKit	MBS MacFrameworks Plugin	13.0	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The default number of players for the match.

If this property is not set, then the default number of players is equal to the value stored in the maxPlayers property. The default number of players determines the number of invitees shown in the standard matchmaking user interface. The player can choose to override this to add or remove slots.

Available on Mac OS X 10.8.2 and newer.
(Read and Write computed property)

GKMatchRequestMBS.inviteMessage as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	GameKit	MBS MacFrameworks Plugin	13.0	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Message sent to invited players, may be modified if using Game Center UI.

Available on Mac OS X 10.8.2 and newer.
(Read and Write computed property)

GKMatchRequestMBS.maxPlayers as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The maximum number of players to join the match.

The maximum number of players must be equal or greater than the minimum number of players. The maximum number of players may be no more than 4 for a peer-to-peer match and no more than 16 for a hosted match.
(Read and Write computed property)

GKMatchRequestMBS.minPlayers as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

The minimum number of players to join the match.

The minimum number of players must be at least 2.
(Read and Write computed property)

GKMatchRequestMBS.playerAttributes as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

A mask that specifies the role that the local player would like to play in the game.

If this value is 0 (the default), this property is ignored. If the value is nonzero, then automatching uses the value as a mask that restricts the role the player can play in the group. Automatching with player attributes follows two rules:

A new player can only be added to the match if the bitwise AND of that player's mask and the mask of any player already in the match equals &h00000000.
Players are added to the match until the bitwise OR of the masks of all the players in the match equals &hFFFFFFFF.
(Read and Write computed property)

GKMatchRequestMBS.playerGroup as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

A number identifying a subset of players allowed to join the match.

If your game sets the playerGroup property, only players whose requests share the same playerGroup value are automatched by Game Center. You can use any values you want for player groups. For example, you could define different playerGroup values to implement any of the following filters:

• A game could restrict players based on skill level.
• A game that provides multiple games could use it to filter players into the specific game they want to play.
• A game with multiple victory conditions (for example, Capture-The-Flag, Survival) could match players to others interested in the same rules.
• A game that provides bonus content through in-app purchase could match players who own the same content with each other.

(Read and Write computed property)

GKMatchRequestMBS.playersToInvite as string()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

A list of players to invite to the match.

If empty (the default), no players are invited. If non-empty, Game Kit populates the match with the provided list of players.

GKMatchRequestMBS.recipients as GKPlayerMBS()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	15.0	✅ Yes	❌ No	❌ No	❌ No	Desktop only

A list of player identifiers for players to invite to the match.

The property holds an array of GKPlayer objects, each of which contains an identifier for a player on Game Center. If the value of the property is non-nil, when you use the request to create a match, Game Center invites those players to the match. No automatching is done and the GKMatchRequestmaxPlayers and minPlayers properties are ignored. If nil (the default), no players are invited. The exact behavior for matchmaking depends on the kind of match being created and the class used to create the match. For more information, see Game Center Programming Guide.

Available in OS X v10.10 and later.

GKMatchRequestMBS.SetInviteeResponseHandler(tag as Variant = nil)

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

Sets the invitee response handler for this match request.

An invitee response handler is called whenever you programmatically invite specific players to join a match. 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 on Mac OS X 10.8.2 and newer.

GKMatchRequestMBS.setPlayersToInvite(playerIDs() as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	12.3	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Sets the list of players to invite to the match.

If empty (the default), no players are invited. If non-empty, Game Kit populates the match with the provided list of players.

GKMatchRequestMBS.SetRecipientResponseHandler(tag as Variant = nil)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	15.0	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Sets the event to be called when a response from an invited player is returned to your game.

Once event is installed, the plugin can call GameKitMBS.recipientResponseHandler event for this match request.

GKMatchRequestMBS.setRecipients(players() as GKPlayerMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	GameKit	MBS MacFrameworks Plugin	15.0	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Sets the list of player identifiers for players to invite to the match.

The property holds an array of GKPlayer objects, each of which contains an identifier for a player on Game Center. If the value of the property is non-nil, when you use the request to create a match, Game Center invites those players to the match. No automatching is done and the GKMatchRequestmaxPlayers and minPlayers properties are ignored. If nil (the default), no players are invited. The exact behavior for matchmaking depends on the kind of match being created and the class used to create the match. For more information, see Game Center Programming Guide.

Available in OS X v10.10 and later.