House

A value shape that methods take or return.

Group
player
Methods
None
Fields
14

Getting one

player:house()

Fields

FieldTypeDescription
locationnumberThe POH_HOUSE_LOCATION varbit: the town the house portal stands in, as the game numbers it.
portals{ string }The portal chamber's destinations, by name ("VARROCK", "KHARYLL"), sorted.
nexusbooleanWhether a portal nexus is built.
jewelleryBox"NONE" | "BASIC" | "FANCY" | "ORNATE"The jewellery box.
fairyRingbooleanWhether a fairy ring is built (a spirit ring counts).
spiritTreebooleanWhether a spirit tree is built (a spirit ring counts).
obeliskbooleanWhether a wilderness obelisk is built.
mounted{ "GLORY" | "XERICS_TALISMAN" | "DIGSITE_PENDANT" | "MYTHICAL_CAPE" }The mounted teleport items, sorted.
pool"NONE" | "RESTORATION" | "REVITALISATION" | "REJUVENATION" | "FANCY" | "ORNATE"The pool ("FANCY" and "ORNATE" are the fancy and ornate rejuvenation pools).
altarHouseAltar?The chapel altar, or nil when none is built.
spellbookAltar("ANCIENT" | "LUNAR" | "DARK" | "OCCULT")?The spellbook altar, or nil when none is built.
repairStandbooleanWhether an armour repair stand is built.
seenAtnumberWhen the client last saw the house from inside, Unix milliseconds.
livebooleanWhether the player is inside it now.

Returned by

MethodReturnsDescription
PlayerDomain.houseHouse?The local player's own house as the client last saw it inside: its portals, jewellery box, pool, altars and travel furniture. Saved per acc…