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

Class WarpTeleportEvent

java.lang.Object
org.bukkit.event.Event
net.godlycow.org.essc.api.warp.event.WarpTeleportEvent
All Implemented Interfaces:
org.bukkit.event.Cancellable
public class WarpTeleportEvent extends org.bukkit.event.Event implements org.bukkit.event.Cancellable
Fired when a warp 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
    WarpTeleportEvent(org.bukkit.entity.Player player, Warp warp)
    Creates a new warp 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()
     
    org.bukkit.entity.Player
    getPlayer()
    Returns the teleporting player.
    Warp
    getWarp()
    Returns the destination warp.
    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

    • WarpTeleportEvent

      public WarpTeleportEvent(org.bukkit.entity.Player player, Warp warp)
      Creates a new warp teleport event.
      Parameters:
      player - the teleporting player
      warp - the destination warp

  • Method Details

    • getPlayer

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

    • getWarp

      public Warp getWarp()
      Returns the destination warp.
      Returns:
      the warp

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