Difference between revisions of "Gaming:loadScores"
From GiderosMobile
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''<translate>Available since</translate>:''' Gideros 2012.09<br/> | '''<translate>Available since</translate>:''' Gideros 2012.09<br/> | ||
+ | '''<translate>Class</translate>:''' [[Special:MyLanguage/Gaming|Gaming]]<br/> | ||
=== <translate>Description</translate> === | === <translate>Description</translate> === | ||
− | <translate>Fetch leaderboard entries. Either | + | <translate>Fetch leaderboard entries. Either `Event.LOAD_SCORES_COMPLETE` or `Event.LOAD_SCORES_ERROR` will be triggered.</translate> |
<source lang="lua"> | <source lang="lua"> | ||
Gaming:loadScores(leaderboardId,timeSpan,collection,maxEntries) | Gaming:loadScores(leaderboardId,timeSpan,collection,maxEntries) | ||
Line 8: | Line 9: | ||
=== <translate>Parameters</translate> === | === <translate>Parameters</translate> === | ||
'''leaderboardId''': (string) <translate>Leaderboard Id</translate> <br/> | '''leaderboardId''': (string) <translate>Leaderboard Id</translate> <br/> | ||
− | '''timeSpan''': (number) <translate>Time range: | + | '''timeSpan''': (number) <translate>Time range: `Gaming.TODAY`, `Gaming.WEEK` or `Gaming.ALL_TIME`</translate> '''optional'''<br/> |
− | '''collection''': (number) <translate>Player range: | + | '''collection''': (number) <translate>Player range: `Gaming.FRIENDS` or `Gaming.ALL_PLAYERS`</translate> '''optional'''<br/> |
'''maxEntries''': (number) <translate>Maximum number of entries to return</translate> '''optional'''<br/> | '''maxEntries''': (number) <translate>Maximum number of entries to return</translate> '''optional'''<br/> |
Revision as of 09:27, 24 August 2018
Available since: Gideros 2012.09
Class: Gaming
Description
Fetch leaderboard entries. Either `Event.LOAD_SCORES_COMPLETE` or `Event.LOAD_SCORES_ERROR` will be triggered.
Gaming:loadScores(leaderboardId,timeSpan,collection,maxEntries)
Parameters
leaderboardId: (string) Leaderboard Id
timeSpan: (number) Time range: `Gaming.TODAY`, `Gaming.WEEK` or `Gaming.ALL_TIME` optional
collection: (number) Player range: `Gaming.FRIENDS` or `Gaming.ALL_PLAYERS` optional
maxEntries: (number) Maximum number of entries to return optional