API reference / @jsprismarine/prismarine / events/player/PlayerMoveEvent / PlayerMoveEvent

Class: PlayerMoveEvent

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

Fired just before a player moves

Extends

• PlayerEvent

Constructors

Constructor

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

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

Parameters

session

PlayerSession

The session of the player the event is about.

to

Vector3

Where it moves to.

mode?

PositionMode = PositionMode.Normal

How the client is told.

Returns

PlayerMoveEvent

Overrides

PlayerEvent.constructor

Methods

getFrom()

getFrom(): Vector3

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

Returns

Vector3

---

getIdentity()

getIdentity(): PlayerIdentity

Defined in: prismarine/src/events/player/PlayerEvent.ts:34

Who the player logged in as.

Returns

PlayerIdentity

The name, the XUID (empty when the login carried none) and the UUID.

Inherited from

PlayerEvent.getIdentity

---

getMode()

getMode(): PositionMode

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

Returns

PositionMode

---

getRuntimeId()

getRuntimeId(): bigint

Defined in: prismarine/src/events/player/PlayerEvent.ts:26

The player's runtime id, which the wire and the player's session use.

Returns

bigint

The id.

Inherited from

PlayerEvent.getRuntimeId

---

getSession()

getSession(): PlayerSession

Defined in: prismarine/src/events/player/PlayerEvent.ts:44

The session of the player the event is about, for a listener that acts on the player: it sends to the client, and getPlayer() reaches the player's state while it is connected. To name the player, read PlayerEvent.getRuntimeId or PlayerEvent.getIdentity.

Returns

PlayerSession

The session.

Inherited from

PlayerEvent.getSession

---

getTo()

getTo(): Vector3

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

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

PlayerEvent.isCanceled

---

preventDefault()

preventDefault(): void

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

Cancel the event

Returns

void

Inherited from

PlayerEvent.preventDefault