gpgs.multiplayer.turnbased.leave()

Type Function
Return value none
Revision Release 2024.3703
Keywords Google Play Games Services, game network, gpgs, multiplayer, turn-based, leave
See also gpgs.multiplayer.turnbased
gpgs.multiplayer
gpgs.*

Overview

Leaves a match. If it's currently the players turn, you must provide the participant ID who has the next turn or else specifiy that the match needs another auto-match participant.

Syntax

gpgs.multiplayer.turnbased.leave( matchId )
params (required)

Table. Contains parameters for the call — see the next section for details.

Parameter Reference

The params table contains parameters for the call.

matchId (required)

String. The match to leave.

pendingParticipantId (optional)

String. Participant who will have the next turn.

isPendingAutomatch (optional)

Boolean. Whether to wait for additional auto-matched players to take the next turn (if possible).

listener (optional)

Listener. Listener function which receives a leave event.