Class YServerData

Hierarchy

YServerData

Index

Constructors

constructor

Methods

Constructors

constructor

new YServerData(): YServerData

Returns YServerData

Methods

Static getLeaderboardPosition

getLeaderboardPosition(player: YCharacter, dataScope: YServerDataScope, leaderboardUid: String, leaderboardPeriod: YLeaderboardPeriod, onResult: (info: YLeaderboardPlayerInfo) => void): void

Returns leaderbord info of target player, which can be then parsed for more data.

Parameters
- player: YCharacter
- dataScope: YServerDataScope
- leaderboardUid: String
- leaderboardPeriod: YLeaderboardPeriod
- onResult: (info: YLeaderboardPlayerInfo) => void
  - - (info: YLeaderboardPlayerInfo): void
    - Parameters
      - info: YLeaderboardPlayerInfo
      Returns void
Returns void

Static getLeaderboardScore

getLeaderboardScore(player: YCharacter, dataScope: YServerDataScope, leaderboardUid: String, leaderboardPeriod: YLeaderboardPeriod): number

Returns selected score value of target player.

Parameters
- player: YCharacter
- dataScope: YServerDataScope
- leaderboardUid: String
- leaderboardPeriod: YLeaderboardPeriod
Returns number

Static getLeaderboardSegment

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

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

Parameters
- dataScope: YServerDataScope
- leaderboardUid: String
- leaderboardPeriod: YLeaderboardPeriod
- from: number
- to: number
- onResult: (result: YLeaderboardSegmentResult) => void
  - - (result: YLeaderboardSegmentResult): void
    - Parameters
      - result: YLeaderboardSegmentResult
      Returns void
Returns void

Static getServerVariable

getServerVariable(player: YCharacter, dataScope: YServerDataScope, variableUid: string): any

Parameters
- player: YCharacter
- dataScope: YServerDataScope
- variableUid: string
Returns any

Static setLeaderboardScore

setLeaderboardScore(player: YCharacter, dataScope: YServerDataScope, leaderboardUid: String, leaderboardPeriod: YLeaderboardPeriod, score: number): void

Allows to set player score value for given time period.

Parameters
- player: YCharacter
- dataScope: YServerDataScope
- leaderboardUid: String
- leaderboardPeriod: YLeaderboardPeriod
- score: number
Returns void

Static setServerVariable

setServerVariable(player: YCharacter, dataScope: YServerDataScope, variableUid: string, obj: any): void

Parameters
- player: YCharacter
- dataScope: YServerDataScope
- variableUid: string
- obj: any
Returns void

Static updateLeaderboardScore

updateLeaderboardScore(player: YCharacter, dataScope: YServerDataScope, leaderboardUid: String, score: number): void

Allows to update player score value automatically for all time periods.

Parameters
- player: YCharacter
- dataScope: YServerDataScope
- leaderboardUid: String
- score: number
Returns void

Generated using TypeDoc