JSPrismarine

API reference / @jsprismarine/prismarine / Events / PlayerToggleSprintEvent

Class: PlayerToggleSprintEvent ​

Defined in: prismarine/src/events/player/PlayerToggleSprintEvent.ts:7

Fired as the player toggle sprinting

Extends ​

Constructors ​

Constructor ​

new PlayerToggleSprintEvent(player, sprinting): PlayerToggleSprintEvent

Defined in: prismarine/src/events/player/PlayerToggleSprintEvent.ts:11

Parameters ​

player ​

Player

sprinting ​

boolean

Returns ​

PlayerToggleSprintEvent

Overrides ​

Event.constructor

Methods ​

getIsSprinting() ​

getIsSprinting(): boolean

Defined in: prismarine/src/events/player/PlayerToggleSprintEvent.ts:21

Returns ​

boolean

getPlayer() ​

getPlayer(): Player

Defined in: prismarine/src/events/player/PlayerToggleSprintEvent.ts:17

Returns ​

Player

isCanceled() ​

isCanceled(): boolean

Defined in: prismarine/src/events/Event.ts:12

Is the event canceled

Returns ​

boolean

Whether the event is canceled

Inherited from ​

Event.isCanceled

preventDefault() ​

preventDefault(): void

Defined in: prismarine/src/events/Event.ts:19

Cancel the event

Returns ​

void

Inherited from ​

Event.preventDefault