players.load()

Type Function
Return value none
Revision Release 2024.3703
Keywords Google Play Games Services, game network, gpgs, players, load
See also gpgs.players
gpgs.*

Overview

Retrieves information on the current player, a specified player, or multiple players.

Syntax

gpgs.players.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.

playerId (optional)

String. Supported only on Android; if provided, loads information for only this player. If omitted, loads the current player's information.

playerIds (optional)

Array. Supported only on Android; populate with string elements to load information for each specified player. If provided, this has higher priority than playerId.

source (optional)

String. One of the following values. If provided, this has higher priority than playerIds and loads information on players from the specified source.

  • "connected"
  • "invitable" (Android only)
  • "recentlyPlayedWith"
limit (optional)

Number. Limits the number of results to this value. All results are internally fetched in batches of 25 items each.

reload (optional)

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

listener (optional)

Listener. Listener function which receives a load event.