Gaming:loadScores: Difference between revisions

From GiderosMobile
No edit summary
m Text replacement - "</source>" to "</syntaxhighlight>"
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''Available since:''' Gideros 2012.09<br/>
<languages />
=== Description ===
'''<translate>Available since</translate>:''' Gideros 2012.09<br/>
<translate>Fetch leaderboard entries. Either [[Event.LOAD_SCORES_COMPLETE]] or [[Event.LOAD_SCORES_ERROR]] will be triggered.</translate>
'''<translate>Class</translate>:''' [[Special:MyLanguage/Gaming|Gaming]]<br/>
<source lang="lua">
=== <translate>Description</translate> ===
<translate>Fetch leaderboard entries. Either [[Special:MyLanguage/Event.LOAD_SCORES_COMPLETE|Event.LOAD_SCORES_COMPLETE]] or [[Special:MyLanguage/Event.LOAD_SCORES_ERROR|Event.LOAD_SCORES_ERROR]] will be triggered.</translate>
<syntaxhighlight lang="lua">
  Gaming:loadScores(leaderboardId,timeSpan,collection,maxEntries)
  Gaming:loadScores(leaderboardId,timeSpan,collection,maxEntries)
</source>
</syntaxhighlight>
=== Parameters ===
=== <translate>Parameters</translate> ===
'''leaderboardId''': (string) <translate>Leaderboard Id</translate> <br/>
'''leaderboardId''': (string) <translate>Leaderboard Id</translate> <br/>
'''timeSpan''': (number) <translate>Time range: [[Gaming.TODAY]], [[Gaming.WEEK]] or [[Gaming.ALL_TIME]]</translate> '''optional'''<br/>
'''timeSpan''': (number) <translate>Time range: [[Special:MyLanguage/Gaming.TODAY|Gaming.TODAY]], [[Special:MyLanguage/Gaming.WEEK|Gaming.WEEK]] or [[Special:MyLanguage/Gaming.ALL_TIME|Gaming.ALL_TIME]]</translate> '''optional'''<br/>
'''collection''': (number) <translate>Player range: [[Gaming.FRIENDS]] or [[Gaming.ALL_PLAYERS]]</translate> '''optional'''<br/>
'''collection''': (number) <translate>Player range: [[Special:MyLanguage/Gaming.FRIENDS|Gaming.FRIENDS]] or [[Special:MyLanguage/Gaming.ALL_PLAYERS|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/>
{{Gaming}}

Latest revision as of 13:29, 13 July 2023


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