gpgs.multiplayer.realtime.join()

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

Overview

Joins a real-time room by accepting an invitation. The lifetime of the current game's connection to the room is bound to this client's lifecycle. When the client disconnects, the player will leave the room and any peer-to-peer connections for this player will be torn down. The result is delivered to the room listener defined via gpgs.multiplayer.realtime.setListeners().

Syntax

gpgs.multiplayer.realtime.join( invitationId )
invitationId (required)

String. The invitation to accept (and join the associated room).