Interface HomeService

public interface HomeService

Per-player homes, including the permission-driven per-player home limit.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HomeService.HomeLimitExceededException	Thrown by set(UUID, String, Position) when creating a new home would exceed limitFor(UUID).

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Boolean>	delete(UUID owner, String name)
CompletableFuture<Home>	get(UUID owner, String name)
int	limitFor(UUID owner)	Effective max number of homes for this player, from their highest youneedme.homes.limit.<n> node.
CompletableFuture<List<Home>>	list(UUID owner)
CompletableFuture<Home>	set(UUID owner, String name, Position position)	Creates or overwrites a home.

Method Details

list

CompletableFuture<List<Home>> list(UUID owner)

get

CompletableFuture<Home> get(UUID owner,
 String name)

limitFor

int limitFor(UUID owner)

Effective max number of homes for this player, from their highest youneedme.homes.limit.<n> node.

set

CompletableFuture<Home> set(UUID owner,
 String name,
 Position position)

Creates or overwrites a home. Fails (exceptionally, with HomeService.HomeLimitExceededException) if the player is at their limit and name doesn't already exist for them.

delete

CompletableFuture<Boolean> delete(UUID owner,
 String name)