Difference between revisions of "Gaming:loadScores"

From GiderosMobile
Line 6: Line 6:
 
  Gaming:loadScores(leaderboardId,timeSpan,collection,maxEntries)
 
  Gaming:loadScores(leaderboardId,timeSpan,collection,maxEntries)
 
</source>
 
</source>
'''leaderboardId''': (string) Leaderboard Id ''''''<br/>
+
=== Parameters ===
 +
'''leaderboardId''': (string) Leaderboard Id <br/>
 
'''timeSpan''': (number) Time range: `Gaming.TODAY`, `Gaming.WEEK` or `Gaming.ALL_TIME` '''optional'''<br/>
 
'''timeSpan''': (number) Time range: `Gaming.TODAY`, `Gaming.WEEK` or `Gaming.ALL_TIME` '''optional'''<br/>
 
'''collection''': (number) Player range: `Gaming.FRIENDS` or `Gaming.ALL_PLAYERS` '''optional'''<br/>
 
'''collection''': (number) Player range: `Gaming.FRIENDS` or `Gaming.ALL_PLAYERS` '''optional'''<br/>
 
'''maxEntries''': (number) Maximum number of entries to return '''optional'''<br/>
 
'''maxEntries''': (number) Maximum number of entries to return '''optional'''<br/>

Revision as of 11:37, 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