leaderboards.load()

Type Function
Return value none
Revision Current Public Release (2018.3326)
Keywords Google Play Games Services, game network, gpgs, leaderboards, load
See also gpgs.leaderboards
gpgs.*

Overview

Retrieves information for a specific leaderboard, or all leaderboards.

Syntax

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

leaderboardId (optional)

String. If provided, loads information about only this leaderboard. If omitted, all leaderboards will be loaded.

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.