io.github.nucleuspowered.nucleus.api.events

Interface NucleusHomeEvent.Modify

All Superinterfaces:

org.spongepowered.api.event.Cancellable, CancelMessage, org.spongepowered.api.event.Event, NucleusHomeEvent

Enclosing interface:

NucleusHomeEvent

@MightOccurAsync
public static interface NucleusHomeEvent.Modify
extends NucleusHomeEvent

Fired when a home is moved.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.nucleuspowered.nucleus.api.events.NucleusHomeEvent

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

Method Summary

Modifier and Type	Method and Description
Home	getHome() Gets the existing home.
Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>>	getOriginalLocation() Gets the original Location of the home.

Methods inherited from interface io.github.nucleuspowered.nucleus.api.events.NucleusHomeEvent

getLocation, getName, getUser

Methods inherited from interface io.github.nucleuspowered.nucleus.api.events.CancelMessage

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

getHome

Home getHome()

Gets the existing home.

Returns:

The Home

getOriginalLocation

Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>> getOriginalLocation()

Gets the original Location of the home. To get the proposed new location, see NucleusHomeEvent.getLocation()

Returns:

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