org.bukkit.event.player
Class PlayerToggleSprintEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.player.PlayerEvent
          extended by org.bukkit.event.player.PlayerToggleSprintEvent
All Implemented Interfaces:
Cancellable

public class PlayerToggleSprintEvent
extends PlayerEvent
implements Cancellable

Called when a player toggles their sprinting state


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
PlayerToggleSprintEvent(Player player, boolean isSprinting)
           
 
Method Summary
static HandlerList getHandlerList()
           
 HandlerList getHandlers()
           
 boolean isCancelled()
          Gets the cancellation state of this event.
 boolean isSprinting()
          Gets whether the player is now sprinting or not.
 void setCancelled(boolean cancel)
          Sets the cancellation state of this event.
 
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

PlayerToggleSprintEvent

public PlayerToggleSprintEvent(Player player,
                               boolean isSprinting)
Method Detail

isSprinting

public boolean isSprinting()
Gets whether the player is now sprinting or not.

Returns:
sprinting state

isCancelled

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

Specified by:
isCancelled in interface Cancellable
Returns:
true if this event is cancelled

setCancelled

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

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

getHandlers

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

getHandlerList

public static HandlerList getHandlerList()


Copyright © 2013. All Rights Reserved.