Package net.ess3.api.events

Class UserTeleportHomeEvent

java.lang.Object

org.bukkit.event.Event

net.ess3.api.events.UserTeleportHomeEvent

All Implemented Interfaces:

Cancellable

public class UserTeleportHomeEvent
extends Event
implements Cancellable

Called when a user is teleported home via the /home command.

This is called before TeleportWarmupEvent.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserTeleportHomeEvent.HomeType	The type of home location.

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

Event.Result

Constructor Summary

Constructors

Constructor	Description
UserTeleportHomeEvent(IUser user, String homeName, Location target, UserTeleportHomeEvent.HomeType homeType)

Method Summary

Modifier and Type	Method	Description
static HandlerList	getHandlerList()
HandlerList	getHandlers()
Location	getHomeLocation()	Returns the location the user is teleporting to.
String	getHomeName()	Returns the name of the home being teleported to.
UserTeleportHomeEvent.HomeType	getHomeType()	Returns the home location type.
IUser	getUser()	Returns the user who is being teleported
boolean	isCancelled()
void	setCancelled(boolean cancelled)

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

UserTeleportHomeEvent

public UserTeleportHomeEvent(IUser user,
 String homeName,
 Location target,
 UserTeleportHomeEvent.HomeType homeType)

Method Details

getHandlerList

public static HandlerList getHandlerList()

getUser

public IUser getUser()

Returns the user who is being teleported

Returns:

The teleportee.

getHomeName

public String getHomeName()

Returns the name of the home being teleported to.

The behavior of this method varies based on the UserTeleportHomeEvent.HomeType as follows; UserTeleportHomeEvent.HomeType.HOME - Returns name of home being teleported to. UserTeleportHomeEvent.HomeType.BED - Returns "bed". UserTeleportHomeEvent.HomeType.SPAWN - Returns null.

Returns:

Name of home being teleported to, or null if the user had no homes set.

getHomeLocation

public Location getHomeLocation()

Returns the location the user is teleporting to.

Returns:

Teleportation destination location.

getHomeType

public UserTeleportHomeEvent.HomeType getHomeType()

Returns the home location type.

UserTeleportHomeEvent.HomeType.HOME - A user-set home location. UserTeleportHomeEvent.HomeType.BED - A user's bed location. UserTeleportHomeEvent.HomeType.SPAWN - The user's current world spawn.

Returns:

Home location type.

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

setCancelled

public void setCancelled(boolean cancelled)

Specified by:

setCancelled in interface Cancellable

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event