House

@Serializable
sealed class House : BaseHouse(source)

A house or guildhall.

Inheritors

Types

Link copied to clipboard
@Serializable
@SerialName(value = "AUCTIONED")
data class Auctioned(val houseId: Int, val name: String, val size: Int, val houseType: HouseType, val beds: Int, val rent: Int, val world: String, val highestBid: Int?, val highestBidder: String?, val auctionEnd: Instant?) : House

An auctioned house or guildhall.

Link copied to clipboard
@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

A rented house or guildhall.

Properties

Link copied to clipboard
abstract val beds: Int

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

Link copied to clipboard
abstract override val houseId: Int

The internal ID of the house.

Link copied to clipboard
abstract val houseType: HouseType

The type of the house.

Link copied to clipboard
open val imageUrl: String

URL to the house's image.

Link copied to clipboard
abstract val name: String

The name of the house.

Link copied to clipboard
abstract val rent: Int

The monthly rent paid for this house in gold coins.

Link copied to clipboard
abstract val size: Int

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

Link copied to clipboard
abstract val status: HouseStatus

The current status of the house.

Link copied to clipboard
open val url: String

The URL to the house's information page.

Link copied to clipboard
abstract override val world: String

The world where this house is located.