JSPrismarine

API reference / @jsprismarine/prismarine / Events / PlayerMoveEvent

Class: PlayerMoveEvent ​

Defined in: prismarine/src/events/player/PlayerMoveEvent.ts:9

Fired just before a player moves

Extends ​

Constructors ​

Constructor ​

new PlayerMoveEvent(player, to, mode?): PlayerMoveEvent

Defined in: prismarine/src/events/player/PlayerMoveEvent.ts:15

Parameters ​

player ​

Player

to ​

Vector3

mode? ​

PositionMode = PositionMode.Normal

Returns ​

PlayerMoveEvent

Overrides ​

Event.constructor

Methods ​

getFrom() ​

getFrom(): Vector3

Defined in: prismarine/src/events/player/PlayerMoveEvent.ts:28

Returns ​

Vector3

getMode() ​

getMode(): PositionMode

Defined in: prismarine/src/events/player/PlayerMoveEvent.ts:36

Returns ​

PositionMode

getPlayer() ​

getPlayer(): Player

Defined in: prismarine/src/events/player/PlayerMoveEvent.ts:24

Returns ​

Player

getTo() ​

getTo(): Vector3

Defined in: prismarine/src/events/player/PlayerMoveEvent.ts:32

Returns ​

Vector3

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