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

Class HomeTeleportEvent

java.lang.Object
org.bukkit.event.Event
net.godlycow.org.essc.api.home.event.HomeTeleportEvent
All Implemented Interfaces:
org.bukkit.event.Cancellable
public class HomeTeleportEvent extends org.bukkit.event.Event implements org.bukkit.event.Cancellable
Fired when a home teleport starts.

Cancelling this event blocks the teleport. 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
    HomeTeleportEvent(org.bukkit.entity.Player player, Home home)
    Creates a new home teleport 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()
     
    Home
    getHome()
    Returns the destination home.
    org.bukkit.entity.Player
    getPlayer()
    Returns the teleporting player.
    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

    • HomeTeleportEvent

      public HomeTeleportEvent(org.bukkit.entity.Player player, Home home)
      Creates a new home teleport event.
      Parameters:
      player - the teleporting player
      home - the destination home

  • Method Details

    • getPlayer

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

    • getHome

      public Home getHome()
      Returns the destination home.
      Returns:
      the home

    • 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()