io.github.nucleuspowered.nucleus.api.module.home

Interface NucleusHomeService

public interface NucleusHomeService

Provides information about user homes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALTERNATIVE_HOME_COUNT_OPTION Deprecated. Use HOME_COUNT_OPTION as the permission option to set home counts, as that will override this one.
static java.lang.String	DEFAULT_HOME_NAME The default home name.
static java.lang.String	HOME_COUNT_OPTION The name of the permission option that will contain the number of homes a player may have.
static java.util.regex.Pattern	HOME_NAME_PATTERN The pattern that all home names must follow.

Method Summary

Modifier and Type	Method and Description
void	createHome(org.spongepowered.api.event.cause.Cause cause, org.spongepowered.api.entity.living.player.User user, java.lang.String name, org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, com.flowpowered.math.vector.Vector3d rotation) Creates a home.
default void	createHome(org.spongepowered.api.event.cause.Cause cause, java.util.UUID user, java.lang.String name, org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, com.flowpowered.math.vector.Vector3d rotation) Creates a home.
default java.util.Optional<Home>	getHome(org.spongepowered.api.entity.living.player.User user, java.lang.String name)
java.util.Optional<Home>	getHome(java.util.UUID user, java.lang.String name) Gets a specified home of the user, if it exists.
default int	getHomeCount(org.spongepowered.api.entity.living.player.User user) Gets the number of homes the player currently has.
default int	getHomeCount(java.util.UUID user) Gets the number of homes the player currently has.
default java.util.List<Home>	getHomes(org.spongepowered.api.entity.living.player.User user) Gets the Homes for the specified user, identified by their UUID.
java.util.List<Home>	getHomes(java.util.UUID user) Gets the Homes for the specified user, identified by their UUID.
int	getMaximumHomes(org.spongepowered.api.entity.living.player.User user) Returns the maximum number of homes the player can have.
int	getMaximumHomes(java.util.UUID uuid) Returns the maximum number of homes the player can have.
void	modifyHome(org.spongepowered.api.event.cause.Cause cause, Home home, org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, com.flowpowered.math.vector.Vector3d rotation) Modifies a home's location.
default void	modifyHome(org.spongepowered.api.event.cause.Cause cause, org.spongepowered.api.entity.living.player.User user, java.lang.String name, org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, com.flowpowered.math.vector.Vector3d rotation)
default void	modifyHome(org.spongepowered.api.event.cause.Cause cause, java.util.UUID user, java.lang.String name, org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, com.flowpowered.math.vector.Vector3d rotation) Modifies a home's location.
default void	modifyOrCreateHome(org.spongepowered.api.event.cause.Cause cause, org.spongepowered.api.entity.living.player.User user, java.lang.String name, org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, com.flowpowered.math.vector.Vector3d rotation) Modifies a home's location, if it exists, otherwise creates a home.
default void	modifyOrCreateHome(org.spongepowered.api.event.cause.Cause cause, java.util.UUID user, java.lang.String name, org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, com.flowpowered.math.vector.Vector3d rotation) Modifies a home's location, if it exists, otherwise creates a home.
void	removeHome(org.spongepowered.api.event.cause.Cause cause, Home home) Removes a home.
default void	removeHome(org.spongepowered.api.event.cause.Cause cause, java.util.UUID user, java.lang.String name) Removes a home.

Field Detail

DEFAULT_HOME_NAME

static final java.lang.String DEFAULT_HOME_NAME

The default home name.

See Also:

Constant Field Values

HOME_COUNT_OPTION

static final java.lang.String HOME_COUNT_OPTION

The name of the permission option that will contain the number of homes a player may have.

See Also:

Constant Field Values

ALTERNATIVE_HOME_COUNT_OPTION

@Deprecated
static final java.lang.String ALTERNATIVE_HOME_COUNT_OPTION

Deprecated. Use HOME_COUNT_OPTION as the permission option to set home counts, as that will override this one.

An alternative name that can be used instead of HOME_COUNT_OPTION. Should only be used for reading, as an option named HOME_COUNT_OPTION will supersede this.

See Also:

Constant Field Values

HOME_NAME_PATTERN

static final java.util.regex.Pattern HOME_NAME_PATTERN

The pattern that all home names must follow.

Method Detail

getHomeCount

default int getHomeCount(java.util.UUID user)

Gets the number of homes the player currently has.

Parameters:

user - The UUID of the player

Returns:

The number of homes.

getHomeCount

default int getHomeCount(org.spongepowered.api.entity.living.player.User user)

Gets the number of homes the player currently has.

Parameters:

user - The User

Returns:

The number of homes.

getHomes

java.util.List<Home> getHomes(java.util.UUID user)

Gets the Homes for the specified user, identified by their UUID.

Parameters:

user - The UUID

Returns:

The homes.

getHomes

default java.util.List<Home> getHomes(org.spongepowered.api.entity.living.player.User user)

Gets the Homes for the specified user, identified by their UUID.

Parameters:

user - The UUID

Returns:

The homes.

getHome

java.util.Optional<Home> getHome(java.util.UUID user,
                                 java.lang.String name)

Gets a specified home of the user, if it exists.

Parameters:

user - The UUID of the user to get the home for.

name - The name of the home.

Returns:

The Home, if it exists.

getHome

default java.util.Optional<Home> getHome(org.spongepowered.api.entity.living.player.User user,
                                         java.lang.String name)

createHome

void createHome(org.spongepowered.api.event.cause.Cause cause,
                org.spongepowered.api.entity.living.player.User user,
                java.lang.String name,
                org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                com.flowpowered.math.vector.Vector3d rotation)
         throws HomeException

