tibiakt-core/com.galarzaa.tibiakt.core.models.world/World

World

@Serializable

data class World(val name: String, val isOnline: Boolean, val onlineCount: Int, val location: String, val pvpType: PvpType, val battlEyeType: BattlEyeType, val battlEyeStartDate: LocalDate?, val transferType: TransferType, val isPremiumRestricted: Boolean, val isExperimental: Boolean, val onlineRecordCount: Int, val onlineRecordDateTime: Instant, val creationDate: YearMonth, val worldQuests: List<String>, val playersOnline: List<OnlineCharacter>) : BaseWorld(source)

A game world.

Constructors

constructor(name: String, isOnline: Boolean, onlineCount: Int, location: String, pvpType: PvpType, battlEyeType: BattlEyeType, battlEyeStartDate: LocalDate?, transferType: TransferType, isPremiumRestricted: Boolean, isExperimental: Boolean, onlineRecordCount: Int, onlineRecordDateTime: Instant, creationDate: YearMonth, worldQuests: List<String>, playersOnline: List<OnlineCharacter>)

Properties

battlEyeStartDate

val battlEyeStartDate: LocalDate?

The date when BattlEye was implemented in this world.

val battlEyeType: BattlEyeType

The type of BattlEye protection present in this world.

val creationDate: YearMonth

The year and month when this world was created.

val isExperimental: Boolean

Whether the world is experimental or not.

val isOnline: Boolean

Whether this world is currently online or not.

isPremiumRestricted

val isPremiumRestricted: Boolean

Whether the world can only be played by premium account characters or not.

val location: String

The geographical location of the server.

open override val name: String

The name of the world.

val onlineCount: Int

The total of online players in this world.

onlineRecordCount

val onlineRecordCount: Int

The maximum online players recorded on this world.

onlineRecordDateTime

val onlineRecordDateTime: Instant

The date and time when the maximum online players record was set.

val playersOnline: List<OnlineCharacter>

The list of online players in this world.

val pvpType: PvpType

The type of PvP in this world.

val transferType: TransferType

The type of transfer restrictions this world has.

open val url: String

The URL to the world's page in Tibia.com.

val worldQuests: List<String>

The list of world quests completed.

Functions

transferableFrom

fun transferableFrom(origin: World): Boolean

Check if a character from the origin world can transfer to this world.