Package net.ess3.api.events.teleport

Class TeleportEvent

java.lang.Object

org.bukkit.event.Event

net.ess3.api.events.teleport.TeleportEvent

All Implemented Interfaces:

Cancellable

Direct Known Subclasses:

PreTeleportEvent, TeleportWarmupEvent

public abstract class TeleportEvent
extends Event
implements Cancellable

Abstract class for various teleport events. You should listen to PreTeleportEvent or TeleportWarmupEvent depending on your needs.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Method Summary

Modifier and Type	Method	Description
ITarget	getTarget()
PlayerTeleportEvent.TeleportCause	getTeleportCause()
IUser	getTeleportee()
IUser	getTeleporter()
boolean	isCancelled()
void	setCancelled(boolean b)

Methods inherited from class org.bukkit.event.Event

getEventName, getHandlers, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getTeleporter

public IUser getTeleporter()

Returns:

The user that initiated the teleportation, or null if unknown

getTeleportee

public IUser getTeleportee()

Returns:

The user to be teleported

getTeleportCause

public PlayerTeleportEvent.TeleportCause getTeleportCause()

Returns:

The reason for teleportation

getTarget

public ITarget getTarget()

Returns:

The target to teleport to, or null if unknown at this stage (such as a forced respawn)

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

setCancelled

public void setCancelled(boolean b)

Specified by:

setCancelled in interface Cancellable