Package net.essentialsx.api.v2.events

Class HomeModifyEvent

java.lang.Object

org.bukkit.event.Event

net.essentialsx.api.v2.events.HomeModifyEvent

All Implemented Interfaces:

Cancellable

public class HomeModifyEvent
extends Event
implements Cancellable

Called when a home is about to be modified.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HomeModifyEvent.HomeModifyCause	The cause of why a home was modified.

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

Event.Result

Constructor Summary

Constructors

Constructor	Description
HomeModifyEvent(IUser user, IUser homeOwner, String oldName, String newName, Location location)
HomeModifyEvent(IUser user, IUser homeOwner, String name, Location location, boolean create)
HomeModifyEvent(IUser user, IUser homeOwner, String name, Location oldLocation, Location newLocation)
HomeModifyEvent(IUser user, IUser homeOwner, Location newLocation, Location oldLocation, String newName, String oldName, HomeModifyEvent.HomeModifyCause cause)

Method Summary

Modifier and Type	Method	Description
HomeModifyEvent.HomeModifyCause	getCause()	Returns the underlying cause of this modification to a home.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
IUser	getHomeOwner()	Gets the owner of the home being modified.
Location	getNewLocation()	Returns the location of the home when getCause() returns HomeModifyEvent.HomeModifyCause.CREATE or HomeModifyEvent.HomeModifyCause.RENAME, returns the updated location of the home if it returns HomeModifyEvent.HomeModifyCause.UPDATE, or returns null if it returns HomeModifyEvent.HomeModifyCause.DELETE.
String	getNewName()	Returns the name of the home when getCause() returns HomeModifyEvent.HomeModifyCause.CREATE or HomeModifyEvent.HomeModifyCause.UPDATE, returns the updated name if it returns HomeModifyEvent.HomeModifyCause.RENAME, or returns null if it returns HomeModifyEvent.HomeModifyCause.DELETE.
Location	getOldLocation()	Returns the location of the home when getCause() returns HomeModifyEvent.HomeModifyCause.RENAME or HomeModifyEvent.HomeModifyCause.DELETE, returns the previous location of the home if it returns HomeModifyEvent.HomeModifyCause.UPDATE, or returns null if it returns HomeModifyEvent.HomeModifyCause.CREATE.
String	getOldName()	Returns the name of the home when getCause() returns HomeModifyEvent.HomeModifyCause.UPDATE or HomeModifyEvent.HomeModifyCause.DELETE, returns the previous name if it returns HomeModifyEvent.HomeModifyCause.RENAME, or returns null if it returns HomeModifyEvent.HomeModifyCause.CREATE.
IUser	getUser()	Gets the user who modified the home or null if the console modified the home.
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

HomeModifyEvent

public HomeModifyEvent(IUser user,
 IUser homeOwner,
 String name,
 Location location,
 boolean create)

HomeModifyEvent

public HomeModifyEvent(IUser user,
 IUser homeOwner,
 String oldName,
 String newName,
 Location location)

HomeModifyEvent

public HomeModifyEvent(IUser user,
 IUser homeOwner,
 String name,
 Location oldLocation,
 Location newLocation)

HomeModifyEvent

public HomeModifyEvent(IUser user,
 IUser homeOwner,
 Location newLocation,
 Location oldLocation,
 String newName,
 String oldName,
 HomeModifyEvent.HomeModifyCause cause)

Method Details

getUser

public IUser getUser()

Gets the user who modified the home or null if the console modified the home.

Returns:

The user who modified the home or null.

getHomeOwner

public IUser getHomeOwner()

Gets the owner of the home being modified.

Returns:

The user who owns the home.

getNewLocation

public Location getNewLocation()

Returns the location of the home when getCause() returns HomeModifyEvent.HomeModifyCause.CREATE or HomeModifyEvent.HomeModifyCause.RENAME, returns the updated location of the home if it returns HomeModifyEvent.HomeModifyCause.UPDATE, or returns null if it returns HomeModifyEvent.HomeModifyCause.DELETE.

Returns:

The location of the home or null.

getOldLocation

public Location getOldLocation()

Returns the location of the home when getCause() returns HomeModifyEvent.HomeModifyCause.RENAME or HomeModifyEvent.HomeModifyCause.DELETE, returns the previous location of the home if it returns HomeModifyEvent.HomeModifyCause.UPDATE, or returns null if it returns HomeModifyEvent.HomeModifyCause.CREATE.

Returns:

The location of the home or null.

getNewName

public String getNewName()

Returns the name of the home when getCause() returns HomeModifyEvent.HomeModifyCause.CREATE or HomeModifyEvent.HomeModifyCause.UPDATE, returns the updated name if it returns HomeModifyEvent.HomeModifyCause.RENAME, or returns null if it returns HomeModifyEvent.HomeModifyCause.DELETE.

Returns:

The name of the home or null.

getOldName

public String getOldName()

Returns the name of the home when getCause() returns HomeModifyEvent.HomeModifyCause.UPDATE or HomeModifyEvent.HomeModifyCause.DELETE, returns the previous name if it returns HomeModifyEvent.HomeModifyCause.RENAME, or returns null if it returns HomeModifyEvent.HomeModifyCause.CREATE.

Returns:

The name of the home or null.

getCause

public HomeModifyEvent.HomeModifyCause getCause()

Returns the underlying cause of this modification to a home.

Returns:

The cause.

setCancelled

public void setCancelled(boolean cancel)

Specified by:

setCancelled in interface Cancellable

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()