Class PlayerMoveEvent

All Implemented Interfaces:
Cancellable
Direct Known Subclasses:
PlayerTeleportEvent

public class PlayerMoveEvent extends PlayerEvent implements Cancellable
Holds information for player movement events
  • Constructor Details Link icon

    • PlayerMoveEvent Link icon

      public PlayerMoveEvent(@NotNull Player player, @NotNull Location from, @Nullable Location to)
  • Method Details Link icon

    • isCancelled Link icon

      public boolean isCancelled()
      Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

      If a move or teleport event is cancelled, the player will be moved or teleported back to the Location as defined by getFrom(). This will not fire an event

      Specified by:
      isCancelled in interface Cancellable
      Returns:
      true if this event is cancelled
    • setCancelled Link icon

      public void setCancelled(boolean cancel)
      Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

      If a move or teleport event is cancelled, the player will be moved or teleported back to the Location as defined by getFrom(). This will not fire an event

      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      cancel - true if you wish to cancel this event
    • getFrom Link icon

      @NotNull public Location getFrom()
      Gets the location this player moved from
      Returns:
      Location the player moved from
    • setFrom Link icon

      public void setFrom(@NotNull Location from)
      Sets the location to mark as where the player moved from
      Parameters:
      from - New location to mark as the players previous location
    • getTo Link icon

      @Nullable public Location getTo()
      Gets the location this player moved to
      Returns:
      Location the player moved to
    • setTo Link icon

      public void setTo(@NotNull Location to)
      Sets the location that this player will move to
      Parameters:
      to - New Location this player will move to
    • getHandlers Link icon

      @NotNull public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event
    • getHandlerList Link icon

      @NotNull public static HandlerList getHandlerList()