net.tridentsdk.event.entity

Class PlayerToggleSprintEvent

java.lang.Object

net.tridentsdk.event.Event

net.tridentsdk.event.player.PlayerEvent

net.tridentsdk.event.entity.PlayerToggleSprintEvent

All Implemented Interfaces:

Cancellable

public class PlayerToggleSprintEvent
extends PlayerEvent
implements Cancellable

Called when a player tries to start sprinting, even if hunger would otherwise prevent them from sprinting

Constructor Summary

Constructors

Constructor and Description
PlayerToggleSprintEvent(Player player, boolean toggle)

Method Summary

Modifier and Type	Method and Description
void	cancel(boolean cancelled)
boolean	isIgnored()
boolean	sprintOff()
boolean	sprintOn()

Methods inherited from class net.tridentsdk.event.player.PlayerEvent

player

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

Method Detail

sprintOn

public boolean sprintOn()

Returns:

true if the player is trying to sprint

sprintOff

public boolean sprintOff()

Returns:

true if the player is trying to stop sprinting

isIgnored

public boolean isIgnored()

Specified by:

isIgnored in interface Cancellable

Returns:

return true if event is set to cancelled

cancel

public void cancel(boolean cancelled)

Specified by:

cancel in interface Cancellable

Parameters:

cancelled - set the cancellation state of the event