Package net.godlycow.org.essc.api.home.event

Class HomeSetEvent

java.lang.Object
org.bukkit.event.Event
net.godlycow.org.essc.api.home.event.HomeSetEvent
All Implemented Interfaces:
org.bukkit.event.Cancellable
public class HomeSetEvent extends org.bukkit.event.Event implements org.bukkit.event.Cancellable
Fired when a home is about to be set or overwritten.

Cancelling this event blocks the write. Communicate why via setCancelReason(String).

  • Nested Class Summary

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

    org.bukkit.event.Event.Result

  • Constructor Summary

    Constructors
    Constructor
    Description
    HomeSetEvent(org.bukkit.entity.Player player, String homeName, org.bukkit.Location location)
    Creates a new home set event.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCancelReason()
    Returns why the event was cancelled, or an empty string if not cancelled.
    static org.bukkit.event.HandlerList
    getHandlerList()
     
    org.bukkit.event.HandlerList
    getHandlers()
     
    String
    getHomeName()
    Returns the home name.
    org.bukkit.Location
    getLocation()
    Returns the home location (a copy).
    org.bukkit.entity.Player
    getPlayer()
    Returns the player setting the home.
    boolean
    isCancelled()
     
    void
    setCancelled(boolean cancel)
     
    void
    setCancelReason(String cancelReason)
    Sets why the event is being cancelled.

    Methods inherited from class org.bukkit.event.Event

    callEvent, getEventName, isAsynchronous

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • HomeSetEvent

      public HomeSetEvent(org.bukkit.entity.Player player, String homeName, org.bukkit.Location location)
      Creates a new home set event.
      Parameters:
      player - the player setting the home
      homeName - the home name
      location - the home location

  • Method Details

    • getPlayer

      public org.bukkit.entity.Player getPlayer()
      Returns the player setting the home.
      Returns:
      the player

    • getHomeName

      public String getHomeName()
      Returns the home name.
      Returns:
      the home name

    • getLocation

      public org.bukkit.Location getLocation()
      Returns the home location (a copy).
      Returns:
      the location

    • getCancelReason

      public String getCancelReason()
      Returns why the event was cancelled, or an empty string if not cancelled.
      Returns:
      the cancel reason

    • setCancelReason

      public void setCancelReason(String cancelReason)
      Sets why the event is being cancelled.
      Parameters:
      cancelReason - the cancel reason

    • isCancelled

      public boolean isCancelled()
      Specified by:
      isCancelled in interface org.bukkit.event.Cancellable

    • setCancelled

      public void setCancelled(boolean cancel)
      Specified by:
      setCancelled in interface org.bukkit.event.Cancellable

    • getHandlers

      public org.bukkit.event.HandlerList getHandlers()
      Specified by:
      getHandlers in class org.bukkit.event.Event

    • getHandlerList

      public static org.bukkit.event.HandlerList getHandlerList()