tibiakt-core/com.galarzaa.tibiakt.core.models.house/House/Rented

Rented

@Serializable

@SerialName(value = "RENTED")

data class Rented(val houseId: Int, val name: String, val size: Int, val houseType: HouseType, val beds: Int, val rent: Int, val world: String, val paidUntil: Instant, val owner: String, val transferDate: Instant?, val transferPrice: Int?, val transferAccepted: Boolean?, val transferRecipient: String?) : House(source)

A rented house or guildhall.

Constructors

constructor(houseId: Int, name: String, size: Int, houseType: HouseType, beds: Int, rent: Int, world: String, paidUntil: Instant, owner: String, transferDate: Instant?, transferPrice: Int?, transferAccepted: Boolean?, transferRecipient: String?)

Properties

open override val beds: Int

The maximum amount of beds that can be placed in there.

open override val houseId: Int

The internal ID of the house.

open override val houseType: HouseType

The type of the house.

open val imageUrl: String

URL to the house's image.

open override val name: String

The name of the house.

val owner: String

The character that currently owns the house.

val ownerUrl: String

URL to the owner's information page.

val paidUntil: Instant

The date when the last paid rent is due.

open override val rent: Int

The monthly rent paid for this house in gold coins.

open override val size: Int

The size of the house in square meters (tiles).

open override val status: HouseStatus

The current status of the house.

transferAccepted

val transferAccepted: Boolean?

Whether the transfer has been accepted by the recipient or not.

val transferDate: Instant?

The date when the current owner will move out of the house.

val transferPrice: Int?

The amount of gold coins to be paid for transferring the house.

transferRecipient

val transferRecipient: String?

The character that will receive the house.

transferRecipientUrl

val transferRecipientUrl: String?

URL to the transfer recipient's information page, if any.

open val url: String

The URL to the house's information page.

open override val world: String

The world where this house is located.