Contents

participantQuitOutOfTurn(with:withCompletionHandler:)

Forfeits the match on behalf of the local player when it’s not their turn.

Declaration

func participantQuitOutOfTurn(with matchOutcome: GKTurnBasedMatch.Outcome, withCompletionHandler completionHandler: (@Sendable ((any Error)?) -> Void)? = nil)
func participantQuitOutOfTurn(with matchOutcome: GKTurnBasedMatch.Outcome) async throws

Parameters

  • matchOutcome:

    The outcome of the local player who forfeits the match. Don’t pass nil as this parameter.

  • completionHandler:

    The block that GameKit calls when it completes the request.

    The block receives the following parameter:

    error

    Describes an error if it occurs, or nil if the operation completes.

Mentioned in

Discussion

Invoke this method to forfeit a match when the local player isn’t the current participant. To receive turn-based events that this method generates, register a listener that conforms to the GKTurnBasedEventListener protocol with the local player. See Starting turn-based matches and passing turns between players.

See Also

Forfeiting a Match