Package org.bukkit.event.player
Class PlayerMoveEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerMoveEvent
- All Implemented Interfaces:
Cancellable
- Direct Known Subclasses:
PlayerTeleportEvent
Holds information for player movement events
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.player.PlayerEvent
player
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetFrom()
Gets the location this player moved fromstatic @NotNull HandlerList
getTo()
Gets the location this player moved toboolean
Check if the player has moved to a new block in the eventboolean
Check if the player has changed orientation in the eventboolean
Check if the player has changed position (even within the same block) in the eventboolean
Check if the player has moved to a new block in the event, disregarding a possible world changeboolean
Check if the player has changed position (even within the same block) in the event, disregarding a possible world changeboolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
Sets the location to mark as where the player moved fromvoid
Sets the location that this player will move toMethods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerMoveEvent
-
-
Method Details
-
isCancelled
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 pluginsIf 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 interfaceCancellable
- Returns:
- true if this event is cancelled
-
setCancelled
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 pluginsIf 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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getFrom
Gets the location this player moved from- Returns:
- Location the player moved from
-
setFrom
Sets the location to mark as where the player moved from- Parameters:
from
- New location to mark as the players previous location
-
getTo
Gets the location this player moved to- Returns:
- Location the player moved to
-
setTo
Sets the location that this player will move to- Parameters:
to
- New Location this player will move to
-
hasChangedPosition
public boolean hasChangedPosition()Check if the player has changed position (even within the same block) in the event- Returns:
- whether the player has changed position or not
-
hasExplicitlyChangedPosition
public boolean hasExplicitlyChangedPosition()Check if the player has changed position (even within the same block) in the event, disregarding a possible world change- Returns:
- whether the player has changed position or not
-
hasChangedBlock
public boolean hasChangedBlock()Check if the player has moved to a new block in the event- Returns:
- whether the player has moved to a new block or not
-
hasExplicitlyChangedBlock
public boolean hasExplicitlyChangedBlock()Check if the player has moved to a new block in the event, disregarding a possible world change- Returns:
- whether the player has moved to a new block or not
-
hasChangedOrientation
public boolean hasChangedOrientation()Check if the player has changed orientation in the event- Returns:
- whether the player has changed orientation or not
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-