org.bukkit.event.player
Class PlayerMoveEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.player.PlayerEvent
          extended by org.bukkit.event.player.PlayerMoveEvent
All Implemented Interfaces:
Cancellable
Direct Known Subclasses:
PlayerTeleportEvent

public class PlayerMoveEvent
extends PlayerEvent
implements Cancellable

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
PlayerMoveEvent(Player player, Location from, Location to)
           
 
Method Summary
 Location getFrom()
          Gets the location this player moved from
static HandlerList getHandlerList()
           
 HandlerList getHandlers()
           
 Location getTo()
          Gets the location this player moved to
 boolean isCancelled()
          Gets the cancellation state of this event.
 void setCancelled(boolean cancel)
          Sets the cancellation state of this event.
 void setFrom(Location from)
          Sets the location to mark as where the player moved from
 void setTo(Location to)
          Sets the location that this player will move to
 
Methods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
 
Methods inherited from class org.bukkit.event.Event
getEventName, isAsynchronous
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlayerMoveEvent

public PlayerMoveEvent(Player player,
                       Location from,
                       Location to)
Method Detail

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 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

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

public Location getFrom()
Gets the location this player moved from

Returns:
Location the player moved from

setFrom

public void setFrom(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

public Location getTo()
Gets the location this player moved to

Returns:
Location the player moved to

setTo

public void setTo(Location to)
Sets the location that this player will move to

Parameters:
to - New Location this player will move to

getHandlers

public HandlerList getHandlers()
Specified by:
getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()


Copyright © 2013. All Rights Reserved.