Package net.minestom.server.event.player

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 Summary

Constructors

Constructor	Description
PlayerMoveEvent(@NotNull Player player, @NotNull Pos newPosition, boolean onGround)

Method Summary

Modifier and Type	Method	Description
@NotNull Pos	getNewPosition()	Gets the target position.
@NotNull Player	getPlayer()	Gets the player.
boolean	isCancelled()	Gets if the Event should be cancelled or not.
boolean	isOnGround()	Gets if the player is now on the ground.
void	setCancelled(boolean cancel)	Marks the Event as cancelled or not.
void	setNewPosition(@NotNull Pos newPosition)	Changes the target position.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.minestom.server.event.trait.EntityInstanceEvent

getInstance

Methods inherited from interface net.minestom.server.event.trait.PlayerEvent

getEntity

Constructor Details

PlayerMoveEvent

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

Method Details

getNewPosition

@NotNull
public @NotNull Pos getNewPosition()

Gets the target position.

Returns:

the new position

setNewPosition

public void setNewPosition(@NotNull
 @NotNull 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

@NotNull
public @NotNull Player getPlayer()

Description copied from interface: PlayerEvent

Gets the player.

Specified by:

getPlayer in interface PlayerEvent

Returns:

the player