gpgs.players.load()

Type String
Return value none
Revision Release 2021.3646
Keywords Google Play Games Services, game network, gpgs
See also gpgs2.players.*
gpgs2.*

Overview

Retrieves information on current player, specified player or players.

Syntax

gpgs.players.load(params)
params (required)

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

Parameter Reference

playerId (optional)

String. If provided loads only this player information. If not - loads the current player information.

playerIds (optional)

Array. Populate with string elements. If provided loads information on each specified player. Higher priority thann playerId.

source (optional)

String. One of these: "connected", "invitable" or "recentlyPlayedWith". If provided loads information on players from the specified source. Higher priority than playerIds.

limit (optional)

Integer. Limit results count to this value. All results internally are fetched in pages of 25 items each.

reload (optional)

Boolean. If true, the data will be pulled fresh, not from a cache.

listener (optional)

Listener. Receives load event.