Tile - YServerData - Get Segment – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Wiki|stub}}
<!---
THIS PAGE WAS GENERATED AUTOMATICALLY; DO NOT EDIT IT, OTHERWISE YOUR CHANGES WILL BE LOST DURING FUTURE UPDATE.
-->
== Get Segment(Scope, Leaderboard, Period, From, To, On result) ==
 
[[File:YlandsTile-1013.png]]
 
<pre>static getLeaderboardSegment(dataScope: YServerDataScope, leaderboardUid: String, leaderboardPeriod: YLeaderboardPeriod, from: number, to: number, onResult: (result: YLeaderboardSegmentResult) =&gt; void): void;</pre>
=== Parameters ===
 
==== dataScope ====
 
Whenever you are quering data from Game or Game Set
 
==== leaderboardUid ====
 
Target leaderboard variable (i.e score)
 
==== leaderboardPeriod ====
 
Target leaderboard time period
 
==== from ====
 
Leaderboard segment start (min 1)
 
==== to ====
 
Leaderboard segment start (max 500)
 
==== onResult ====
 
Player leaderboard information (array)
 
=== Description ===
 
Returns leaderbord info for selected leaderboard range, which can be then parsed for more data.
 
=== Notes ===
 
* Leaderboards are ranked from 1 to 500, further position are unranked.




Line 7: Line 47:


[[Category: Instructions]]
[[Category: Instructions]]
[[Category: Ylands 1.6]]

Revision as of 08:52, 8 July 2021

Get Segment(Scope, Leaderboard, Period, From, To, On result)

YlandsTile-1013.png

static getLeaderboardSegment(dataScope: YServerDataScope, leaderboardUid: String, leaderboardPeriod: YLeaderboardPeriod, from: number, to: number, onResult: (result: YLeaderboardSegmentResult) => void): void;

Parameters

dataScope

Whenever you are quering data from Game or Game Set

leaderboardUid

Target leaderboard variable (i.e score)

leaderboardPeriod

Target leaderboard time period

from

Leaderboard segment start (min 1)

to

Leaderboard segment start (max 500)

onResult

Player leaderboard information (array)

Description

Returns leaderbord info for selected leaderboard range, which can be then parsed for more data.

Notes

  • Leaderboards are ranked from 1 to 500, further position are unranked.