Package net.essentialsx.api.v2.events

Class WarpModifyEvent

java.lang.Object

org.bukkit.event.Event

net.essentialsx.api.v2.events.WarpModifyEvent

All Implemented Interfaces:

Cancellable

public class WarpModifyEvent
extends Event
implements Cancellable

Called when a warp is about to be modified. Includes creation and deletion as described in WarpModifyEvent.WarpModifyCause.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WarpModifyEvent.WarpModifyCause	The cause of why a warp was modified.

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

Event.Result

Constructor Summary

Constructors

Constructor	Description
WarpModifyEvent(IUser user, String warpName, Location oldLocation, Location newLocation, WarpModifyEvent.WarpModifyCause cause)

Method Summary

Modifier and Type	Method	Description
WarpModifyEvent.WarpModifyCause	getCause()
static HandlerList	getHandlerList()
HandlerList	getHandlers()
Location	getNewLocation()	Gets the new location this warp is being updated to, or null if it's being deleted.
Location	getOldLocation()	Gets the current location of the warp or null if it's being created or if the previous location's world is not loaded.
IUser	getUser()
String	getWarpName()
boolean	isCancelled()
void	setCancelled(boolean cancel)

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

WarpModifyEvent

public WarpModifyEvent(IUser user,
 String warpName,
 Location oldLocation,
 Location newLocation,
 WarpModifyEvent.WarpModifyCause cause)

Parameters:

user - the IUser who is modifing the warp.

warpName - the name of the warp that's being altered.

oldLocation - the old location before being modified. Null if WarpModifyEvent.WarpModifyCause.CREATE or if the previous location's world is not loaded.

newLocation - the new location after being modified. Null if WarpModifyEvent.WarpModifyCause.DELETE.

cause - the cause of change.

Method Details

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

setCancelled

public void setCancelled(boolean cancel)

Specified by:

setCancelled in interface Cancellable

getUser

public IUser getUser()

getCause

public WarpModifyEvent.WarpModifyCause getCause()

getWarpName

public String getWarpName()

getOldLocation

public Location getOldLocation()

Gets the current location of the warp or null if it's being created or if the previous location's world is not loaded.

Returns:

The warps new location or null.

getNewLocation

public Location getNewLocation()

Gets the new location this warp is being updated to, or null if it's being deleted.

Returns:

The warps new location or null.

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()