Instance Method

participantQuitInTurn(with:nextParticipant:match:completionHandler:)

Resigns the current player from the match without ending the match.

Declaration

func participantQuitInTurn(with matchOutcome: GKTurnBasedMatch.Outcome, nextParticipant: GKTurnBasedParticipant, match matchData: Data, completionHandler: ((Error?) -> Void)? = nil)

Parameters

matchOutcome

The end outcome of the current player in the match. Do not pass nil as an argument.

nextParticipant

The next player in the match who needs to take an action. It must be one of the object’s stored in the match’s participants property.

matchData

A serialized blob of data reflecting the game-specific state for the match.

completionHandler

A block to be called after the data is uploaded to the server.

The block receives the following parameters:

error

If an error occurred, this error object describes the error. If the operation was completed successfully, the value is nil.

Discussion

Your game calls this method on an instance of your game that is processing the current player’s turn, but that player has left the match. For example, the player may have willingly resigned from the match or that player may have been eliminated by the other players (based on your game’s internal logic).

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 completion handler. The completion handler is always called on the main thread.

See Also

Deprecated Methods