Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.event.player.PlayerToggleSprintEvent Class Reference
Inheritance diagram for org.bukkit.event.player.PlayerToggleSprintEvent:
org.bukkit.event.player.PlayerEvent org.bukkit.event.Cancellable org.bukkit.event.Event

Public Member Functions

 PlayerToggleSprintEvent (final Player player, final boolean isSprinting)
 
boolean isSprinting ()
 
boolean isCancelled ()
 
void setCancelled (boolean cancel)
 
HandlerList getHandlers ()
 
- Public Member Functions inherited from org.bukkit.event.player.PlayerEvent
 PlayerEvent (final Player who)
 
final Player getPlayer ()
 
- Public Member Functions inherited from org.bukkit.event.Event
 Event ()
 
 Event (boolean isAsync)
 
String getEventName ()
 
abstract HandlerList getHandlers ()
 
final boolean isAsynchronous ()
 

Static Public Member Functions

static HandlerList getHandlerList ()
 

Additional Inherited Members

- Protected Attributes inherited from org.bukkit.event.player.PlayerEvent
Player player
 

Detailed Description

Called when a player toggles their sprinting state

Definition at line 10 of file PlayerToggleSprintEvent.java.

Member Function Documentation

boolean org.bukkit.event.player.PlayerToggleSprintEvent.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

Returns
true if this event is cancelled

Implements org.bukkit.event.Cancellable.

Definition at line 29 of file PlayerToggleSprintEvent.java.

29  {
30  return cancel;
31  }
boolean org.bukkit.event.player.PlayerToggleSprintEvent.isSprinting ( )

Gets whether the player is now sprinting or not.

Returns
sprinting state

Definition at line 25 of file PlayerToggleSprintEvent.java.

void org.bukkit.event.player.PlayerToggleSprintEvent.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.

Parameters
canceltrue if you wish to cancel this event

Implements org.bukkit.event.Cancellable.

Definition at line 33 of file PlayerToggleSprintEvent.java.

33  {
34  this.cancel = cancel;
35  }

The documentation for this class was generated from the following file: