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

Interface NucleusHomeEvent.Use

All Superinterfaces:

org.spongepowered.api.event.Cancellable, CancelMessageEvent, org.spongepowered.api.event.Event, NucleusHomeEvent, org.spongepowered.api.event.user.TargetUserEvent

Enclosing interface:

NucleusHomeEvent

public static interface NucleusHomeEvent.Use
extends NucleusHomeEvent, org.spongepowered.api.event.user.TargetUserEvent

Fired when a User is warped to a home. Target user is the user being warped.

Note that the user does not necessarily need to be online.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.nucleuspowered.nucleus.api.module.home.event.NucleusHomeEvent

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

Method Summary

Modifier and Type	Method and Description
Home	getHome() Gets the existing home.

Methods inherited from interface io.github.nucleuspowered.nucleus.api.module.home.event.NucleusHomeEvent

getLocation, getName, getUser

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.user.TargetUserEvent

getTargetUser

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

getCause, getContext, getSource

Method Detail

getHome

Home getHome()

Gets the existing home.

Returns:

The Home