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

Class RtpTeleportEvent

java.lang.Object
org.bukkit.event.Event
net.godlycow.org.essc.api.rtp.event.RtpTeleportEvent
All Implemented Interfaces:
org.bukkit.event.Cancellable
public class RtpTeleportEvent extends org.bukkit.event.Event implements org.bukkit.event.Cancellable
Fired right before the RTP teleport.

Rewrite the landing spot with setDestination(Location), or cancel the event to block the teleport.

  • Nested Class Summary

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

    org.bukkit.event.Event.Result

  • Constructor Summary

    Constructors
    Constructor
    Description
    RtpTeleportEvent(org.bukkit.entity.Player player, org.bukkit.World world, org.bukkit.Location destination)
    Creates a new RTP teleport event.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCancelReason()
    Returns why the event was cancelled, or an empty string if not cancelled.
    org.bukkit.Location
    getDestination()
    Returns the landing spot (a copy).
    static org.bukkit.event.HandlerList
    getHandlerList()
     
    org.bukkit.event.HandlerList
    getHandlers()
     
    org.bukkit.entity.Player
    getPlayer()
    Returns the teleporting player.
    org.bukkit.World
    getWorld()
    Returns the world.
    boolean
    isCancelled()
     
    void
    setCancelled(boolean cancel)
     
    void
    setCancelReason(String cancelReason)
    Sets why the event is being cancelled.
    void
    setDestination(org.bukkit.Location destination)
    Rewrites the landing spot.

    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

    • RtpTeleportEvent

      public RtpTeleportEvent(org.bukkit.entity.Player player, org.bukkit.World world, org.bukkit.Location destination)
      Creates a new RTP teleport event.
      Parameters:
      player - the teleporting player
      world - the world
      destination - the landing spot

  • Method Details

    • getPlayer

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

    • getWorld

      public org.bukkit.World getWorld()
      Returns the world.
      Returns:
      the world

    • getDestination

      public org.bukkit.Location getDestination()
      Returns the landing spot (a copy).
      Returns:
      the destination

    • setDestination

      public void setDestination(org.bukkit.Location destination)
      Rewrites the landing spot.
      Parameters:
      destination - the new destination

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