Tile - YServerData - Get Segment – Ylands

From Bohemia Interactive Community
Revision as of 11:16, 12 November 2021 by YlandsClassyBot (talk | contribs)
Jump to navigation Jump to search

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)

Availability

Server

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.