Package org.bukkit.event.player
Class PlayerToggleSprintEvent
- java.lang.Object
-
- org.bukkit.event.Event
-
- org.bukkit.event.player.PlayerEvent
-
- 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
Constructors Constructor Description PlayerToggleSprintEvent(Player player, boolean isSprinting)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
-
-
-
-
Constructor Detail
-
PlayerToggleSprintEvent
public PlayerToggleSprintEvent(@NotNull 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 interfaceCancellable
- 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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getHandlers
@NotNull public HandlerList getHandlers()
- Specified by:
getHandlers
in classEvent
-
getHandlerList
@NotNull public static HandlerList getHandlerList()
-
-