Gaming:loadScores: Difference between revisions
From GiderosMobile
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
'''Available since:''' Gideros 2012.09<br/> | '''Available since:''' Gideros 2012.09<br/> | ||
=== Description === | === Description === | ||
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) | ||
</source> | </source> | ||
=== Parameters === | === Parameters === | ||
'''leaderboardId''': (string) Leaderboard Id <br/> | '''leaderboardId''': (string) <translate>Leaderboard Id</translate> <br/> | ||
'''timeSpan''': (number) Time range: | '''timeSpan''': (number) <translate>Time range: [[[Gaming.TODAY`, `Gaming.WEEK` or `Gaming.ALL_TIME]]]</translate> '''optional'''<br/> | ||
'''collection''': (number) Player range: | '''collection''': (number) <translate>Player range: [[[Gaming.FRIENDS` or `Gaming.ALL_PLAYERS]]]</translate> '''optional'''<br/> | ||
'''maxEntries''': (number) Maximum number of entries to return '''optional'''<br/> | '''maxEntries''': (number) <translate>Maximum number of entries to return</translate> '''optional'''<br/> | ||
Revision as of 12:32, 23 August 2018
Available since: Gideros 2012.09
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