gpgs.multiplayer.turnbased.load()

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

Overview

Retrieves information on a specific turn-based match or all turn-based matches for the current player.

Syntax

gpgs.multiplayer.turnbased.load( 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.

matchId (optional)

String. If provided, loads only this match information. If omitted, information on all matches will be loaded.

filters (optional)

Array. Populate with string elements. If provided, selects only specified turn states of matches. Elements of this array can be "complete", "invited", "my turn", or "their turn".

mostRecentFirst (optional)

Boolean. If true, the results will be sorted by date. By default, the results are sorted in social order.

listener (optional)

Listener. Listener function which receives a load event.