fetchHighscores

suspend fun fetchHighscores(world: String?, category: HighscoresCategory, vocation: HighscoresProfession = HighscoresProfession.ALL, battlEyeType: HighscoresBattlEyeType = HighscoresBattlEyeType.ANY_WORLD, pvpTypes: Set<PvpType>? = null): TibiaResponse<Highscores?>(source)

Fetches highscores based on the specified filters and returns them in a structured format.

Return

A TibiaResponse object containing the highscores data, or null if the fetch fails.

Parameters

world

The name of the world to fetch highscores for. If null, high scores across all worlds are fetched.

category

The category of highscores to fetch (e.g., experience, magic level).

vocation

The profession filter for highscores. Defaults to HighscoresProfession.ALL.

battlEyeType

The BattlEye filter for the worlds to include.

pvpTypes

Optional set of PvP types to filter the worlds. If null, no PvP filtering is applied.