gpgs.multiplayer.realtime.sendReliably()

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

Overview

Sends a message to participants in a real-time room reliably. You can receive callbacks to report the status of the send operation for each participant.

Syntax

gpgs.multiplayer.realtime.sendReliably( params )
params (required)

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

Parameter Reference

The params table contains parameters for the call.

roomId (required)

String. The multiplayer room ID.

participantId (optional)

String. The participant to send the message to.

participantIds (optional)

Array. Populate with string elements to send the message to the specified participants. If provided, this has higher priority than participantId.

payload (required)

String. The message to send. This has a size limit as noted in plugin.gpgs.multiplayer.getLimits().

listener (optional)

Listener. Listener function which receives a sendReliably event.