leaderboards.show()

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

Overview

Shows a specific leaderboard, or all leaderboards.

Syntax

gpgs.leaderboards.show( params )
params (optional)

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, shows only this leaderboard. If omitted, all leaderboards will be shown.

friendsOnly (optional)

Boolean. Supported only on Android; if true, shows only the scores for the current player's friends.

timeSpan (optional)

String. One of the following values:

  • "all time" — shows all scores (default).
  • "weekly" — shows scores from the week.
  • "daily" — shows scores from the day.
listener (optional)

Listener. Listener function which receives a show event.