HouseSettings

interface HouseSettings

Represents miscellaneous house settings in Housing.

Provides suspendable accessors and mutators for various house-level configuration values such as daylight cycle, player limits, tags, languages, parkour announcement mode, and gameplay-related toggles.

Implementations perform sequential behavior and therefore expose suspend functions for better interaction with Housing.

Inheritors

Types

Link copied to clipboard

Fishing-related settings.

Link copied to clipboard

Specified house languages.

Link copied to clipboard

House tags categorizing the house by activity/style.

Link copied to clipboard

Options for maximum player counts.

Link copied to clipboard

Options for how parkour completion announcements are handled.

Link copied to clipboard

Types of player-state data that may be saved/restored.

Link copied to clipboard

PvP and damage-related settings.

Functions

Link copied to clipboard
abstract suspend fun clearPlayerStates(): HouseSettings

Clears all player states.

Link copied to clipboard
abstract suspend fun getDaylightCycle(): Boolean

Returns whether the daylight cycle is enabled for this house.

Link copied to clipboard
abstract suspend fun getDefaultVariableDuration(): Duration

Returns the default variable duration used when no override exists.

Link copied to clipboard

Returns the map of global fishing-related settings and whether each is enabled.

Link copied to clipboard

Returns the set of specified languages for the house.

Link copied to clipboard
abstract suspend fun getHouseName(): String

Returns the human-facing name of the house.

Link copied to clipboard
abstract suspend fun getHouseTags(): Set<HouseSettings.HouseTag>

Returns the set of tags associated with the house.

Link copied to clipboard
abstract suspend fun getMaxPlayers(): HouseSettings.MaxPlayers

Returns the configured maximum players setting for the house.

Link copied to clipboard

Returns the parkour announce behavior for the house.

Link copied to clipboard
abstract suspend fun getPlayerStateDuration(): Duration

Returns the default storage duration for player states.

Link copied to clipboard

Returns a map of player state types to their enabled/disabled state.

Link copied to clipboard

Returns the map of global PvP-related settings and whether each is enabled.

Link copied to clipboard
abstract suspend fun getVariableDurationOverride(variable: String): Duration?

Returns an override duration for a specific variable, if present.

Link copied to clipboard
abstract suspend fun removeVariableDurationOverride(variable: String): HouseSettings

Removes a previously set variable duration override.

Link copied to clipboard
abstract suspend fun setDaylightCycle(newDaylightCycle: Boolean): HouseSettings

Sets whether the daylight cycle should be enabled.

Link copied to clipboard
abstract suspend fun setDefaultVariableDuration(newDuration: Duration): HouseSettings

Sets the default variable duration.

Link copied to clipboard

Replaces fishing-related settings with the provided map.

Link copied to clipboard
abstract suspend fun setHouseLanguages(newLanguages: Set<HouseSettings.HouseLanguage>): HouseSettings

Sets the specified languages for the house.

Link copied to clipboard
abstract suspend fun setHouseName(newName: String): HouseSettings

Sets the human-facing name of the house.

Link copied to clipboard
abstract suspend fun setHouseTags(newTags: Set<HouseSettings.HouseTag>): HouseSettings

Replaces the house tags with the provided set.

Link copied to clipboard
abstract suspend fun setMaxPlayers(newMaxPlayers: HouseSettings.MaxPlayers): HouseSettings

Sets the maximum players configuration for the house.

Link copied to clipboard
abstract suspend fun setParkourAnnounce(newParkourAnnounce: HouseSettings.ParkourAnnounce): HouseSettings

Sets the parkour announce behavior.

Link copied to clipboard
abstract suspend fun setPlayerStateDuration(newDuration: Duration): HouseSettings

Sets the default storage duration for player states.

Link copied to clipboard

Enables/disables the storage of specific player state types.

Link copied to clipboard

Replaces PvP-related settings with the provided map.

Link copied to clipboard
abstract suspend fun setVariableDurationOverride(variable: String, newDuration: Duration): HouseSettings

Sets an override duration for a specific variable.