Package io.github.thebusybiscuit.slimefun4.api.events

Class WaypointCreateEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
io.github.thebusybiscuit.slimefun4.api.events.WaypointCreateEvent
All Implemented Interfaces:
org.bukkit.event.Cancellable
public class WaypointCreateEvent extends org.bukkit.event.player.PlayerEvent implements org.bukkit.event.Cancellable
A WaypointCreateEvent is called when a Player creates a new waypoint. Either manually or through dying with an emergency transmitter.
Author:
TheBusyBiscuit
See Also:

  • Nested Class Summary

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

    org.bukkit.event.Event.Result

  • Field Summary

    Fields inherited from class org.bukkit.event.player.PlayerEvent

    player

  • Constructor Summary

    Constructors
    Constructor
    Description
    WaypointCreateEvent(org.bukkit.entity.Player player, String name, org.bukkit.Location location)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static org.bukkit.event.HandlerList
    getHandlerList()
     
    org.bukkit.event.HandlerList
    getHandlers()
     
    org.bukkit.Location
    getLocation()
    This returns the Location of the waypoint that should be created.
    String
    getName()
    This returns the name of the waypoint.
    boolean
    isCancelled()
     
    boolean
    isDeathpoint()
    This method returns whether this waypoint was created by an Emergency Transmitter.
    void
    setCancelled(boolean cancel)
     
    void
    setLocation(org.bukkit.Location loc)
    This sets the Location of the waypoint.
    void
    setName(String name)
    This sets the name of the waypoint to the given argument.

    Methods inherited from class org.bukkit.event.player.PlayerEvent

    getPlayer

    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

    • WaypointCreateEvent

      public WaypointCreateEvent(@Nonnull org.bukkit.entity.Player player, @Nonnull String name, @Nonnull org.bukkit.Location location)

  • Method Details

    • getLocation

      @Nonnull public org.bukkit.Location getLocation()
      This returns the Location of the waypoint that should be created.
      Returns:
      The Location of this waypoint

    • setLocation

      public void setLocation(@Nonnull org.bukkit.Location loc)
      This sets the Location of the waypoint. The Location may never be null!
      Parameters:
      loc - The Location to set

    • getName

      @Nonnull public String getName()
      This returns the name of the waypoint.
      Returns:
      The name of this waypoint

    • setName

      public void setName(@Nonnull String name)
      This sets the name of the waypoint to the given argument.
      Parameters:
      name - The name for this waypoint

    • isDeathpoint

      public boolean isDeathpoint()
      This method returns whether this waypoint was created by an Emergency Transmitter. This should mean that our Player has died.
      Returns:
      Whether this is a deathpoint

    • 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

    • getHandlerList

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

    • getHandlers

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