0.9.0

tibiakt-core/com.galarzaa.tibiakt.core.models.highscores/Highscores

Highscores

@Serializable

data class Highscores( val world: String?, val category: HighscoresCategory, val vocation: HighscoresProfession, val worldTypes: Set<PvpType>, val battlEyeType: HighscoresBattlEyeType, val lastUpdated: Instant, val currentPage: Int, val totalPages: Int, val resultsCount: Int, val entries: List<HighscoresEntry>) : PaginatedWithUrl<HighscoresEntry> (source)

The Tibia highscores, containing the highest levels of a given category.

Constructors

constructor( world: String?, category: HighscoresCategory, vocation: HighscoresProfession, worldTypes: Set<PvpType>, battlEyeType: HighscoresBattlEyeType, lastUpdated: Instant, currentPage: Int, totalPages: Int, resultsCount: Int, entries: List<HighscoresEntry>)

Properties

val battlEyeType: HighscoresBattlEyeType

The BattlEye type of worlds to show for global highscores.

val category: HighscoresCategory

The displayed highscores category.

open override val currentPage: Int

The currently viewed page.

open override val entries: List<HighscoresEntry>

The entries in this page.

val lastUpdated: Instant

The time when the currently displayed results were last updated.

open val nextPageUrl: String?

Get the URL to the next page if there is any.

previousPageUrl

open val previousPageUrl: String?

Get the URL to the previous page if there is any.

open override val resultsCount: Int

The total number of entries across all pages.

open override val totalPages: Int

The total number of pages.

val url: String

The URL to these highscores.

val vocation: HighscoresProfession

The selected vocation filter for the entries.

val world: String?

The world the highscores belong to, or null if these are global highscores.

val worldTypes: Set<PvpType>

The selected world types to show for global highscores.

Functions

open override fun getPageUrl(page: Int): String

Get the URL to a specific page.