Class PlayerToggleSprintEvent

Fired as the player toggle sprinting

Hierarchy (View Summary)

Event
- PlayerToggleSprintEvent

Index

Constructors

Methods

getIsSprinting getPlayer isCancelled preventDefault

Constructors

constructor

new PlayerToggleSprintEvent(
player: Player,
sprinting: boolean,
): PlayerToggleSprintEvent
Parameters
- player: Player
- sprinting: boolean
Returns PlayerToggleSprintEvent
Overrides Event.constructor
- Defined in packages/prismarine/src/events/player/PlayerToggleSprintEvent.ts:11

Methods

getIsSprinting

getIsSprinting(): boolean
Returns boolean
- Defined in packages/prismarine/src/events/player/PlayerToggleSprintEvent.ts:21

getPlayer

getPlayer(): Player
Returns Player
- Defined in packages/prismarine/src/events/player/PlayerToggleSprintEvent.ts:17

isCancelled

isCancelled(): boolean
Is the event cancelled

Returns boolean
Whether the event is cancelled
Inherited from Event.isCancelled
- Defined in packages/prismarine/src/events/Event.ts:12

preventDefault

preventDefault(): void
Cancel the event

Returns void
Inherited from Event.preventDefault
- Defined in packages/prismarine/src/events/Event.ts:19