Class PlayerMoveEvent

java.lang.Object
net.minestom.server.event.player.PlayerMoveEvent
All Implemented Interfaces:
Event, CancellableEvent, EntityEvent, EntityInstanceEvent, InstanceEvent, PlayerEvent, PlayerInstanceEvent
public class PlayerMoveEvent extends Object implements PlayerInstanceEvent, CancellableEvent
Called when a player is modifying his position.

  • Constructor Details

    • PlayerMoveEvent

      public PlayerMoveEvent(Player player, Pos newPosition, boolean onGround)

  • Method Details

    • getNewPosition

      public Pos getNewPosition()
      Gets the target position.
      Returns:
      the new position

    • setNewPosition

      public void setNewPosition(Pos newPosition)
      Changes the target position.
      Parameters:
      newPosition - the new target position

    • isOnGround

      public boolean isOnGround()
      Gets if the player is now on the ground. This is the original value that the client sent, and is not modified by setting the new position.
      Returns:
      onGround

    • isCancelled

      public boolean isCancelled()
      Description copied from interface: CancellableEvent
      Gets if the Event should be cancelled or not.
      Specified by:
      isCancelled in interface CancellableEvent
      Returns:
      true if the event should be cancelled

    • setCancelled

      public void setCancelled(boolean cancel)
      Description copied from interface: CancellableEvent
      Marks the Event as cancelled or not.
      Specified by:
      setCancelled in interface CancellableEvent
      Parameters:
      cancel - true if the event should be cancelled, false otherwise

    • getPlayer

      public Player getPlayer()
      Description copied from interface: PlayerEvent
      Gets the player.
      Specified by:
      getPlayer in interface PlayerEvent
      Returns:
      the player