Class PlayerMoveEvent

Fired just before a player moves

Hierarchy (View Summary)

Event
- PlayerMoveEvent

Index

Constructors

Methods

getFrom getMode getPlayer getTo isCancelled preventDefault

Constructors

constructor

new PlayerMoveEvent(
    player: Player,
    to: Vector3,
    mode?: MovementType,
): PlayerMoveEvent
Parameters
- player: Player
- to: Vector3
- mode: MovementType = MovementType.Normal
Returns PlayerMoveEvent
Overrides Event.constructor
- Defined in packages/prismarine/src/events/player/PlayerMoveEvent.ts:15

Methods

getFrom

getFrom(): Vector3
Returns Vector3
- Defined in packages/prismarine/src/events/player/PlayerMoveEvent.ts:28

getMode

getMode(): MovementType
Returns MovementType
- Defined in packages/prismarine/src/events/player/PlayerMoveEvent.ts:36

getPlayer

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

getTo

getTo(): Vector3
Returns Vector3
- Defined in packages/prismarine/src/events/player/PlayerMoveEvent.ts:32

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