gpgs.multiplayer.realtime.leave()

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

Overview

Leaves the specified room. This will disconnect the player from the room but allow other players to continue playing the game. The result is delivered to the room listener defined using gpgs.multiplayer.realtime.setListeners().

Gotchas

After this method is called, you cannot perform any further actions on the room, and you can only create or join another room after the correspoding room event is received.

Syntax

gpgs.multiplayer.realtime.leave( roomId )
roomId (required)

String. The room to leave.