tibiakt-core/com.galarzaa.tibiakt.core.utils

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPE, AnnotationTarget.FUNCTION])

annotation class BuilderDsl

A builder DSL.

Properties

SERVER_SAVE_TIME

val SERVER_SAVE_TIME: LocalTime

The local time when server save happens.

val TIBIA_TIMEZONE: ZoneId

The timezone Tibia time is based on.

Functions

fun buildTibiaUrl(section: String, vararg params: Pair<String, Any?>, test: Boolean = false, anchor: String? = null): String

fun buildTibiaUrl(section: String, subtopic: String, vararg params: Pair<String, Any?>, test: Boolean = false, anchor: String? = null): String

Build a URL to Tibia.com.

fun String.clean(): String

Clean the string of non-breaking spaces and trims whitespace.

fun String.findInteger(): Int

Find and parse an integer from a string, ignoring everything that is not a digit.

fun getAuctionUrl(auctionId: Int): String

Get the URL to a specific auction.

fun getBazaarUrl(type: BazaarType = BazaarType.CURRENT, filters: BazaarFilters? = null, page: Int = 1): String

Get the URL to the character bazaar.

getBoostableBossesUrl

fun getBoostableBossesUrl(): String

Get the URL to the Creatures section in Tibia.com.

getCharacterUrl

fun getCharacterUrl(name: String): String

Get the URL to specific character.

getCMPostArchiveUrl

fun getCMPostArchiveUrl(startDate: LocalDate, endDate: LocalDate, page: Int = 1): String

Get the URL to the CM Post Archive in Tibia.com.

fun <V> Map<String, V>.getContaining(key: String, default: V? = null): V?

Get a mapping's key containing the string.

getCreaturesSectionUrl

fun getCreaturesSectionUrl(): String

Get the URL to the Creatures section in Tibia.com.

fun getCreatureUrl(identifier: String): String

Get the URL to a specific creature in Tibia.com.

getEventsScheduleUrl

fun getEventsScheduleUrl(yearMonth: YearMonth? = null): String

Get the URL to the events schedule.

getForumAnnouncementUrl

fun getForumAnnouncementUrl(announcementId: Int): String

Get the URL to a forum announcement.

getForumBoardUrl

fun getForumBoardUrl(boardId: Int, page: Int = 1, threadAge: Int? = null): String

Get the URL to a forum board.

getForumPostUrl

fun getForumPostUrl(postId: Int): String

Get the URL of a forum post with a specific postId in Tibia.com.

getForumSectionUrl

fun getForumSectionUrl(section: AvailableForumSection): String

fun getForumSectionUrl(sectionId: Int): String

Get the URL to a specific forum section.

fun getForumSectionUrl(sectionName: String): String

Get the URL to a specific forum section by its name.

getForumThreadUrl

fun getForumThreadUrl(threadId: Int, page: Int = 1): String

Get the URL to a specific thread in the forums.

fun getGuildUrl(name: String): String

Get the URL to a specific guild.

getHighscoresUrl

fun getHighscoresUrl(world: String?, category: HighscoresCategory = HighscoresCategory.EXPERIENCE_POINTS, vocations: HighscoresProfession = HighscoresProfession.ALL, page: Int = 1, battleEye: HighscoresBattlEyeType = HighscoresBattlEyeType.ANY_WORLD, worldTypes: Set<PvpType>? = null): String

Get the URL to the highscores, with the specified parameters.

getHousesSectionUrl

fun getHousesSectionUrl(world: String, town: String, type: HouseType? = null, status: HouseStatus? = null, order: HouseOrder? = null): String

Get the URL to the houses section with the provided parameters.

fun getHouseUrl(world: String, houseId: Int): String

Get the URL to a house on a specific world.

getKillStatisticsUrl

fun getKillStatisticsUrl(world: String): String

Get the URL to the kill statistics of a specific world.

getLastServerSaveTime

fun getLastServerSaveTime(currentTime: ZonedDateTime = ZonedDateTime.now(TIBIA_TIMEZONE)): ZonedDateTime

fun getLastServerSaveTime(currentTime: Instant): Instant

Get the time of the last server save from a currentTime.

getLeaderboardUrl

fun getLeaderboardUrl(world: String, rotation: Int? = null, page: Int = 1): String

Get the URL to the Leaderboard of a specific world in Tibia.com.

getNewArchiveFormData

fun getNewArchiveFormData(startDate: LocalDate, endDate: LocalDate, categories: Set<NewsCategory>? = null, types: Set<NewsType>? = null): List<Pair<String, String>>

Get the post parameters to filter news in the News Archive.

getNewsArchiveUrl

fun getNewsArchiveUrl(): String

Get the URL to the News Archive.

fun getNewsUrl(newsId: Int): String

Get the URL to a specific news article.

getNextServerSaveTime

fun getNextServerSaveTime(currentTime: ZonedDateTime = ZonedDateTime.now(TIBIA_TIMEZONE)): ZonedDateTime

fun getNextServerSaveTime(currentTime: Instant): Instant

Get the time of the next server save from a currentTime.

getStaticFileUrl

fun getStaticFileUrl(vararg path: String, test: Boolean = false): String

fun getStaticFileUrl(path: String, test: Boolean = false): String

Get the URL of a static asset in Tibia.com.

getTibiaDateTime

fun getTibiaDateTime(): LocalDateTime

Get the local datetime in Tibia's servers.

getTibiaWeekDay

fun getTibiaWeekDay(): DayOfWeek

Get the current day of the week in Tibia

getWorldGuildsUrl

fun getWorldGuildsUrl(world: String): String

Get the URL to the list of guilds for a specific world.

getWorldOverviewUrl

fun getWorldOverviewUrl(): String

Get the URL to the World Overview section.

fun getWorldUrl(name: String): String

Get the URL to a specific world.

fun String?.nullIfBlank(): String?

Return null if the string is blank.

fun <T> List<T>.offsetStart(offset: Int): List<T>

Get a sublist from the receiver, starting at a certain offset.

fun String.parseInteger(): Int

Parse a string into an integer, removing any thousand separators.

fun String.parseLong(): Long

Parse a string into a long integer, removing any thousand separators.

parseThousandSuffix

fun String.parseThousandSuffix(): Int

Parses strings with numbers using "k" as suffix to represent thousands.

fun parseTibiaDate(input: String): LocalDate

Parses a string containing date from Tibia.com into an LocalDate instance.

parseTibiaDateTime

fun parseTibiaDateTime(input: String): Instant

Parses a string containing date and time from Tibia.com into an Instant instance.

parseTibiaForumDateTime

fun parseTibiaForumDateTime(input: String): Instant

Parses a string containing a date time from Tibia.com forums into an Instant instance.

parseTibiaFullDate

fun parseTibiaFullDate(input: String): LocalDate

Parses a string containing date from Tibia.com into an LocalDate instance.

fun String.remove(value: String, ignoreCase: Boolean = false): String

Remove an arbitrary string from a string, as many times as it is found.

fun String?.splitList(separator: String = ",", lastSeparator: String = " and "): List<String>

Split a string enumerating elements, using a different separator for the last item.