PlayerMoveBeforeEvent

Interface in @minecraft/server

Extends CancellableEvent

Basalt’s own: cancelled, the player is put back; a changed toLocation sends them there.

import type { PlayerMoveBeforeEvent } from '@minecraft/server';

Subscribe to it with world.beforeEvents.playerMove.

Example

TypeScript JavaScript

import { world, type PlayerMoveBeforeEvent } from '@minecraft/server';

world.beforeEvents.playerMove.subscribe((event: PlayerMoveBeforeEvent) => {
    console.log('playerMove', event.player.name);

    // Uncomment to stop it from happening.
    // event.cancel = true;
});

import { world } from '@minecraft/server';

world.beforeEvents.playerMove.subscribe((event) => {
    console.log('playerMove', event.player.name);

    // Uncomment to stop it from happening.
    // event.cancel = true;
});

Properties

player

read-only

readonly player: Player;

Types

Player

fromLocation

read-only

readonly fromLocation: Vector3;

Types

Vector3

toLocation

toLocation: Vector3;

Types

Vector3

Used by

WorldBeforeEvents.playerMove

Inherited

From CancellableEvent: cancel