io.github.nucleuspowered.nucleus.api.teleport.event

Interface NucleusTeleportEvent.AboutToTeleport

All Superinterfaces:

org.spongepowered.api.event.Cancellable, CancelMessageEvent, org.spongepowered.api.event.Event, NucleusTeleportEvent, org.spongepowered.api.event.entity.TargetEntityEvent, org.spongepowered.api.event.entity.living.humanoid.TargetHumanoidEvent, org.spongepowered.api.event.entity.living.TargetLivingEvent, org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

Enclosing interface:

NucleusTeleportEvent

public static interface NucleusTeleportEvent.AboutToTeleport
extends NucleusTeleportEvent

Called when a player is about to be teleported through the Nucleus system.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.nucleuspowered.nucleus.api.teleport.event.NucleusTeleportEvent

NucleusTeleportEvent.AboutToTeleport, NucleusTeleportEvent.Request

Method Summary

Modifier and Type	Method and Description
org.spongepowered.api.entity.living.player.Player	getTargetEntity() The Player to be teleported.
org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World>	getToTransform() Gets the proposed location of the entity that will be teleported.

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

getCause, getContext, getSource

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

getCancelMessage, setCancelMessage

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

isCancelled, setCancelled

Method Detail

getToTransform

org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World> getToTransform()

Gets the proposed location of the entity that will be teleported.

Returns:

The Transform that the player would teleport to. Note that for NucleusTeleportEvent.Request, this might change when the teleportation gets underway - any changes should be made during the MoveEntityEvent.Teleport event.

getTargetEntity

org.spongepowered.api.entity.living.player.Player getTargetEntity()

The Player to be teleported.

Specified by:

getTargetEntity in interface org.spongepowered.api.event.entity.TargetEntityEvent

Specified by:

getTargetEntity in interface org.spongepowered.api.event.entity.living.humanoid.TargetHumanoidEvent

Specified by:

getTargetEntity in interface org.spongepowered.api.event.entity.living.TargetLivingEvent

Specified by:

getTargetEntity in interface org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

Returns:

The Player in question.