Creates a home. This is subject to Nucleus' standard checks.

Home names must follow the regex defined by HOME_NAME_PATTERN.

Parameters:

cause - The Cause of the change. The PluginContainer must be the root cause.

user - The UUID of the user to create the home for.

name - The name of the home to create.

location - The location of the home.

rotation - The rotation of the player when they return to this home.

Throws:

HomeException - if the home could not be created as the name is incorrect, could not be created due to home limits, or if a plugin cancelled the creation event.

createHome

default void createHome(org.spongepowered.api.event.cause.Cause cause,
                        java.util.UUID user,
                        java.lang.String name,
                        org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                        com.flowpowered.math.vector.Vector3d rotation)
                 throws HomeException,
                        NoSuchPlayerException

Creates a home. This is subject to Nucleus' standard checks.

Home names must follow the regex defined by HOME_NAME_PATTERN.

Parameters:

cause - The Cause of the change. The PluginContainer must be the root cause.

user - The UUID of the user to create the home for.

name - The name of the home to create.

location - The location of the home.

rotation - The rotation of the player when they return to this home.

Throws:

HomeException - if the home could not be created as the name is incorrect, could not be created due to home limits, or if a plugin cancelled the creation event.

NoSuchPlayerException - if the UUID does not map onto a player.

modifyHome

default void modifyHome(org.spongepowered.api.event.cause.Cause cause,
                        java.util.UUID user,
                        java.lang.String name,
                        org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                        com.flowpowered.math.vector.Vector3d rotation)
                 throws HomeException

Modifies a home's location.

Parameters:

cause - The Cause of the change. The PluginContainer must be the root cause.

user - The UUID of the user to modify the home for.

name - The name of the home to modify.

location - The location of the home.

rotation - The rotation of the player when they return to this home.

Throws:

HomeException - if the home could not be found or if a plugin cancelled the event.

modifyHome

void modifyHome(org.spongepowered.api.event.cause.Cause cause,
                Home home,
                org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                com.flowpowered.math.vector.Vector3d rotation)
         throws HomeException

Modifies a home's location.

Parameters:

cause - The Cause of the change. The PluginContainer must be the root cause.

home - The Home to modify.

location - The location of the home.

rotation - The rotation of the player when they return to this home.

Throws:

HomeException - if the home could not be found, or a plugin cancelled the event.

modifyHome

default void modifyHome(org.spongepowered.api.event.cause.Cause cause,
                        org.spongepowered.api.entity.living.player.User user,
                        java.lang.String name,
                        org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                        com.flowpowered.math.vector.Vector3d rotation)
                 throws HomeException

Throws:

HomeException

modifyOrCreateHome

default void modifyOrCreateHome(org.spongepowered.api.event.cause.Cause cause,
                                org.spongepowered.api.entity.living.player.User user,
                                java.lang.String name,
                                org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                                com.flowpowered.math.vector.Vector3d rotation)
                         throws HomeException

Modifies a home's location, if it exists, otherwise creates a home. This is subject to Nucleus' standard checks.

Parameters:

cause - The Cause of the change. The PluginContainer must be the root cause.

user - The UUID of the user to modify the home for.

name - The name of the home to modify or create.

location - The location of the home.

rotation - The rotation of the player when they return to this home.

Throws:

HomeException - if the home could not be created, due to home limits, or a plugin cancelled the event.

modifyOrCreateHome

default void modifyOrCreateHome(org.spongepowered.api.event.cause.Cause cause,
                                java.util.UUID user,
                                java.lang.String name,
                                org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                                com.flowpowered.math.vector.Vector3d rotation)
                         throws HomeException,
                                NoSuchPlayerException

Modifies a home's location, if it exists, otherwise creates a home. This is subject to Nucleus' standard checks.

Parameters:

cause - The Cause of the change. The PluginContainer must be the root cause.

user - The UUID of the user to modify the home for.

name - The name of the home to modify or create.

location - The location of the home.

rotation - The rotation of the player when they return to this home.

Throws:

HomeException - if the home could not be created, due to home limits, or a plugin cancelled the event.

NoSuchPlayerException - if the supplied UUID does not map to a known user

removeHome

default void removeHome(org.spongepowered.api.event.cause.Cause cause,
                        java.util.UUID user,
                        java.lang.String name)
                 throws HomeException

Removes a home.

Parameters:

cause - The Cause of the change. The PluginContainer must be the root cause.

user - The UUID of the user to remove the home of.

name - The name of the home to remove.

Throws:

HomeException - if the home could not be found, or a plugin cancelled the event.

removeHome

void removeHome(org.spongepowered.api.event.cause.Cause cause,
                Home home)
         throws HomeException

Removes a home.

Parameters:

cause - The Cause of the change. The PluginContainer must be the root cause.

home - The Home to remove.

Throws:

HomeException - if the home could not be found, or a plugin cancelled the event.

getMaximumHomes

int getMaximumHomes(java.util.UUID uuid)
             throws java.lang.IllegalArgumentException

Returns the maximum number of homes the player can have.

Parameters:

uuid - The UUID of the player.

Returns:

The number of homes, or Integer.MAX_VALUE if unlimited.

Throws:

java.lang.IllegalArgumentException - if the user cannot be found

getMaximumHomes

int getMaximumHomes(org.spongepowered.api.entity.living.player.User user)

Returns the maximum number of homes the player can have.

Parameters:

user - The User.

Returns:

The number of homes, or Integer.MAX_VALUE if unlimited.