All Classes and Interfaces
Class
Description
Sub-command (
/hs accept) that lets a player accept a pending region invite.Paginated list of all regions visible to the player.
Tracks which players are in auto-claim mode.
Sub-command (
/hs auto) that toggles automatic chunk claiming while walking.Sub-command (
/hs balance) that shows the bank balance of a region.Fired when money is deposited into a region's bank.
Fired when money is withdrawn from a region's bank.
Sub-command (
/hs banlist) that shows the banned players of the current region,
optionally as a GUI (/hs banlist gui).A utility class that manages
RegionBan.Paginated banned players list for a region.
Fired when a player is banned from a region.
Sub-command (
/hs ban) that bans a player from the current region, with an optional reason.Handles region protection for block-related world events: placement, destruction,
fire, growth, pistons, dispensers, liquids, explosions, and weather.
Renders region borders using fake block changes sent to individual players.
Protects the plugin's visual border blocks from being broken or dropped, and cleans up a player's
rendered borders when the block is removed or the player quits.
Sub-command (
/hs borders) that toggles the visual display of region chunk borders.Fluent builder for a Brigadier command tree registered through Commodore.
Registers the Brigadier command trees that mirror the plugin's Bukkit commands.
A single literal node (and its optional arguments and nested literals) of a Brigadier command tree.
Fired when all pending invitations for a region are deleted at once.
Fired when all banned players are unbanned from a region at once.
Holds the raw data for a single menu button: display name, lore lines, and item type.
Sub-command (
/hs chat) that toggles private region chat or sends a message
to the current region's members.Admin sub-command (
/hsadmin updates) that checks for a new plugin version.Central manager for region border visualization.
Enum representing available border visualization types.
Fired when chunks are about to be claimed.
Spawns glowing border particles around claimed region chunks for a specific player.
A utility class that manages
RegionChunk.Handles particle spawning around claimed region chunks for a specific player.
Fired when chunks are about to be unclaimed.
Player command (
/claim) that claims chunks, either from a wand selection
or around the player with an optional radius.Paginated claimed chunks manager for a region.
Tracks which players are in claim-fly mode.
Sub-command (
/hs claimlist) that shows the claimed chunk count of the current region,
optionally as a GUI (/hs claimlist gui).Admin sub-command (
/hsadmin claim) that claims a square area of chunks
for any region, centered on the player's position or on given chunk coordinates.Base class for every top-level Bukkit command.
Central registry for all top-level Homestead commands.
Applies a per-player cooldown to Homestead commands to prevent spam, based on the configured
COMMANDS_COOLDOWN limit.Represents the type of command sender.
Typed accessor for
config.yml.Enum representing control flags for region management permissions.
Sub-command (
/hs create) that creates a new region owned by the player.Handles Homestead's custom signs:
[Welcome], [Rent] and [HSell].Builds the "property / value" tables printed by the admin sub-commands, so that the
underlying data summary is defined in a single place.
Cancels pending delayed teleports if the player moves (when configured) or quits the server.
Sub-command (
/hs delete) that deletes the current region after confirmation.Sub-command (
/hs deny) that rejects a pending region invite.Sub-command (
/hs deposit) that deposits money from the player's balance
into the current region's bank.Awards region XP when the region owner kills a rewarded entity inside their own claimed chunks
(or an Ender Dragon anywhere), subject to a configurable cooldown.
Handles region protection for entity-related events: damage, interactions,
griefing, spawning, deaths, explosions, projectiles, and creature spawns.
Admin sub-command (
/hsadmin export) that exports all plugin data from the active
database provider into a target provider, asynchronously.Registry for managing fake border blocks shown to specific players.
Record representing a fake border block shown to a specific viewer.
Utility class for bitwise flag operations.
Typed accessor for
flags.yml.Sub-command (
/hs flags) that manages player, global, and world flags
of the current region.Sub-command (
/hs fly) that toggles flight while inside the player's region.Admin command (
/forceunclaim) that forcefully unclaims the chunk the player is standing on,
even when it would split an existing region.Global player flag configuration menu for a region.
Lifecycle helper for the glowing border display entities spawned by
ChunkGlowSpawner and SelectedAreaGlowSpawner.Paper/Folia-only companion to
BorderBreakListener: on these server softwares the
entities of a chunk are loaded asynchronously, after ChunkLoadEvent has already
fired, so leftover glowing border entities must be swept once the entity storage itself
becomes available.Sub-command (
/hs help) that shows the command descriptions in a paged list.Entry point of Homestead plugin.
Admin command (
/homesteadadmin, /hsadmin) used to manage the plugin
and perform administrative operations on regions.Sub-command (
/hs home) that teleports the player to the current region's spawn point.Admin sub-command (
/hsadmin import) that imports regions and members from
another land-claiming plugin.Static registry mapping players to their open menus, with anti-autoclicker protection.
Handles region protection for inventory/container access: villager trading,
chest boats, storage minecarts, and lectern book access.
Paginated invited players list for a region.
A utility class that manages
RegionInvite.Fired when a player is invited to join a region.
Abstraction layer for API calls that exist on Paper (Adventure) but differ
on Spigot.
Paper-only listener that governs whether Copper Golems may pick up / move items across region
boundaries using the
WorldFlag.ENTITY_GRIEFING flag.Sub-command (
/hs kick) that kicks a player out of the current region.Typed accessor for the active
languages/<locale>.yml file.Sub-command (
/hs leave) that lets a member leave the current region.Tracks the level and experience of a region.
A utility class that manages
Level.Typed accessor for
levels.yml.Sub-command (
/hs levels) that opens the level overview of the current region.Typed accessor for
limits.yml.Central logging facade for the plugin.
ANSI color codes for console output.
Pre-defined log messages for common plugin events.
A utility class that manages
RegionLog.Manages the plugin's persistent log file (
logs.txt).Sub-command (
/hs logs) that opens the action log of the current region.Sub-command (
/hs mail) that sends a mail message to a region.Paginated map color picker for regions with dynamic map support.
Paginated map icon picker for regions with dynamic map support.
Per-member control flag configuration menu.
A utility class that manages
RegionMember.Per-member player flag configuration menu.
Sub-command (
/hs members) that opens the member overview of the current region.Base menu class providing a builder-pattern API for creating non-paginated Bukkit inventory
menus.
Fired when a button is being rendered in a Homestead menu, before the player sees it.
Provides access to menu button data and constructs
ItemStack instances from
the YAML configuration.Fired when a player clicks inside a Homestead menu.
Fired when a Homestead menu is closed by a player.
Resolves
ButtonData into concrete ItemStack instances.Fired after a Homestead menu is opened for a player.
Fired when a player navigates to a different page in a paginated menu.
Typed accessor for the menus YAML configuration file.
Sub-command (
/hs menu) that opens the region menu, or the region list
when no region is selected.Resolves menu titles from the YAML configuration.
Sub-command (
/hs mergeaccept) that accepts a pending region merge request.Tracks pending merge requests between regions.
Sub-command (
/hs merge) that requests a merge with another region.bStats collects some data for plugin authors.
Represents a custom advanced bar chart.
Represents a custom advanced pie.
Represents a custom chart.
Represents a custom drilldown pie.
Represents a custom multi line chart.
Represents a custom simple bar chart.
Represents a custom simple pie.
Represents a custom single line chart.
Region miscellaneous settings menu.
Admin sub-command (
/hsadmin overrideflag) that applies a flag state across
every region, ignoring the regular per-region permission checks.Paginated menu class with page navigation support.
Context passed to content click callbacks.
Class holder for creating placeholders for a string.
Handles region protection for player-initiated actions: block interactions,
item usage, bucket operations, vehicles, elytra, fall damage, potions, and more.
Listener that manages automatic chunk claiming when a player moves between chunks.
Resolves active wars when a region owner dies.
Solution to
PlayerPortalEvent since it doesn't emit when a player enters the Exit Portal,
which is weird.Enum representing player flags that control individual player permissions within a region.
Read-only player information display.
Sub-command (
/hs player) that opens the info menu of a player,
or of the sender when no player is specified.A session that waits for a player to type text input in chat.
A builder for constructing
PlayerInputSession instances with
a fluent API.Sends a welcome message to players on join, including the number of unread region logs
and pending region invites, when the feature is enabled in the configuration.
Fired when a player joins a region as a member.
Fired when a player joins a sub-area within a region.
Fired when a player leaves a region they were a member of.
Fired when a player leaves a sub-area within a region.
Fired when a player sends mail to a region.
Tracks when players enter and leave claimed regions.
Player management hub for a region.
Utility methods for player-related operations: teleportation, operator checks and, most
importantly, the resolution of
PlayerFlag/ControlFlag permissions inside regions
and sub-areas.Admin sub-command (
/hsadmin plugin) that prints server software and plugin
data statistics to the console.Tracks which players are in private-region-chat mode.
Routes chat messages sent by players in a private-region chat session to the region's members
only, and fires a
RegionChatEvent.Base class for region protection handlers providing shared permission
checking and material classification helpers.
Admin sub-command (
/hsadmin protectionmode) that toggles the plugin-wide lock-down state.A utility class that manages
RegionRate.Sub-command (
/hs rate) that opens the rating menu of a region.Represents a claimable region in the world.
Represents a ban issued against a player for a specific region.
Fired when a player sends a message in region chat.
Represents a single chunk claimed by a region.
Main player command (
/region, /rg, /hs, /homestead)
exposing every region management sub-command.Fired when a new region is created.
Fired when a region is about to be deleted.
Fired when a region's description is changed.
Fired when a region's display name is changed.
Read-only region information display.
Sub-command (
/hs info) that opens the info menu of a region,
or of the region the sender is standing in when none is specified.Represents an invitation to join a region.
Paginated region levels display showing all level tiers and the region's current progress.
Fired when a region's spawn location is changed.
Represents a log entry for a region.
Paginated region activity log viewer.
A utility class that manages
Region.Represents a player's membership within a region or sub-area.
Identifies whether a member is linked to a region or a sub-area.
Fired when a region's name is changed.
Fired when a region's owner is changed.
Represents a rating given by a player to a region.
Region rating menu allowing players to rate a region from 1 to 5 stars.
Typed accessor for
regions.yml.High-level, region-aware facade for the storage system.
Paginated list of regions with welcome signs.
World flag configuration menu for a region.
Admin sub-command (
/hsadmin reload) that reloads the plugin's resource files.Sub-command (
/hs rename) that renames the current region.Rent configuration menu for a region or sub-area.
Fired when a rental configuration field is updated.
Rent acceptance/denial confirmation menu.
Fired when a rent is ended early by the renter or an admin.
Fired when a rent expires and access is revoked.
Fired when a notice is sent or retracted on a rental.
Fired when a rent is started and money is exchanged.
Sub-command (
/hs rent) that configures renting for the current region or a specific sub-area.Fired when a pending invitation to a region is revoked.
Region rewards/bank information menu.
Sub-command (
/hs rewards) that opens the rewards menu of the current region.Serializable representation of a block position.
Spawns glowing border particles around a player-selected cuboid area.
Handles particle spawning around a selected cuboid area for a specific player.
The main region management hub menu.
Manages the region selection tool: left/right-clicking sets the first/second corner of a
selection, shows a particle outline, and cancels the session when the tool is swapped out.
Holds the two corners of a region selection.
Serializable representation of a location with full precision.
Serializable representation of a notice-to-vacate for rented regions.
Serializable representation of rental data for a region or sub-area.
Sub-command (
/hs setdescription) that sets the description of the current region.Sub-command (
/hs setdisplayname) that sets the display name of the current region.Sub-command (
/hs setmapcolor) that changes the map color of the current region,
or opens the color menu when no color is specified.Sub-command (
/hs setmapicon) that changes the map icon of the current region,
or opens the icon menu when no icon is specified.Sub-command (
/hs setmembertax) that sets the member tax of the current region.Sub-command (
/hs set) that selects a region as the current target.Sub-command (
/hs setspawn) that sets the spawn location of the current region
to the player's current location.Sub-command (
/hs settime) that sets the time of the current region.Sub-command (
/hs setweather) that sets the weather of the current region.Thread-safe, in-memory representation of a region's shared storage.
Snowflake ID Generator for Homestead models.
Central manager for all region storages.
A player-specific inventory menu backed by a
SharedStorage.Sub-command (
/hs storage) that opens the storage of the current region.I used DeepSeek for this.
A rectangular sub-area within a parent region.
Sub-area player flag configuration menu.
A utility class that manages
SubArea.Per-member player flag configuration menu for a sub-area.
Paginated member list for a sub-area.
Sub-area management hub menu.
Paginated list of sub-areas within a region.
Sub-command (
/hs subareas) that manages the sub-areas of the current region:
create, configure, and manage their players and flags.Base class for every sub-command registered on a
CommandBuilder.Manages the "target region" session for each player.
Paginated top regions leaderboard with sorting and public/private toggle.
Sub-command (
/hs top) that opens the top regions menu.Admin sub-command (
/hsadmin transfer) that transfers the ownership of a region
to another player.Paginated list of region members.
Sub-command (
/hs trust) that invites or instantly trusts a player
in the current region, depending on the instant-trust system.Fired when a banned player is unbanned from a region.
Sub-command (
/hs unban) that unbans a player from the current region.Player command (
/unclaim) that unclaims the chunk the player is standing on.Admin sub-command (
/hsadmin unclaim) that forcefully unclaims a square area of chunks
from any region, centered on the player's position or on given chunk coordinates.Sub-command (
/hs untrust) that revokes a player's invitation or membership
in the current region.Holds the result of an update check against the remote repository.
The ancient Vault plugin, doesn't support Folia.
Sub-command (
/hs visit) that teleports to a region's welcome sign or spawn,
or opens the welcome signs menu when no region is specified.Represents a war between multiple regions.
The type of wager for a war.
Fired when a player kill is counted toward an ownership war.
A utility class that manages
War.Fired when ownership of a region is transferred as a result of an ownership war.
Sub-command (
/hs war) that manages wars between regions:
declare, surrender, or inspect the current war.Sub-command (
/hs withdraw) that withdraws money from the current region's bank
into the player's balance.Enum representing world flags that control world-level mechanics within a region.