Region

interface Region

Represents a region within housing.

A Region provides metadata (name), PvP-related configuration and entry/exit action containers.

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

Types

PvP and damage-related toggleable settings for a region.

abstract var name: String

The unique name of the region.

abstract suspend fun delete()

Deletes this region.

Returns the action container executed when a player enters the region.

Returns the action container executed when a player exits the region.

open suspend fun getName(): String

Returns the current region name.

Returns the PvP-related settings for this region.

abstract suspend fun moveRegion(): Region

Moves the region bounds. The caller must have a region selected for this to succeed.

abstract suspend fun setName(newName: String): Region

Sets a new name for the region.

Updates the PvP settings for this region.