io.github.nucleuspowered.nucleus.api.events

Interface NucleusWarpEvent.Use

All Superinterfaces:

org.spongepowered.api.event.Cancellable, CancelMessage, org.spongepowered.api.event.Event, NucleusWarpEvent, org.spongepowered.api.event.user.TargetUserEvent

Enclosing interface:

NucleusWarpEvent

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

Fired when a User tries to teleport to a warp. The Cause of the event is who requests the warp, and is not necessarily the TargetUserEvent.getTargetUser() who is 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.events.NucleusWarpEvent

NucleusWarpEvent.Create, NucleusWarpEvent.Delete, NucleusWarpEvent.Use

Method Summary

Modifier and Type	Method and Description
org.spongepowered.api.world.Location<org.spongepowered.api.world.World>	getLocation() Gets the Location of the warp.
Warp	getWarp() Gets the Warp

Methods inherited from interface org.spongepowered.api.event.user.TargetUserEvent

getTargetUser

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

getName

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

getWarp

Warp getWarp()

Gets the Warp

Returns:

The warp.

getLocation

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

Gets the Location of the warp.

Returns:

The location.