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

Interface NucleusHomeEvent

All Superinterfaces:

org.spongepowered.api.event.Cancellable, CancelMessageEvent, org.spongepowered.api.event.Event

All Known Subinterfaces:

NucleusHomeEvent.Create, NucleusHomeEvent.Delete, NucleusHomeEvent.Modify, NucleusHomeEvent.Use

public interface NucleusHomeEvent
extends org.spongepowered.api.event.Cancellable, CancelMessageEvent, org.spongepowered.api.event.Event

Events when a player's home changes.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusHomeEvent.Create Fired when a home is created.
static interface	NucleusHomeEvent.Delete Fired when a home is deleted.
static interface	NucleusHomeEvent.Modify Fired when a home is moved.
static interface	NucleusHomeEvent.Use Fired when a User is warped to a home.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>>	getLocation() Gets the Location of the home.
java.lang.String	getName() Gets the name of the home.
org.spongepowered.api.entity.living.player.User	getUser() Gets the owner of the house

Methods inherited from interface io.github.nucleuspowered.nucleus.api.util.CancelMessageEvent

getCancelMessage, setCancelMessage

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Method Detail

getName

java.lang.String getName()

Gets the name of the home.

Returns:

The name of the home.

getUser

org.spongepowered.api.entity.living.player.User getUser()

Gets the owner of the house

Returns:

The owner.

getLocation

java.util.Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>> getLocation()

Gets the Location of the home.

Returns:

The location. It might not exist if the world does not exist any more.